Class SettingsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo update updateWithHttpInfo

Constructors

constructor

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

Methods

archive

archive(appId, _options?): Promise<void>
Deletes this 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: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:143

archiveWithHttpInfo

archiveWithHttpInfo(appId, _options?): Promise<HttpInfo<void>>
Deletes this 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: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:133

create

create(appId, settingsRequest, _options?): Promise<SettingsResponse>
Used to 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: Configuration
Returns Promise<SettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:165

createWithHttpInfo

createWithHttpInfo(appId, settingsRequest, _options?): Promise<HttpInfo<SettingsResponse>>
Used to 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: Configuration
Returns Promise<HttpInfo<SettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:154

getById

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

getByIdWithHttpInfo

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

update

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

updateWithHttpInfo

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