Class StatusApi

Hierarchy

StatusApi

Index

Constructors

Properties

Methods

getEmailStatus subscribe unsubscribe

Constructors

constructor

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

Properties

`Private` api

api: ObservableStatusApi

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:54

subscribe

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:64

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:74

Generated using TypeDoc