Class BasicApi

Constructors

constructor

new BasicApi(configuration, requestFactory?, responseProcessor?): BasicApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: BasicApiRequestFactory
- OptionalresponseProcessor: BasicApiResponseProcessor
Returns BasicApi
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:27

Methods

archiveWithHttpInfo

archiveWithHttpInfo(objectId, archived?, _options?): Promise<HttpInfo<void>>
Delete a blog post by ID. Delete a blog post
Parameters
- objectId: string
  The ID of the blog post to delete.
- Optionalarchived: boolean
  Whether to return only results that have been deleted.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:41

clone

clone(contentCloneRequestVNext, _options?): Promise<BlogPost>
Clone a blog post, making a copy of it in a new blog post. Clone a blog post
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:108

cloneWithHttpInfo

cloneWithHttpInfo(contentCloneRequestVNext, _options?): Promise<HttpInfo<BlogPost>>
Clone a blog post, making a copy of it in a new blog post. Clone a blog post
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:86

create

create(blogPost, _options?): Promise<BlogPost>
Create a new blog post, specifying its content in the request body. Create a new post
Parameters
- blogPost: BlogPost
  The JSON representation of a new Blog Post.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:152

createWithHttpInfo

createWithHttpInfo(blogPost, _options?): Promise<HttpInfo<BlogPost>>
Create a new blog post, specifying its content in the request body. Create a new post
Parameters
- blogPost: BlogPost
  The JSON representation of a new Blog Post.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:130

getById

getById(objectId, archived?, property?, _options?): Promise<BlogPost>
Retrieve a blog post by the post ID. Retrieve a blog post
Parameters
- objectId: string
  The ID of the blog post to retrieve.
- Optionalarchived: boolean
  Specifies whether to return deleted blog posts. Defaults to `false`.
- Optionalproperty: string
  Specific properties to return.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:200

getByIdWithHttpInfo

getByIdWithHttpInfo(objectId, archived?, property?, _options?): Promise<HttpInfo<BlogPost>>
Retrieve a blog post by the post ID. Retrieve a blog post
Parameters
- objectId: string
  The ID of the blog post to retrieve.
- Optionalarchived: boolean
  Specifies whether to return deleted blog posts. Defaults to `false`.
- Optionalproperty: string
  Specific properties to return.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:176

getDraftById

getDraftById(objectId, _options?): Promise<BlogPost>
Retrieve the full draft version of a blog post. Retrieve the full draft version of the Blog Post
Parameters
- objectId: string
  The ID of the blog post to retrieve the draft of.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:244

getDraftByIdWithHttpInfo

getDraftByIdWithHttpInfo(objectId, _options?): Promise<HttpInfo<BlogPost>>
Retrieve the full draft version of a blog post. Retrieve the full draft version of the Blog Post
Parameters
- objectId: string
  The ID of the blog post to retrieve the draft of.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:222

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<CollectionResponseWithTotalBlogPostForwardPaging>
Retrieve all blog posts, with paging and filtering options. This method would be useful for an integration that ingests posts and suggests edits. Get all posts
Parameters
- OptionalcreatedAt: Date
  Only return blog posts created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return blog posts created after the specified time.
- OptionalcreatedBefore: Date
  Only return blog posts created before the specified time.
- OptionalupdatedAt: Date
  Only return blog posts last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return blog posts last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return blog posts last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `createdAt` (default), `name`, `updatedAt`, `createdBy`, `updatedBy`.
- 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 20.
- Optionalarchived: boolean
  Specifies whether to return deleted blog posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalBlogPostForwardPaging>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:308

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<HttpInfo<CollectionResponseWithTotalBlogPostForwardPaging>>
Retrieve all blog posts, with paging and filtering options. This method would be useful for an integration that ingests posts and suggests edits. Get all posts
Parameters
- OptionalcreatedAt: Date
  Only return blog posts created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return blog posts created after the specified time.
- OptionalcreatedBefore: Date
  Only return blog posts created before the specified time.
- OptionalupdatedAt: Date
  Only return blog posts last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return blog posts last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return blog posts last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `createdAt` (default), `name`, `updatedAt`, `createdBy`, `updatedBy`.
- 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 20.
- Optionalarchived: boolean
  Specifies whether to return deleted blog posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalBlogPostForwardPaging>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:276

getPreviousVersion

getPreviousVersion(objectId, revisionId, _options?): Promise<VersionBlogPost>
Retrieve a previous version of a blog post. Retrieve a previous version of a blog post
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: string
  The ID of the version to retrieve.
- Optional_options: PromiseConfigurationOptions
Returns Promise<VersionBlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:354

getPreviousVersions

getPreviousVersions(objectId, after?, before?, limit?, _options?): Promise<CollectionResponseWithTotalVersionBlogPost>
Retrieve all the previous versions of a blog post. Retrieves all previous versions of a post
Parameters
- objectId: string
  The ID of the blog post to retrieve previous versions of.
- 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<CollectionResponseWithTotalVersionBlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:404

getPreviousVersionsWithHttpInfo

getPreviousVersionsWithHttpInfo(objectId, after?, before?, limit?, _options?): Promise<HttpInfo<CollectionResponseWithTotalVersionBlogPost>>
Retrieve all the previous versions of a blog post. Retrieves all previous versions of a post
Parameters
- objectId: string
  The ID of the blog post to retrieve previous versions of.
