Class RedirectsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new RedirectsApi(configuration, requestFactory?, responseProcessor?): RedirectsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: RedirectsApiRequestFactory
- OptionalresponseProcessor: RedirectsApiResponseProcessor
Returns RedirectsApi
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:14

Methods

archiveWithHttpInfo

archiveWithHttpInfo(urlRedirectId, _options?): Promise<HttpInfo<void>>
Delete one existing redirect, so it is no longer mapped. Delete a redirect
Parameters
- urlRedirectId: string
  The ID of the target redirect.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:27

create

create(urlMappingCreateRequestBody, _options?): Promise<UrlMapping>
Creates and configures a new URL redirect. Create a redirect
Parameters
- urlMappingCreateRequestBody: UrlMappingCreateRequestBody
- Optional_options: PromiseConfigurationOptions
Returns Promise<UrlMapping>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:93

createWithHttpInfo

createWithHttpInfo(urlMappingCreateRequestBody, _options?): Promise<HttpInfo<UrlMapping>>
Creates and configures a new URL redirect. Create a redirect
Parameters
- urlMappingCreateRequestBody: UrlMappingCreateRequestBody
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<UrlMapping>>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:71

getById

getById(urlRedirectId, _options?): Promise<UrlMapping>
Returns the details for a single existing URL redirect by ID. Get details for a redirect
Parameters
- urlRedirectId: string
  The ID of the target redirect.
- Optional_options: PromiseConfigurationOptions
Returns Promise<UrlMapping>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:137

getByIdWithHttpInfo

getByIdWithHttpInfo(urlRedirectId, _options?): Promise<HttpInfo<UrlMapping>>
Returns the details for a single existing URL redirect by ID. Get details for a redirect
Parameters
- urlRedirectId: string
  The ID of the target redirect.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<UrlMapping>>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:115

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, _options?): Promise<CollectionResponseWithTotalUrlMappingForwardPaging>
Returns all existing URL redirects. Results can be limited and filtered by creation or updated date. Get current redirects
Parameters
- OptionalcreatedAt: Date
  Only return redirects created on exactly this date.
- OptionalcreatedAfter: Date
  Only return redirects created after this date.
- OptionalcreatedBefore: Date
  Only return redirects created before this date.
- OptionalupdatedAt: Date
  Only return redirects last updated on exactly this date.
- OptionalupdatedAfter: Date
  Only return redirects last updated after this date.
- OptionalupdatedBefore: Date
  Only return redirects last updated before this date.
- Optionalsort: string[]
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  Maximum number of result per page
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalUrlMappingForwardPaging>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:199

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, archived?, _options?): Promise<HttpInfo<CollectionResponseWithTotalUrlMappingForwardPaging>>
Returns all existing URL redirects. Results can be limited and filtered by creation or updated date. Get current redirects
Parameters
- OptionalcreatedAt: Date
  Only return redirects created on exactly this date.
- OptionalcreatedAfter: Date
  Only return redirects created after this date.
- OptionalcreatedBefore: Date
  Only return redirects created before this date.
- OptionalupdatedAt: Date
  Only return redirects last updated on exactly this date.
- OptionalupdatedAfter: Date
  Only return redirects last updated after this date.
- OptionalupdatedBefore: Date
  Only return redirects last updated before this date.
- Optionalsort: string[]
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  Maximum number of result per page
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalUrlMappingForwardPaging>>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:168

update

update(urlRedirectId, urlMapping, _options?): Promise<UrlMapping>
Updates the settings for an existing URL redirect. Update a redirect
Parameters
- urlRedirectId: string
- urlMapping: UrlMapping
- Optional_options: PromiseConfigurationOptions
Returns Promise<UrlMapping>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:245

updateWithHttpInfo

updateWithHttpInfo(urlRedirectId, urlMapping, _options?): Promise<HttpInfo<UrlMapping>>
Updates the settings for an existing URL redirect. Update a redirect
Parameters
- urlRedirectId: string
- urlMapping: UrlMapping
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<UrlMapping>>
- Defined in codegen/cms/url_redirects/types/PromiseAPI.ts:222

Class RedirectsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RedirectsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<UrlMapping>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<UrlMapping>>

getById

Parameters

Returns Promise<UrlMapping>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<UrlMapping>>

getPage

Parameters

Returns Promise<CollectionResponseWithTotalUrlMappingForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalUrlMappingForwardPaging>>

update

Parameters

Returns Promise<UrlMapping>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<UrlMapping>>

Settings

On This Page