514 lines (373 loc) · 32.2 KB

Shared

Types:

Send

Types:

SendMessageResponse

Methods:

client.send.message({ ...params }) -> SendMessageResponse

Audiences

Types:

Methods:

client.audiences.retrieve(audienceID) -> Audience
client.audiences.update(audienceID, { ...params }) -> AudienceUpdateResponse
client.audiences.list({ ...params }) -> AudienceListResponse
client.audiences.delete(audienceID) -> void
client.audiences.listMembers(audienceID, { ...params }) -> AudienceListMembersResponse

Providers

Types:

Methods:

client.providers.create({ ...params }) -> Provider
client.providers.retrieve(id) -> Provider
client.providers.update(id, { ...params }) -> Provider
client.providers.list({ ...params }) -> ProviderListResponse
client.providers.delete(id) -> void

Catalog

Types:

CatalogListResponse

Methods:

client.providers.catalog.list({ ...params }) -> CatalogListResponse

AuditEvents

Types:

AuditEvent
AuditEventListResponse

Methods:

client.auditEvents.retrieve(auditEventID) -> AuditEvent
client.auditEvents.list({ ...params }) -> AuditEventListResponse

Auth

Types:

AuthIssueTokenResponse

Methods:

client.auth.issueToken({ ...params }) -> AuthIssueTokenResponse

Automations

Types:

Methods:

client.automations.list({ ...params }) -> AutomationTemplateListResponse

Invoke

Methods:

client.automations.invoke.invokeAdHoc({ ...params }) -> AutomationInvokeResponse
client.automations.invoke.invokeByTemplate(templateID, { ...params }) -> AutomationInvokeResponse

Journeys

Types:

Methods:

client.journeys.list({ ...params }) -> JourneysListResponse
client.journeys.invoke(templateID, { ...params }) -> JourneysInvokeResponse

Brands

Types:

Methods:

client.brands.create({ ...params }) -> Brand
client.brands.retrieve(brandID) -> Brand
client.brands.update(brandID, { ...params }) -> Brand
client.brands.list({ ...params }) -> BrandListResponse
client.brands.delete(brandID) -> void

Bulk

Types:

Methods:

client.bulk.addUsers(jobID, { ...params }) -> void
client.bulk.createJob({ ...params }) -> BulkCreateJobResponse
client.bulk.listUsers(jobID, { ...params }) -> BulkListUsersResponse
client.bulk.retrieveJob(jobID) -> BulkRetrieveJobResponse
client.bulk.runJob(jobID) -> void

Inbound

Types:

InboundTrackEventResponse

Methods:

client.inbound.trackEvent({ ...params }) -> InboundTrackEventResponse

Lists

Types:

Methods:

client.lists.retrieve(listID) -> SubscriptionList
client.lists.update(listID, { ...params }) -> void
client.lists.list({ ...params }) -> ListListResponse
client.lists.delete(listID) -> void
client.lists.restore(listID) -> void

Subscriptions

Types:

SubscriptionListResponse

Methods:

client.lists.subscriptions.list(listID, { ...params }) -> SubscriptionListResponse
client.lists.subscriptions.add(listID, { ...params }) -> void
client.lists.subscriptions.subscribe(listID, { ...params }) -> void
client.lists.subscriptions.subscribeUser(userID, { ...params }) -> void
client.lists.subscriptions.unsubscribeUser(userID, { ...params }) -> void

Messages

Types:

Methods:

client.messages.retrieve(messageID) -> MessageRetrieveResponse
client.messages.list({ ...params }) -> MessageListResponse
client.messages.cancel(messageID) -> MessageDetails
client.messages.content(messageID) -> MessageContentResponse
client.messages.history(messageID, { ...params }) -> MessageHistoryResponse

Requests

Methods:

client.requests.archive(requestID) -> void

Notifications

Types:

Methods:

client.notifications.create({ ...params }) -> NotificationTemplateResponse
client.notifications.retrieve(id, { ...params }) -> NotificationTemplateResponse
client.notifications.list({ ...params }) -> NotificationListResponse
client.notifications.archive(id) -> void
client.notifications.listVersions(id, { ...params }) -> NotificationTemplateVersionListResponse
client.notifications.publish(id, { ...params }) -> void
client.notifications.putContent(id, { ...params }) -> NotificationContentMutationResponse
client.notifications.putElement(elementID, { ...params }) -> NotificationContentMutationResponse
client.notifications.putLocale(localeID, { ...params }) -> NotificationContentMutationResponse
client.notifications.replace(id, { ...params }) -> NotificationTemplateResponse
client.notifications.retrieveContent(id, { ...params }) -> NotificationRetrieveContentResponse

