CustomerApi

CustomerApi - object-oriented interface

Export

CustomerApi

Extends

  • BaseAPI

Constructors

Constructor

new CustomerApi(configuration?, basePath?, axios?): CustomerApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

CustomerApi

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: Configuration | undefined

Inherited from

BaseAPI.configuration

Methods

apiV1CustomerFeaturesCheckGet()

apiV1CustomerFeaturesCheckGet(featureName?, options?): Promise<AxiosResponse<CustomerFeatureCheckDTO, any, { }>>

Parameters

featureName?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<CustomerFeatureCheckDTO, any, { }>>

Throws

Memberof

CustomerApi


apiV1CustomerGet()

apiV1CustomerGet(options?): Promise<AxiosResponse<CustomerResponseDTO, any, { }>>

Parameters

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<CustomerResponseDTO, any, { }>>

Throws

Memberof

CustomerApi


apiV1CustomerNameGet()

apiV1CustomerNameGet(name, options?): Promise<AxiosResponse<string, any, { }>>

Parameters

name

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<string, any, { }>>

Throws

Memberof

CustomerApi


apiV1CustomerRetentionPolicyGet()

apiV1CustomerRetentionPolicyGet(options?): Promise<AxiosResponse<CustomerRetentionPolicyResponseDTO, any, { }>>

Parameters

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<CustomerRetentionPolicyResponseDTO, any, { }>>

Throws

Memberof

CustomerApi


apiV1CustomerRetentionPolicyPut()

apiV1CustomerRetentionPolicyPut(customerRetentionPolicyRequestDTO?, options?): Promise<AxiosResponse<void, any, { }>>

Parameters

customerRetentionPolicyRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void, any, { }>>

Throws

Memberof

CustomerApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.