- 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<CollectionResponseWithTotalVersionBlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:379

getPreviousVersionWithHttpInfo

getPreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<VersionBlogPost>>
Retrieve a previous version of a blog post. Retrieve a previous version of a blog post
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: string
  The ID of the version to retrieve.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<VersionBlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:331

pushLive

pushLive(objectId, _options?): Promise<void>
Publish the draft version of the blog post, sending its content to the live page. Publish blog post draft
Parameters
- objectId: string
  The ID of the post to publish.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:448

pushLiveWithHttpInfo

pushLiveWithHttpInfo(objectId, _options?): Promise<HttpInfo<void>>
Publish the draft version of the blog post, sending its content to the live page. Publish blog post draft
Parameters
- objectId: string
  The ID of the post to publish.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:426

resetDraft

resetDraft(objectId, _options?): Promise<void>
Discard all drafted content, resetting the draft to contain the content in the currently published version. Reset post draft to the live version
Parameters
- objectId: string
  The ID of the blog post to reset.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:492

resetDraftWithHttpInfo

resetDraftWithHttpInfo(objectId, _options?): Promise<HttpInfo<void>>
Discard all drafted content, resetting the draft to contain the content in the currently published version. Reset post draft to the live version
Parameters
- objectId: string
  The ID of the blog post to reset.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:470

restorePreviousVersion

restorePreviousVersion(objectId, revisionId, _options?): Promise<BlogPost>
Restores a blog post to one of its previous versions. Restore a previous version
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: string
  The ID of the version to restore the blog post to.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:538

restorePreviousVersionToDraft

restorePreviousVersionToDraft(objectId, revisionId, _options?): Promise<BlogPost>
Takes a specified version of a blog post, sets it as the new draft version of the blog post. Restore a draft to a previous version
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: number
  The ID of the version to restore the blog post to.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:584

restorePreviousVersionToDraftWithHttpInfo

restorePreviousVersionToDraftWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<BlogPost>>
Takes a specified version of a blog post, sets it as the new draft version of the blog post. Restore a draft to a previous version
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: number
  The ID of the version to restore the blog post to.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:561

restorePreviousVersionWithHttpInfo

restorePreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<BlogPost>>
Restores a blog post to one of its previous versions. Restore a previous version
Parameters
- objectId: string
  The ID of the blog post.
- revisionId: string
  The ID of the version to restore the blog post to.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:515

schedule

schedule(contentScheduleRequestVNext, _options?): Promise<void>
Schedule a blog post to be published at a specified time. Schedule a post to be published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:628

scheduleWithHttpInfo

scheduleWithHttpInfo(contentScheduleRequestVNext, _options?): Promise<HttpInfo<void>>
Schedule a blog post to be published at a specified time. Schedule a post to be published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:606

update

update(objectId, blogPost, archived?, _options?): Promise<BlogPost>
Partially updates a single blog post by ID. You only need to specify the values that you want to update. Update a post
Parameters
- objectId: string
  The ID of the blog post to update.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post.
- Optionalarchived: boolean
  Specifies whether to update deleted blog posts. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:676

updateDraft

updateDraft(objectId, blogPost, _options?): Promise<BlogPost>
Partially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update. Update the draft of a post
Parameters
- objectId: string
  The ID of the blog post to update the draft of.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post to be applied to the draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:722

updateDraftWithHttpInfo

updateDraftWithHttpInfo(objectId, blogPost, _options?): Promise<HttpInfo<BlogPost>>
Partially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update. Update the draft of a post
Parameters
- objectId: string
  The ID of the blog post to update the draft of.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post to be applied to the draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:699

updateWithHttpInfo

updateWithHttpInfo(objectId, blogPost, archived?, _options?): Promise<HttpInfo<BlogPost>>
Partially updates a single blog post by ID. You only need to specify the values that you want to update. Update a post
Parameters
- objectId: string
  The ID of the blog post to update.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post.
- Optionalarchived: boolean
  Specifies whether to update deleted blog posts. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:652

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

clone

Parameters

Returns Promise<BlogPost>

cloneWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

create

Parameters

Returns Promise<BlogPost>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

getById

Parameters

Returns Promise<BlogPost>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

getDraftById

Parameters

Returns Promise<BlogPost>

getDraftByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

getPage

Parameters

Returns Promise<CollectionResponseWithTotalBlogPostForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalBlogPostForwardPaging>>

getPreviousVersion

Parameters

Returns Promise<VersionBlogPost>

getPreviousVersions

Parameters

Returns Promise<CollectionResponseWithTotalVersionBlogPost>

getPreviousVersionsWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalVersionBlogPost>>

getPreviousVersionWithHttpInfo

Parameters

Returns Promise<HttpInfo<VersionBlogPost>>

pushLive

Parameters

Returns Promise<void>

pushLiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

resetDraft

Parameters

Returns Promise<void>

resetDraftWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

restorePreviousVersion

Parameters

Returns Promise<BlogPost>

restorePreviousVersionToDraft

Parameters

Returns Promise<BlogPost>

restorePreviousVersionToDraftWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

restorePreviousVersionWithHttpInfo

Parameters