enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation

Rust API client for enbbox

Notification infrastructure API — open-source alternative to Novu/Courier

For more information, please visit https://github.com/enbbox/enbbox

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.1
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named enbbox and add the following to Cargo.toml under [dependencies]:

enbbox = { path = "./enbbox" }

Documentation for API Endpoints

All URIs are relative to https://api.enbbox.com

Class Method HTTP request Description
ActivityApi activity_chart GET /v1/activity/chart/ GET /v1/activity/chart — activity chart data
ActivityApi activity_stats GET /v1/activity/stats/ GET /v1/activity/stats
ActivityApi engagement_stats GET /v1/activity/engagement/ GET /v1/activity/engagement — subscriber engagement stats
ActivityApi get_activity_by_notification GET /v1/activity/{notification_id}/ GET /v1/activity/:notificationId
ActivityApi list_activity GET /v1/activity/ GET /v1/activity
ActivityApi list_activity_requests GET /v1/activity/requests/ GET /v1/activity/requests — list trigger requests GET /v1/activity/requests — list trigger requests
ActivityApi list_workflow_runs GET /v1/activity/workflow-runs/ GET /v1/activity/workflow-runs — list workflow executions
ActivityApi workflow_stats GET /v1/activity/workflows/stats/ GET /v1/activity/workflows/stats — workflow execution stats
BillingApi create_checkout_session POST /v1/billing/checkout-session/ Create a Stripe Checkout Session for upgrading a plan.
BillingApi get_billing_limits GET /v1/billing/limits/ Get plan limits and current usage for the project.
BillingApi get_billing_subscription GET /v1/billing/subscription/ Get the current subscription for the authed project.
BillingApi get_entitlements GET /v1/billing/entitlements/ Get active entitlements for the project.
BillingApi get_portal_url GET /v1/billing/portal/ Get a Stripe Customer Portal URL for managing the subscription.
BillingApi get_prices GET /v1/billing/prices/ Get available plan prices.
BillingApi get_usage GET /v1/billing/usage/ Get current usage data for the project.
BillingApi stripe_webhook POST /v1/billing/webhooks/stripe/ Handle Stripe webhook events.
ChannelConnectionsApi create_connection POST /v1/channel-connections/ POST /v1/channel-connections
ChannelConnectionsApi delete_connection DELETE /v1/channel-connections/{id}/ DELETE /v1/channel-connections/:identifier
ChannelConnectionsApi get_connection GET /v1/channel-connections/{id}/ GET /v1/channel-connections/:identifier
ChannelConnectionsApi list_connections GET /v1/channel-connections/ GET /v1/channel-connections
ChannelConnectionsApi update_connection PATCH /v1/channel-connections/{id}/ PATCH /v1/channel-connections/:identifier
ChannelEndpointsApi create_endpoint POST /v1/channel-endpoints/ POST /v1/channel-endpoints
ChannelEndpointsApi delete_endpoint DELETE /v1/channel-endpoints/{id}/ DELETE /v1/channel-endpoints/:identifier
ChannelEndpointsApi get_endpoint GET /v1/channel-endpoints/{id}/ GET /v1/channel-endpoints/:identifier
ChannelEndpointsApi list_endpoints GET /v1/channel-endpoints/ GET /v1/channel-endpoints
ChannelEndpointsApi update_endpoint PATCH /v1/channel-endpoints/{id}/ PATCH /v1/channel-endpoints/:identifier
ContextsApi create_context POST /v1/contexts/ POST /v1/contexts
ContextsApi delete_context DELETE /v1/contexts/{type}/{id}/ DELETE /v1/contexts/:type/:id
ContextsApi get_context GET /v1/contexts/{type}/{id}/ GET /v1/contexts/:type/:id
ContextsApi list_contexts GET /v1/contexts/ GET /v1/contexts — list contexts
ContextsApi update_context PATCH /v1/contexts/{type}/{id}/ PATCH /v1/contexts/:type/:id
EventsApi cancel_event DELETE /v1/events/{transaction_id}/ DELETE /v1/events/:transaction_id
EventsApi trigger_broadcast POST /v1/events/trigger/broadcast/ POST /v1/events/trigger/broadcast — broadcast to all subscribers
EventsApi trigger_bulk POST /v1/events/trigger/bulk/ POST /v1/events/trigger/bulk
EventsApi trigger_event POST /v1/events/trigger/ POST /v1/events/trigger
FeatureFlagsApi get_feature_flags GET /v1/feature-flags/ GET /v1/feature-flags — returns enabled features for the current project.
HealthApi health_check 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 inbound_parse_webhook 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 archive_all POST /v1/inbox/notifications/archive/ POST /v1/inbox/notifications/archive (archive all)
InboxApi execute_action POST /v1/inbox/notifications/{id}/actions/{action_type}/ POST /v1/inbox/notifications/:id/actions/:actionType
InboxApi get_inbox_preferences GET /v1/inbox/preferences/ GET /v1/inbox/preferences
InboxApi inbox_list_notifications GET /v1/inbox/notifications/ GET /v1/inbox/notifications/
InboxApi init_inbox_session POST /v1/inbox/session/ POST /v1/inbox/session/
InboxApi mark_all_read POST /v1/inbox/notifications/read/ POST /v1/inbox/notifications/read (mark all as read)
InboxApi mark_read POST /v1/inbox/notifications/{id}/read/ POST /v1/inbox/notifications/:id/read
InboxApi mark_unread POST /v1/inbox/notifications/{id}/unread/ POST /v1/inbox/notifications/:id/unread
InboxApi notification_count 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 update_inbox_global_preference PATCH /v1/inbox/preferences/ PATCH /v1/inbox/preferences
InboxApi update_inbox_workflow_preference PATCH /v1/inbox/preferences/{workflow_id}/ PATCH /v1/inbox/preferences/:workflowId
IntegrationsApi auto_configure POST /v1/integrations/{id}/auto-configure/ POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
IntegrationsApi chat_oauth POST /v1/integrations/chat/oauth/ POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
IntegrationsApi create_integration POST /v1/integrations/ POST /v1/integrations
IntegrationsApi delete_integration DELETE /v1/integrations/{id}/ DELETE /v1/integrations/:id
IntegrationsApi get_integration GET /v1/integrations/{id}/ GET /v1/integrations/:id
IntegrationsApi list_active_integrations GET /v1/integrations/active/ GET /v1/integrations/active — list only active integrations
IntegrationsApi list_integrations GET /v1/integrations/ GET /v1/integrations
IntegrationsApi set_primary PUT /v1/integrations/{id}/set-primary/ PUT /v1/integrations/:id/set-primary
IntegrationsApi test_connection POST /v1/integrations/{id}/test-connection/ POST /v1/integrations/:id/test-connection
IntegrationsApi update_integration PUT /v1/integrations/{id}/ PUT /v1/integrations/:id
LayoutsApi create_layout POST /v1/layouts/ POST /v1/layouts
LayoutsApi delete_layout DELETE /v1/layouts/{id}/ DELETE /v1/layouts/:id
LayoutsApi duplicate_layout POST /v1/layouts/{id}/duplicate/ POST /v1/layouts/:id/duplicate — clone layout
LayoutsApi get_layout GET /v1/layouts/{id}/ GET /v1/layouts/:id
LayoutsApi layout_usage GET /v1/layouts/{id}/usage/ GET /v1/layouts/:id/usage — list workflows using this layout
LayoutsApi list_layouts GET /v1/layouts/ GET /v1/layouts
LayoutsApi preview_layout POST /v1/layouts/{id}/preview/ POST /v1/layouts/:id/preview — render layout with sample content
LayoutsApi set_default POST /v1/layouts/{id}/default/ POST /v1/layouts/:id/default
LayoutsApi update_layout PATCH /v1/layouts/{id}/ PATCH /v1/layouts/:id
MessagesApi delete_by_transaction DELETE /v1/messages/transaction/{transaction_id}/ DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction
MessagesApi delete_message DELETE /v1/messages/{id}/ DELETE /v1/messages/:id — soft-delete a single message
MessagesApi list_messages GET /v1/messages/ GET /v1/messages — list all messages with cursor pagination
MetricsApi metrics_endpoint GET /metrics/ GET /metrics — Prometheus scrape endpoint.
NotificationGroupsApi create_notification_group POST /v1/notification-groups/ POST /v1/notification-groups
NotificationGroupsApi delete_notification_group DELETE /v1/notification-groups/{id}/ DELETE /v1/notification-groups/:id
NotificationGroupsApi list_notification_groups GET /v1/notification-groups/ GET /v1/notification-groups
NotificationGroupsApi update_notification_group PATCH /v1/notification-groups/{id}/ PATCH /v1/notification-groups/:id
NotificationsApi get_notification GET /v1/notifications/{id}/ GET /v1/notifications/:id
NotificationsApi get_notification_jobs GET /v1/notifications/{id}/jobs/ GET /v1/notifications/:id/jobs
NotificationsApi list_notifications GET /v1/notifications/ GET /v1/notifications
PreferencesApi list_preferences GET /v1/subscribers/{id}/preferences/ GET /v1/subscribers/:id/preferences
PreferencesApi update_global_preference PATCH /v1/subscribers/{id}/preferences/ PATCH /v1/subscribers/:id/preferences
PreferencesApi update_workflow_preference PATCH /v1/subscribers/{id}/preferences/{workflow_id}/ PATCH /v1/subscribers/:id/preferences/:workflowId
ProjectsApi create_project POST /v1/projects/ POST /v1/projects/ — create a new project
ProjectsApi delete_api_key DELETE /v1/projects/{id}/api-keys/{key_id}/ DELETE /v1/projects/{id}/api-keys/{key_id}/ — revoke an API key by ID
ProjectsApi delete_project DELETE /v1/projects/{id}/ DELETE /v1/projects/{id}/ — delete a project (owner only)
ProjectsApi generate_api_key POST /v1/projects/{id}/api-keys/ POST /v1/projects/{id}/api-keys/ — generate a new API key
ProjectsApi get_project GET /v1/projects/{id}/ GET /v1/projects/{id}/ — get a project by ID
ProjectsApi invite_member POST /v1/projects/{id}/members/ POST /v1/projects/{id}/members/ — invite a member by email (token-based)
ProjectsApi list_api_keys GET /v1/projects/{id}/api-keys/ GET /v1/projects/{id}/api-keys/ — list API keys for a project
ProjectsApi list_members GET /v1/projects/{id}/members/ GET /v1/projects/{id}/members/ — list project members
ProjectsApi list_projects GET /v1/projects/ GET /v1/projects/ — list all projects the user is a member of
ProjectsApi project_tags GET /v1/projects/{id}/tags/ GET /v1/projects/{id}/tags/ — returns unique tags from all workflows in the project
ProjectsApi remove_member DELETE /v1/projects/{id}/members/{member_id}/ DELETE /v1/projects/{id}/members/{member_id}/ — remove a member
ProjectsApi update_project PATCH /v1/projects/{id}/ PATCH /v1/projects/{id}/ — update a project
SubscriberCredentialsApi delete_credentials DELETE /v1/subscribers/{id}/credentials/{provider_id}/ DELETE /v1/subscribers/:id/credentials/:provider_id — remove credentials for a provider
SubscriberCredentialsApi get_credential GET /v1/subscribers/{id}/credentials/{provider_id}/ GET /v1/subscribers/:id/credentials/:provider_id — get credentials for one provider
SubscriberCredentialsApi list_credentials GET /v1/subscribers/{id}/credentials/ GET /v1/subscribers/:id/credentials — list all provider credentials
SubscriberCredentialsApi set_credentials PUT /v1/subscribers/{id}/credentials/{provider_id}/ PUT /v1/subscribers/:id/credentials/:provider_id — create or replace credentials for a provider
SubscriberCredentialsApi upsert_credentials PATCH /v1/subscribers/{id}/credentials/{provider_id}/ PATCH /v1/subscribers/:id/credentials/:provider_id — partially update credentials for a provider
SubscribersApi bulk_create POST /v1/subscribers/bulk/ POST /v1/subscribers/bulk — create multiple subscribers at once
SubscribersApi bulk_update_preferences PATCH /v1/subscribers/{id}/preferences/bulk/ PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
SubscribersApi create_subscriber POST /v1/subscribers/ POST /v1/subscribers
SubscribersApi delete_subscriber DELETE /v1/subscribers/{id}/ DELETE /v1/subscribers/:subscriber_id
SubscribersApi get_subscriber GET /v1/subscribers/{id}/ GET /v1/subscribers/:subscriber_id
SubscribersApi list_subscriber_subscriptions GET /v1/subscribers/{id}/subscriptions/ GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
SubscribersApi list_subscribers GET /v1/subscribers/ GET /v1/subscribers
SubscribersApi mark_all_messages POST /v1/subscribers/{id}/messages/mark-all/ POST /v1/subscribers/:id/messages/mark-all — mark all messages
SubscribersApi mark_messages POST /v1/subscribers/{id}/messages/mark-as/ POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
SubscribersApi subscriber_feed GET /v1/subscribers/{id}/notifications/feed/ GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
SubscribersApi unseen_count GET /v1/subscribers/{id}/notifications/unseen/ GET /v1/subscribers/:id/notifications/unseen — unseen count
SubscribersApi update_online_status PATCH /v1/subscribers/{id}/online-status/ PATCH /v1/subscribers/:id/online-status — set online/offline
SubscribersApi update_subscriber PATCH /v1/subscribers/{id}/ PATCH /v1/subscribers/:subscriber_id
TopicsApi add_subscribers POST /v1/topics/{key}/subscribers/ POST /v1/topics/:topicKey/subscribers
TopicsApi check_subscriber GET /v1/topics/{key}/subscribers/{subscriber_id}/ GET /v1/topics/:key/subscribers/:subscriber_id — membership check
TopicsApi create_subscriptions POST /v1/topics/{key}/subscriptions/ POST /v1/topics/:key/subscriptions — create subscriptions
TopicsApi create_topic POST /v1/topics/ POST /v1/topics
TopicsApi delete_subscriptions DELETE /v1/topics/{key}/subscriptions/ DELETE /v1/topics/:key/subscriptions — bulk delete
TopicsApi delete_topic DELETE /v1/topics/{key}/ DELETE /v1/topics/:topicKey
TopicsApi get_subscription GET /v1/topics/{key}/subscriptions/{id}/ GET /v1/topics/:key/subscriptions/:id — get single subscription
TopicsApi get_topic GET /v1/topics/{key}/ GET /v1/topics/:topicKey
TopicsApi list_subscriptions GET /v1/topics/{key}/subscriptions/ GET /v1/topics/:key/subscriptions — list subscriptions
TopicsApi list_topic_subscribers GET /v1/topics/{key}/subscribers/ GET /v1/topics/:topicKey/subscribers
TopicsApi list_topics GET /v1/topics/ GET /v1/topics
TopicsApi remove_subscribers POST /v1/topics/{key}/subscribers/removal/ POST /v1/topics/:topicKey/subscribers/removal
TopicsApi update_subscription PATCH /v1/topics/{key}/subscriptions/{id}/ PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
TopicsApi update_topic PATCH /v1/topics/{key}/ PATCH /v1/topics/:topicKey
TranslationsApi create_translation_group POST /v1/translations/groups/ POST /v1/translations/groups — create a translation group.
TranslationsApi delete_translation_group DELETE /v1/translations/groups/{id}/ DELETE /v1/translations/groups/:id — soft-delete a translation group.
TranslationsApi get_translation_group GET /v1/translations/groups/{id}/ GET /v1/translations/groups/:id — get a translation group.
TranslationsApi list_translation_groups GET /v1/translations/groups/ GET /v1/translations/groups — list translation groups.
TranslationsApi update_translation_group PATCH /v1/translations/groups/{id}/ PATCH /v1/translations/groups/:id — update a translation group.
WebhooksApi delete_webhook DELETE /v1/webhooks/{id}/ DELETE /v1/webhooks/:id
WebhooksApi inbound_delivery_webhook POST /v1/inbound-webhooks/delivery-providers/{project_id}/{integration_id}/ POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
WebhooksApi list_webhooks GET /v1/webhooks/ GET /v1/webhooks
WebhooksApi register_webhook POST /v1/webhooks/ POST /v1/webhooks
WorkflowsApi create_workflow POST /v1/workflows/ POST /v1/workflows
WorkflowsApi delete_workflow DELETE /v1/workflows/{id}/ DELETE /v1/workflows/:id
WorkflowsApi duplicate_workflow POST /v1/workflows/{id}/duplicate/ POST /v1/workflows/:id/duplicate — clone workflow
WorkflowsApi get_step GET /v1/workflows/{id}/steps/{step_id}/ GET /v1/workflows/:id/steps/:step_id — get step details
WorkflowsApi get_workflow GET /v1/workflows/{id}/ GET /v1/workflows/:id
WorkflowsApi list_workflows GET /v1/workflows/ GET /v1/workflows
WorkflowsApi step_preview POST /v1/workflows/{id}/step/{step_id}/preview/ POST /v1/workflows/:id/step/:step_id/preview — render step template
WorkflowsApi sync_workflow PUT /v1/workflows/{id}/sync/ PUT /v1/workflows/:id/sync — sync from code-first workflow definition
WorkflowsApi update_workflow PUT /v1/workflows/{id}/ PUT /v1/workflows/:id
WorkflowsApi update_workflow_status PUT /v1/workflows/{id}/status/ PUT /v1/workflows/:id/status

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author