Class BlogTagsApi

Constructors

constructor

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

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:67

archiveBatchWithHttpInfo

archiveBatchWithHttpInfo(batchInputString, _options?): Promise<HttpInfo<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<HttpInfo<void>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:57

archiveWithHttpInfo

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

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:87

attachToLangGroupWithHttpInfo

attachToLangGroupWithHttpInfo(attachToLangPrimaryRequestVNext, _options?): Promise<HttpInfo<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<HttpInfo<void>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:77

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:107

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:127

createBatchWithHttpInfo

createBatchWithHttpInfo(batchInputTag, _options?): Promise<HttpInfo<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<HttpInfo<BatchResponseTag | BatchResponseTagWithErrors>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:117

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:147

createLangVariationWithHttpInfo

createLangVariationWithHttpInfo(tagCloneRequestVNext, _options?): Promise<HttpInfo<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<HttpInfo<Tag>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:137

createWithHttpInfo

createWithHttpInfo(tag, _options?): Promise<HttpInfo<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<HttpInfo<Tag>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:97

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:167

detachFromLangGroupWithHttpInfo

detachFromLangGroupWithHttpInfo(detachFromLangGroupRequestVNext, _options?): Promise<HttpInfo<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<HttpInfo<void>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:157

getById

getById(objectId, archived?, property?, _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.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Tags. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<Tag>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:191

getByIdWithHttpInfo

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

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _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
- OptionalcreatedAt: Date
  Only return Blog Tags created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Blog Tags created after the specified time.
- OptionalcreatedBefore: Date
  Only return Blog Tags created before the specified time.
- OptionalupdatedAt: Date
  Only return Blog Tags last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Blog Tags last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Blog Tags 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 Blog Tags. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<CollectionResponseWithTotalTagForwardPaging>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:231

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, property?, _options?): Promise<HttpInfo<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
- OptionalcreatedAt: Date
  Only return Blog Tags created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return Blog Tags created after the specified time.
- OptionalcreatedBefore: Date
  Only return Blog Tags created before the specified time.
- OptionalupdatedAt: Date
  Only return Blog Tags last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return Blog Tags last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return Blog Tags 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 Blog Tags. Defaults to `false`.
- Optionalproperty: string
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseWithTotalTagForwardPaging>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:211

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.
- Optionalarchived: 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:253

readBatchWithHttpInfo

readBatchWithHttpInfo(batchInputString, archived?, _options?): Promise<HttpInfo<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.
- Optionalarchived: boolean
  Specifies whether to return deleted Blog Tags. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseTag | BatchResponseTagWithErrors>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:242

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:273

setLangPrimaryWithHttpInfo

setLangPrimaryWithHttpInfo(setNewLanguagePrimaryRequestVNext, _options?): Promise<HttpInfo<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<HttpInfo<void>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:263

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.
- Optionalarchived: 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:297

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.
- Optionalarchived: 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:319

updateBatchWithHttpInfo

updateBatchWithHttpInfo(batchInputJsonNode, archived?, _options?): Promise<HttpInfo<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.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Tags. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseTag | BatchResponseTagWithErrors>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:308

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:339

updateLangsWithHttpInfo

updateLangsWithHttpInfo(updateLanguagesRequestVNext, _options?): Promise<HttpInfo<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<HttpInfo<void>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:329

updateWithHttpInfo

updateWithHttpInfo(objectId, tag, archived?, _options?): Promise<HttpInfo<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.
- Optionalarchived: boolean
  Specifies whether to update deleted Blog Tags. Defaults to `false`.
- Optional_options: Configuration
Returns Promise<HttpInfo<Tag>>
- Defined in codegen/cms/blogs/tags/types/PromiseAPI.ts:285

Class BlogTagsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BlogTagsApi

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

create

Parameters

Returns Promise<Tag>

createBatch

Parameters

Returns Promise<BatchResponseTag | BatchResponseTagWithErrors>

createBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseTag | BatchResponseTagWithErrors>>

createLangVariation

Parameters

Returns Promise<Tag>

createLangVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<Tag>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<Tag>>

detachFromLangGroup

Parameters

Returns Promise<void>

detachFromLangGroupWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

getById

Parameters

Returns Promise<Tag>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<Tag>>

getPage

Parameters

Returns Promise<CollectionResponseWithTotalTagForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalTagForwardPaging>>

readBatch

Parameters

Returns Promise<BatchResponseTag | BatchResponseTagWithErrors>

readBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseTag | BatchResponseTagWithErrors>>

setLangPrimary

Parameters

Returns Promise<void>

setLangPrimaryWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

update

Parameters

Returns Promise<Tag>

updateBatch

Parameters