@enbbox/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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/[email protected] --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 | GET /v1/activity/chart/ | GET /v1/activity/chart — activity chart data ActivityApi | activityStats | GET /v1/activity/stats/ | GET /v1/activity/stats ActivityApi | engagementStats | GET /v1/activity/engagement/ | GET /v1/activity/engagement — subscriber engagement stats ActivityApi | getActivityByNotification | GET /v1/activity/{notification_id}/ | GET /v1/activity/:notificationId ActivityApi | listActivity | GET /v1/activity/ | GET /v1/activity ActivityApi | listActivityRequests | GET /v1/activity/requests/ | GET /v1/activity/requests — list trigger requests GET /v1/activity/requests — list trigger requests ActivityApi | listWorkflowRuns | GET /v1/activity/workflow-runs/ | GET /v1/activity/workflow-runs — list workflow executions ActivityApi | workflowStats | GET /v1/activity/workflows/stats/ | GET /v1/activity/workflows/stats — workflow execution stats BillingApi | createCheckoutSession | POST /v1/billing/checkout-session/ | Create a Stripe Checkout Session for upgrading a plan. BillingApi | getBillingLimits | GET /v1/billing/limits/ | Get plan limits and current usage for the project. BillingApi | getBillingSubscription | GET /v1/billing/subscription/ | Get the current subscription for the authed project. BillingApi | getEntitlements | GET /v1/billing/entitlements/ | Get active entitlements for the project. BillingApi | getPortalUrl | GET /v1/billing/portal/ | Get a Stripe Customer Portal URL for managing the subscription. BillingApi | getPrices | GET /v1/billing/prices/ | Get available plan prices. BillingApi | getUsage | GET /v1/billing/usage/ | Get current usage data for the project. BillingApi | stripeWebhook | POST /v1/billing/webhooks/stripe/ | Handle Stripe webhook events. ChannelConnectionsApi | createConnection | POST /v1/channel-connections/ | POST /v1/channel-connections ChannelConnectionsApi | deleteConnection | DELETE /v1/channel-connections/{id}/ | DELETE /v1/channel-connections/:identifier ChannelConnectionsApi | getConnection | GET /v1/channel-connections/{id}/ | GET /v1/channel-connections/:identifier ChannelConnectionsApi | listConnections | GET /v1/channel-connections/ | GET /v1/channel-connections ChannelConnectionsApi | updateConnection | PATCH /v1/channel-connections/{id}/ | PATCH /v1/channel-connections/:identifier ChannelEndpointsApi | createEndpoint | POST /v1/channel-endpoints/ | POST /v1/channel-endpoints ChannelEndpointsApi | deleteEndpoint | DELETE /v1/channel-endpoints/{id}/ | DELETE /v1/channel-endpoints/:identifier ChannelEndpointsApi | getEndpoint | GET /v1/channel-endpoints/{id}/ | GET /v1/channel-endpoints/:identifier ChannelEndpointsApi | listEndpoints | GET /v1/channel-endpoints/ | GET /v1/channel-endpoints ChannelEndpointsApi | updateEndpoint | PATCH /v1/channel-endpoints/{id}/ | PATCH /v1/channel-endpoints/:identifier ContextsApi | createContext | POST /v1/contexts/ | POST /v1/contexts ContextsApi | deleteContext | DELETE /v1/contexts/{type}/{id}/ | DELETE /v1/contexts/:type/:id ContextsApi | getContext | GET /v1/contexts/{type}/{id}/ | GET /v1/contexts/:type/:id ContextsApi | listContexts | GET /v1/contexts/ | GET /v1/contexts — list contexts ContextsApi | updateContext | PATCH /v1/contexts/{type}/{id}/ | PATCH /v1/contexts/:type/:id EventsApi | cancelEvent | DELETE /v1/events/{transaction_id}/ | DELETE /v1/events/:transaction_id EventsApi | triggerBroadcast | POST /v1/events/trigger/broadcast/ | POST /v1/events/trigger/broadcast — broadcast to all subscribers EventsApi | triggerBulk | POST /v1/events/trigger/bulk/ | POST /v1/events/trigger/bulk EventsApi | triggerEvent | POST /v1/events/trigger/ | POST /v1/events/trigger FeatureFlagsApi | getFeatureFlags | GET /v1/feature-flags/ | GET /v1/feature-flags — returns enabled features for the current project. HealthApi | healthCheck | GET /health/ | GET /health — basic health check (backward compat). HealthApi | liveness | GET /health/live/ | GET /health/live — liveness probe: returns 200 if process is alive. HealthApi | readiness | GET /health/ready/ | GET /health/ready — readiness probe: returns 200 if dependencies are connected. InboundParseApi | inboundParseWebhook | POST /v1/inbound-parse/webhook/ | POST /v1/inbound-parse/webhook — receive parsed email from provider. InboxApi | archive | POST /v1/inbox/notifications/{id}/archive/ | POST /v1/inbox/notifications/:id/archive InboxApi | archiveAll | POST /v1/inbox/notifications/archive/ | POST /v1/inbox/notifications/archive (archive all) InboxApi | executeAction | POST /v1/inbox/notifications/{id}/actions/{action_type}/ | POST /v1/inbox/notifications/:id/actions/:actionType InboxApi | getInboxPreferences | GET /v1/inbox/preferences/ | GET /v1/inbox/preferences InboxApi | inboxListNotifications | GET /v1/inbox/notifications/ | GET /v1/inbox/notifications/ InboxApi | initInboxSession | POST /v1/inbox/session/ | POST /v1/inbox/session/ InboxApi | markAllRead | POST /v1/inbox/notifications/read/ | POST /v1/inbox/notifications/read (mark all as read) InboxApi | markRead | POST /v1/inbox/notifications/{id}/read/ | POST /v1/inbox/notifications/:id/read InboxApi | markUnread | POST /v1/inbox/notifications/{id}/unread/ | POST /v1/inbox/notifications/:id/unread InboxApi | notificationCount | GET /v1/inbox/notifications/count/ | GET /v1/inbox/notifications/count InboxApi | unarchive | POST /v1/inbox/notifications/{id}/unarchive/ | POST /v1/inbox/notifications/:id/unarchive InboxApi | updateInboxGlobalPreference | PATCH /v1/inbox/preferences/ | PATCH /v1/inbox/preferences InboxApi | updateInboxWorkflowPreference | PATCH /v1/inbox/preferences/{workflow_id}/ | PATCH /v1/inbox/preferences/:workflowId IntegrationsApi | autoConfigure | POST /v1/integrations/{id}/auto-configure/ | POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks IntegrationsApi | chatOauth | POST /v1/integrations/chat/oauth/ | POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers IntegrationsApi | createIntegration | POST /v1/integrations/ | POST /v1/integrations IntegrationsApi | deleteIntegration | DELETE /v1/integrations/{id}/ | DELETE /v1/integrations/:id IntegrationsApi | getIntegration | GET /v1/integrations/{id}/ | GET /v1/integrations/:id IntegrationsApi | listActiveIntegrations | GET /v1/integrations/active/ | GET /v1/integrations/active — list only active integrations IntegrationsApi | listIntegrations | GET /v1/integrations/ | GET /v1/integrations IntegrationsApi | setPrimary | PUT /v1/integrations/{id}/set-primary/ | PUT /v1/integrations/:id/set-primary IntegrationsApi | testConnection | POST /v1/integrations/{id}/test-connection/ | POST /v1/integrations/:id/test-connection IntegrationsApi | updateIntegration | PUT /v1/integrations/{id}/ | PUT /v1/integrations/:id LayoutsApi | createLayout | POST /v1/layouts/ | POST /v1/layouts LayoutsApi | deleteLayout | DELETE /v1/layouts/{id}/ | DELETE /v1/layouts/:id LayoutsApi | duplicateLayout | POST /v1/layouts/{id}/duplicate/ | POST /v1/layouts/:id/duplicate — clone layout LayoutsApi | getLayout | GET /v1/layouts/{id}/ | GET /v1/layouts/:id LayoutsApi | layoutUsage | GET /v1/layouts/{id}/usage/ | GET /v1/layouts/:id/usage — list workflows using this layout LayoutsApi | listLayouts | GET /v1/layouts/ | GET /v1/layouts LayoutsApi | previewLayout | POST /v1/layouts/{id}/preview/ | POST /v1/layouts/:id/preview — render layout with sample content LayoutsApi | setDefault | POST /v1/layouts/{id}/default/ | POST /v1/layouts/:id/default LayoutsApi | updateLayout | PATCH /v1/layouts/{id}/ | PATCH /v1/layouts/:id MessagesApi | deleteByTransaction | DELETE /v1/messages/transaction/{transaction_id}/ | DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction MessagesApi | deleteMessage | DELETE /v1/messages/{id}/ | DELETE /v1/messages/:id — soft-delete a single message MessagesApi | listMessages | GET /v1/messages/ | GET /v1/messages — list all messages with cursor pagination MetricsApi | metricsEndpoint | GET /metrics/ | `GET /metrics` — Prometheus scrape endpoint. NotificationGroupsApi | createNotificationGroup | POST /v1/notification-groups/ | POST /v1/notification-groups NotificationGroupsApi | deleteNotificationGroup | DELETE /v1/notification-groups/{id}/ | DELETE /v1/notification-groups/:id NotificationGroupsApi | listNotificationGroups | GET /v1/notification-groups/ | GET /v1/notification-groups NotificationGroupsApi | updateNotificationGroup | PATCH /v1/notification-groups/{id}/ | PATCH /v1/notification-groups/:id NotificationsApi | getNotification | GET /v1/notifications/{id}/ | GET /v1/notifications/:id NotificationsApi | getNotificationJobs | GET /v1/notifications/{id}/jobs/ | GET /v1/notifications/:id/jobs NotificationsApi | listNotifications | GET /v1/notifications/ | GET /v1/notifications PreferencesApi | listPreferences | GET /v1/subscribers/{id}/preferences/ | GET /v1/subscribers/:id/preferences PreferencesApi | updateGlobalPreference | PATCH /v1/subscribers/{id}/preferences/ | PATCH /v1/subscribers/:id/preferences PreferencesApi | updateWorkflowPreference | PATCH /v1/subscribers/{id}/preferences/{workflow_id}/ | PATCH /v1/subscribers/:id/preferences/:workflowId ProjectsApi | createProject | POST /v1/projects/ | POST /v1/projects/ — create a new project ProjectsApi | 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 | DELETE /v1/projects/{id}/ | DELETE /v1/projects/{id}/ — delete a project (owner only) ProjectsApi | generateApiKey | POST /v1/projects/{id}/api-keys/ | POST /v1/projects/{id}/api-keys/ — generate a new API key ProjectsApi | getProject | GET /v1/projects/{id}/ | GET /v1/projects/{id}/ — get a project by ID ProjectsApi | inviteMember | POST /v1/projects/{id}/members/ | POST /v1/projects/{id}/members/ — invite a member ProjectsApi | listApiKeys | GET /v1/projects/{id}/api-keys/ | GET /v1/projects/{id}/api-keys/ — list API keys for a project ProjectsApi | listMembers | GET /v1/projects/{id}/members/ | GET /v1/projects/{id}/members/ — list project members ProjectsApi | listProjects | GET /v1/projects/ | GET /v1/projects/ — list all projects the user is a member of ProjectsApi | projectTags | GET /v1/projects/{id}/tags/ | GET /v1/projects/{id}/tags/ — returns unique tags from all workflows in the project ProjectsApi | removeMember | DELETE /v1/projects/{id}/members/{member_id}/ | DELETE /v1/projects/{id}/members/{member_id}/ — remove a member ProjectsApi | updateProject | PATCH /v1/projects/{id}/ | PATCH /v1/projects/{id}/ — update a project SubscriberCredentialsApi | deleteCredentials | DELETE /v1/subscribers/{id}/credentials/{provider_id}/ | DELETE /v1/subscribers/:id/credentials/:provider_id — remove credentials for a provider SubscriberCredentialsApi | getCredential | GET /v1/subscribers/{id}/credentials/{provider_id}/ | GET /v1/subscribers/:id/credentials/:provider_id — get credentials for one provider SubscriberCredentialsApi | listCredentials | GET /v1/subscribers/{id}/credentials/ | GET /v1/subscribers/:id/credentials — list all provider credentials SubscriberCredentialsApi | setCredentials | PUT /v1/subscribers/{id}/credentials/{provider_id}/ | PUT /v1/subscribers/:id/credentials/:provider_id — create or replace credentials for a provider SubscriberCredentialsApi | upsertCredentials | PATCH /v1/subscribers/{id}/credentials/{provider_id}/ | PATCH /v1/subscribers/:id/credentials/:provider_id — partially update credentials for a provider SubscribersApi | bulkCreate | POST /v1/subscribers/bulk/ | POST /v1/subscribers/bulk — create multiple subscribers at once SubscribersApi | bulkUpdatePreferences | PATCH /v1/subscribers/{id}/preferences/bulk/ | PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once SubscribersApi | createSubscriber | POST /v1/subscribers/ | POST /v1/subscribers SubscribersApi | deleteSubscriber | DELETE /v1/subscribers/{id}/ | DELETE /v1/subscribers/:subscriber_id SubscribersApi | getSubscriber | GET /v1/subscribers/{id}/ | GET /v1/subscribers/:subscriber_id SubscribersApi | listSubscriberSubscriptions | GET /v1/subscribers/{id}/subscriptions/ | GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber SubscribersApi | listSubscribers | GET /v1/subscribers/ | GET /v1/subscribers SubscribersApi | markAllMessages | POST /v1/subscribers/{id}/messages/mark-all/ | POST /v1/subscribers/:id/messages/mark-all — mark all messages SubscribersApi | markMessages | POST /v1/subscribers/{id}/messages/mark-as/ | POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen SubscribersApi | subscriberFeed | GET /v1/subscribers/{id}/notifications/feed/ | GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list SubscribersApi | unseenCount | GET /v1/subscribers/{id}/notifications/unseen/ | GET /v1/subscribers/:id/notifications/unseen — unseen count SubscribersApi | updateOnlineStatus | PATCH /v1/subscribers/{id}/online-status/ | PATCH /v1/subscribers/:id/online-status — set online/offline SubscribersApi | updateSubscriber | PATCH /v1/subscribers/{id}/ | PATCH /v1/subscribers/:subscriber_id TopicsApi | addSubscribers | POST /v1/topics/{key}/subscribers/ | POST /v1/topics/:topicKey/subscribers TopicsApi | checkSubscriber | GET /v1/topics/{key}/subscribers/{subscriber_id}/ | GET /v1/topics/:key/subscribers/:subscriber_id — membership check TopicsApi | createSubscriptions | POST /v1/topics/{key}/subscriptions/ | POST /v1/topics/:key/subscriptions — create subscriptions TopicsApi | createTopic | POST /v1/topics/ | POST /v1/topics TopicsApi | deleteSubscriptions | DELETE /v1/topics/{key}/subscriptions/ | DELETE /v1/topics/:key/subscriptions — bulk delete TopicsApi | deleteTopic | DELETE /v1/topics/{key}/ | DELETE /v1/topics/:topicKey TopicsApi | getSubscription | GET /v1/topics/{key}/subscriptions/{id}/ | GET /v1/topics/:key/subscriptions/:id — get single subscription TopicsApi | getTopic | GET /v1/topics/{key}/ | GET /v1/topics/:topicKey TopicsApi | listSubscriptions | GET /v1/topics/{key}/subscriptions/ | GET /v1/topics/:key/subscriptions — list subscriptions TopicsApi | listTopicSubscribers | GET /v1/topics/{key}/subscribers/ | GET /v1/topics/:topicKey/subscribers TopicsApi | listTopics | GET /v1/topics/ | GET /v1/topics TopicsApi | removeSubscribers | POST /v1/topics/{key}/subscribers/removal/ | POST /v1/topics/:topicKey/subscribers/removal TopicsApi | updateSubscription | PATCH /v1/topics/{key}/subscriptions/{id}/ | PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata TopicsApi | updateTopic | PATCH /v1/topics/{key}/ | PATCH /v1/topics/:topicKey TranslationsApi | createTranslationGroup | POST /v1/translations/groups/ | POST /v1/translations/groups — create a translation group. TranslationsApi | deleteTranslationGroup | DELETE /v1/translations/groups/{id}/ | DELETE /v1/translations/groups/:id — soft-delete a translation group. TranslationsApi | getTranslationGroup | GET /v1/translations/groups/{id}/ | GET /v1/translations/groups/:id — get a translation group. TranslationsApi | listTranslationGroups | GET /v1/translations/groups/ | GET /v1/translations/groups — list translation groups. TranslationsApi | updateTranslationGroup | PATCH /v1/translations/groups/{id}/ | PATCH /v1/translations/groups/:id — update a translation group. WebhooksApi | deleteWebhook | DELETE /v1/webhooks/{id}/ | DELETE /v1/webhooks/:id WebhooksApi | inboundDeliveryWebhook | POST /v1/inbound-webhooks/delivery-providers/{project_id}/{integration_id}/ | POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id WebhooksApi | listWebhooks | GET /v1/webhooks/ | GET /v1/webhooks WebhooksApi | registerWebhook | POST /v1/webhooks/ | POST /v1/webhooks WorkflowsApi | createWorkflow | POST /v1/workflows/ | POST /v1/workflows WorkflowsApi | deleteWorkflow | DELETE /v1/workflows/{id}/ | DELETE /v1/workflows/:id WorkflowsApi | duplicateWorkflow | POST /v1/workflows/{id}/duplicate/ | POST /v1/workflows/:id/duplicate — clone workflow WorkflowsApi | getStep | GET /v1/workflows/{id}/steps/{step_id}/ | GET /v1/workflows/:id/steps/:step_id — get step details WorkflowsApi | getWorkflow | GET /v1/workflows/{id}/ | GET /v1/workflows/:id WorkflowsApi | listWorkflows | GET /v1/workflows/ | GET /v1/workflows WorkflowsApi | stepPreview | POST /v1/workflows/{id}/step/{step_id}/preview/ | POST /v1/workflows/:id/step/:step_id/preview — render step template WorkflowsApi | syncWorkflow | PUT /v1/workflows/{id}/sync/ | PUT /v1/workflows/:id/sync — sync from code-first workflow definition WorkflowsApi | updateWorkflow | PUT /v1/workflows/{id}/ | PUT /v1/workflows/:id WorkflowsApi | updateWorkflowStatus | PUT /v1/workflows/{id}/status/ | PUT /v1/workflows/:id/status

