Class LandingPagesApi

Index

Constructors

Methods

archive archiveBatch archiveBatchWithHttpInfo archiveFolder archiveFolders archiveFoldersWithHttpInfo archiveFolderWithHttpInfo archiveWithHttpInfo attachToLangGroup attachToLangGroupWithHttpInfo clone cloneWithHttpInfo create createABTestVariation createABTestVariationWithHttpInfo createBatch createBatchWithHttpInfo createFolder createFolders createFoldersWithHttpInfo createFolderWithHttpInfo createLangVariation createLangVariationWithHttpInfo createWithHttpInfo detachFromLangGroup detachFromLangGroupWithHttpInfo endActiveABTest endActiveABTestWithHttpInfo getById getByIdWithHttpInfo getDraftById getDraftByIdWithHttpInfo getFolderById getFolderByIdWithHttpInfo getFolderPreviousVersion getFolderPreviousVersions getFolderPreviousVersionsWithHttpInfo getFolderPreviousVersionWithHttpInfo getFoldersPage getFoldersPageWithHttpInfo getPage getPageWithHttpInfo getPreviousVersion getPreviousVersions getPreviousVersionsWithHttpInfo getPreviousVersionWithHttpInfo pushLive pushLiveWithHttpInfo readBatch readBatchWithHttpInfo readFolders readFoldersWithHttpInfo rerunPreviousABTest rerunPreviousABTestWithHttpInfo resetDraft resetDraftWithHttpInfo restoreFolderPreviousVersion restoreFolderPreviousVersionWithHttpInfo restorePreviousVersion restorePreviousVersionToDraft restorePreviousVersionToDraftWithHttpInfo restorePreviousVersionWithHttpInfo schedule scheduleWithHttpInfo setLangPrimary setLangPrimaryWithHttpInfo update updateBatch updateBatchWithHttpInfo updateDraft updateDraftWithHttpInfo updateFolder updateFolders updateFoldersWithHttpInfo updateFolderWithHttpInfo updateLangs updateLangsWithHttpInfo updateWithHttpInfo

Constructors

constructor

new LandingPagesApi(configuration, requestFactory?, responseProcessor?): LandingPagesApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: LandingPagesApiRequestFactory
- OptionalresponseProcessor: LandingPagesApiResponseProcessor
Returns LandingPagesApi
- Defined in codegen/cms/pages/types/PromiseAPI.ts:37

Methods

archiveBatch

archiveBatch(batchInputString, _options?): Promise<void>
Delete the Landing Page objects identified in the request body. Note: This is not the same as the dashboard archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true. Delete a batch of Landing Pages
Parameters
- batchInputString: BatchInputString
  The JSON array of Landing Page ids.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:118

archiveBatchWithHttpInfo

archiveBatchWithHttpInfo(batchInputString, _options?): Promise<HttpInfo<void>>
Delete the Landing Page objects identified in the request body. Note: This is not the same as the dashboard archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true. Delete a batch of Landing Pages
Parameters
- batchInputString: BatchInputString
  The JSON array of Landing Page ids.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:96

archiveFolder

archiveFolder(objectId, archived?, _options?): Promise<void>
Delete the Folder object identified by the id in the path. Delete a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:164

archiveFolders

archiveFolders(batchInputString, _options?): Promise<void>
Delete the Folder objects identified in the request body. Delete a batch of Folders
Parameters
- batchInputString: BatchInputString
  The JSON array of Folder ids.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:208

archiveFoldersWithHttpInfo

archiveFoldersWithHttpInfo(batchInputString, _options?): Promise<HttpInfo<void>>
Delete the Folder objects identified in the request body. Delete a batch of Folders
Parameters
- batchInputString: BatchInputString
  The JSON array of Folder ids.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:186

archiveFolderWithHttpInfo

archiveFolderWithHttpInfo(objectId, archived?, _options?): Promise<HttpInfo<void>>
Delete the Folder object identified by the id in the path. Delete a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:141

archiveWithHttpInfo

archiveWithHttpInfo(objectId, archived?, _options?): Promise<HttpInfo<void>>
Delete the Landing Page object identified by the id in the path. Delete a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:51

attachToLangGroup

attachToLangGroup(attachToLangPrimaryRequestVNext, _options?): Promise<void>
Attach a landing page to a multi-language group. Attach a landing page to a multi-language group
Parameters
- attachToLangPrimaryRequestVNext: AttachToLangPrimaryRequestVNext
  The JSON representation of the AttachToLangPrimaryRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:252

