@enbbox/api 1.0.0

package/README.md

@@ -0,0 +1,380 @@
+## @enbbox/api-client@0.1.0
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @enbbox/api-client@0.1.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ActivityApi* | [**activityChart**](docs/ActivityApi.md#activitychart) | **GET** /v1/activity/chart/ | GET /v1/activity/chart — activity chart data
+*ActivityApi* | [**activityStats**](docs/ActivityApi.md#activitystats) | **GET** /v1/activity/stats/ | GET /v1/activity/stats
+*ActivityApi* | [**engagementStats**](docs/ActivityApi.md#engagementstats) | **GET** /v1/activity/engagement/ | GET /v1/activity/engagement — subscriber engagement stats
+*ActivityApi* | [**getActivityByNotification**](docs/ActivityApi.md#getactivitybynotification) | **GET** /v1/activity/{notification_id}/ | GET /v1/activity/:notificationId
+*ActivityApi* | [**listActivity**](docs/ActivityApi.md#listactivity) | **GET** /v1/activity/ | GET /v1/activity
+*ActivityApi* | [**listActivityRequests**](docs/ActivityApi.md#listactivityrequests) | **GET** /v1/activity/requests/ | GET /v1/activity/requests — list trigger requests
+*ActivityApi* | [**listWorkflowRuns**](docs/ActivityApi.md#listworkflowruns) | **GET** /v1/activity/workflow-runs/ | GET /v1/activity/workflow-runs — list workflow executions
+*ActivityApi* | [**workflowStats**](docs/ActivityApi.md#workflowstats) | **GET** /v1/activity/workflows/stats/ | GET /v1/activity/workflows/stats — workflow execution stats
+*BillingApi* | [**createCheckoutSession**](docs/BillingApi.md#createcheckoutsession) | **POST** /v1/billing/checkout-session/ | Create a Stripe Checkout Session for upgrading a plan.
+*BillingApi* | [**getBillingLimits**](docs/BillingApi.md#getbillinglimits) | **GET** /v1/billing/limits/ | Get plan limits and current usage for the project.
+*BillingApi* | [**getBillingSubscription**](docs/BillingApi.md#getbillingsubscription) | **GET** /v1/billing/subscription/ | Get the current subscription for the authed project.
+*BillingApi* | [**getEntitlements**](docs/BillingApi.md#getentitlements) | **GET** /v1/billing/entitlements/ | Get active entitlements for the project.
+*BillingApi* | [**getPortalUrl**](docs/BillingApi.md#getportalurl) | **GET** /v1/billing/portal/ | Get a Stripe Customer Portal URL for managing the subscription.
+*BillingApi* | [**getPrices**](docs/BillingApi.md#getprices) | **GET** /v1/billing/prices/ | Get available plan prices.
+*BillingApi* | [**getUsage**](docs/BillingApi.md#getusage) | **GET** /v1/billing/usage/ | Get current usage data for the project.
+*BillingApi* | [**stripeWebhook**](docs/BillingApi.md#stripewebhook) | **POST** /v1/billing/webhooks/stripe/ | Handle Stripe webhook events.
+*ChannelConnectionsApi* | [**createConnection**](docs/ChannelConnectionsApi.md#createconnection) | **POST** /v1/channel-connections/ | POST /v1/channel-connections
+*ChannelConnectionsApi* | [**deleteConnection**](docs/ChannelConnectionsApi.md#deleteconnection) | **DELETE** /v1/channel-connections/{id}/ | DELETE /v1/channel-connections/:identifier
+*ChannelConnectionsApi* | [**getConnection**](docs/ChannelConnectionsApi.md#getconnection) | **GET** /v1/channel-connections/{id}/ | GET /v1/channel-connections/:identifier
+*ChannelConnectionsApi* | [**listConnections**](docs/ChannelConnectionsApi.md#listconnections) | **GET** /v1/channel-connections/ | GET /v1/channel-connections
+*ChannelConnectionsApi* | [**updateConnection**](docs/ChannelConnectionsApi.md#updateconnection) | **PATCH** /v1/channel-connections/{id}/ | PATCH /v1/channel-connections/:identifier
+*ChannelEndpointsApi* | [**createEndpoint**](docs/ChannelEndpointsApi.md#createendpoint) | **POST** /v1/channel-endpoints/ | POST /v1/channel-endpoints
+*ChannelEndpointsApi* | [**deleteEndpoint**](docs/ChannelEndpointsApi.md#deleteendpoint) | **DELETE** /v1/channel-endpoints/{id}/ | DELETE /v1/channel-endpoints/:identifier
+*ChannelEndpointsApi* | [**getEndpoint**](docs/ChannelEndpointsApi.md#getendpoint) | **GET** /v1/channel-endpoints/{id}/ | GET /v1/channel-endpoints/:identifier
+*ChannelEndpointsApi* | [**listEndpoints**](docs/ChannelEndpointsApi.md#listendpoints) | **GET** /v1/channel-endpoints/ | GET /v1/channel-endpoints
+*ChannelEndpointsApi* | [**updateEndpoint**](docs/ChannelEndpointsApi.md#updateendpoint) | **PATCH** /v1/channel-endpoints/{id}/ | PATCH /v1/channel-endpoints/:identifier
+*ContextsApi* | [**createContext**](docs/ContextsApi.md#createcontext) | **POST** /v1/contexts/ | POST /v1/contexts
+*ContextsApi* | [**deleteContext**](docs/ContextsApi.md#deletecontext) | **DELETE** /v1/contexts/{type}/{id}/ | DELETE /v1/contexts/:type/:id
+*ContextsApi* | [**getContext**](docs/ContextsApi.md#getcontext) | **GET** /v1/contexts/{type}/{id}/ | GET /v1/contexts/:type/:id
+*ContextsApi* | [**listContexts**](docs/ContextsApi.md#listcontexts) | **GET** /v1/contexts/ | GET /v1/contexts — list contexts
+*ContextsApi* | [**updateContext**](docs/ContextsApi.md#updatecontext) | **PATCH** /v1/contexts/{type}/{id}/ | PATCH /v1/contexts/:type/:id
+*EventsApi* | [**cancelEvent**](docs/EventsApi.md#cancelevent) | **DELETE** /v1/events/{transaction_id}/ | DELETE /v1/events/:transaction_id
+*EventsApi* | [**triggerBroadcast**](docs/EventsApi.md#triggerbroadcast) | **POST** /v1/events/trigger/broadcast/ | POST /v1/events/trigger/broadcast — broadcast to all subscribers
+*EventsApi* | [**triggerBulk**](docs/EventsApi.md#triggerbulk) | **POST** /v1/events/trigger/bulk/ | POST /v1/events/trigger/bulk
+*EventsApi* | [**triggerEvent**](docs/EventsApi.md#triggerevent) | **POST** /v1/events/trigger/ | POST /v1/events/trigger
+*FeatureFlagsApi* | [**getFeatureFlags**](docs/FeatureFlagsApi.md#getfeatureflags) | **GET** /v1/feature-flags/ | GET /v1/feature-flags — returns enabled features for the current project.
+*HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health/ | GET /health — basic health check (backward compat).
+*HealthApi* | [**liveness**](docs/HealthApi.md#liveness) | **GET** /health/live/ | GET /health/live — liveness probe: returns 200 if process is alive.
+*HealthApi* | [**readiness**](docs/HealthApi.md#readiness) | **GET** /health/ready/ | GET /health/ready — readiness probe: returns 200 if dependencies are connected.
+*InboundParseApi* | [**inboundParseWebhook**](docs/InboundParseApi.md#inboundparsewebhook) | **POST** /v1/inbound-parse/webhook/ | POST /v1/inbound-parse/webhook — receive parsed email from provider.
+*InboxApi* | [**archive**](docs/InboxApi.md#archive) | **POST** /v1/inbox/notifications/{id}/archive/ | POST /v1/inbox/notifications/:id/archive
+*InboxApi* | [**archiveAll**](docs/InboxApi.md#archiveall) | **POST** /v1/inbox/notifications/archive/ | POST /v1/inbox/notifications/archive  (archive all)
+*InboxApi* | [**executeAction**](docs/InboxApi.md#executeaction) | **POST** /v1/inbox/notifications/{id}/actions/{action_type}/ | POST /v1/inbox/notifications/:id/actions/:actionType
+*InboxApi* | [**getInboxPreferences**](docs/InboxApi.md#getinboxpreferences) | **GET** /v1/inbox/preferences/ | GET /v1/inbox/preferences
+*InboxApi* | [**inboxListNotifications**](docs/InboxApi.md#inboxlistnotifications) | **GET** /v1/inbox/notifications/ | GET /v1/inbox/notifications/
+*InboxApi* | [**initInboxSession**](docs/InboxApi.md#initinboxsession) | **POST** /v1/inbox/session/ | POST /v1/inbox/session/
+*InboxApi* | [**markAllRead**](docs/InboxApi.md#markallread) | **POST** /v1/inbox/notifications/read/ | POST /v1/inbox/notifications/read  (mark all as read)
+*InboxApi* | [**markRead**](docs/InboxApi.md#markread) | **POST** /v1/inbox/notifications/{id}/read/ | POST /v1/inbox/notifications/:id/read
+*InboxApi* | [**markUnread**](docs/InboxApi.md#markunread) | **POST** /v1/inbox/notifications/{id}/unread/ | POST /v1/inbox/notifications/:id/unread
+*InboxApi* | [**notificationCount**](docs/InboxApi.md#notificationcount) | **GET** /v1/inbox/notifications/count/ | GET /v1/inbox/notifications/count
+*InboxApi* | [**unarchive**](docs/InboxApi.md#unarchive) | **POST** /v1/inbox/notifications/{id}/unarchive/ | POST /v1/inbox/notifications/:id/unarchive
+*InboxApi* | [**updateInboxGlobalPreference**](docs/InboxApi.md#updateinboxglobalpreference) | **PATCH** /v1/inbox/preferences/ | PATCH /v1/inbox/preferences
+*InboxApi* | [**updateInboxWorkflowPreference**](docs/InboxApi.md#updateinboxworkflowpreference) | **PATCH** /v1/inbox/preferences/{workflow_id}/ | PATCH /v1/inbox/preferences/:workflowId
+*IntegrationsApi* | [**autoConfigure**](docs/IntegrationsApi.md#autoconfigure) | **POST** /v1/integrations/{id}/auto-configure/ | POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+*IntegrationsApi* | [**chatOauth**](docs/IntegrationsApi.md#chatoauth) | **POST** /v1/integrations/chat/oauth/ | POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+*IntegrationsApi* | [**createIntegration**](docs/IntegrationsApi.md#createintegration) | **POST** /v1/integrations/ | POST /v1/integrations
+*IntegrationsApi* | [**deleteIntegration**](docs/IntegrationsApi.md#deleteintegration) | **DELETE** /v1/integrations/{id}/ | DELETE /v1/integrations/:id
+*IntegrationsApi* | [**getIntegration**](docs/IntegrationsApi.md#getintegration) | **GET** /v1/integrations/{id}/ | GET /v1/integrations/:id
+*IntegrationsApi* | [**listActiveIntegrations**](docs/IntegrationsApi.md#listactiveintegrations) | **GET** /v1/integrations/active/ | GET /v1/integrations/active — list only active integrations
+*IntegrationsApi* | [**listIntegrations**](docs/IntegrationsApi.md#listintegrations) | **GET** /v1/integrations/ | GET /v1/integrations
+*IntegrationsApi* | [**setPrimary**](docs/IntegrationsApi.md#setprimary) | **PUT** /v1/integrations/{id}/set-primary/ | PUT /v1/integrations/:id/set-primary
+*IntegrationsApi* | [**updateIntegration**](docs/IntegrationsApi.md#updateintegration) | **PUT** /v1/integrations/{id}/ | PUT /v1/integrations/:id
+*LayoutsApi* | [**createLayout**](docs/LayoutsApi.md#createlayout) | **POST** /v1/layouts/ | POST /v1/layouts
+*LayoutsApi* | [**deleteLayout**](docs/LayoutsApi.md#deletelayout) | **DELETE** /v1/layouts/{id}/ | DELETE /v1/layouts/:id
+*LayoutsApi* | [**duplicateLayout**](docs/LayoutsApi.md#duplicatelayout) | **POST** /v1/layouts/{id}/duplicate/ | POST /v1/layouts/:id/duplicate — clone layout
+*LayoutsApi* | [**getLayout**](docs/LayoutsApi.md#getlayout) | **GET** /v1/layouts/{id}/ | GET /v1/layouts/:id
+*LayoutsApi* | [**layoutUsage**](docs/LayoutsApi.md#layoutusage) | **GET** /v1/layouts/{id}/usage/ | GET /v1/layouts/:id/usage — list workflows using this layout
+*LayoutsApi* | [**listLayouts**](docs/LayoutsApi.md#listlayouts) | **GET** /v1/layouts/ | GET /v1/layouts
+*LayoutsApi* | [**previewLayout**](docs/LayoutsApi.md#previewlayout) | **POST** /v1/layouts/{id}/preview/ | POST /v1/layouts/:id/preview — render layout with sample content
+*LayoutsApi* | [**setDefault**](docs/LayoutsApi.md#setdefault) | **POST** /v1/layouts/{id}/default/ | POST /v1/layouts/:id/default
+*LayoutsApi* | [**updateLayout**](docs/LayoutsApi.md#updatelayout) | **PATCH** /v1/layouts/{id}/ | PATCH /v1/layouts/:id
+*MessagesApi* | [**deleteByTransaction**](docs/MessagesApi.md#deletebytransaction) | **DELETE** /v1/messages/transaction/{transaction_id}/ | DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction
+*MessagesApi* | [**deleteMessage**](docs/MessagesApi.md#deletemessage) | **DELETE** /v1/messages/{id}/ | DELETE /v1/messages/:id — soft-delete a single message
+*MessagesApi* | [**listMessages**](docs/MessagesApi.md#listmessages) | **GET** /v1/messages/ | GET /v1/messages — list all messages with cursor pagination
+*MetricsApi* | [**metricsEndpoint**](docs/MetricsApi.md#metricsendpoint) | **GET** /metrics/ | `GET /metrics` — Prometheus scrape endpoint.
+*NotificationGroupsApi* | [**createNotificationGroup**](docs/NotificationGroupsApi.md#createnotificationgroup) | **POST** /v1/notification-groups/ | POST /v1/notification-groups
+*NotificationGroupsApi* | [**deleteNotificationGroup**](docs/NotificationGroupsApi.md#deletenotificationgroup) | **DELETE** /v1/notification-groups/{id}/ | DELETE /v1/notification-groups/:id
+*NotificationGroupsApi* | [**listNotificationGroups**](docs/NotificationGroupsApi.md#listnotificationgroups) | **GET** /v1/notification-groups/ | GET /v1/notification-groups
+*NotificationGroupsApi* | [**updateNotificationGroup**](docs/NotificationGroupsApi.md#updatenotificationgroup) | **PATCH** /v1/notification-groups/{id}/ | PATCH /v1/notification-groups/:id
+*NotificationsApi* | [**getNotification**](docs/NotificationsApi.md#getnotification) | **GET** /v1/notifications/{id}/ | GET /v1/notifications/:id
+*NotificationsApi* | [**getNotificationJobs**](docs/NotificationsApi.md#getnotificationjobs) | **GET** /v1/notifications/{id}/jobs/ | GET /v1/notifications/:id/jobs
+*NotificationsApi* | [**listNotifications**](docs/NotificationsApi.md#listnotifications) | **GET** /v1/notifications/ | GET /v1/notifications
+*PreferencesApi* | [**listPreferences**](docs/PreferencesApi.md#listpreferences) | **GET** /v1/subscribers/{id}/preferences/ | GET /v1/subscribers/:id/preferences
+*PreferencesApi* | [**updateGlobalPreference**](docs/PreferencesApi.md#updateglobalpreference) | **PATCH** /v1/subscribers/{id}/preferences/ | PATCH /v1/subscribers/:id/preferences
+*PreferencesApi* | [**updateWorkflowPreference**](docs/PreferencesApi.md#updateworkflowpreference) | **PATCH** /v1/subscribers/{id}/preferences/{workflow_id}/ | PATCH /v1/subscribers/:id/preferences/:workflowId
+*ProjectsApi* | [**createProject**](docs/ProjectsApi.md#createproject) | **POST** /v1/projects/ | POST /v1/projects/ — create a new project
+*ProjectsApi* | [**deleteApiKey**](docs/ProjectsApi.md#deleteapikey) | **DELETE** /v1/projects/{id}/api-keys/{key_id}/ | DELETE /v1/projects/{id}/api-keys/{key_id}/ — revoke an API key by ID
+*ProjectsApi* | [**deleteProject**](docs/ProjectsApi.md#deleteproject) | **DELETE** /v1/projects/{id}/ | DELETE /v1/projects/{id}/ — delete a project (owner only)
+*ProjectsApi* | [**generateApiKey**](docs/ProjectsApi.md#generateapikey) | **POST** /v1/projects/{id}/api-keys/ | POST /v1/projects/{id}/api-keys/ — generate a new API key
+*ProjectsApi* | [**getProject**](docs/ProjectsApi.md#getproject) | **GET** /v1/projects/{id}/ | GET /v1/projects/{id}/ — get a project by ID
+*ProjectsApi* | [**inviteMember**](docs/ProjectsApi.md#invitemember) | **POST** /v1/projects/{id}/members/ | POST /v1/projects/{id}/members/ — invite a member
+*ProjectsApi* | [**listApiKeys**](docs/ProjectsApi.md#listapikeys) | **GET** /v1/projects/{id}/api-keys/ | GET /v1/projects/{id}/api-keys/ — list API keys for a project
+*ProjectsApi* | [**listMembers**](docs/ProjectsApi.md#listmembers) | **GET** /v1/projects/{id}/members/ | GET /v1/projects/{id}/members/ — list project members
+*ProjectsApi* | [**listProjects**](docs/ProjectsApi.md#listprojects) | **GET** /v1/projects/ | GET /v1/projects/ — list all projects the user is a member of
+*ProjectsApi* | [**projectTags**](docs/ProjectsApi.md#projecttags) | **GET** /v1/projects/{id}/tags/ | GET /v1/projects/{id}/tags/ — returns unique tags from all workflows in the project
+*ProjectsApi* | [**removeMember**](docs/ProjectsApi.md#removemember) | **DELETE** /v1/projects/{id}/members/{member_id}/ | DELETE /v1/projects/{id}/members/{member_id}/ — remove a member
+*ProjectsApi* | [**updateProject**](docs/ProjectsApi.md#updateproject) | **PATCH** /v1/projects/{id}/ | PATCH /v1/projects/{id}/ — update a project
+*SubscribersApi* | [**bulkCreate**](docs/SubscribersApi.md#bulkcreate) | **POST** /v1/subscribers/bulk/ | POST /v1/subscribers/bulk — create multiple subscribers at once
+*SubscribersApi* | [**bulkUpdatePreferences**](docs/SubscribersApi.md#bulkupdatepreferences) | **PATCH** /v1/subscribers/{id}/preferences/bulk/ | PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+*SubscribersApi* | [**createSubscriber**](docs/SubscribersApi.md#createsubscriber) | **POST** /v1/subscribers/ | POST /v1/subscribers
+*SubscribersApi* | [**deleteCredentials**](docs/SubscribersApi.md#deletecredentials) | **DELETE** /v1/subscribers/{id}/credentials/{provider_id}/ | DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+*SubscribersApi* | [**deleteSubscriber**](docs/SubscribersApi.md#deletesubscriber) | **DELETE** /v1/subscribers/{id}/ | DELETE /v1/subscribers/:subscriber_id
+*SubscribersApi* | [**getSubscriber**](docs/SubscribersApi.md#getsubscriber) | **GET** /v1/subscribers/{id}/ | GET /v1/subscribers/:subscriber_id
+*SubscribersApi* | [**listSubscriberSubscriptions**](docs/SubscribersApi.md#listsubscribersubscriptions) | **GET** /v1/subscribers/{id}/subscriptions/ | GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+*SubscribersApi* | [**listSubscribers**](docs/SubscribersApi.md#listsubscribers) | **GET** /v1/subscribers/ | GET /v1/subscribers
+*SubscribersApi* | [**markAllMessages**](docs/SubscribersApi.md#markallmessages) | **POST** /v1/subscribers/{id}/messages/mark-all/ | POST /v1/subscribers/:id/messages/mark-all — mark all messages
+*SubscribersApi* | [**markMessages**](docs/SubscribersApi.md#markmessages) | **POST** /v1/subscribers/{id}/messages/mark-as/ | POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+*SubscribersApi* | [**setCredentials**](docs/SubscribersApi.md#setcredentials) | **PUT** /v1/subscribers/{id}/credentials/ | PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+*SubscribersApi* | [**subscriberFeed**](docs/SubscribersApi.md#subscriberfeed) | **GET** /v1/subscribers/{id}/notifications/feed/ | GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+*SubscribersApi* | [**unseenCount**](docs/SubscribersApi.md#unseencount) | **GET** /v1/subscribers/{id}/notifications/unseen/ | GET /v1/subscribers/:id/notifications/unseen — unseen count
+*SubscribersApi* | [**updateOnlineStatus**](docs/SubscribersApi.md#updateonlinestatus) | **PATCH** /v1/subscribers/{id}/online-status/ | PATCH /v1/subscribers/:id/online-status — set online/offline
+*SubscribersApi* | [**updateSubscriber**](docs/SubscribersApi.md#updatesubscriber) | **PATCH** /v1/subscribers/{id}/ | PATCH /v1/subscribers/:subscriber_id
+*SubscribersApi* | [**upsertCredentials**](docs/SubscribersApi.md#upsertcredentials) | **PATCH** /v1/subscribers/{id}/credentials/ | PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+*TopicsApi* | [**addSubscribers**](docs/TopicsApi.md#addsubscribers) | **POST** /v1/topics/{key}/subscribers/ | POST /v1/topics/:topicKey/subscribers
+*TopicsApi* | [**checkSubscriber**](docs/TopicsApi.md#checksubscriber) | **GET** /v1/topics/{key}/subscribers/{subscriber_id}/ | GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+*TopicsApi* | [**createSubscriptions**](docs/TopicsApi.md#createsubscriptions) | **POST** /v1/topics/{key}/subscriptions/ | POST /v1/topics/:key/subscriptions — create subscriptions
+*TopicsApi* | [**createTopic**](docs/TopicsApi.md#createtopic) | **POST** /v1/topics/ | POST /v1/topics
+*TopicsApi* | [**deleteSubscriptions**](docs/TopicsApi.md#deletesubscriptions) | **DELETE** /v1/topics/{key}/subscriptions/ | DELETE /v1/topics/:key/subscriptions — bulk delete
+*TopicsApi* | [**deleteTopic**](docs/TopicsApi.md#deletetopic) | **DELETE** /v1/topics/{key}/ | DELETE /v1/topics/:topicKey
+*TopicsApi* | [**getSubscription**](docs/TopicsApi.md#getsubscription) | **GET** /v1/topics/{key}/subscriptions/{id}/ | GET /v1/topics/:key/subscriptions/:id — get single subscription
+*TopicsApi* | [**getTopic**](docs/TopicsApi.md#gettopic) | **GET** /v1/topics/{key}/ | GET /v1/topics/:topicKey
+*TopicsApi* | [**listSubscriptions**](docs/TopicsApi.md#listsubscriptions) | **GET** /v1/topics/{key}/subscriptions/ | GET /v1/topics/:key/subscriptions — list subscriptions
+*TopicsApi* | [**listTopicSubscribers**](docs/TopicsApi.md#listtopicsubscribers) | **GET** /v1/topics/{key}/subscribers/ | GET /v1/topics/:topicKey/subscribers
+*TopicsApi* | [**listTopics**](docs/TopicsApi.md#listtopics) | **GET** /v1/topics/ | GET /v1/topics
+*TopicsApi* | [**removeSubscribers**](docs/TopicsApi.md#removesubscribers) | **POST** /v1/topics/{key}/subscribers/removal/ | POST /v1/topics/:topicKey/subscribers/removal
+*TopicsApi* | [**updateSubscription**](docs/TopicsApi.md#updatesubscription) | **PATCH** /v1/topics/{key}/subscriptions/{id}/ | PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+*TopicsApi* | [**updateTopic**](docs/TopicsApi.md#updatetopic) | **PATCH** /v1/topics/{key}/ | PATCH /v1/topics/:topicKey
+*TranslationsApi* | [**createTranslationGroup**](docs/TranslationsApi.md#createtranslationgroup) | **POST** /v1/translations/groups/ | POST /v1/translations/groups — create a translation group.
+*TranslationsApi* | [**deleteTranslationGroup**](docs/TranslationsApi.md#deletetranslationgroup) | **DELETE** /v1/translations/groups/{id}/ | DELETE /v1/translations/groups/:id — soft-delete a translation group.
+*TranslationsApi* | [**getTranslationGroup**](docs/TranslationsApi.md#gettranslationgroup) | **GET** /v1/translations/groups/{id}/ | GET /v1/translations/groups/:id — get a translation group.
+*TranslationsApi* | [**listTranslationGroups**](docs/TranslationsApi.md#listtranslationgroups) | **GET** /v1/translations/groups/ | GET /v1/translations/groups — list translation groups.
+*TranslationsApi* | [**updateTranslationGroup**](docs/TranslationsApi.md#updatetranslationgroup) | **PATCH** /v1/translations/groups/{id}/ | PATCH /v1/translations/groups/:id — update a translation group.
+*WebhooksApi* | [**deleteWebhook**](docs/WebhooksApi.md#deletewebhook) | **DELETE** /v1/webhooks/{id}/ | DELETE /v1/webhooks/:id
+*WebhooksApi* | [**inboundDeliveryWebhook**](docs/WebhooksApi.md#inbounddeliverywebhook) | **POST** /v1/inbound-webhooks/delivery-providers/{project_id}/{integration_id}/ | POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+*WebhooksApi* | [**listWebhooks**](docs/WebhooksApi.md#listwebhooks) | **GET** /v1/webhooks/ | GET /v1/webhooks
+*WebhooksApi* | [**registerWebhook**](docs/WebhooksApi.md#registerwebhook) | **POST** /v1/webhooks/ | POST /v1/webhooks
+*WorkflowsApi* | [**createWorkflow**](docs/WorkflowsApi.md#createworkflow) | **POST** /v1/workflows/ | POST /v1/workflows
+*WorkflowsApi* | [**deleteWorkflow**](docs/WorkflowsApi.md#deleteworkflow) | **DELETE** /v1/workflows/{id}/ | DELETE /v1/workflows/:id
+*WorkflowsApi* | [**duplicateWorkflow**](docs/WorkflowsApi.md#duplicateworkflow) | **POST** /v1/workflows/{id}/duplicate/ | POST /v1/workflows/:id/duplicate — clone workflow
+*WorkflowsApi* | [**getStep**](docs/WorkflowsApi.md#getstep) | **GET** /v1/workflows/{id}/steps/{step_id}/ | GET /v1/workflows/:id/steps/:step_id — get step details
+*WorkflowsApi* | [**getWorkflow**](docs/WorkflowsApi.md#getworkflow) | **GET** /v1/workflows/{id}/ | GET /v1/workflows/:id
+*WorkflowsApi* | [**listWorkflows**](docs/WorkflowsApi.md#listworkflows) | **GET** /v1/workflows/ | GET /v1/workflows
+*WorkflowsApi* | [**stepPreview**](docs/WorkflowsApi.md#steppreview) | **POST** /v1/workflows/{id}/step/{step_id}/preview/ | POST /v1/workflows/:id/step/:step_id/preview — render step template
+*WorkflowsApi* | [**syncWorkflow**](docs/WorkflowsApi.md#syncworkflow) | **PUT** /v1/workflows/{id}/sync/ | PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+*WorkflowsApi* | [**updateWorkflow**](docs/WorkflowsApi.md#updateworkflow) | **PUT** /v1/workflows/{id}/ | PUT /v1/workflows/:id
+*WorkflowsApi* | [**updateWorkflowStatus**](docs/WorkflowsApi.md#updateworkflowstatus) | **PUT** /v1/workflows/{id}/status/ | PUT /v1/workflows/:id/status
+
+
+### Documentation For Models
+
+ - [ActionBody](docs/ActionBody.md)
+ - [ActionRecord](docs/ActionRecord.md)
+ - [ActionType](docs/ActionType.md)
+ - [ActivityChartPoint](docs/ActivityChartPoint.md)
+ - [ActivityRecord](docs/ActivityRecord.md)
+ - [ActivityRequestRecord](docs/ActivityRequestRecord.md)
+ - [ActivityStats](docs/ActivityStats.md)
+ - [ActorType](docs/ActorType.md)
+ - [ApiKeyCreated](docs/ApiKeyCreated.md)
+ - [ApiKeyInfo](docs/ApiKeyInfo.md)
+ - [AutoConfigureResult](docs/AutoConfigureResult.md)
+ - [BillingInterval](docs/BillingInterval.md)
+ - [Branding](docs/Branding.md)
+ - [BroadcastTrigger](docs/BroadcastTrigger.md)
+ - [BulkCreateSubscribers](docs/BulkCreateSubscribers.md)
+ - [BulkPreferenceItem](docs/BulkPreferenceItem.md)
+ - [BulkPreferences](docs/BulkPreferences.md)
+ - [BulkResult](docs/BulkResult.md)
+ - [BulkTrigger](docs/BulkTrigger.md)
+ - [ChannelConnectionRecord](docs/ChannelConnectionRecord.md)
+ - [ChannelEndpointRecord](docs/ChannelEndpointRecord.md)
+ - [ChannelPreferences](docs/ChannelPreferences.md)
+ - [ChannelType](docs/ChannelType.md)
+ - [ChartQuery](docs/ChartQuery.md)
+ - [ChatOauth](docs/ChatOauth.md)
+ - [ChatOauthRequest](docs/ChatOauthRequest.md)
+ - [CheckoutSession](docs/CheckoutSession.md)
+ - [ContextRecord](docs/ContextRecord.md)
+ - [CreateChannelConnection](docs/CreateChannelConnection.md)
+ - [CreateChannelEndpoint](docs/CreateChannelEndpoint.md)
+ - [CreateCheckout](docs/CreateCheckout.md)
+ - [CreateContext](docs/CreateContext.md)
+ - [CreateIntegration](docs/CreateIntegration.md)
+ - [CreateLayout](docs/CreateLayout.md)
+ - [CreateNotificationGroup](docs/CreateNotificationGroup.md)
+ - [CreateProject](docs/CreateProject.md)
+ - [CreateSubscriber](docs/CreateSubscriber.md)
+ - [CreateSubscription](docs/CreateSubscription.md)
+ - [CreateTopic](docs/CreateTopic.md)
+ - [CreateWebhook](docs/CreateWebhook.md)
+ - [CreateWorkflow](docs/CreateWorkflow.md)
+ - [CtaType](docs/CtaType.md)
+ - [CursorMeta](docs/CursorMeta.md)
+ - [CursorPaginatedFeedItem](docs/CursorPaginatedFeedItem.md)
+ - [CursorPaginatedFeedItemDataInner](docs/CursorPaginatedFeedItemDataInner.md)
+ - [CursorPaginatedMessageRecord](docs/CursorPaginatedMessageRecord.md)
+ - [CursorPaginatedMessageRecordDataInner](docs/CursorPaginatedMessageRecordDataInner.md)
+ - [CursorPagination](docs/CursorPagination.md)
+ - [DeleteSubscription](docs/DeleteSubscription.md)
+ - [DeliveryAck](docs/DeliveryAck.md)
+ - [DeliveryStatusWebhook](docs/DeliveryStatusWebhook.md)
+ - [DnsSettings](docs/DnsSettings.md)
+ - [EngagementStatsResponse](docs/EngagementStatsResponse.md)
+ - [EntitlementItem](docs/EntitlementItem.md)
+ - [Entitlements](docs/Entitlements.md)
+ - [ErrorDetail](docs/ErrorDetail.md)
+ - [EventsUsage](docs/EventsUsage.md)
+ - [FeedItem](docs/FeedItem.md)
+ - [FeedQuery](docs/FeedQuery.md)
+ - [InboxNotification](docs/InboxNotification.md)
+ - [InboxPreference](docs/InboxPreference.md)
+ - [InboxQuery](docs/InboxQuery.md)
+ - [InitSessionRequest](docs/InitSessionRequest.md)
+ - [InitSessionResponse](docs/InitSessionResponse.md)
+ - [IntegrationRecord](docs/IntegrationRecord.md)
+ - [InviteMember](docs/InviteMember.md)
+ - [InviteMemberBody](docs/InviteMemberBody.md)
+ - [JobLog](docs/JobLog.md)
+ - [LayoutPreview](docs/LayoutPreview.md)
+ - [LayoutPreviewResult](docs/LayoutPreviewResult.md)
+ - [LayoutRecord](docs/LayoutRecord.md)
+ - [LayoutUsageItem](docs/LayoutUsageItem.md)
+ - [MarkAll](docs/MarkAll.md)
+ - [MarkMessages](docs/MarkMessages.md)
+ - [MarkResult](docs/MarkResult.md)
+ - [MemberRecord](docs/MemberRecord.md)
+ - [MemberRole](docs/MemberRole.md)
+ - [MemberStatus](docs/MemberStatus.md)
+ - [MessageQuery](docs/MessageQuery.md)
+ - [MessageRecord](docs/MessageRecord.md)
+ - [NotificationCount](docs/NotificationCount.md)
+ - [NotificationGroupRecord](docs/NotificationGroupRecord.md)
+ - [NotificationLog](docs/NotificationLog.md)
+ - [NotificationQuery](docs/NotificationQuery.md)
+ - [OffsetMeta](docs/OffsetMeta.md)
+ - [OffsetPagination](docs/OffsetPagination.md)
+ - [OnlineStatus](docs/OnlineStatus.md)
+ - [PaginatedChannelConnectionRecord](docs/PaginatedChannelConnectionRecord.md)
+ - [PaginatedChannelConnectionRecordDataInner](docs/PaginatedChannelConnectionRecordDataInner.md)
+ - [PaginatedChannelEndpointRecord](docs/PaginatedChannelEndpointRecord.md)
+ - [PaginatedChannelEndpointRecordDataInner](docs/PaginatedChannelEndpointRecordDataInner.md)
+ - [PaginatedContextRecord](docs/PaginatedContextRecord.md)
+ - [PaginatedContextRecordDataInner](docs/PaginatedContextRecordDataInner.md)
+ - [PaginatedIntegrationRecord](docs/PaginatedIntegrationRecord.md)
+ - [PaginatedIntegrationRecordDataInner](docs/PaginatedIntegrationRecordDataInner.md)
+ - [PaginatedLayoutRecord](docs/PaginatedLayoutRecord.md)
+ - [PaginatedLayoutRecordDataInner](docs/PaginatedLayoutRecordDataInner.md)
+ - [PaginatedSubscriberRecord](docs/PaginatedSubscriberRecord.md)
+ - [PaginatedSubscriberRecordDataInner](docs/PaginatedSubscriberRecordDataInner.md)
+ - [PaginatedTopicRecord](docs/PaginatedTopicRecord.md)
+ - [PaginatedTopicRecordDataInner](docs/PaginatedTopicRecordDataInner.md)
+ - [PaginatedTopicSubscriptionRecord](docs/PaginatedTopicSubscriptionRecord.md)
+ - [PaginatedTopicSubscriptionRecordDataInner](docs/PaginatedTopicSubscriptionRecordDataInner.md)
+ - [PaginatedWorkflowRecord](docs/PaginatedWorkflowRecord.md)
+ - [PaginatedWorkflowRecordDataInner](docs/PaginatedWorkflowRecordDataInner.md)
+ - [PaginationQuery](docs/PaginationQuery.md)
+ - [PatchCredentials](docs/PatchCredentials.md)
+ - [Plan](docs/Plan.md)
+ - [PlanLimitsResponse](docs/PlanLimitsResponse.md)
+ - [PortalUrl](docs/PortalUrl.md)
+ - [PreferenceChannels](docs/PreferenceChannels.md)
+ - [PreferenceRecord](docs/PreferenceRecord.md)
+ - [PreviewResult](docs/PreviewResult.md)
+ - [PriceInfo](docs/PriceInfo.md)
+ - [Prices](docs/Prices.md)
+ - [ProjectRecord](docs/ProjectRecord.md)
+ - [SetCredentials](docs/SetCredentials.md)
+ - [StepPreview](docs/StepPreview.md)
+ - [StepRecord](docs/StepRecord.md)
+ - [StepType](docs/StepType.md)
+ - [SubscriberCredential](docs/SubscriberCredential.md)
+ - [SubscriberPayload](docs/SubscriberPayload.md)
+ - [SubscriberRecord](docs/SubscriberRecord.md)
+ - [Subscription](docs/Subscription.md)
+ - [SyncWorkflow](docs/SyncWorkflow.md)
+ - [SystemAvatarIcon](docs/SystemAvatarIcon.md)
+ - [TopicRecord](docs/TopicRecord.md)
+ - [TopicSubscribers](docs/TopicSubscribers.md)
+ - [TopicSubscription](docs/TopicSubscription.md)
+ - [TopicSubscriptionRecord](docs/TopicSubscriptionRecord.md)
+ - [TrialInfo](docs/TrialInfo.md)
+ - [TriggerEvent](docs/TriggerEvent.md)
+ - [TriggerRecipients](docs/TriggerRecipients.md)
+ - [TriggerRecipientsOneOf](docs/TriggerRecipientsOneOf.md)
+ - [TriggerResult](docs/TriggerResult.md)
+ - [TriggerStatus](docs/TriggerStatus.md)
+ - [UnseenCount](docs/UnseenCount.md)
+ - [UpdateChannelConnection](docs/UpdateChannelConnection.md)
+ - [UpdateChannelEndpoint](docs/UpdateChannelEndpoint.md)
+ - [UpdateContext](docs/UpdateContext.md)
+ - [UpdateInboxPreferences](docs/UpdateInboxPreferences.md)
+ - [UpdateIntegration](docs/UpdateIntegration.md)
+ - [UpdateLayout](docs/UpdateLayout.md)
+ - [UpdateNotificationGroup](docs/UpdateNotificationGroup.md)
+ - [UpdatePreference](docs/UpdatePreference.md)
+ - [UpdateProject](docs/UpdateProject.md)
+ - [UpdateSubscriber](docs/UpdateSubscriber.md)
+ - [UpdateSubscriptionMeta](docs/UpdateSubscriptionMeta.md)
+ - [UpdateTopic](docs/UpdateTopic.md)
+ - [UpdateWorkflow](docs/UpdateWorkflow.md)
+ - [Usage](docs/Usage.md)
+ - [WebhookRecord](docs/WebhookRecord.md)
+ - [WidgetSettings](docs/WidgetSettings.md)
+ - [WorkflowRecord](docs/WorkflowRecord.md)
+ - [WorkflowRunRecord](docs/WorkflowRunRecord.md)
+ - [WorkflowStatsResponse](docs/WorkflowStatsResponse.md)
+ - [WorkflowStatus](docs/WorkflowStatus.md)
+ - [WorkflowStepCreate](docs/WorkflowStepCreate.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api_key"></a>
+### api_key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="bearer_auth"></a>
+### bearer_auth
+
+- **Type**: Bearer authentication
+