Class SettingsApi

Hierarchy

BaseAPI
- SettingsApi

Index

Constructors

Properties

Methods

request settingsGet settingsGetRaw settingsPut settingsPutRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new SettingsApi(configuration?): SettingsApi
Parameters
- configuration: Configuration = ...
Returns SettingsApi
Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

`Protected` request

request(context): Promise<Response>
Parameters
- context: RequestOpts
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in client/runtime.ts:50

settingsGet

settingsGet(): Promise<ProfileSettings>
Get the configurable settings associated with the profile.

Returns Promise<ProfileSettings>
- Defined in client/apis/SettingsApi.ts:54

settingsGetRaw

settingsGetRaw(): Promise<ApiResponse<ProfileSettings>>
Get the configurable settings associated with the profile.

Returns Promise<ApiResponse<ProfileSettings>>
- Defined in client/apis/SettingsApi.ts:34

settingsPut

settingsPut(requestParameters): Promise<ProfileSettings>
Update configurable settings associated with the profile.
Parameters
- requestParameters: SettingsPutRequest
Returns Promise<ProfileSettings>
- Defined in client/apis/SettingsApi.ts:87

settingsPutRaw

settingsPutRaw(requestParameters): Promise<ApiResponse<ProfileSettings>>
Update configurable settings associated with the profile.
Parameters
- requestParameters: SettingsPutRequest
Returns Promise<ApiResponse<ProfileSettings>>
- Defined in client/apis/SettingsApi.ts:62

withMiddleware

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

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42

withPreMiddleware

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

Generated using TypeDoc