attachToLangGroupWithHttpInfo

attachToLangGroupWithHttpInfo(attachToLangPrimaryRequestVNext, _options?): Promise<HttpInfo<void>>
Attach a landing page to a multi-language group. Attach a landing page to a multi-language group
Parameters
- attachToLangPrimaryRequestVNext: AttachToLangPrimaryRequestVNext
  The JSON representation of the AttachToLangPrimaryRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:230

clone

clone(contentCloneRequestVNext, _options?): Promise<Page>
Clone a Landing Page Clone a Landing Page
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:296

cloneWithHttpInfo

cloneWithHttpInfo(contentCloneRequestVNext, _options?): Promise<HttpInfo<Page>>
Clone a Landing Page Clone a Landing Page
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:274

create

create(page, _options?): Promise<void | Page>
Create a new Landing Page Create a new Landing Page
Parameters
- page: Page
  The JSON representation of a new Landing Page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void | Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:340

createABTestVariation

createABTestVariation(abTestCreateRequestVNext, _options?): Promise<Page>
Create a new A/B test variation based on the information provided in the request body. Create a new A/B test variation
Parameters
- abTestCreateRequestVNext: AbTestCreateRequestVNext
  The JSON representation of the AbTestCreateRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:384

createABTestVariationWithHttpInfo

createABTestVariationWithHttpInfo(abTestCreateRequestVNext, _options?): Promise<HttpInfo<Page>>
Create a new A/B test variation based on the information provided in the request body. Create a new A/B test variation
Parameters
- abTestCreateRequestVNext: AbTestCreateRequestVNext
  The JSON representation of the AbTestCreateRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:362

createBatch

createBatch(batchInputPage, _options?): Promise<BatchResponsePage | BatchResponsePageWithErrors>
Create the Landing Page objects detailed in the request body. Create a batch of Landing Pages
Parameters
- batchInputPage: BatchInputPage
  The JSON array of new Landing Pages to create.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePage | BatchResponsePageWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:428

createBatchWithHttpInfo

createBatchWithHttpInfo(batchInputPage, _options?): Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
Create the Landing Page objects detailed in the request body. Create a batch of Landing Pages
Parameters
- batchInputPage: BatchInputPage
  The JSON array of new Landing Pages to create.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:406

createFolder

createFolder(contentFolder, _options?): Promise<ContentFolder>
Create a new Folder Create a new Folder
Parameters
- contentFolder: ContentFolder
  The JSON representation of a new Folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:472

createFolders

createFolders(batchInputContentFolder, _options?): Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
Create the Folder objects detailed in the request body. Create a batch of Folders
Parameters
- batchInputContentFolder: BatchInputContentFolder
  The JSON array of new Folders to create.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:516

createFoldersWithHttpInfo

createFoldersWithHttpInfo(batchInputContentFolder, _options?): Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
Create the Folder objects detailed in the request body. Create a batch of Folders
Parameters
- batchInputContentFolder: BatchInputContentFolder
  The JSON array of new Folders to create.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:494

createFolderWithHttpInfo

createFolderWithHttpInfo(contentFolder, _options?): Promise<HttpInfo<ContentFolder>>
Create a new Folder Create a new Folder
Parameters
- contentFolder: ContentFolder
  The JSON representation of a new Folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:450

createLangVariation

createLangVariation(contentLanguageCloneRequestVNext, _options?): Promise<Page>
Create a new language variation from an existing landing page Create a new language variation
Parameters
- contentLanguageCloneRequestVNext: ContentLanguageCloneRequestVNext
  The JSON representation of the ContentLanguageCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:560

createLangVariationWithHttpInfo

createLangVariationWithHttpInfo(contentLanguageCloneRequestVNext, _options?): Promise<HttpInfo<Page>>
Create a new language variation from an existing landing page Create a new language variation
Parameters
- contentLanguageCloneRequestVNext: ContentLanguageCloneRequestVNext
  The JSON representation of the ContentLanguageCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:538

createWithHttpInfo

createWithHttpInfo(page, _options?): Promise<HttpInfo<void | Page>>
Create a new Landing Page Create a new Landing Page
Parameters
- page: Page
  The JSON representation of a new Landing Page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void | Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:318

