Class SettingsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new SettingsApi(configuration, requestFactory?, responseProcessor?): SettingsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: SettingsApiRequestFactory
- OptionalresponseProcessor: SettingsApiResponseProcessor
Returns SettingsApi
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:419

Methods

archive

archive(appId, _options?): Promise<void>
Delete a calling extension. This will remove your service as an option for all connected accounts. Delete calling settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:454

archiveWithHttpInfo

archiveWithHttpInfo(appId, _options?): Promise<HttpInfo<void>>
Delete a calling extension. This will remove your service as an option for all connected accounts. Delete calling settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:432

create

create(appId, settingsRequest, _options?): Promise<SettingsResponse>
Set the menu label, target iframe URL, and dimensions for your calling extension. Configure a calling extension
Parameters
- appId: number
  The ID of the app.
- settingsRequest: SettingsRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<SettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:500

createWithHttpInfo

createWithHttpInfo(appId, settingsRequest, _options?): Promise<HttpInfo<SettingsResponse>>
Set the menu label, target iframe URL, and dimensions for your calling extension. Configure a calling extension
Parameters
- appId: number
  The ID of the app.
- settingsRequest: SettingsRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:477

getById

getById(appId, _options?): Promise<SettingsResponse>
Retrieve the settings configured for the app. Retrieve settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<SettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:544

getByIdWithHttpInfo

getByIdWithHttpInfo(appId, _options?): Promise<HttpInfo<SettingsResponse>>
Retrieve the settings configured for the app. Retrieve settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:522

update

update(appId, settingsPatchRequest, _options?): Promise<SettingsResponse>
Update existing calling extension settings. Update settings
Parameters
- appId: number
  The ID of the app.
- settingsPatchRequest: SettingsPatchRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<SettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:590

updateWithHttpInfo

updateWithHttpInfo(appId, settingsPatchRequest, _options?): Promise<HttpInfo<SettingsResponse>>
Update existing calling extension settings. Update settings
Parameters
- appId: number
  The ID of the app.
- settingsPatchRequest: SettingsPatchRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:567