CustomerKeyValueApi

CustomerKeyValueApi - object-oriented interface

Export

CustomerKeyValueApi

Extends

  • BaseAPI

Constructors

Constructor

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

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

CustomerKeyValueApi

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

apiV1KeyvalueDelete()

apiV1KeyvalueDelete(key?, options?): Promise<AxiosResponse<void, any, { }>>

Parameters

key?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

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

Throws

Memberof

CustomerKeyValueApi


apiV1KeyvalueGet()

apiV1KeyvalueGet(key?, options?): Promise<AxiosResponse<string, any, { }>>

Parameters

key?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

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

Throws

Memberof

CustomerKeyValueApi


apiV1KeyvalueKeysGet()

apiV1KeyvalueKeysGet(options?): Promise<AxiosResponse<string[], any, { }>>

Parameters

options?

RawAxiosRequestConfig

Override http request option.

Returns

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

Throws

Memberof

CustomerKeyValueApi


apiV1KeyvaluePost()

apiV1KeyvaluePost(keyValueAddRequestDTO?, options?): Promise<AxiosResponse<void, any, { }>>

Parameters

keyValueAddRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

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

Throws

Memberof

CustomerKeyValueApi

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.