detachFromLangGroup

detachFromLangGroup(detachFromLangGroupRequestVNext, _options?): Promise<void>
Detach a landing page from a multi-language group. Detach a landing page from a multi-language group
Parameters
- detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext
  The JSON representation of the DetachFromLangGroupRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:604

detachFromLangGroupWithHttpInfo

detachFromLangGroupWithHttpInfo(detachFromLangGroupRequestVNext, _options?): Promise<HttpInfo<void>>
Detach a landing page from a multi-language group. Detach a landing page from a multi-language group
Parameters
- detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext
  The JSON representation of the DetachFromLangGroupRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:582

endActiveABTest

endActiveABTest(abTestEndRequestVNext, _options?): Promise<void>
End an active A/B test and designate a winner. End an active A/B test
Parameters
- abTestEndRequestVNext: AbTestEndRequestVNext
  The JSON representation of the AbTestEndRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:648

endActiveABTestWithHttpInfo

endActiveABTestWithHttpInfo(abTestEndRequestVNext, _options?): Promise<HttpInfo<void>>
End an active A/B test and designate a winner. End an active A/B test
Parameters
- abTestEndRequestVNext: AbTestEndRequestVNext
  The JSON representation of the AbTestEndRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:626

getById

getById(objectId, archived?, property?, _options?): Promise<Page>
Retrieve the Landing Page object identified by the id in the path. Retrieve a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:696

getByIdWithHttpInfo

getByIdWithHttpInfo(objectId, archived?, property?, _options?): Promise<HttpInfo<Page>>
Retrieve the Landing Page object identified by the id in the path. Retrieve a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:672

getDraftById

getDraftById(objectId, _options?): Promise<Page>
Retrieve the full draft version of the Landing Page. Retrieve the full draft version of the Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:740

getDraftByIdWithHttpInfo

getDraftByIdWithHttpInfo(objectId, _options?): Promise<HttpInfo<Page>>
Retrieve the full draft version of the Landing Page. Retrieve the full draft version of the Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:718

getFolderById

getFolderById(objectId, archived?, property?, _options?): Promise<ContentFolder>
Retrieve the Folder object identified by the id in the path. Retrieve a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<ContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:788

getFolderByIdWithHttpInfo

getFolderByIdWithHttpInfo(objectId, archived?, property?, _options?): Promise<HttpInfo<ContentFolder>>
Retrieve the Folder object identified by the id in the path. Retrieve a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:764

getFolderPreviousVersion

getFolderPreviousVersion(objectId, revisionId, _options?): Promise<VersionContentFolder>
Retrieves a previous version of a Folder Retrieves a previous version of a Folder
Parameters
- objectId: string
  The Folder id.
- revisionId: string
  The Folder version id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<VersionContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:834

getFolderPreviousVersions

getFolderPreviousVersions(objectId, after?, before?, limit?, _options?): Promise<CollectionResponseWithTotalVersionContentFolder>
Retrieves all the previous versions of a Folder. Retrieves all the previous versions of a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalVersionContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:884

getFolderPreviousVersionsWithHttpInfo

getFolderPreviousVersionsWithHttpInfo(objectId, after?, before?, limit?, _options?): Promise<HttpInfo<CollectionResponseWithTotalVersionContentFolder>>
Retrieves all the previous versions of a Folder. Retrieves all the previous versions of a Folder
Parameters
- objectId: string
  The Folder id.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalVersionContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:859

getFolderPreviousVersionWithHttpInfo

getFolderPreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<VersionContentFolder>>
Retrieves a previous version of a Folder Retrieves a previous version of a Folder
Parameters
- objectId: string
  The Folder id.
- revisionId: string
  The Folder version id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<VersionContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:811

getFoldersPage

getFoldersPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<CollectionResponseWithTotalContentFolderForwardPaging>
Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. Get all Landing Page Folders
Parameters
- OptionalcreatedAt: Date
  Only return Folders created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Folders created after the specified time.
- OptionalcreatedBefore: Date
  Only return Folders created before the specified time.
- OptionalupdatedAt: Date
  Only return Folders last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Folders last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Folders last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalContentFolderForwardPaging>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:948

getFoldersPageWithHttpInfo

getFoldersPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<HttpInfo<CollectionResponseWithTotalContentFolderForwardPaging>>
Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. Get all Landing Page Folders
Parameters
- OptionalcreatedAt: Date
  Only return Folders created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Folders created after the specified time.
