Class ChannelConnectionSettingsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new ChannelConnectionSettingsApi(configuration, requestFactory?, responseProcessor?): ChannelConnectionSettingsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: ChannelConnectionSettingsApiRequestFactory
- OptionalresponseProcessor: ChannelConnectionSettingsApiResponseProcessor
Returns ChannelConnectionSettingsApi
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:21

Methods

archive

archive(appId, _options?): Promise<void>
Delete the channel connection settings for the app. Delete channel connection settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:56

archiveWithHttpInfo

archiveWithHttpInfo(appId, _options?): Promise<HttpInfo<void>>
Delete the channel connection settings for the app. Delete channel connection 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:34

create

create(appId, channelConnectionSettingsRequest, _options?): Promise<ChannelConnectionSettingsResponse>
Configure channel connection settings for the app. Configure channel connection settings
Parameters
- appId: number
  The ID of the app.
- channelConnectionSettingsRequest: ChannelConnectionSettingsRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<ChannelConnectionSettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:102

createWithHttpInfo

createWithHttpInfo(appId, channelConnectionSettingsRequest, _options?): Promise<HttpInfo<ChannelConnectionSettingsResponse>>
Configure channel connection settings for the app. Configure channel connection settings
Parameters
- appId: number
  The ID of the app.
- channelConnectionSettingsRequest: ChannelConnectionSettingsRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ChannelConnectionSettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:79

getById

getById(appId, _options?): Promise<ChannelConnectionSettingsResponse>
Retrieve the settings related to the app's channel connection. Retrieve channel connection settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ChannelConnectionSettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:146

getByIdWithHttpInfo

getByIdWithHttpInfo(appId, _options?): Promise<HttpInfo<ChannelConnectionSettingsResponse>>
Retrieve the settings related to the app's channel connection. Retrieve channel connection settings
Parameters
- appId: number
  The ID of the app.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ChannelConnectionSettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:124

update

update(appId, channelConnectionSettingsPatchRequest, _options?): Promise<ChannelConnectionSettingsResponse>
Update existing channel connection settings for your app. Update channel connection settings
Parameters
- appId: number
  The ID of the app.
- channelConnectionSettingsPatchRequest: ChannelConnectionSettingsPatchRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<ChannelConnectionSettingsResponse>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:192

updateWithHttpInfo

updateWithHttpInfo(appId, channelConnectionSettingsPatchRequest, _options?): Promise<HttpInfo<ChannelConnectionSettingsResponse>>
Update existing channel connection settings for your app. Update channel connection settings
Parameters
- appId: number
  The ID of the app.
- channelConnectionSettingsPatchRequest: ChannelConnectionSettingsPatchRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ChannelConnectionSettingsResponse>>
- Defined in codegen/crm/extensions/calling/types/PromiseAPI.ts:169