Class StatusApi

Index

Constructors

constructor

Methods

getEmailStatus getEmailStatusWithHttpInfo subscribe subscribeWithHttpInfo unsubscribe unsubscribeWithHttpInfo

Constructors

constructor

new StatusApi(configuration, requestFactory?, responseProcessor?): StatusApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: StatusApiRequestFactory
- OptionalresponseProcessor: StatusApiResponseProcessor
Returns StatusApi
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:51

Methods

getEmailStatus

getEmailStatus(emailAddress, _options?): Promise<PublicSubscriptionStatusesResponse>
Returns a list of subscriptions and their status for a given contact. Get subscription statuses for a contact
Parameters
- emailAddress: string
- Optional_options: Configuration
Returns Promise<PublicSubscriptionStatusesResponse>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:74

getEmailStatusWithHttpInfo

getEmailStatusWithHttpInfo(emailAddress, _options?): Promise<HttpInfo<PublicSubscriptionStatusesResponse>>
Returns a list of subscriptions and their status for a given contact. Get subscription statuses for a contact
Parameters
- emailAddress: string
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicSubscriptionStatusesResponse>>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:64

subscribe(publicUpdateSubscriptionStatusRequest, _options?): Promise<PublicSubscriptionStatus>
Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error. Subscribe a contact
Parameters
- publicUpdateSubscriptionStatusRequest: PublicUpdateSubscriptionStatusRequest
- Optional_options: Configuration
Returns Promise<PublicSubscriptionStatus>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:94

subscribeWithHttpInfo

subscribeWithHttpInfo(publicUpdateSubscriptionStatusRequest, _options?): Promise<HttpInfo<PublicSubscriptionStatus>>
Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error. Subscribe a contact
Parameters
- publicUpdateSubscriptionStatusRequest: PublicUpdateSubscriptionStatusRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicSubscriptionStatus>>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:84

unsubscribe

unsubscribe(publicUpdateSubscriptionStatusRequest, _options?): Promise<PublicSubscriptionStatus>
Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error. Unsubscribe a contact
Parameters
- publicUpdateSubscriptionStatusRequest: PublicUpdateSubscriptionStatusRequest
- Optional_options: Configuration
Returns Promise<PublicSubscriptionStatus>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:114

unsubscribeWithHttpInfo

unsubscribeWithHttpInfo(publicUpdateSubscriptionStatusRequest, _options?): Promise<HttpInfo<PublicSubscriptionStatus>>
Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error. Unsubscribe a contact
Parameters
- publicUpdateSubscriptionStatusRequest: PublicUpdateSubscriptionStatusRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicSubscriptionStatus>>
- Defined in codegen/communication_preferences/types/PromiseAPI.ts:104

Class StatusApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StatusApi

Methods

getEmailStatus

Parameters

Returns Promise<PublicSubscriptionStatusesResponse>

getEmailStatusWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicSubscriptionStatusesResponse>>

subscribe

Parameters

Returns Promise<PublicSubscriptionStatus>

subscribeWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicSubscriptionStatus>>

unsubscribe

Parameters

Returns Promise<PublicSubscriptionStatus>

unsubscribeWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicSubscriptionStatus>>

Settings

On This Page