Class SettingsApi

Index

Constructors

Methods

archive archiveWithHttpInfo getById getByIdWithHttpInfo replace replaceWithHttpInfo

Constructors

constructor

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

Methods

archive

archive(appId, _options?): Promise<void>
Deletes the settings for a video conference application with the specified ID. Delete settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:47

archiveWithHttpInfo

archiveWithHttpInfo(appId, _options?): Promise<HttpInfo<void>>
Deletes the settings for a video conference application with the specified ID. Delete settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:25

getById

getById(appId, _options?): Promise<ExternalSettings>
Return the settings for a video conference application with the specified ID. Get settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ExternalSettings>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:91

getByIdWithHttpInfo

getByIdWithHttpInfo(appId, _options?): Promise<HttpInfo<ExternalSettings>>
Return the settings for a video conference application with the specified ID. Get settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ExternalSettings>>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:69

replace

replace(appId, externalSettings, _options?): Promise<ExternalSettings>
Updates the settings for a video conference application with the specified ID. Update settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- externalSettings: ExternalSettings
- Optional_options: PromiseConfigurationOptions
Returns Promise<ExternalSettings>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:137

replaceWithHttpInfo

replaceWithHttpInfo(appId, externalSettings, _options?): Promise<HttpInfo<ExternalSettings>>
Updates the settings for a video conference application with the specified ID. Update settings
Parameters
- appId: number
  The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.
- externalSettings: ExternalSettings
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ExternalSettings>>
- Defined in codegen/crm/extensions/videoconferencing/types/PromiseAPI.ts:114