Class SettingsApi

Hierarchy (View Summary)

BaseAPI
- SettingsApi

Index

Constructors

Properties

Methods

getAvailableDomainsForRandomAliases getAvailableDomainsForRandomAliasesRaw getUserSettings getUserSettingsRaw isJsonMime request updateUserSettings updateUserSettingsRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

getAvailableDomainsForRandomAliases

getAvailableDomainsForRandomAliases(
initOverrides?: any,
): Promise<SettingDomain[]>
Retrieve available domains for random alias creation Get available domains for random aliases
Parameters
- OptionalinitOverrides: any
Returns Promise<SettingDomain[]>
- Defined in sdk/apis/SettingsApi.ts:77

getAvailableDomainsForRandomAliasesRaw

getAvailableDomainsForRandomAliasesRaw(
initOverrides?: any,
): Promise<ApiResponse<SettingDomain[]>>
Retrieve available domains for random alias creation Get available domains for random aliases
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<SettingDomain[]>>
- Defined in sdk/apis/SettingsApi.ts:51

getUserSettings

getUserSettings(initOverrides?: any): Promise<Setting>
Retrieve user's configuration preferences Get user settings
Parameters
- OptionalinitOverrides: any
Returns Promise<Setting>
- Defined in sdk/apis/SettingsApi.ts:112

getUserSettingsRaw

getUserSettingsRaw(initOverrides?: any): Promise<ApiResponse<Setting>>
Retrieve user's configuration preferences Get user settings
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Setting>>
- Defined in sdk/apis/SettingsApi.ts:86

`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

updateUserSettings

updateUserSettings(
requestParameters: UpdateUserSettingsRequest,
initOverrides?: any,
): Promise<Setting>
Modify user's configuration preferences Update user settings
Parameters
- requestParameters: UpdateUserSettingsRequest
- OptionalinitOverrides: any
Returns Promise<Setting>
- Defined in sdk/apis/SettingsApi.ts:157

updateUserSettingsRaw

updateUserSettingsRaw(
requestParameters: UpdateUserSettingsRequest,
initOverrides?: any,
): Promise<ApiResponse<Setting>>
Modify user's configuration preferences Update user settings
Parameters
- requestParameters: UpdateUserSettingsRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Setting>>
- Defined in sdk/apis/SettingsApi.ts:121

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