Class BlogAuthorsApi

Hierarchy

BlogAuthorsApi

Index

Constructors

Properties

Methods

archive archiveBatch attachToLangGroup create createBatch createLangVariation detachFromLangGroup getById getPage readBatch setLangPrimary update updateBatch updateLangs

Constructors

constructor

new BlogAuthorsApi(configuration, requestFactory?, responseProcessor?): BlogAuthorsApi
Parameters
- configuration: Configuration
- Optional requestFactory: BlogAuthorsApiRequestFactory
- Optional responseProcessor: BlogAuthorsApiResponseProcessor
Returns BlogAuthorsApi
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:21

Properties

`Private` api

api: ObservableBlogAuthorsApi

Methods

archiveBatch

archiveBatch(batchInputString, _options?): Promise<void>
Delete the Blog Author objects identified in the request body. Delete a batch of Blog Authors
Parameters
- batchInputString: BatchInputString
  
  The JSON array of Blog Author ids.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:45

attachToLangGroup

attachToLangGroup(attachToLangPrimaryRequestVNext, _options?): Promise<void>
Attach a Blog Author to a multi-language group. Attach a Blog Author 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/authors/types/PromiseAPI.ts:55

create

create(blogAuthor, _options?): Promise<BlogAuthor>
Create a new Blog Author. Create a new Blog Author
Parameters
- blogAuthor: BlogAuthor
  
  The JSON representation of a new Blog Author.
- Optional _options: Configuration
Returns Promise<BlogAuthor>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:65

createBatch

createBatch(batchInputBlogAuthor, _options?): Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
Create the Blog Author objects detailed in the request body. Create a batch of Blog Authors
Parameters
- batchInputBlogAuthor: BatchInputBlogAuthor
  
  The JSON array of new Blog Authors to create.
- Optional _options: Configuration
Returns Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:75

createLangVariation

createLangVariation(blogAuthorCloneRequestVNext, _options?): Promise<BlogAuthor>
Create a new language variation from an existing Blog Author. Create a new language variation
Parameters
- blogAuthorCloneRequestVNext: BlogAuthorCloneRequestVNext
  
  The JSON representation of the ContentLanguageCloneRequest object.
- Optional _options: Configuration
Returns Promise<BlogAuthor>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:85

detachFromLangGroup

detachFromLangGroup(detachFromLangGroupRequestVNext, _options?): Promise<void>
Detach a Blog Author from a multi-language group. Detach a Blog Author 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/authors/types/PromiseAPI.ts:95

getById

getById(objectId, archived?, _options?): Promise<BlogAuthor>
Retrieve the Blog Author object identified by the id in the path. Retrieve a Blog Author
Parameters
- objectId: string
  
  The Blog Author id.
- Optional archived: boolean
  
  Specifies whether to return deleted Blog Authors. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<BlogAuthor>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:106

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, _options?): Promise<CollectionResponseWithTotalBlogAuthorForwardPaging>
Get the list of blog authors. 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 Authors
Parameters
- Optional createdAt: Date
  
  Only return Blog Authors created at exactly the specified time.
- Optional createdAfter: Date
  
  Only return Blog Authors created after the specified time.
- Optional createdBefore: Date
  
  Only return Blog Authors created before the specified time.
- Optional updatedAt: Date
  
  Only return Blog Authors last updated at exactly the specified time.
- Optional updatedAfter: Date
  
  Only return Blog Authors last updated after the specified time.
- Optional updatedBefore: Date
  
  Only return Blog Authors last updated before the specified time.
- Optional sort: string[]
  
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optional after: 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.
- Optional limit: number
  
  The maximum number of results to return. Default is 100.
- Optional archived: boolean
  
  Specifies whether to return deleted Blog Authors. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<CollectionResponseWithTotalBlogAuthorForwardPaging>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:125

readBatch

readBatch(batchInputString, archived?, _options?): Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
Retrieve the Blog Author objects identified in the request body. Retrieve a batch of Blog Authors
Parameters
- batchInputString: BatchInputString
  
  The JSON array of Blog Author ids.
- Optional archived: boolean
  
  Specifies whether to return deleted Blog Authors. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:136

setLangPrimary

setLangPrimary(setNewLanguagePrimaryRequestVNext, _options?): Promise<void>
Set a Blog Author 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: Configuration
Returns Promise<void>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:146

update

update(objectId, blogAuthor, archived?, _options?): Promise<BlogAuthor>
Sparse updates a single Blog Author 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 Author
Parameters
- objectId: string
  
  The Blog Author id.
- blogAuthor: BlogAuthor
  
  The JSON representation of the updated Blog Author.
- Optional archived: boolean
  
  Specifies whether to update deleted Blog Authors. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<BlogAuthor>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:158

updateBatch

updateBatch(batchInputJsonNode, archived?, _options?): Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
Update the Blog Author objects identified in the request body. Update a batch of Blog Authors
Parameters
- batchInputJsonNode: BatchInputJsonNode
  
  A JSON array of the JSON representations of the updated Blog Authors.
- Optional archived: boolean
  
  Specifies whether to update deleted Blog Authors. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>
- Defined in codegen/cms/blogs/authors/types/PromiseAPI.ts:169

updateLangs

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

Class BlogAuthorsApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: BlogAuthorsApiRequestFactory

Optional responseProcessor: BlogAuthorsApiResponseProcessor

Returns BlogAuthorsApi

Properties

Private api

Methods

archive

Parameters

objectId: string

Optional archived: boolean

Optional _options: Configuration

Returns Promise<void>

archiveBatch

Parameters

batchInputString: BatchInputString

Optional _options: Configuration

Returns Promise<void>

attachToLangGroup

Parameters

attachToLangPrimaryRequestVNext: AttachToLangPrimaryRequestVNext

Optional _options: Configuration

Returns Promise<void>

create

Parameters

blogAuthor: BlogAuthor

Optional _options: Configuration

Returns Promise<BlogAuthor>

createBatch

Parameters

batchInputBlogAuthor: BatchInputBlogAuthor

Optional _options: Configuration

Returns Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>

createLangVariation

Parameters

blogAuthorCloneRequestVNext: BlogAuthorCloneRequestVNext

Optional _options: Configuration

Returns Promise<BlogAuthor>

detachFromLangGroup

Parameters

detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext

Optional _options: Configuration

Returns Promise<void>

getById

Parameters

objectId: string

Optional archived: boolean

Optional _options: Configuration

Returns Promise<BlogAuthor>

getPage

Parameters

Optional createdAt: Date

Optional createdAfter: Date

Optional createdBefore: Date

Optional updatedAt: Date

Optional updatedAfter: Date

Optional updatedBefore: Date

Optional sort: string[]

Optional after: string

Optional limit: number

Optional archived: boolean

Optional _options: Configuration

Returns Promise<CollectionResponseWithTotalBlogAuthorForwardPaging>

readBatch

Parameters

batchInputString: BatchInputString

Optional archived: boolean

Optional _options: Configuration

Returns Promise<BatchResponseBlogAuthor | BatchResponseBlogAuthorWithErrors>

setLangPrimary

Parameters

`Optional` requestFactory: BlogAuthorsApiRequestFactory

`Optional` responseProcessor: BlogAuthorsApiResponseProcessor

`Private` api

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` createdAt: Date

`Optional` createdAfter: Date

`Optional` createdBefore: Date

`Optional` updatedAt: Date

`Optional` updatedAfter: Date

`Optional` updatedBefore: Date

`Optional` sort: string[]

`Optional` after: string

`Optional` limit: number

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` archived: boolean

`Optional` _options: Configuration

`Optional` _options: Configuration