- OptionalcreatedBefore: Date
  Only return Folders created before the specified time.
- OptionalupdatedAt: Date
  Only return Folders last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Folders last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Folders last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalContentFolderForwardPaging>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:916

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<CollectionResponseWithTotalPageForwardPaging>
Get the list of landing pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. Get all Landing Pages
Parameters
- OptionalcreatedAt: Date
  Only return Landing Pages created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Landing Pages created after the specified time.
- OptionalcreatedBefore: Date
  Only return Landing Pages created before the specified time.
- OptionalupdatedAt: Date
  Only return Landing Pages last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Landing Pages last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Landing Pages last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalPageForwardPaging>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1012

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<HttpInfo<CollectionResponseWithTotalPageForwardPaging>>
Get the list of landing pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits. Get all Landing Pages
Parameters
- OptionalcreatedAt: Date
  Only return Landing Pages created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Landing Pages created after the specified time.
- OptionalcreatedBefore: Date
  Only return Landing Pages created before the specified time.
- OptionalupdatedAt: Date
  Only return Landing Pages last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Landing Pages last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Landing Pages last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalPageForwardPaging>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:980

getPreviousVersion

getPreviousVersion(objectId, revisionId, _options?): Promise<VersionPage>
Retrieves a previous version of a Landing Page Retrieves a previous version of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: string
  The Landing Page version id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<VersionPage>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1058

getPreviousVersions

getPreviousVersions(objectId, after?, before?, limit?, _options?): Promise<CollectionResponseWithTotalVersionPage>
Retrieves all the previous versions of a Landing Page. Retrieves all the previous versions of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalVersionPage>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1108

getPreviousVersionsWithHttpInfo

getPreviousVersionsWithHttpInfo(objectId, after?, before?, limit?, _options?): Promise<HttpInfo<CollectionResponseWithTotalVersionPage>>
Retrieves all the previous versions of a Landing Page. Retrieves all the previous versions of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalVersionPage>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1083

getPreviousVersionWithHttpInfo

getPreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<VersionPage>>
Retrieves a previous version of a Landing Page Retrieves a previous version of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: string
  The Landing Page version id.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<VersionPage>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1035

pushLive

pushLive(objectId, _options?): Promise<void>
Take any changes from the draft version of the Landing Page and apply them to the live version. Push Landing Page draft edits live
Parameters
- objectId: string
  The id of the Landing Page for which it's draft will be pushed live.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1152

pushLiveWithHttpInfo

pushLiveWithHttpInfo(objectId, _options?): Promise<HttpInfo<void>>
Take any changes from the draft version of the Landing Page and apply them to the live version. Push Landing Page draft edits live
Parameters
- objectId: string
  The id of the Landing Page for which it's draft will be pushed live.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1130

readBatch

readBatch(batchInputString, archived?, _options?): Promise<BatchResponsePage | BatchResponsePageWithErrors>
Retrieve the Landing Page objects identified in the request body. Retrieve a batch of Landing Pages
Parameters
- batchInputString: BatchInputString
  The JSON array of Landing Page ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePage | BatchResponsePageWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1198

readBatchWithHttpInfo

readBatchWithHttpInfo(batchInputString, archived?, _options?): Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
Retrieve the Landing Page objects identified in the request body. Retrieve a batch of Landing Pages
Parameters
- batchInputString: BatchInputString
  The JSON array of Landing Page ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1175

readFolders

readFolders(batchInputString, archived?, _options?): Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
Update the Folder objects identified in the request body. Retrieve a batch of Folders
Parameters
- batchInputString: BatchInputString
  The JSON array of Folder ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1244

readFoldersWithHttpInfo

readFoldersWithHttpInfo(batchInputString, archived?, _options?): Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
Update the Folder objects identified in the request body. Retrieve a batch of Folders
Parameters
- batchInputString: BatchInputString
  The JSON array of Folder ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Folders. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1221

rerunPreviousABTest

rerunPreviousABTest(abTestRerunRequestVNext, _options?): Promise<void>
Rerun a previous A/B test. Rerun a previous A/B test
Parameters
- abTestRerunRequestVNext: AbTestRerunRequestVNext
  The JSON representation of the AbTestRerunRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1288

rerunPreviousABTestWithHttpInfo

