Class SettingsApi

Index

Constructors

Methods

getAll getAllWithHttpInfo update updateWithHttpInfo

Constructors

constructor

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

Methods

getAll

getAll(appId, _options?): Promise<EventDetailSettings>
Retrieve the current settings for the application. Retrieve the application settings
Parameters
- appId: number
  The id of the application to retrieve the settings for.
- Optional_options: PromiseConfigurationOptions
Returns Promise<EventDetailSettings>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1695

getAllWithHttpInfo

getAllWithHttpInfo(appId, _options?): Promise<HttpInfo<EventDetailSettings>>
Retrieve the current settings for the application. Retrieve the application settings
Parameters
- appId: number
  The id of the application to retrieve the settings for.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<EventDetailSettings>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1673

update

update(appId, eventDetailSettingsUrl, _options?): Promise<EventDetailSettings>
Create or update the current settings for the application. Update the application settings
Parameters
- appId: number
  The id of the application to update the settings for.
- eventDetailSettingsUrl: EventDetailSettingsUrl
- Optional_options: PromiseConfigurationOptions
Returns Promise<EventDetailSettings>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1741

updateWithHttpInfo

updateWithHttpInfo(appId, eventDetailSettingsUrl, _options?): Promise<HttpInfo<EventDetailSettings>>
Create or update the current settings for the application. Update the application settings
Parameters
- appId: number
  The id of the application to update the settings for.
- eventDetailSettingsUrl: EventDetailSettingsUrl
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<EventDetailSettings>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1718