Class BlogTagsApi

Hierarchy

BlogTagsApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

new BlogTagsApi(configuration, requestFactory?, responseProcessor?): BlogTagsApi
Parameters
- configuration: Configuration
- Optional requestFactory: BlogTagsApiRequestFactory
- Optional responseProcessor: BlogTagsApiResponseProcessor
Returns BlogTagsApi
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:21

Properties

`Private` api

api: ObservableBlogTagsApi

Methods

archiveBatch

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

attachToLangGroup

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

create

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

createBatch

createBatch(batchInputTag, _options?): Promise<BatchResponseTag | BatchResponseTagWithErrors>
Create the Blog Tag objects detailed in the request body. Create a batch of Blog Tags
Parameters
- batchInputTag: BatchInputTag
  
  The JSON array of new Blog Tags to create.
- Optional _options: Configuration
Returns Promise<BatchResponseTag | BatchResponseTagWithErrors>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:75

createLangVariation

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

detachFromLangGroup

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

getById

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

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, _options?): Promise<CollectionResponseWithTotalTagForwardPaging>
Get the list of blog tags. 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 Tags
Parameters
- Optional createdAt: Date
  
  Only return Blog Tags created at exactly the specified time.
- Optional createdAfter: Date
  
  Only return Blog Tags created after the specified time.
- Optional createdBefore: Date
  
  Only return Blog Tags created before the specified time.
- Optional updatedAt: Date
  
  Only return Blog Tags last updated at exactly the specified time.
- Optional updatedAfter: Date
  
  Only return Blog Tags last updated after the specified time.
- Optional updatedBefore: Date
  
  Only return Blog Tags 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 Tags. Defaults to `false`.
- Optional _options: Configuration
Returns Promise<CollectionResponseWithTotalTagForwardPaging>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:125

readBatch

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

setLangPrimary

setLangPrimary(setNewLanguagePrimaryRequestVNext, _options?): Promise<void>
Set a Blog Tag 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/tags/types/PromiseAPI.ts:146

update

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

updateBatch

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

updateLangs

updateLangs(updateLanguagesRequestVNext, _options?): Promise<void>
Explicitly set new languages for each Blog Tag 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/tags/types/PromiseAPI.ts:179

Class BlogTagsApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: BlogTagsApiRequestFactory

Optional responseProcessor: BlogTagsApiResponseProcessor

Returns BlogTagsApi

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

tag: Tag

Optional _options: Configuration

Returns Promise<Tag>

createBatch

Parameters

batchInputTag: BatchInputTag

Optional _options: Configuration

Returns Promise<BatchResponseTag | BatchResponseTagWithErrors>

createLangVariation

Parameters

tagCloneRequestVNext: TagCloneRequestVNext

Optional _options: Configuration

Returns Promise<Tag>

detachFromLangGroup

Parameters

detachFromLangGroupRequestVNext: DetachFromLangGroupRequestVNext

Optional _options: Configuration

Returns Promise<void>

getById

Parameters

objectId: string

Optional archived: boolean

Optional _options: Configuration

Returns Promise<Tag>

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

readBatch

Parameters

batchInputString: BatchInputString

Optional archived: boolean

Optional _options: Configuration

Returns Promise<BatchResponseTag | BatchResponseTagWithErrors>

setLangPrimary

Parameters

`Optional` requestFactory: BlogTagsApiRequestFactory

`Optional` responseProcessor: BlogTagsApiResponseProcessor

`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