rerunPreviousABTestWithHttpInfo(abTestRerunRequestVNext, _options?): Promise<HttpInfo<void>>
Rerun a previous A/B test. Rerun a previous A/B test
Parameters
- abTestRerunRequestVNext: AbTestRerunRequestVNext
  The JSON representation of the AbTestRerunRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1266

resetDraft

resetDraft(objectId, _options?): Promise<void>
Discards any edits and resets the draft to the live version. Reset the Landing Page draft to the live version
Parameters
- objectId: string
  The id of the Landing Page for which it's draft will be reset.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1332

resetDraftWithHttpInfo

resetDraftWithHttpInfo(objectId, _options?): Promise<HttpInfo<void>>
Discards any edits and resets the draft to the live version. Reset the Landing Page draft to the live version
Parameters
- objectId: string
  The id of the Landing Page for which it's draft will be reset.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1310

restoreFolderPreviousVersion

restoreFolderPreviousVersion(objectId, revisionId, _options?): Promise<ContentFolder>
Takes a specified version of a Folder and restores it. Restore a previous version of a Folder
Parameters
- objectId: string
  The Folder id.
- revisionId: string
  The Folder version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1378

restoreFolderPreviousVersionWithHttpInfo

restoreFolderPreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<ContentFolder>>
Takes a specified version of a Folder and restores it. Restore a previous version of a Folder
Parameters
- objectId: string
  The Folder id.
- revisionId: string
  The Folder version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1355

restorePreviousVersion

restorePreviousVersion(objectId, revisionId, _options?): Promise<Page>
Takes a specified version of a Landing Page and restores it. Restore a previous version of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: string
  The Landing Page version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1424

restorePreviousVersionToDraft

restorePreviousVersionToDraft(objectId, revisionId, _options?): Promise<Page>
Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page. Restore a previous version of a Landing Page, to the draft version of the Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: number
  The Landing Page version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1470

restorePreviousVersionToDraftWithHttpInfo

restorePreviousVersionToDraftWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<Page>>
Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page. Restore a previous version of a Landing Page, to the draft version of the Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: number
  The Landing Page version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1447

restorePreviousVersionWithHttpInfo

restorePreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<Page>>
Takes a specified version of a Landing Page and restores it. Restore a previous version of a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- revisionId: string
  The Landing Page version id to restore.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1401

schedule

schedule(contentScheduleRequestVNext, _options?): Promise<void>
Schedule a Landing Page to be Published Schedule a Landing Page to be Published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1514

scheduleWithHttpInfo

scheduleWithHttpInfo(contentScheduleRequestVNext, _options?): Promise<HttpInfo<void>>
Schedule a Landing Page to be Published Schedule a Landing Page to be Published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1492

setLangPrimary

setLangPrimary(setNewLanguagePrimaryRequestVNext, _options?): Promise<void>
Set a landing page as the primary language of a multi-language group. Set a new primary language
Parameters
- setNewLanguagePrimaryRequestVNext: SetNewLanguagePrimaryRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1558

setLangPrimaryWithHttpInfo

setLangPrimaryWithHttpInfo(setNewLanguagePrimaryRequestVNext, _options?): Promise<HttpInfo<void>>
Set a landing page as the primary language of a multi-language group. Set a new primary language
Parameters
- setNewLanguagePrimaryRequestVNext: SetNewLanguagePrimaryRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1536

update

update(objectId, page, archived?, _options?): Promise<Page>
Sparse updates a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- page: Page
  The JSON representation of the updated Landing Page.
- Optionalarchived: boolean
  Specifies whether to update deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1606

updateBatch

updateBatch(batchInputJsonNode, archived?, _options?): Promise<BatchResponsePage | BatchResponsePageWithErrors>
Update the Landing Page objects identified in the request body. Update a batch of Landing Pages
Parameters
- batchInputJsonNode: BatchInputJsonNode
  The JSON representation of the updated Landing Pages.
- Optionalarchived: boolean
  Specifies whether to update deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePage | BatchResponsePageWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1652

updateBatchWithHttpInfo

updateBatchWithHttpInfo(batchInputJsonNode, archived?, _options?): Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
Update the Landing Page objects identified in the request body. Update a batch of Landing Pages
Parameters
- batchInputJsonNode: BatchInputJsonNode
  The JSON representation of the updated Landing Pages.
- Optionalarchived: boolean
  Specifies whether to update deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1629

updateDraft

