Type Alias Site

Type declaration

• createSiteExportTemplate:function

  • createSiteExportTemplate(): SiteExportInterface

    Create an empty site export template

    Returns SiteExportInterface

    an empty site export template

• exportSite:function

  • exportSite(siteId: string): Promise<SiteExportInterface>

    Export a single site by id. The response can be saved to file as is.

    Parameters

    • siteId: string

      Site id

    Returns Promise<SiteExportInterface>

    Promise resolving to a SiteExportInterface object.

• exportSites:function

  • exportSites(): Promise<SiteExportInterface>

    Export all sites. The response can be saved to file as is.

    Returns Promise<SiteExportInterface>

    Promise resolving to a SiteExportInterface object.

• importSites:function

  • importSites(
        importData: SiteExportInterface,
        siteId?: string,
        siteUrl?: string,
    ): Promise<SiteSkeleton[]>

    Import sites

    Parameters

    • importData: SiteExportInterface

      site import data
    • OptionalsiteId: string

      Optional site id. If supplied, only the site of that id is imported. Takes priority over siteUrl if both are provided.
    • OptionalsiteUrl: string

      Optional site url. If supplied, only the site of that url is imported.

    Returns Promise<SiteSkeleton[]>

    the imported sites

• readSite:function

  • readSite(siteId: string): Promise<SiteSkeleton>

    Read site by id

    Parameters

    • siteId: string

      Site id

    Returns Promise<SiteSkeleton>

    a promise that resolves to a site object

• readSites:function

  • readSites(): Promise<SiteSkeleton[]>

    Read all sites.

    Returns Promise<SiteSkeleton[]>

    a promise that resolves to an array of site objects

• updateSite:function

  • updateSite(siteId: string, siteData: SiteSkeleton): Promise<SiteSkeleton>

    Update site

    Parameters

    • siteId: string

      site id
    • siteData: SiteSkeleton

      site data

    Returns Promise<SiteSkeleton>

    a promise resolving to a site object