Documentation For Models

• ActionBody
• ActionRecord
• ActionType
• ActivityChartPoint
• ActivityRecord
• ActivityRequestRecord
• ActivityStats
• ActorType
• ApiKey
• ApiKeyCreateResponse
• AutoConfiguration
• BillingInterval
• Branding
• BroadcastTrigger
• BulkCreateSubscribers
• BulkPreferenceItem
• BulkPreferences
• BulkResult
• BulkTrigger
• ChannelConnectionRecord
• ChannelEndpointRecord
• ChannelPreferences
• ChannelType
• ChartQuery
• ChatOauth
• ChatOauthRequest
• CheckoutSession
• ConnectionTest
• ContextRecord
• CreateChannelConnection
• CreateChannelEndpoint
• CreateCheckout
• CreateContext
• CreateIntegration
• CreateLayout
• CreateNotificationGroup
• CreateProject
• CreateSubscriber
• CreateSubscription
• CreateTopic
• CreateWebhook
• CreateWorkflow
• Credential
• CredentialRecord
• CtaType
• CursorMeta
• CursorPaginatedFeedItem
• CursorPaginatedFeedItemDataInner
• CursorPaginatedMessageRecord
• CursorPaginatedMessageRecordDataInner
• CursorPagination
• DeleteSubscription
• DeliveryAck
• DeliveryStatusWebhook
• DnsSettings
• EngagementStats
• EntitlementItem
• Entitlements
• ErrorDetail
• EventsUsage
• FeedItem
• FeedQuery
• InboxNotification
• InboxPreference
• InboxQuery
• InitSessionRequest
• InitSessionResponse
• IntegrationRecord
• InviteMember
• InviteMemberBody
• JobLog
• LayoutPreview
• LayoutPreviewResult
• LayoutRecord
• LayoutUsageItem
• MarkAll
• MarkMessages
• MarkResult
• MemberRecord
• MemberRole
• MemberStatus
• MessageQuery
• MessageRecord
• NotificationCount
• NotificationGroupRecord
• NotificationLog
• OffsetMeta
• OffsetPagination
• OnlineStatus
• PaginatedActivityRecord
• PaginatedActivityRecordDataInner
• PaginatedChannelConnectionRecord
• PaginatedChannelConnectionRecordDataInner
• PaginatedChannelEndpointRecord
• PaginatedChannelEndpointRecordDataInner
• PaginatedContextRecord
• PaginatedContextRecordDataInner
• PaginatedIntegrationRecord
• PaginatedIntegrationRecordDataInner
• PaginatedLayoutRecord
• PaginatedLayoutRecordDataInner
• PaginatedNotificationLog
• PaginatedNotificationLogDataInner
• PaginatedSubscriberRecord
• PaginatedSubscriberRecordDataInner
• PaginatedTopicRecord
• PaginatedTopicRecordDataInner
• PaginatedTopicSubscriptionRecord
• PaginatedTopicSubscriptionRecordDataInner
• PaginatedWorkflowRecord
• PaginatedWorkflowRecordDataInner
• PatchCredential
• Plan
• PlanLimits
• PortalUrl
• PreferenceChannels
• PreferenceRecord
• PreviewResult
• PriceTier
• Prices
• ProjectRecord
• StepPreview
• StepRecord
• StepType
• SubscriberCredential
• SubscriberPayload
• SubscriberRecord
• Subscription
• SyncWorkflow
• SystemAvatarIcon
• TopicRecord
• TopicSubscribers
• TopicSubscription
• TopicSubscriptionRecord
• Trial
• TriggerEvent
• TriggerRecipients
• TriggerRecipientsOneOf
• TriggerResult
• TriggerStatus
• UnseenCount
• UpdateChannelConnection
• UpdateChannelEndpoint
• UpdateContext
• UpdateInboxPreferences
• UpdateIntegration
• UpdateLayout
• UpdateNotificationGroup
• UpdatePreference
• UpdateProject
• UpdateSubscriber
• UpdateSubscriptionMeta
• UpdateTopic
• UpdateWorkflow
• Usage
• WebhookRecord
• WidgetSettings
• WorkflowRecord
• WorkflowRunRecord
• WorkflowStats
• WorkflowStatus
• WorkflowStepCreate

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

bearer_auth

• Type: Bearer authentication