updateDraft(objectId, page, _options?): Promise<Page>
Sparse updates the draft version of a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Landing Page draft
Parameters
- objectId: string
  The Landing Page id.
- page: Page
  The JSON representation of the updated Landing Page to be applied to the draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<Page>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1698

updateDraftWithHttpInfo

updateDraftWithHttpInfo(objectId, page, _options?): Promise<HttpInfo<Page>>
Sparse updates the draft version of a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Landing Page draft
Parameters
- objectId: string
  The Landing Page id.
- page: Page
  The JSON representation of the updated Landing Page to be applied to the draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1675

updateFolder

updateFolder(objectId, contentFolder, archived?, _options?): Promise<ContentFolder>
Sparse updates a single Folder object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Folder
Parameters
- objectId: string
  The Folder id.
- contentFolder: ContentFolder
  The JSON representation of the updated Folder.
- Optionalarchived: boolean
  Specifies whether to update deleted Folders. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ContentFolder>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1746

updateFolders

updateFolders(batchInputJsonNode, archived?, _options?): Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
Update the Folder objects identified in the request body. Update a batch of Folders
Parameters
- batchInputJsonNode: BatchInputJsonNode
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1792

updateFoldersWithHttpInfo

updateFoldersWithHttpInfo(batchInputJsonNode, archived?, _options?): Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
Update the Folder objects identified in the request body. Update a batch of Folders
Parameters
- batchInputJsonNode: BatchInputJsonNode
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1769

updateFolderWithHttpInfo

updateFolderWithHttpInfo(objectId, contentFolder, archived?, _options?): Promise<HttpInfo<ContentFolder>>
Sparse updates a single Folder object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Folder
Parameters
- objectId: string
  The Folder id.
- contentFolder: ContentFolder
  The JSON representation of the updated Folder.
- Optionalarchived: boolean
  Specifies whether to update deleted Folders. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ContentFolder>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1722

updateLangs

updateLangs(updateLanguagesRequestVNext, _options?): Promise<void>
Explicitly set new languages for each landing page in a multi-language group. Update languages of multi-language group
Parameters
- updateLanguagesRequestVNext: UpdateLanguagesRequestVNext
  The JSON representation of the UpdateLanguagesRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1836

updateLangsWithHttpInfo

updateLangsWithHttpInfo(updateLanguagesRequestVNext, _options?): Promise<HttpInfo<void>>
Explicitly set new languages for each landing page in a multi-language group. Update languages of multi-language group
Parameters
- updateLanguagesRequestVNext: UpdateLanguagesRequestVNext
  The JSON representation of the UpdateLanguagesRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1814

updateWithHttpInfo

updateWithHttpInfo(objectId, page, archived?, _options?): Promise<HttpInfo<Page>>
Sparse updates a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying. Update a Landing Page
Parameters
- objectId: string
  The Landing Page id.
- page: Page
  The JSON representation of the updated Landing Page.
- Optionalarchived: boolean
  Specifies whether to update deleted Landing Pages. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Page>>
- Defined in codegen/cms/pages/types/PromiseAPI.ts:1582

Class LandingPagesApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LandingPagesApi

Methods

archive

Parameters

Returns Promise<void>

archiveBatch

Parameters

Returns Promise<void>

archiveBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveFolder

Parameters

Returns Promise<void>

archiveFolders

Parameters

Returns Promise<void>

archiveFoldersWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveFolderWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

attachToLangGroup

Parameters

Returns Promise<void>

attachToLangGroupWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

clone

Parameters

Returns Promise<Page>

cloneWithHttpInfo

Parameters

Returns Promise<HttpInfo<Page>>

create

Parameters

Returns Promise<void | Page>

createABTestVariation

Parameters

Returns Promise<Page>

createABTestVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<Page>>

createBatch

Parameters

Returns Promise<BatchResponsePage | BatchResponsePageWithErrors>

createBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponsePage | BatchResponsePageWithErrors>>

createFolder

Parameters

Returns Promise<ContentFolder>

createFolders

Parameters

Returns Promise<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>

createFoldersWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseContentFolder | BatchResponseContentFolderWithErrors>>

createFolderWithHttpInfo

Parameters

Returns Promise<HttpInfo<ContentFolder>>

createLangVariation

Parameters

Returns Promise<Page>

createLangVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<Page>>

createWithHttpInfo

Parameters