Configurations | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Configurations

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Configurations(options: ConfigurationsOptions, http: Client): Configurations

Overrides ThBaseHandler.constructor
- Defined in src/v0/configurations.ts:127
Parameters
- options: ConfigurationsOptions
- http: Client
Returns Configurations

Properties

endpoint

endpoint: string

http

http: Client

options

options: ConfigurationsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/configurations'

Methods

bulkFetch

bulkFetch(body: BulkFetchRequestBody): Promise<BulkFetchResponse>

- Defined in src/v0/configurations.ts:237
Parameters
- body: BulkFetchRequestBody
Returns Promise<BulkFetchResponse>

bulkUpdate

bulkUpdate(body: BulkUpdateRequestBody): Promise<BulkUpdateResponse>

- Defined in src/v0/configurations.ts:255
Parameters
- body: BulkUpdateRequestBody
Returns Promise<BulkUpdateResponse>

create

create(configuration: Configuration): Promise<ConfigurationResponse>

- Defined in src/v0/configurations.ts:209
Parameters
- configuration: Configuration
Returns Promise<ConfigurationResponse>

delete

delete(configurationId: string): Promise<ConfigurationResponse>

- Defined in src/v0/configurations.ts:223
Parameters
- configurationId: string
Returns Promise<ConfigurationResponse>

get

get(configurationId: string): Promise<ConfigurationReference>

- Defined in src/v0/configurations.ts:159
Parameters
- configurationId: string
Returns Promise<ConfigurationReference>

getAll

getAll(optionsOrQuery?: ConfigurationsQueryOptions): Promise<ConfigurationsResponse>

- Defined in src/v0/configurations.ts:142
Parameters
- Optional optionsOrQuery: ConfigurationsQueryOptions
Returns Promise<ConfigurationsResponse>

patch

patch(configurationId: string, configuration: Configuration): Promise<ConfigurationResponse>

- Defined in src/v0/configurations.ts:195
Parameters
- configurationId: string
- configuration: Configuration
Returns Promise<ConfigurationResponse>

put

put(configurationId: string, configuration: Configuration): Promise<ConfigurationResponse>

- Defined in src/v0/configurations.ts:181
Parameters
- configurationId: string
- configuration: Configuration
Returns Promise<ConfigurationResponse>

Generated using TypeDoc