Class BlogPostsApi

Index

Constructors

Methods

archive archiveBatch archiveBatchWithHttpInfo archiveWithHttpInfo attachToLangGroup attachToLangGroupWithHttpInfo clone cloneWithHttpInfo create createBatch createBatchWithHttpInfo createLangVariation createLangVariationWithHttpInfo createWithHttpInfo detachFromLangGroup detachFromLangGroupWithHttpInfo getById getByIdWithHttpInfo getDraftById getDraftByIdWithHttpInfo getPage getPageWithHttpInfo getPreviousVersion getPreviousVersions getPreviousVersionsWithHttpInfo getPreviousVersionWithHttpInfo pushLive pushLiveWithHttpInfo readBatch readBatchWithHttpInfo resetDraft resetDraftWithHttpInfo restorePreviousVersion restorePreviousVersionToDraft restorePreviousVersionToDraftWithHttpInfo restorePreviousVersionWithHttpInfo schedule scheduleWithHttpInfo setLangPrimary setLangPrimaryWithHttpInfo update updateBatch updateBatchWithHttpInfo updateDraft updateDraftWithHttpInfo updateLangs updateLangsWithHttpInfo updateWithHttpInfo

Constructors

constructor

new BlogPostsApi(configuration, requestFactory?, responseProcessor?): BlogPostsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: BlogPostsApiRequestFactory
- OptionalresponseProcessor: BlogPostsApiResponseProcessor
Returns BlogPostsApi
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:26

Methods

archiveBatch

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

archiveBatchWithHttpInfo

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

archiveWithHttpInfo

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

attachToLangGroup

attachToLangGroup(attachToLangPrimaryRequestVNext, _options?): Promise<void>
Attach a Blog Post to a multi-language group. Attach a Blog Post to a multi-language group
Parameters
- attachToLangPrimaryRequestVNext: AttachToLangPrimaryRequestVNext
  The JSON representation of the AttachToLangPrimaryRequest object.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:91

attachToLangGroupWithHttpInfo

attachToLangGroupWithHttpInfo(attachToLangPrimaryRequestVNext, _options?): Promise<HttpInfo<void>>
Attach a Blog Post to a multi-language group. Attach a Blog Post to a multi-language group
Parameters
- attachToLangPrimaryRequestVNext: AttachToLangPrimaryRequestVNext
  The JSON representation of the AttachToLangPrimaryRequest object.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:81

clone

clone(contentCloneRequestVNext, _options?): Promise<BlogPost>
Clone a Blog Post. Clone a Blog Post
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:111

cloneWithHttpInfo

cloneWithHttpInfo(contentCloneRequestVNext, _options?): Promise<HttpInfo<BlogPost>>
Clone a Blog Post. Clone a Blog Post
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
  The JSON representation of the ContentCloneRequest object.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:101

create

create(blogPost, _options?): Promise<BlogPost>
Create a new Blog Post. Create a new Blog Post
Parameters
- blogPost: BlogPost
  The JSON representation of a new Blog Post.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:131

createBatch

createBatch(batchInputBlogPost, _options?): Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
Create the Blog Post objects detailed in the request body. Create a batch of Blog Posts
Parameters
- batchInputBlogPost: BatchInputBlogPost
  The JSON array of new Blog Posts to create.
- Optional_options: Configuration
Returns Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:151

createBatchWithHttpInfo

createBatchWithHttpInfo(batchInputBlogPost, _options?): Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
Create the Blog Post objects detailed in the request body. Create a batch of Blog Posts
Parameters
- batchInputBlogPost: BatchInputBlogPost
  The JSON array of new Blog Posts to create.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:141

createLangVariation

createLangVariation(blogPostLanguageCloneRequestVNext, _options?): Promise<BlogPost>
Create a new language variation from an existing Blog Post Create a new language variation
Parameters
- blogPostLanguageCloneRequestVNext: BlogPostLanguageCloneRequestVNext
  The JSON representation of the BlogPostLanguageCloneRequestVNext object.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:171

createLangVariationWithHttpInfo

createLangVariationWithHttpInfo(blogPostLanguageCloneRequestVNext, _options?): Promise<HttpInfo<BlogPost>>
Create a new language variation from an existing Blog Post Create a new language variation
Parameters
- blogPostLanguageCloneRequestVNext: BlogPostLanguageCloneRequestVNext
  The JSON representation of the BlogPostLanguageCloneRequestVNext object.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:161

createWithHttpInfo

