Type Alias Site

type Site = {
    createSiteExportTemplate(): SiteExportInterface;
    exportSite(siteId: string): Promise<SiteExportInterface>;
    exportSites(): Promise<SiteExportInterface>;
    importSites(
        importData: SiteExportInterface,
        siteId?: string,
        siteUrl?: string,
    ): Promise<SiteSkeleton[]>;
    readSite(siteId: string): Promise<SiteSkeleton>;
    readSites(): Promise<SiteSkeleton[]>;
    updateSite(siteId: string, siteData: SiteSkeleton): Promise<SiteSkeleton>;
}

Index

Methods

createSiteExportTemplate exportSite exportSites importSites readSite readSites updateSite

Methods

createSiteExportTemplate

createSiteExportTemplate(): SiteExportInterface
Create an empty site export template

Returns SiteExportInterface
an empty site export template
- Defined in ops/classic/SiteOps.ts:23

exportSite

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.
- Defined in ops/classic/SiteOps.ts:40

exportSites

exportSites(): Promise<SiteExportInterface>
Export all sites. The response can be saved to file as is.

Returns Promise<SiteExportInterface>
Promise resolving to a SiteExportInterface object.
- Defined in ops/classic/SiteOps.ts:45

importSites

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
- Defined in ops/classic/SiteOps.ts:60

readSite

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
- Defined in ops/classic/SiteOps.ts:29

readSites

readSites(): Promise<SiteSkeleton[]>
Read all sites.

Returns Promise<SiteSkeleton[]>
a promise that resolves to an array of site objects
- Defined in ops/classic/SiteOps.ts:34

updateSite

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
- Defined in ops/classic/SiteOps.ts:52