Checks

Types:

Methods:

client.notifications.checks.update(submissionID, { ...params }) -> CheckUpdateResponse
client.notifications.checks.list(submissionID, { ...params }) -> CheckListResponse
client.notifications.checks.delete(submissionID, { ...params }) -> void

RoutingStrategies

Types:

Methods:

client.routingStrategies.create({ ...params }) -> RoutingStrategyGetResponse
client.routingStrategies.retrieve(id) -> RoutingStrategyGetResponse
client.routingStrategies.list({ ...params }) -> RoutingStrategyListResponse
client.routingStrategies.archive(id) -> void
client.routingStrategies.listNotifications(id, { ...params }) -> AssociatedNotificationListResponse
client.routingStrategies.replace(id, { ...params }) -> RoutingStrategyGetResponse

Profiles

Types:

Methods:

client.profiles.create(userID, { ...params }) -> ProfileCreateResponse
client.profiles.retrieve(userID) -> ProfileRetrieveResponse
client.profiles.update(userID, { ...params }) -> void
client.profiles.delete(userID) -> void
client.profiles.replace(userID, { ...params }) -> ProfileReplaceResponse

Lists

Types:

Methods:

client.profiles.lists.retrieve(userID, { ...params }) -> ListRetrieveResponse
client.profiles.lists.delete(userID) -> ListDeleteResponse
client.profiles.lists.subscribe(userID, { ...params }) -> ListSubscribeResponse

Tenants

Types:

Methods:

client.tenants.retrieve(tenantID) -> Tenant
client.tenants.update(tenantID, { ...params }) -> Tenant
client.tenants.list({ ...params }) -> TenantListResponse
client.tenants.delete(tenantID) -> void
client.tenants.listUsers(tenantID, { ...params }) -> TenantListUsersResponse

Preferences

Items

Methods:

client.tenants.preferences.items.update(topicID, { ...params }) -> void
client.tenants.preferences.items.delete(topicID, { ...params }) -> void

Templates

Types:

TemplateListResponse

Methods:

client.tenants.templates.retrieve(templateID, { ...params }) -> BaseTemplateTenantAssociation
client.tenants.templates.list(tenantID, { ...params }) -> TemplateListResponse
client.tenants.templates.publish(templateID, { ...params }) -> PostTenantTemplatePublishResponse
client.tenants.templates.replace(templateID, { ...params }) -> PutTenantTemplateResponse

Versions

Methods:

client.tenants.templates.versions.retrieve(version, { ...params }) -> BaseTemplateTenantAssociation

Translations

Types:

TranslationRetrieveResponse

Methods:

client.translations.retrieve(locale, { ...params }) -> string
client.translations.update(locale, { ...params }) -> void

Users

Preferences

Types:

Methods:

client.users.preferences.retrieve(userID, { ...params }) -> PreferenceRetrieveResponse
client.users.preferences.retrieveTopic(topicID, { ...params }) -> PreferenceRetrieveTopicResponse
client.users.preferences.updateOrCreateTopic(topicID, { ...params }) -> PreferenceUpdateOrCreateTopicResponse

Tenants

Types:

TenantListResponse

Methods:

client.users.tenants.list(userID, { ...params }) -> TenantListResponse
client.users.tenants.addMultiple(userID, { ...params }) -> void
client.users.tenants.addSingle(tenantID, { ...params }) -> void
client.users.tenants.removeAll(userID) -> void
client.users.tenants.removeSingle(tenantID, { ...params }) -> void

Tokens

Types:

Methods:

client.users.tokens.retrieve(token, { ...params }) -> TokenRetrieveResponse
client.users.tokens.update(token, { ...params }) -> void
client.users.tokens.list(userID) -> TokenListResponse
client.users.tokens.delete(token, { ...params }) -> void
client.users.tokens.addMultiple(userID) -> void
client.users.tokens.addSingle(token, { ...params }) -> void