createWithHttpInfo(blogPost, _options?): Promise<HttpInfo<BlogPost>>
Create a new Blog Post. Create a new Blog Post
Parameters
- blogPost: BlogPost
  The JSON representation of a new Blog Post.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:121

detachFromLangGroup

detachFromLangGroup(detachFromLangGroupRequestVNext, _options?): Promise<void>
Detach a Blog Post from a multi-language group. Detach a Blog Post from a multi-language group
Parameters
- detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext
  The JSON representation of the DetachFromLangGroupRequest object.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:191

detachFromLangGroupWithHttpInfo

detachFromLangGroupWithHttpInfo(detachFromLangGroupRequestVNext, _options?): Promise<HttpInfo<void>>
Detach a Blog Post from a multi-language group. Detach a Blog Post from a multi-language group
Parameters
- detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext
  The JSON representation of the DetachFromLangGroupRequest object.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:181

getById

getById(objectId, archived?, property?, _options?): Promise<BlogPost>
Retrieve the Blog Post object identified by the id in the path. Retrieve a Blog Post
Parameters
- objectId: string
  The Blog Post id.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:215

getByIdWithHttpInfo

getByIdWithHttpInfo(objectId, archived?, property?, _options?): Promise<HttpInfo<BlogPost>>
Retrieve the Blog Post object identified by the id in the path. Retrieve a Blog Post
Parameters
- objectId: string
  The Blog Post id.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:203

getDraftById

getDraftById(objectId, _options?): Promise<BlogPost>
Retrieve the full draft version of the Blog Post. Retrieve the full draft version of the Blog Post
Parameters
- objectId: string
  The Blog Post id.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:235

getDraftByIdWithHttpInfo

getDraftByIdWithHttpInfo(objectId, _options?): Promise<HttpInfo<BlogPost>>
Retrieve the full draft version of the Blog Post. Retrieve the full draft version of the Blog Post
Parameters
- objectId: string
  The Blog Post id.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:225

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<CollectionResponseWithTotalBlogPostForwardPaging>
Get the list of blog posts. 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 Blog 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 `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 20.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<CollectionResponseWithTotalBlogPostForwardPaging>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:275

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<HttpInfo<CollectionResponseWithTotalBlogPostForwardPaging>>
Get the list of blog posts. 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 Blog 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 `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 20.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseWithTotalBlogPostForwardPaging>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:255

getPreviousVersion

getPreviousVersion(objectId, revisionId, _options?): Promise<VersionBlogPost>
Retrieves a previous version of a blog post. Retrieves a previous version of a blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: string
  The Blog Post version id.
- Optional_options: Configuration
Returns Promise<VersionBlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:297

getPreviousVersions

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

getPreviousVersionsWithHttpInfo

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

getPreviousVersionWithHttpInfo

getPreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<VersionBlogPost>>
Retrieves a previous version of a blog post. Retrieves a previous version of a blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: string
  The Blog Post version id.
- Optional_options: Configuration
Returns Promise<HttpInfo<VersionBlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:286

pushLive

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

pushLiveWithHttpInfo

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

readBatch

readBatch(batchInputString, archived?, _options?): Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
Retrieve the Blog Post objects identified in the request body. Retrieve a batch of Blog Posts
Parameters
- batchInputString: BatchInputString
  The JSON array of Blog Post ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:365

readBatchWithHttpInfo

readBatchWithHttpInfo(batchInputString, archived?, _options?): Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
Retrieve the Blog Post objects identified in the request body. Retrieve a batch of Blog Posts
Parameters
- batchInputString: BatchInputString
  The JSON array of Blog Post ids.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:354

resetDraft

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

resetDraftWithHttpInfo

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

restorePreviousVersion

restorePreviousVersion(objectId, revisionId, _options?): Promise<BlogPost>
Takes a specified version of a blog post and restores it. Restore a previous version of a blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: string
  The Blog Post version id to restore.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:407

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 previous version of a blog post, to the draft version of the blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: number
  The Blog Post version id to restore.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:429

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 previous version of a blog post, to the draft version of the blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: number
  The Blog Post version id to restore.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:418

restorePreviousVersionWithHttpInfo

restorePreviousVersionWithHttpInfo(objectId, revisionId, _options?): Promise<HttpInfo<BlogPost>>
Takes a specified version of a blog post and restores it. Restore a previous version of a blog post
Parameters
- objectId: string
  The Blog Post id.
- revisionId: string
  The Blog Post version id to restore.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:396

