Class CustomDomainApi

Hierarchy (View Summary)

BaseAPI
- CustomDomainApi

Index

Constructors

Properties

Methods

getCustomDomains getCustomDomainsRaw getDeletedAliases getDeletedAliasesRaw isJsonMime request updateCustomDomain updateCustomDomainRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new CustomDomainApi(configuration?: Configuration): CustomDomainApi
Parameters
- configuration: Configuration = DefaultConfig
Returns CustomDomainApi
Inherited from BaseAPI.constructor
- Defined in sdk/runtime.ts:104

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

getCustomDomains

getCustomDomains(
requestParameters: GetCustomDomainsRequest,
initOverrides?: any,
): Promise<CustomDomain>
Get users custom domains. Get custom domains
Parameters
- requestParameters: GetCustomDomainsRequest
- OptionalinitOverrides: any
Returns Promise<CustomDomain>
- Defined in sdk/apis/CustomDomainApi.ts:94

getCustomDomainsRaw

getCustomDomainsRaw(
requestParameters: GetCustomDomainsRequest,
initOverrides?: any,
): Promise<ApiResponse<CustomDomain>>
Get users custom domains. Get custom domains
Parameters
- requestParameters: GetCustomDomainsRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<CustomDomain>>
- Defined in sdk/apis/CustomDomainApi.ts:60

getDeletedAliases

getDeletedAliases(
requestParameters: GetDeletedAliasesRequest,
initOverrides?: any,
): Promise<CustomDomainCustomDomainIdTrash>
Get all deleted aliases for a custom domain (trash). Get deleted aliases
Parameters
- requestParameters: GetDeletedAliasesRequest
- OptionalinitOverrides: any
Returns Promise<CustomDomainCustomDomainIdTrash>
- Defined in sdk/apis/CustomDomainApi.ts:137

getDeletedAliasesRaw

getDeletedAliasesRaw(
requestParameters: GetDeletedAliasesRequest,
initOverrides?: any,
): Promise<ApiResponse<CustomDomainCustomDomainIdTrash>>
Get all deleted aliases for a custom domain (trash). Get deleted aliases
Parameters
- requestParameters: GetDeletedAliasesRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<CustomDomainCustomDomainIdTrash>>
- Defined in sdk/apis/CustomDomainApi.ts:103

`Protected`isJsonMime

isJsonMime(mime: string | null | undefined): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string | null | undefined
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in sdk/runtime.ts:134

`Protected`request

request(context: RequestOpts, initOverrides?: any): Promise<any>
Parameters
- context: RequestOpts
- OptionalinitOverrides: any
Returns Promise<any>
Inherited from BaseAPI.request
- Defined in sdk/runtime.ts:141

updateCustomDomain

updateCustomDomain(
requestParameters: UpdateCustomDomainRequest,
initOverrides?: any,
): Promise<CustomDomain>
Update settings for a custom domain. Update custom domain
Parameters
- requestParameters: UpdateCustomDomainRequest
- OptionalinitOverrides: any
Returns Promise<CustomDomain>
- Defined in sdk/apis/CustomDomainApi.ts:190

updateCustomDomainRaw

updateCustomDomainRaw(
requestParameters: UpdateCustomDomainRequest,
initOverrides?: any,
): Promise<ApiResponse<CustomDomain>>
Update settings for a custom domain. Update custom domain
Parameters
- requestParameters: UpdateCustomDomainRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<CustomDomain>>
- Defined in sdk/apis/CustomDomainApi.ts:146

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in sdk/runtime.ts:108

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        ((context: ResponseContext) => Promise<any>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (((context: ResponseContext) => Promise<any>) | undefined)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in sdk/runtime.ts:119

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        ((context: RequestContext) => Promise<void | FetchParams>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (((context: RequestContext) => Promise<void | FetchParams>) | undefined)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in sdk/runtime.ts:114