schedule

schedule(contentScheduleRequestVNext, _options?): Promise<void>
Schedule a Blog Post to be Published. Schedule a Blog Post to be Published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:449

scheduleWithHttpInfo

scheduleWithHttpInfo(contentScheduleRequestVNext, _options?): Promise<HttpInfo<void>>
Schedule a Blog Post to be Published. Schedule a Blog Post to be Published
Parameters
- contentScheduleRequestVNext: ContentScheduleRequestVNext
  The JSON representation of the ContentScheduleRequestVNext object.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:439

setLangPrimary

setLangPrimary(setNewLanguagePrimaryRequestVNext, _options?): Promise<void>
Set the primary language of a multi-language group to the language of the provided post (specified as an id in the request body) Set a new primary language
Parameters
- setNewLanguagePrimaryRequestVNext: SetNewLanguagePrimaryRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:469

setLangPrimaryWithHttpInfo

setLangPrimaryWithHttpInfo(setNewLanguagePrimaryRequestVNext, _options?): Promise<HttpInfo<void>>
Set the primary language of a multi-language group to the language of the provided post (specified as an id in the request body) Set a new primary language
Parameters
- setNewLanguagePrimaryRequestVNext: SetNewLanguagePrimaryRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:459

update

update(objectId, blogPost, archived?, _options?): Promise<BlogPost>
Sparse updates a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. Update a Blog Post
Parameters
- objectId: string
  The Blog Post id.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:493

updateBatch

updateBatch(batchInputJsonNode, archived?, _options?): Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
Update the Blog Post objects identified in the request body. Update a batch of Blog Posts
Parameters
- batchInputJsonNode: BatchInputJsonNode
  A JSON array of the JSON representations of the updated Blog Posts.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:515

updateBatchWithHttpInfo

updateBatchWithHttpInfo(batchInputJsonNode, archived?, _options?): Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
Update the Blog Post objects identified in the request body. Update a batch of Blog Posts
Parameters
- batchInputJsonNode: BatchInputJsonNode
  A JSON array of the JSON representations of the updated Blog Posts.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:504

updateDraft

updateDraft(objectId, blogPost, _options?): Promise<BlogPost>
Sparse updates the draft version of a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. Update a Blog Post draft
Parameters
- objectId: string
  The Blog Post id.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post to be applied to the draft.
- Optional_options: Configuration
Returns Promise<BlogPost>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:537

updateDraftWithHttpInfo

updateDraftWithHttpInfo(objectId, blogPost, _options?): Promise<HttpInfo<BlogPost>>
Sparse updates the draft version of a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. Update a Blog Post draft
Parameters
- objectId: string
  The Blog Post id.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post to be applied to the draft.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:526

updateLangs

updateLangs(updateLanguagesRequestVNext, _options?): Promise<void>
Explicitly set new languages for each Blog Post in a multi-language group. Update languages of multi-language group
Parameters
- updateLanguagesRequestVNext: UpdateLanguagesRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:557

updateLangsWithHttpInfo

updateLangsWithHttpInfo(updateLanguagesRequestVNext, _options?): Promise<HttpInfo<void>>
Explicitly set new languages for each Blog Post in a multi-language group. Update languages of multi-language group
Parameters
- updateLanguagesRequestVNext: UpdateLanguagesRequestVNext
  The JSON representation of the SetNewLanguagePrimaryRequest object.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:547

updateWithHttpInfo

updateWithHttpInfo(objectId, blogPost, archived?, _options?): Promise<HttpInfo<BlogPost>>
Sparse updates a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. Update a Blog Post
Parameters
- objectId: string
  The Blog Post id.
- blogPost: BlogPost
  The JSON representation of the updated Blog Post.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Posts. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<BlogPost>>
- Defined in codegen/cms/blogs/blog_posts/types/PromiseAPI.ts:481

Class BlogPostsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BlogPostsApi

Methods

archive

Parameters

Returns Promise<void>

archiveBatch

Parameters

Returns Promise<void>

archiveBatchWithHttpInfo

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<BlogPost>

cloneWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

create

Parameters

Returns Promise<BlogPost>

createBatch

Parameters

Returns Promise<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>

createBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseBlogPost | BatchResponseBlogPostWithErrors>>

createLangVariation

Parameters

Returns Promise<BlogPost>

createLangVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<BlogPost>>

detachFromLangGroup

Parameters

Returns Promise<void>

detachFromLangGroupWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

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