@enbbox/api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +375 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +2 -2
- package/api/activity-api.ts +756 -0
- package/api/billing-api.ts +673 -0
- package/api/channel-connections-api.ts +510 -0
- package/api/channel-endpoints-api.ts +510 -0
- package/api/contexts-api.ts +534 -0
- package/api/events-api.ts +394 -0
- package/api/feature-flags-api.ts +132 -0
- package/api/health-api.ts +264 -0
- package/api/inbound-parse-api.ts +137 -0
- package/api/inbox-api.ts +1151 -0
- package/api/integrations-api.ts +833 -0
- package/api/layouts-api.ts +849 -0
- package/api/messages-api.ts +349 -0
- package/api/metrics-api.ts +128 -0
- package/api/notification-groups-api.ts +391 -0
- package/api/notifications-api.ts +326 -0
- package/api/preferences-api.ts +333 -0
- package/api/projects-api.ts +1075 -0
- package/api/subscribers-api.ts +1542 -0
- package/api/topics-api.ts +1352 -0
- package/api/translations-api.ts +462 -0
- package/api/webhooks-api.ts +397 -0
- package/api/workflows-api.ts +970 -0
- package/api.ts +40 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/docs/ActionBody.md +21 -0
- package/docs/ActionRecord.md +25 -0
- package/docs/ActionType.md +17 -0
- package/docs/ActivityApi.md +412 -0
- package/docs/ActivityChartPoint.md +31 -0
- package/docs/ActivityRecord.md +39 -0
- package/docs/ActivityRequestRecord.md +31 -0
- package/docs/ActivityStats.md +31 -0
- package/docs/ActorType.md +15 -0
- package/docs/ApiKeyCreated.md +27 -0
- package/docs/ApiKeyInfo.md +27 -0
- package/docs/AutoConfigureResult.md +21 -0
- package/docs/BillingApi.md +375 -0
- package/docs/BillingInterval.md +11 -0
- package/docs/Branding.md +31 -0
- package/docs/BroadcastTrigger.md +27 -0
- package/docs/BulkCreateSubscribers.md +21 -0
- package/docs/BulkPreferenceItem.md +24 -0
- package/docs/BulkPreferences.md +21 -0
- package/docs/BulkResult.md +22 -0
- package/docs/BulkTrigger.md +21 -0
- package/docs/ChannelConnectionRecord.md +31 -0
- package/docs/ChannelConnectionsApi.md +276 -0
- package/docs/ChannelEndpointRecord.md +33 -0
- package/docs/ChannelEndpointsApi.md +276 -0
- package/docs/ChannelPreferences.md +29 -0
- package/docs/ChannelType.md +17 -0
- package/docs/ChartQuery.md +21 -0
- package/docs/ChatOauth.md +21 -0
- package/docs/ChatOauthRequest.md +22 -0
- package/docs/CheckoutSession.md +23 -0
- package/docs/ContextRecord.md +29 -0
- package/docs/ContextsApi.md +285 -0
- package/docs/CreateChannelConnection.md +27 -0
- package/docs/CreateChannelEndpoint.md +29 -0
- package/docs/CreateCheckout.md +23 -0
- package/docs/CreateContext.md +25 -0
- package/docs/CreateIntegration.md +31 -0
- package/docs/CreateLayout.md +31 -0
- package/docs/CreateNotificationGroup.md +21 -0
- package/docs/CreateProject.md +21 -0
- package/docs/CreateSubscriber.md +37 -0
- package/docs/CreateSubscription.md +21 -0
- package/docs/CreateTopic.md +23 -0
- package/docs/CreateWebhook.md +23 -0
- package/docs/CreateWorkflow.md +35 -0
- package/docs/CtaType.md +9 -0
- package/docs/CursorMeta.md +27 -0
- package/docs/CursorPaginatedFeedItem.md +23 -0
- package/docs/CursorPaginatedFeedItemDataInner.md +37 -0
- package/docs/CursorPaginatedMessageRecord.md +23 -0
- package/docs/CursorPaginatedMessageRecordDataInner.md +41 -0
- package/docs/CursorPagination.md +25 -0
- package/docs/DeleteSubscription.md +20 -0
- package/docs/DeliveryAck.md +21 -0
- package/docs/DeliveryStatusWebhook.md +27 -0
- package/docs/DnsSettings.md +23 -0
- package/docs/EngagementStatsResponse.md +27 -0
- package/docs/EntitlementItem.md +25 -0
- package/docs/Entitlements.md +21 -0
- package/docs/ErrorDetail.md +27 -0
- package/docs/EventsApi.md +214 -0
- package/docs/EventsUsage.md +23 -0
- package/docs/FeatureFlagsApi.md +51 -0
- package/docs/FeedItem.md +37 -0
- package/docs/FeedQuery.md +31 -0
- package/docs/HealthApi.md +140 -0
- package/docs/InboundParseApi.md +59 -0
- package/docs/InboxApi.md +673 -0
- package/docs/InboxNotification.md +41 -0
- package/docs/InboxPreference.md +23 -0
- package/docs/InboxQuery.md +27 -0
- package/docs/InitSessionRequest.md +23 -0
- package/docs/InitSessionResponse.md +23 -0
- package/docs/IntegrationRecord.md +35 -0
- package/docs/IntegrationsApi.md +475 -0
- package/docs/InviteMember.md +23 -0
- package/docs/InviteMemberBody.md +23 -0
- package/docs/JobLog.md +33 -0
- package/docs/LayoutPreview.md +21 -0
- package/docs/LayoutPreviewResult.md +21 -0
- package/docs/LayoutRecord.md +31 -0
- package/docs/LayoutUsageItem.md +23 -0
- package/docs/LayoutsApi.md +484 -0
- package/docs/MarkAll.md +21 -0
- package/docs/MarkMessages.md +23 -0
- package/docs/MarkResult.md +21 -0
- package/docs/MemberRecord.md +27 -0
- package/docs/MemberRole.md +15 -0
- package/docs/MemberStatus.md +13 -0
- package/docs/MessageQuery.md +31 -0
- package/docs/MessageRecord.md +41 -0
- package/docs/MessagesApi.md +175 -0
- package/docs/MetricsApi.md +51 -0
- package/docs/NotificationCount.md +25 -0
- package/docs/NotificationGroupRecord.md +23 -0
- package/docs/NotificationGroupsApi.md +209 -0
- package/docs/NotificationLog.md +33 -0
- package/docs/NotificationQuery.md +25 -0
- package/docs/NotificationsApi.md +166 -0
- package/docs/OffsetMeta.md +27 -0
- package/docs/OffsetPagination.md +27 -0
- package/docs/OnlineStatus.md +21 -0
- package/docs/PaginatedChannelConnectionRecord.md +23 -0
- package/docs/PaginatedChannelConnectionRecordDataInner.md +31 -0
- package/docs/PaginatedChannelEndpointRecord.md +23 -0
- package/docs/PaginatedChannelEndpointRecordDataInner.md +33 -0
- package/docs/PaginatedContextRecord.md +23 -0
- package/docs/PaginatedContextRecordDataInner.md +29 -0
- package/docs/PaginatedIntegrationRecord.md +23 -0
- package/docs/PaginatedIntegrationRecordDataInner.md +35 -0
- package/docs/PaginatedLayoutRecord.md +23 -0
- package/docs/PaginatedLayoutRecordDataInner.md +31 -0
- package/docs/PaginatedSubscriberRecord.md +23 -0
- package/docs/PaginatedSubscriberRecordDataInner.md +41 -0
- package/docs/PaginatedTopicRecord.md +23 -0
- package/docs/PaginatedTopicRecordDataInner.md +24 -0
- package/docs/PaginatedTopicSubscriptionRecord.md +23 -0
- package/docs/PaginatedTopicSubscriptionRecordDataInner.md +29 -0
- package/docs/PaginatedWorkflowRecord.md +23 -0
- package/docs/PaginatedWorkflowRecordDataInner.md +37 -0
- package/docs/PaginationQuery.md +25 -0
- package/docs/PatchCredentials.md +27 -0
- package/docs/Plan.md +17 -0
- package/docs/PlanLimitsResponse.md +33 -0
- package/docs/PortalUrl.md +21 -0
- package/docs/PreferenceChannels.md +29 -0
- package/docs/PreferenceRecord.md +27 -0
- package/docs/PreferencesApi.md +171 -0
- package/docs/PreviewResult.md +20 -0
- package/docs/PriceInfo.md +27 -0
- package/docs/Prices.md +21 -0
- package/docs/ProjectRecord.md +27 -0
- package/docs/ProjectsApi.md +638 -0
- package/docs/SetCredentials.md +27 -0
- package/docs/StepPreview.md +21 -0
- package/docs/StepRecord.md +29 -0
- package/docs/StepType.md +27 -0
- package/docs/SubscriberCredential.md +27 -0
- package/docs/SubscriberPayload.md +37 -0
- package/docs/SubscriberRecord.md +41 -0
- package/docs/SubscribersApi.md +887 -0
- package/docs/Subscription.md +39 -0
- package/docs/SyncWorkflow.md +21 -0
- package/docs/SystemAvatarIcon.md +19 -0
- package/docs/TopicRecord.md +24 -0
- package/docs/TopicSubscribers.md +21 -0
- package/docs/TopicSubscription.md +23 -0
- package/docs/TopicSubscriptionRecord.md +29 -0
- package/docs/TopicsApi.md +777 -0
- package/docs/TranslationsApi.md +258 -0
- package/docs/TrialInfo.md +27 -0
- package/docs/TriggerEvent.md +31 -0
- package/docs/TriggerRecipients.md +39 -0
- package/docs/TriggerRecipientsOneOf.md +21 -0
- package/docs/TriggerResult.md +25 -0
- package/docs/TriggerStatus.md +21 -0
- package/docs/UnseenCount.md +21 -0
- package/docs/UpdateChannelConnection.md +21 -0
- package/docs/UpdateChannelEndpoint.md +23 -0
- package/docs/UpdateContext.md +21 -0
- package/docs/UpdateInboxPreferences.md +29 -0
- package/docs/UpdateIntegration.md +27 -0
- package/docs/UpdateLayout.md +27 -0
- package/docs/UpdateNotificationGroup.md +21 -0
- package/docs/UpdatePreference.md +23 -0
- package/docs/UpdateProject.md +23 -0
- package/docs/UpdateSubscriber.md +35 -0
- package/docs/UpdateSubscriptionMeta.md +21 -0
- package/docs/UpdateTopic.md +21 -0
- package/docs/UpdateWorkflow.md +31 -0
- package/docs/Usage.md +35 -0
- package/docs/WebhookRecord.md +31 -0
- package/docs/WebhooksApi.md +212 -0
- package/docs/WidgetSettings.md +21 -0
- package/docs/WorkflowRecord.md +37 -0
- package/docs/WorkflowRunRecord.md +31 -0
- package/docs/WorkflowStatsResponse.md +27 -0
- package/docs/WorkflowStatus.md +21 -0
- package/docs/WorkflowStepCreate.md +31 -0
- package/docs/WorkflowsApi.md +550 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/models/action-body.ts +26 -0
- package/models/action-record.ts +28 -0
- package/models/action-type.ts +32 -0
- package/models/activity-chart-point.ts +46 -0
- package/models/activity-record.ts +62 -0
- package/models/activity-request-record.ts +46 -0
- package/models/activity-stats.ts +46 -0
- package/models/actor-type.ts +31 -0
- package/models/api-key-created.ts +38 -0
- package/models/api-key-info.ts +38 -0
- package/models/auto-configure-result.ts +23 -0
- package/models/billing-interval.ts +29 -0
- package/models/branding.ts +46 -0
- package/models/broadcast-trigger.ts +29 -0
- package/models/bulk-create-subscribers.ts +26 -0
- package/models/bulk-preference-item.ts +25 -0
- package/models/bulk-preferences.ts +26 -0
- package/models/bulk-result.ts +24 -0
- package/models/bulk-trigger.ts +29 -0
- package/models/channel-connection-record.ts +43 -0
- package/models/channel-endpoint-record.ts +47 -0
- package/models/channel-preferences.ts +27 -0
- package/models/channel-type.ts +32 -0
- package/models/chart-query.ts +26 -0
- package/models/chat-oauth-request.ts +21 -0
- package/models/chat-oauth.ts +23 -0
- package/models/checkout-session.ts +35 -0
- package/models/context-record.ts +42 -0
- package/models/create-channel-connection.ts +35 -0
- package/models/create-channel-endpoint.ts +39 -0
- package/models/create-checkout.ts +35 -0
- package/models/create-context.ts +34 -0
- package/models/create-integration.ts +51 -0
- package/models/create-layout.ts +34 -0
- package/models/create-notification-group.ts +26 -0
- package/models/create-project.ts +26 -0
- package/models/create-subscriber.ts +58 -0
- package/models/create-subscription.ts +23 -0
- package/models/create-topic.ts +30 -0
- package/models/create-webhook.ts +30 -0
- package/models/create-workflow.ts +60 -0
- package/models/cta-type.ts +28 -0
- package/models/cursor-meta.ts +38 -0
- package/models/cursor-paginated-feed-item-data-inner.ts +40 -0
- package/models/cursor-paginated-feed-item.ts +36 -0
- package/models/cursor-paginated-message-record-data-inner.ts +45 -0
- package/models/cursor-paginated-message-record.ts +36 -0
- package/models/cursor-pagination.ts +34 -0
- package/models/delete-subscription.ts +20 -0
- package/models/delivery-ack.ts +23 -0
- package/models/delivery-status-webhook.ts +29 -0
- package/models/dns-settings.ts +30 -0
- package/models/engagement-stats-response.ts +38 -0
- package/models/entitlement-item.ts +34 -0
- package/models/entitlements.ts +26 -0
- package/models/error-detail.ts +38 -0
- package/models/events-usage.ts +30 -0
- package/models/feed-item.ts +40 -0
- package/models/feed-query.ts +28 -0
- package/models/inbox-notification.ts +39 -0
- package/models/inbox-preference.ts +27 -0
- package/models/inbox-query.ts +26 -0
- package/models/index.ts +158 -0
- package/models/init-session-request.ts +30 -0
- package/models/init-session-response.ts +30 -0
- package/models/integration-record.ts +59 -0
- package/models/invite-member-body.ts +30 -0
- package/models/invite-member.ts +30 -0
- package/models/job-log.ts +47 -0
- package/models/layout-preview-result.ts +23 -0
- package/models/layout-preview.ts +23 -0
- package/models/layout-record.ts +37 -0
- package/models/layout-usage-item.ts +24 -0
- package/models/mark-all.ts +23 -0
- package/models/mark-messages.ts +24 -0
- package/models/mark-result.ts +23 -0
- package/models/member-record.ts +38 -0
- package/models/member-role.ts +31 -0
- package/models/member-status.ts +30 -0
- package/models/message-query.ts +46 -0
- package/models/message-record.ts +45 -0
- package/models/notification-count.ts +25 -0
- package/models/notification-group-record.ts +30 -0
- package/models/notification-log.ts +41 -0
- package/models/notification-query.ts +34 -0
- package/models/offset-meta.ts +38 -0
- package/models/offset-pagination.ts +38 -0
- package/models/online-status.ts +23 -0
- package/models/paginated-channel-connection-record-data-inner.ts +43 -0
- package/models/paginated-channel-connection-record.ts +36 -0
- package/models/paginated-channel-endpoint-record-data-inner.ts +47 -0
- package/models/paginated-channel-endpoint-record.ts +36 -0
- package/models/paginated-context-record-data-inner.ts +42 -0
- package/models/paginated-context-record.ts +36 -0
- package/models/paginated-integration-record-data-inner.ts +59 -0
- package/models/paginated-integration-record.ts +36 -0
- package/models/paginated-layout-record-data-inner.ts +37 -0
- package/models/paginated-layout-record.ts +36 -0
- package/models/paginated-subscriber-record-data-inner.ts +69 -0
- package/models/paginated-subscriber-record.ts +36 -0
- package/models/paginated-topic-record-data-inner.ts +28 -0
- package/models/paginated-topic-record.ts +36 -0
- package/models/paginated-topic-subscription-record-data-inner.ts +39 -0
- package/models/paginated-topic-subscription-record.ts +36 -0
- package/models/paginated-workflow-record-data-inner.ts +58 -0
- package/models/paginated-workflow-record.ts +36 -0
- package/models/pagination-query.ts +34 -0
- package/models/patch-credentials.ts +29 -0
- package/models/plan-limits-response.ts +55 -0
- package/models/plan.ts +32 -0
- package/models/portal-url.ts +26 -0
- package/models/preference-channels.ts +27 -0
- package/models/preference-record.ts +32 -0
- package/models/preview-result.ts +20 -0
- package/models/price-info.ts +38 -0
- package/models/prices.ts +26 -0
- package/models/project-record.ts +46 -0
- package/models/set-credentials.ts +29 -0
- package/models/step-preview.ts +23 -0
- package/models/step-record.ts +36 -0
- package/models/step-type.ts +37 -0
- package/models/subscriber-credential.ts +26 -0
- package/models/subscriber-payload.ts +24 -0
- package/models/subscriber-record.ts +69 -0
- package/models/subscription.ts +73 -0
- package/models/sync-workflow.ts +26 -0
- package/models/system-avatar-icon.ts +33 -0
- package/models/topic-record.ts +28 -0
- package/models/topic-subscribers.ts +23 -0
- package/models/topic-subscription-record.ts +39 -0
- package/models/topic-subscription.ts +27 -0
- package/models/trial-info.ts +38 -0
- package/models/trigger-event.ts +49 -0
- package/models/trigger-recipients-one-of.ts +23 -0
- package/models/trigger-recipients.ts +29 -0
- package/models/trigger-result.ts +39 -0
- package/models/trigger-status.ts +34 -0
- package/models/unseen-count.ts +23 -0
- package/models/update-channel-connection.ts +23 -0
- package/models/update-channel-endpoint.ts +27 -0
- package/models/update-context.ts +26 -0
- package/models/update-inbox-preferences.ts +27 -0
- package/models/update-integration.ts +38 -0
- package/models/update-layout.ts +29 -0
- package/models/update-notification-group.ts +26 -0
- package/models/update-preference.ts +27 -0
- package/models/update-project.ts +33 -0
- package/models/update-subscriber.ts +54 -0
- package/models/update-subscription-meta.ts +23 -0
- package/models/update-topic.ts +26 -0
- package/models/update-workflow.ts +52 -0
- package/models/usage.ts +59 -0
- package/models/webhook-record.ts +46 -0
- package/models/widget-settings.ts +26 -0
- package/models/workflow-record.ts +58 -0
- package/models/workflow-run-record.ts +46 -0
- package/models/workflow-stats-response.ts +38 -0
- package/models/workflow-status.ts +26 -0
- package/models/workflow-step-create.ts +51 -0
- package/package.json +9 -33
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
package/api/inbox-api.ts
ADDED
|
@@ -0,0 +1,1151 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* enbbox API
|
|
5
|
+
* Notification infrastructure API — open-source alternative to Novu/Courier
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { ActionBody } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { ActionRecord } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { InboxNotification } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { InboxPreference } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import type { InitSessionRequest } from '../models';
|
|
34
|
+
// @ts-ignore
|
|
35
|
+
import type { InitSessionResponse } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
import type { NotificationCount } from '../models';
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { UpdateInboxPreferences } from '../models';
|
|
40
|
+
/**
|
|
41
|
+
* InboxApi - axios parameter creator
|
|
42
|
+
*/
|
|
43
|
+
export const InboxApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
|
+
return {
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @summary POST /v1/inbox/notifications/:id/archive
|
|
48
|
+
* @param {string} id Notification ID
|
|
49
|
+
* @param {*} [options] Override http request option.
|
|
50
|
+
* @throws {RequiredError}
|
|
51
|
+
*/
|
|
52
|
+
archive: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53
|
+
// verify required parameter 'id' is not null or undefined
|
|
54
|
+
assertParamExists('archive', 'id', id)
|
|
55
|
+
const localVarPath = `/v1/inbox/notifications/{id}/archive/`
|
|
56
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
57
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
58
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59
|
+
let baseOptions;
|
|
60
|
+
if (configuration) {
|
|
61
|
+
baseOptions = configuration.baseOptions;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
65
|
+
const localVarHeaderParameter = {} as any;
|
|
66
|
+
const localVarQueryParameter = {} as any;
|
|
67
|
+
|
|
68
|
+
// authentication bearer_auth required
|
|
69
|
+
// http bearer authentication required
|
|
70
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
74
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
75
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
76
|
+
|
|
77
|
+
return {
|
|
78
|
+
url: toPathString(localVarUrlObj),
|
|
79
|
+
options: localVarRequestOptions,
|
|
80
|
+
};
|
|
81
|
+
},
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @summary POST /v1/inbox/notifications/archive (archive all)
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
*/
|
|
88
|
+
archiveAll: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
89
|
+
const localVarPath = `/v1/inbox/notifications/archive/`;
|
|
90
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
92
|
+
let baseOptions;
|
|
93
|
+
if (configuration) {
|
|
94
|
+
baseOptions = configuration.baseOptions;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
98
|
+
const localVarHeaderParameter = {} as any;
|
|
99
|
+
const localVarQueryParameter = {} as any;
|
|
100
|
+
|
|
101
|
+
// authentication bearer_auth required
|
|
102
|
+
// http bearer authentication required
|
|
103
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
108
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
109
|
+
|
|
110
|
+
return {
|
|
111
|
+
url: toPathString(localVarUrlObj),
|
|
112
|
+
options: localVarRequestOptions,
|
|
113
|
+
};
|
|
114
|
+
},
|
|
115
|
+
/**
|
|
116
|
+
* Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
|
|
117
|
+
* @summary POST /v1/inbox/notifications/:id/actions/:actionType
|
|
118
|
+
* @param {string} id Notification ID
|
|
119
|
+
* @param {string} actionType Action type
|
|
120
|
+
* @param {ActionBody} actionBody
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
executeAction: async (id: string, actionType: string, actionBody: ActionBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
125
|
+
// verify required parameter 'id' is not null or undefined
|
|
126
|
+
assertParamExists('executeAction', 'id', id)
|
|
127
|
+
// verify required parameter 'actionType' is not null or undefined
|
|
128
|
+
assertParamExists('executeAction', 'actionType', actionType)
|
|
129
|
+
// verify required parameter 'actionBody' is not null or undefined
|
|
130
|
+
assertParamExists('executeAction', 'actionBody', actionBody)
|
|
131
|
+
const localVarPath = `/v1/inbox/notifications/{id}/actions/{action_type}/`
|
|
132
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
133
|
+
.replace(`{${"action_type"}}`, encodeURIComponent(String(actionType)));
|
|
134
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
135
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
136
|
+
let baseOptions;
|
|
137
|
+
if (configuration) {
|
|
138
|
+
baseOptions = configuration.baseOptions;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
142
|
+
const localVarHeaderParameter = {} as any;
|
|
143
|
+
const localVarQueryParameter = {} as any;
|
|
144
|
+
|
|
145
|
+
// authentication bearer_auth required
|
|
146
|
+
// http bearer authentication required
|
|
147
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
148
|
+
|
|
149
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
150
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
151
|
+
|
|
152
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
153
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
155
|
+
localVarRequestOptions.data = serializeDataIfNeeded(actionBody, localVarRequestOptions, configuration)
|
|
156
|
+
|
|
157
|
+
return {
|
|
158
|
+
url: toPathString(localVarUrlObj),
|
|
159
|
+
options: localVarRequestOptions,
|
|
160
|
+
};
|
|
161
|
+
},
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @summary GET /v1/inbox/preferences
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
getInboxPreferences: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
169
|
+
const localVarPath = `/v1/inbox/preferences/`;
|
|
170
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
171
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
172
|
+
let baseOptions;
|
|
173
|
+
if (configuration) {
|
|
174
|
+
baseOptions = configuration.baseOptions;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
178
|
+
const localVarHeaderParameter = {} as any;
|
|
179
|
+
const localVarQueryParameter = {} as any;
|
|
180
|
+
|
|
181
|
+
// authentication bearer_auth required
|
|
182
|
+
// http bearer authentication required
|
|
183
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
184
|
+
|
|
185
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
186
|
+
|
|
187
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
188
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
189
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
190
|
+
|
|
191
|
+
return {
|
|
192
|
+
url: toPathString(localVarUrlObj),
|
|
193
|
+
options: localVarRequestOptions,
|
|
194
|
+
};
|
|
195
|
+
},
|
|
196
|
+
/**
|
|
197
|
+
* Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
|
|
198
|
+
* @summary GET /v1/inbox/notifications/
|
|
199
|
+
* @param {number | null} [limit]
|
|
200
|
+
* @param {string | null} [after]
|
|
201
|
+
* @param {boolean | null} [read]
|
|
202
|
+
* @param {boolean | null} [archived]
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
inboxListNotifications: async (limit?: number | null, after?: string | null, read?: boolean | null, archived?: boolean | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
207
|
+
const localVarPath = `/v1/inbox/notifications/`;
|
|
208
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
209
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
210
|
+
let baseOptions;
|
|
211
|
+
if (configuration) {
|
|
212
|
+
baseOptions = configuration.baseOptions;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
216
|
+
const localVarHeaderParameter = {} as any;
|
|
217
|
+
const localVarQueryParameter = {} as any;
|
|
218
|
+
|
|
219
|
+
// authentication bearer_auth required
|
|
220
|
+
// http bearer authentication required
|
|
221
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
222
|
+
|
|
223
|
+
if (limit !== undefined) {
|
|
224
|
+
localVarQueryParameter['limit'] = limit;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
if (after !== undefined) {
|
|
228
|
+
localVarQueryParameter['after'] = after;
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
if (read !== undefined) {
|
|
232
|
+
localVarQueryParameter['read'] = read;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
if (archived !== undefined) {
|
|
236
|
+
localVarQueryParameter['archived'] = archived;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
240
|
+
|
|
241
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
242
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
243
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
244
|
+
|
|
245
|
+
return {
|
|
246
|
+
url: toPathString(localVarUrlObj),
|
|
247
|
+
options: localVarRequestOptions,
|
|
248
|
+
};
|
|
249
|
+
},
|
|
250
|
+
/**
|
|
251
|
+
* Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
|
|
252
|
+
* @summary POST /v1/inbox/session/
|
|
253
|
+
* @param {string} xProjectId Project UUID
|
|
254
|
+
* @param {InitSessionRequest} initSessionRequest
|
|
255
|
+
* @param {*} [options] Override http request option.
|
|
256
|
+
* @throws {RequiredError}
|
|
257
|
+
*/
|
|
258
|
+
initInboxSession: async (xProjectId: string, initSessionRequest: InitSessionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
259
|
+
// verify required parameter 'xProjectId' is not null or undefined
|
|
260
|
+
assertParamExists('initInboxSession', 'xProjectId', xProjectId)
|
|
261
|
+
// verify required parameter 'initSessionRequest' is not null or undefined
|
|
262
|
+
assertParamExists('initInboxSession', 'initSessionRequest', initSessionRequest)
|
|
263
|
+
const localVarPath = `/v1/inbox/session/`;
|
|
264
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
265
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
266
|
+
let baseOptions;
|
|
267
|
+
if (configuration) {
|
|
268
|
+
baseOptions = configuration.baseOptions;
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
272
|
+
const localVarHeaderParameter = {} as any;
|
|
273
|
+
const localVarQueryParameter = {} as any;
|
|
274
|
+
|
|
275
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
276
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
277
|
+
|
|
278
|
+
if (xProjectId != null) {
|
|
279
|
+
localVarHeaderParameter['X-Project-Id'] = String(xProjectId);
|
|
280
|
+
}
|
|
281
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
282
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
283
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
284
|
+
localVarRequestOptions.data = serializeDataIfNeeded(initSessionRequest, localVarRequestOptions, configuration)
|
|
285
|
+
|
|
286
|
+
return {
|
|
287
|
+
url: toPathString(localVarUrlObj),
|
|
288
|
+
options: localVarRequestOptions,
|
|
289
|
+
};
|
|
290
|
+
},
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @summary POST /v1/inbox/notifications/read (mark all as read)
|
|
294
|
+
* @param {*} [options] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
*/
|
|
297
|
+
markAllRead: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
298
|
+
const localVarPath = `/v1/inbox/notifications/read/`;
|
|
299
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
300
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
301
|
+
let baseOptions;
|
|
302
|
+
if (configuration) {
|
|
303
|
+
baseOptions = configuration.baseOptions;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
307
|
+
const localVarHeaderParameter = {} as any;
|
|
308
|
+
const localVarQueryParameter = {} as any;
|
|
309
|
+
|
|
310
|
+
// authentication bearer_auth required
|
|
311
|
+
// http bearer authentication required
|
|
312
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
316
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
317
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
318
|
+
|
|
319
|
+
return {
|
|
320
|
+
url: toPathString(localVarUrlObj),
|
|
321
|
+
options: localVarRequestOptions,
|
|
322
|
+
};
|
|
323
|
+
},
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @summary POST /v1/inbox/notifications/:id/read
|
|
327
|
+
* @param {string} id Notification ID
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
markRead: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
332
|
+
// verify required parameter 'id' is not null or undefined
|
|
333
|
+
assertParamExists('markRead', 'id', id)
|
|
334
|
+
const localVarPath = `/v1/inbox/notifications/{id}/read/`
|
|
335
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
336
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
337
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
338
|
+
let baseOptions;
|
|
339
|
+
if (configuration) {
|
|
340
|
+
baseOptions = configuration.baseOptions;
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
344
|
+
const localVarHeaderParameter = {} as any;
|
|
345
|
+
const localVarQueryParameter = {} as any;
|
|
346
|
+
|
|
347
|
+
// authentication bearer_auth required
|
|
348
|
+
// http bearer authentication required
|
|
349
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
353
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
354
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
355
|
+
|
|
356
|
+
return {
|
|
357
|
+
url: toPathString(localVarUrlObj),
|
|
358
|
+
options: localVarRequestOptions,
|
|
359
|
+
};
|
|
360
|
+
},
|
|
361
|
+
/**
|
|
362
|
+
*
|
|
363
|
+
* @summary POST /v1/inbox/notifications/:id/unread
|
|
364
|
+
* @param {string} id Notification ID
|
|
365
|
+
* @param {*} [options] Override http request option.
|
|
366
|
+
* @throws {RequiredError}
|
|
367
|
+
*/
|
|
368
|
+
markUnread: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
369
|
+
// verify required parameter 'id' is not null or undefined
|
|
370
|
+
assertParamExists('markUnread', 'id', id)
|
|
371
|
+
const localVarPath = `/v1/inbox/notifications/{id}/unread/`
|
|
372
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
375
|
+
let baseOptions;
|
|
376
|
+
if (configuration) {
|
|
377
|
+
baseOptions = configuration.baseOptions;
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
381
|
+
const localVarHeaderParameter = {} as any;
|
|
382
|
+
const localVarQueryParameter = {} as any;
|
|
383
|
+
|
|
384
|
+
// authentication bearer_auth required
|
|
385
|
+
// http bearer authentication required
|
|
386
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
390
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
391
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
392
|
+
|
|
393
|
+
return {
|
|
394
|
+
url: toPathString(localVarUrlObj),
|
|
395
|
+
options: localVarRequestOptions,
|
|
396
|
+
};
|
|
397
|
+
},
|
|
398
|
+
/**
|
|
399
|
+
*
|
|
400
|
+
* @summary GET /v1/inbox/notifications/count
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
notificationCount: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
405
|
+
const localVarPath = `/v1/inbox/notifications/count/`;
|
|
406
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
407
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
408
|
+
let baseOptions;
|
|
409
|
+
if (configuration) {
|
|
410
|
+
baseOptions = configuration.baseOptions;
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
414
|
+
const localVarHeaderParameter = {} as any;
|
|
415
|
+
const localVarQueryParameter = {} as any;
|
|
416
|
+
|
|
417
|
+
// authentication bearer_auth required
|
|
418
|
+
// http bearer authentication required
|
|
419
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
420
|
+
|
|
421
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
422
|
+
|
|
423
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
424
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
425
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
426
|
+
|
|
427
|
+
return {
|
|
428
|
+
url: toPathString(localVarUrlObj),
|
|
429
|
+
options: localVarRequestOptions,
|
|
430
|
+
};
|
|
431
|
+
},
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @summary POST /v1/inbox/notifications/:id/unarchive
|
|
435
|
+
* @param {string} id Notification ID
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
*/
|
|
439
|
+
unarchive: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
440
|
+
// verify required parameter 'id' is not null or undefined
|
|
441
|
+
assertParamExists('unarchive', 'id', id)
|
|
442
|
+
const localVarPath = `/v1/inbox/notifications/{id}/unarchive/`
|
|
443
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
444
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
445
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
446
|
+
let baseOptions;
|
|
447
|
+
if (configuration) {
|
|
448
|
+
baseOptions = configuration.baseOptions;
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
452
|
+
const localVarHeaderParameter = {} as any;
|
|
453
|
+
const localVarQueryParameter = {} as any;
|
|
454
|
+
|
|
455
|
+
// authentication bearer_auth required
|
|
456
|
+
// http bearer authentication required
|
|
457
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
461
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
462
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
463
|
+
|
|
464
|
+
return {
|
|
465
|
+
url: toPathString(localVarUrlObj),
|
|
466
|
+
options: localVarRequestOptions,
|
|
467
|
+
};
|
|
468
|
+
},
|
|
469
|
+
/**
|
|
470
|
+
*
|
|
471
|
+
* @summary PATCH /v1/inbox/preferences
|
|
472
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
updateInboxGlobalPreference: async (updateInboxPreferences: UpdateInboxPreferences, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
477
|
+
// verify required parameter 'updateInboxPreferences' is not null or undefined
|
|
478
|
+
assertParamExists('updateInboxGlobalPreference', 'updateInboxPreferences', updateInboxPreferences)
|
|
479
|
+
const localVarPath = `/v1/inbox/preferences/`;
|
|
480
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
481
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
482
|
+
let baseOptions;
|
|
483
|
+
if (configuration) {
|
|
484
|
+
baseOptions = configuration.baseOptions;
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
488
|
+
const localVarHeaderParameter = {} as any;
|
|
489
|
+
const localVarQueryParameter = {} as any;
|
|
490
|
+
|
|
491
|
+
// authentication bearer_auth required
|
|
492
|
+
// http bearer authentication required
|
|
493
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
494
|
+
|
|
495
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
496
|
+
|
|
497
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
498
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
499
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
500
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateInboxPreferences, localVarRequestOptions, configuration)
|
|
501
|
+
|
|
502
|
+
return {
|
|
503
|
+
url: toPathString(localVarUrlObj),
|
|
504
|
+
options: localVarRequestOptions,
|
|
505
|
+
};
|
|
506
|
+
},
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @summary PATCH /v1/inbox/preferences/:workflowId
|
|
510
|
+
* @param {string} workflowId Workflow ID
|
|
511
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
512
|
+
* @param {*} [options] Override http request option.
|
|
513
|
+
* @throws {RequiredError}
|
|
514
|
+
*/
|
|
515
|
+
updateInboxWorkflowPreference: async (workflowId: string, updateInboxPreferences: UpdateInboxPreferences, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
516
|
+
// verify required parameter 'workflowId' is not null or undefined
|
|
517
|
+
assertParamExists('updateInboxWorkflowPreference', 'workflowId', workflowId)
|
|
518
|
+
// verify required parameter 'updateInboxPreferences' is not null or undefined
|
|
519
|
+
assertParamExists('updateInboxWorkflowPreference', 'updateInboxPreferences', updateInboxPreferences)
|
|
520
|
+
const localVarPath = `/v1/inbox/preferences/{workflow_id}/`
|
|
521
|
+
.replace(`{${"workflow_id"}}`, encodeURIComponent(String(workflowId)));
|
|
522
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
523
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
524
|
+
let baseOptions;
|
|
525
|
+
if (configuration) {
|
|
526
|
+
baseOptions = configuration.baseOptions;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
530
|
+
const localVarHeaderParameter = {} as any;
|
|
531
|
+
const localVarQueryParameter = {} as any;
|
|
532
|
+
|
|
533
|
+
// authentication bearer_auth required
|
|
534
|
+
// http bearer authentication required
|
|
535
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
536
|
+
|
|
537
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
538
|
+
|
|
539
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
540
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
541
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
542
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateInboxPreferences, localVarRequestOptions, configuration)
|
|
543
|
+
|
|
544
|
+
return {
|
|
545
|
+
url: toPathString(localVarUrlObj),
|
|
546
|
+
options: localVarRequestOptions,
|
|
547
|
+
};
|
|
548
|
+
},
|
|
549
|
+
}
|
|
550
|
+
};
|
|
551
|
+
|
|
552
|
+
/**
|
|
553
|
+
* InboxApi - functional programming interface
|
|
554
|
+
*/
|
|
555
|
+
export const InboxApiFp = function(configuration?: Configuration) {
|
|
556
|
+
const localVarAxiosParamCreator = InboxApiAxiosParamCreator(configuration)
|
|
557
|
+
return {
|
|
558
|
+
/**
|
|
559
|
+
*
|
|
560
|
+
* @summary POST /v1/inbox/notifications/:id/archive
|
|
561
|
+
* @param {string} id Notification ID
|
|
562
|
+
* @param {*} [options] Override http request option.
|
|
563
|
+
* @throws {RequiredError}
|
|
564
|
+
*/
|
|
565
|
+
async archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
566
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.archive(id, options);
|
|
567
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
568
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.archive']?.[localVarOperationServerIndex]?.url;
|
|
569
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
570
|
+
},
|
|
571
|
+
/**
|
|
572
|
+
*
|
|
573
|
+
* @summary POST /v1/inbox/notifications/archive (archive all)
|
|
574
|
+
* @param {*} [options] Override http request option.
|
|
575
|
+
* @throws {RequiredError}
|
|
576
|
+
*/
|
|
577
|
+
async archiveAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
578
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.archiveAll(options);
|
|
579
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
580
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.archiveAll']?.[localVarOperationServerIndex]?.url;
|
|
581
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
582
|
+
},
|
|
583
|
+
/**
|
|
584
|
+
* Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
|
|
585
|
+
* @summary POST /v1/inbox/notifications/:id/actions/:actionType
|
|
586
|
+
* @param {string} id Notification ID
|
|
587
|
+
* @param {string} actionType Action type
|
|
588
|
+
* @param {ActionBody} actionBody
|
|
589
|
+
* @param {*} [options] Override http request option.
|
|
590
|
+
* @throws {RequiredError}
|
|
591
|
+
*/
|
|
592
|
+
async executeAction(id: string, actionType: string, actionBody: ActionBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionRecord>> {
|
|
593
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeAction(id, actionType, actionBody, options);
|
|
594
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
595
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.executeAction']?.[localVarOperationServerIndex]?.url;
|
|
596
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
597
|
+
},
|
|
598
|
+
/**
|
|
599
|
+
*
|
|
600
|
+
* @summary GET /v1/inbox/preferences
|
|
601
|
+
* @param {*} [options] Override http request option.
|
|
602
|
+
* @throws {RequiredError}
|
|
603
|
+
*/
|
|
604
|
+
async getInboxPreferences(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InboxPreference>>> {
|
|
605
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInboxPreferences(options);
|
|
606
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
607
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.getInboxPreferences']?.[localVarOperationServerIndex]?.url;
|
|
608
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
609
|
+
},
|
|
610
|
+
/**
|
|
611
|
+
* Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
|
|
612
|
+
* @summary GET /v1/inbox/notifications/
|
|
613
|
+
* @param {number | null} [limit]
|
|
614
|
+
* @param {string | null} [after]
|
|
615
|
+
* @param {boolean | null} [read]
|
|
616
|
+
* @param {boolean | null} [archived]
|
|
617
|
+
* @param {*} [options] Override http request option.
|
|
618
|
+
* @throws {RequiredError}
|
|
619
|
+
*/
|
|
620
|
+
async inboxListNotifications(limit?: number | null, after?: string | null, read?: boolean | null, archived?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InboxNotification>>> {
|
|
621
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.inboxListNotifications(limit, after, read, archived, options);
|
|
622
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
623
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.inboxListNotifications']?.[localVarOperationServerIndex]?.url;
|
|
624
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
625
|
+
},
|
|
626
|
+
/**
|
|
627
|
+
* Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
|
|
628
|
+
* @summary POST /v1/inbox/session/
|
|
629
|
+
* @param {string} xProjectId Project UUID
|
|
630
|
+
* @param {InitSessionRequest} initSessionRequest
|
|
631
|
+
* @param {*} [options] Override http request option.
|
|
632
|
+
* @throws {RequiredError}
|
|
633
|
+
*/
|
|
634
|
+
async initInboxSession(xProjectId: string, initSessionRequest: InitSessionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitSessionResponse>> {
|
|
635
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.initInboxSession(xProjectId, initSessionRequest, options);
|
|
636
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
637
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.initInboxSession']?.[localVarOperationServerIndex]?.url;
|
|
638
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
639
|
+
},
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @summary POST /v1/inbox/notifications/read (mark all as read)
|
|
643
|
+
* @param {*} [options] Override http request option.
|
|
644
|
+
* @throws {RequiredError}
|
|
645
|
+
*/
|
|
646
|
+
async markAllRead(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
647
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.markAllRead(options);
|
|
648
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
649
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.markAllRead']?.[localVarOperationServerIndex]?.url;
|
|
650
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
651
|
+
},
|
|
652
|
+
/**
|
|
653
|
+
*
|
|
654
|
+
* @summary POST /v1/inbox/notifications/:id/read
|
|
655
|
+
* @param {string} id Notification ID
|
|
656
|
+
* @param {*} [options] Override http request option.
|
|
657
|
+
* @throws {RequiredError}
|
|
658
|
+
*/
|
|
659
|
+
async markRead(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
660
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.markRead(id, options);
|
|
661
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
662
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.markRead']?.[localVarOperationServerIndex]?.url;
|
|
663
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
664
|
+
},
|
|
665
|
+
/**
|
|
666
|
+
*
|
|
667
|
+
* @summary POST /v1/inbox/notifications/:id/unread
|
|
668
|
+
* @param {string} id Notification ID
|
|
669
|
+
* @param {*} [options] Override http request option.
|
|
670
|
+
* @throws {RequiredError}
|
|
671
|
+
*/
|
|
672
|
+
async markUnread(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
673
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.markUnread(id, options);
|
|
674
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
675
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.markUnread']?.[localVarOperationServerIndex]?.url;
|
|
676
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
677
|
+
},
|
|
678
|
+
/**
|
|
679
|
+
*
|
|
680
|
+
* @summary GET /v1/inbox/notifications/count
|
|
681
|
+
* @param {*} [options] Override http request option.
|
|
682
|
+
* @throws {RequiredError}
|
|
683
|
+
*/
|
|
684
|
+
async notificationCount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationCount>> {
|
|
685
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.notificationCount(options);
|
|
686
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
687
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.notificationCount']?.[localVarOperationServerIndex]?.url;
|
|
688
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
689
|
+
},
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
* @summary POST /v1/inbox/notifications/:id/unarchive
|
|
693
|
+
* @param {string} id Notification ID
|
|
694
|
+
* @param {*} [options] Override http request option.
|
|
695
|
+
* @throws {RequiredError}
|
|
696
|
+
*/
|
|
697
|
+
async unarchive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
698
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unarchive(id, options);
|
|
699
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
700
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.unarchive']?.[localVarOperationServerIndex]?.url;
|
|
701
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
702
|
+
},
|
|
703
|
+
/**
|
|
704
|
+
*
|
|
705
|
+
* @summary PATCH /v1/inbox/preferences
|
|
706
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
async updateInboxGlobalPreference(updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateInboxGlobalPreference(updateInboxPreferences, options);
|
|
712
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
713
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.updateInboxGlobalPreference']?.[localVarOperationServerIndex]?.url;
|
|
714
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
715
|
+
},
|
|
716
|
+
/**
|
|
717
|
+
*
|
|
718
|
+
* @summary PATCH /v1/inbox/preferences/:workflowId
|
|
719
|
+
* @param {string} workflowId Workflow ID
|
|
720
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
721
|
+
* @param {*} [options] Override http request option.
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
*/
|
|
724
|
+
async updateInboxWorkflowPreference(workflowId: string, updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
725
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateInboxWorkflowPreference(workflowId, updateInboxPreferences, options);
|
|
726
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
727
|
+
const localVarOperationServerBasePath = operationServerMap['InboxApi.updateInboxWorkflowPreference']?.[localVarOperationServerIndex]?.url;
|
|
728
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
729
|
+
},
|
|
730
|
+
}
|
|
731
|
+
};
|
|
732
|
+
|
|
733
|
+
/**
|
|
734
|
+
* InboxApi - factory interface
|
|
735
|
+
*/
|
|
736
|
+
export const InboxApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
737
|
+
const localVarFp = InboxApiFp(configuration)
|
|
738
|
+
return {
|
|
739
|
+
/**
|
|
740
|
+
*
|
|
741
|
+
* @summary POST /v1/inbox/notifications/:id/archive
|
|
742
|
+
* @param {string} id Notification ID
|
|
743
|
+
* @param {*} [options] Override http request option.
|
|
744
|
+
* @throws {RequiredError}
|
|
745
|
+
*/
|
|
746
|
+
archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
747
|
+
return localVarFp.archive(id, options).then((request) => request(axios, basePath));
|
|
748
|
+
},
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @summary POST /v1/inbox/notifications/archive (archive all)
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
archiveAll(options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
756
|
+
return localVarFp.archiveAll(options).then((request) => request(axios, basePath));
|
|
757
|
+
},
|
|
758
|
+
/**
|
|
759
|
+
* Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
|
|
760
|
+
* @summary POST /v1/inbox/notifications/:id/actions/:actionType
|
|
761
|
+
* @param {string} id Notification ID
|
|
762
|
+
* @param {string} actionType Action type
|
|
763
|
+
* @param {ActionBody} actionBody
|
|
764
|
+
* @param {*} [options] Override http request option.
|
|
765
|
+
* @throws {RequiredError}
|
|
766
|
+
*/
|
|
767
|
+
executeAction(id: string, actionType: string, actionBody: ActionBody, options?: RawAxiosRequestConfig): AxiosPromise<ActionRecord> {
|
|
768
|
+
return localVarFp.executeAction(id, actionType, actionBody, options).then((request) => request(axios, basePath));
|
|
769
|
+
},
|
|
770
|
+
/**
|
|
771
|
+
*
|
|
772
|
+
* @summary GET /v1/inbox/preferences
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
*/
|
|
776
|
+
getInboxPreferences(options?: RawAxiosRequestConfig): AxiosPromise<Array<InboxPreference>> {
|
|
777
|
+
return localVarFp.getInboxPreferences(options).then((request) => request(axios, basePath));
|
|
778
|
+
},
|
|
779
|
+
/**
|
|
780
|
+
* Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
|
|
781
|
+
* @summary GET /v1/inbox/notifications/
|
|
782
|
+
* @param {number | null} [limit]
|
|
783
|
+
* @param {string | null} [after]
|
|
784
|
+
* @param {boolean | null} [read]
|
|
785
|
+
* @param {boolean | null} [archived]
|
|
786
|
+
* @param {*} [options] Override http request option.
|
|
787
|
+
* @throws {RequiredError}
|
|
788
|
+
*/
|
|
789
|
+
inboxListNotifications(limit?: number | null, after?: string | null, read?: boolean | null, archived?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<InboxNotification>> {
|
|
790
|
+
return localVarFp.inboxListNotifications(limit, after, read, archived, options).then((request) => request(axios, basePath));
|
|
791
|
+
},
|
|
792
|
+
/**
|
|
793
|
+
* Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
|
|
794
|
+
* @summary POST /v1/inbox/session/
|
|
795
|
+
* @param {string} xProjectId Project UUID
|
|
796
|
+
* @param {InitSessionRequest} initSessionRequest
|
|
797
|
+
* @param {*} [options] Override http request option.
|
|
798
|
+
* @throws {RequiredError}
|
|
799
|
+
*/
|
|
800
|
+
initInboxSession(xProjectId: string, initSessionRequest: InitSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<InitSessionResponse> {
|
|
801
|
+
return localVarFp.initInboxSession(xProjectId, initSessionRequest, options).then((request) => request(axios, basePath));
|
|
802
|
+
},
|
|
803
|
+
/**
|
|
804
|
+
*
|
|
805
|
+
* @summary POST /v1/inbox/notifications/read (mark all as read)
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
markAllRead(options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
810
|
+
return localVarFp.markAllRead(options).then((request) => request(axios, basePath));
|
|
811
|
+
},
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @summary POST /v1/inbox/notifications/:id/read
|
|
815
|
+
* @param {string} id Notification ID
|
|
816
|
+
* @param {*} [options] Override http request option.
|
|
817
|
+
* @throws {RequiredError}
|
|
818
|
+
*/
|
|
819
|
+
markRead(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
820
|
+
return localVarFp.markRead(id, options).then((request) => request(axios, basePath));
|
|
821
|
+
},
|
|
822
|
+
/**
|
|
823
|
+
*
|
|
824
|
+
* @summary POST /v1/inbox/notifications/:id/unread
|
|
825
|
+
* @param {string} id Notification ID
|
|
826
|
+
* @param {*} [options] Override http request option.
|
|
827
|
+
* @throws {RequiredError}
|
|
828
|
+
*/
|
|
829
|
+
markUnread(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
830
|
+
return localVarFp.markUnread(id, options).then((request) => request(axios, basePath));
|
|
831
|
+
},
|
|
832
|
+
/**
|
|
833
|
+
*
|
|
834
|
+
* @summary GET /v1/inbox/notifications/count
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
notificationCount(options?: RawAxiosRequestConfig): AxiosPromise<NotificationCount> {
|
|
839
|
+
return localVarFp.notificationCount(options).then((request) => request(axios, basePath));
|
|
840
|
+
},
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @summary POST /v1/inbox/notifications/:id/unarchive
|
|
844
|
+
* @param {string} id Notification ID
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
unarchive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
849
|
+
return localVarFp.unarchive(id, options).then((request) => request(axios, basePath));
|
|
850
|
+
},
|
|
851
|
+
/**
|
|
852
|
+
*
|
|
853
|
+
* @summary PATCH /v1/inbox/preferences
|
|
854
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
855
|
+
* @param {*} [options] Override http request option.
|
|
856
|
+
* @throws {RequiredError}
|
|
857
|
+
*/
|
|
858
|
+
updateInboxGlobalPreference(updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
859
|
+
return localVarFp.updateInboxGlobalPreference(updateInboxPreferences, options).then((request) => request(axios, basePath));
|
|
860
|
+
},
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @summary PATCH /v1/inbox/preferences/:workflowId
|
|
864
|
+
* @param {string} workflowId Workflow ID
|
|
865
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
866
|
+
* @param {*} [options] Override http request option.
|
|
867
|
+
* @throws {RequiredError}
|
|
868
|
+
*/
|
|
869
|
+
updateInboxWorkflowPreference(workflowId: string, updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
870
|
+
return localVarFp.updateInboxWorkflowPreference(workflowId, updateInboxPreferences, options).then((request) => request(axios, basePath));
|
|
871
|
+
},
|
|
872
|
+
};
|
|
873
|
+
};
|
|
874
|
+
|
|
875
|
+
/**
|
|
876
|
+
* InboxApi - interface
|
|
877
|
+
*/
|
|
878
|
+
export interface InboxApiInterface {
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @summary POST /v1/inbox/notifications/:id/archive
|
|
882
|
+
* @param {string} id Notification ID
|
|
883
|
+
* @param {*} [options] Override http request option.
|
|
884
|
+
* @throws {RequiredError}
|
|
885
|
+
*/
|
|
886
|
+
archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
*
|
|
890
|
+
* @summary POST /v1/inbox/notifications/archive (archive all)
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
archiveAll(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
895
|
+
|
|
896
|
+
/**
|
|
897
|
+
* Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
|
|
898
|
+
* @summary POST /v1/inbox/notifications/:id/actions/:actionType
|
|
899
|
+
* @param {string} id Notification ID
|
|
900
|
+
* @param {string} actionType Action type
|
|
901
|
+
* @param {ActionBody} actionBody
|
|
902
|
+
* @param {*} [options] Override http request option.
|
|
903
|
+
* @throws {RequiredError}
|
|
904
|
+
*/
|
|
905
|
+
executeAction(id: string, actionType: string, actionBody: ActionBody, options?: RawAxiosRequestConfig): AxiosPromise<ActionRecord>;
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
*
|
|
909
|
+
* @summary GET /v1/inbox/preferences
|
|
910
|
+
* @param {*} [options] Override http request option.
|
|
911
|
+
* @throws {RequiredError}
|
|
912
|
+
*/
|
|
913
|
+
getInboxPreferences(options?: RawAxiosRequestConfig): AxiosPromise<Array<InboxPreference>>;
|
|
914
|
+
|
|
915
|
+
/**
|
|
916
|
+
* Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
|
|
917
|
+
* @summary GET /v1/inbox/notifications/
|
|
918
|
+
* @param {number | null} [limit]
|
|
919
|
+
* @param {string | null} [after]
|
|
920
|
+
* @param {boolean | null} [read]
|
|
921
|
+
* @param {boolean | null} [archived]
|
|
922
|
+
* @param {*} [options] Override http request option.
|
|
923
|
+
* @throws {RequiredError}
|
|
924
|
+
*/
|
|
925
|
+
inboxListNotifications(limit?: number | null, after?: string | null, read?: boolean | null, archived?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<InboxNotification>>;
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
|
|
929
|
+
* @summary POST /v1/inbox/session/
|
|
930
|
+
* @param {string} xProjectId Project UUID
|
|
931
|
+
* @param {InitSessionRequest} initSessionRequest
|
|
932
|
+
* @param {*} [options] Override http request option.
|
|
933
|
+
* @throws {RequiredError}
|
|
934
|
+
*/
|
|
935
|
+
initInboxSession(xProjectId: string, initSessionRequest: InitSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<InitSessionResponse>;
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
*
|
|
939
|
+
* @summary POST /v1/inbox/notifications/read (mark all as read)
|
|
940
|
+
* @param {*} [options] Override http request option.
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
*/
|
|
943
|
+
markAllRead(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
*
|
|
947
|
+
* @summary POST /v1/inbox/notifications/:id/read
|
|
948
|
+
* @param {string} id Notification ID
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
*/
|
|
952
|
+
markRead(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
*
|
|
956
|
+
* @summary POST /v1/inbox/notifications/:id/unread
|
|
957
|
+
* @param {string} id Notification ID
|
|
958
|
+
* @param {*} [options] Override http request option.
|
|
959
|
+
* @throws {RequiredError}
|
|
960
|
+
*/
|
|
961
|
+
markUnread(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
962
|
+
|
|
963
|
+
/**
|
|
964
|
+
*
|
|
965
|
+
* @summary GET /v1/inbox/notifications/count
|
|
966
|
+
* @param {*} [options] Override http request option.
|
|
967
|
+
* @throws {RequiredError}
|
|
968
|
+
*/
|
|
969
|
+
notificationCount(options?: RawAxiosRequestConfig): AxiosPromise<NotificationCount>;
|
|
970
|
+
|
|
971
|
+
/**
|
|
972
|
+
*
|
|
973
|
+
* @summary POST /v1/inbox/notifications/:id/unarchive
|
|
974
|
+
* @param {string} id Notification ID
|
|
975
|
+
* @param {*} [options] Override http request option.
|
|
976
|
+
* @throws {RequiredError}
|
|
977
|
+
*/
|
|
978
|
+
unarchive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
*
|
|
982
|
+
* @summary PATCH /v1/inbox/preferences
|
|
983
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
984
|
+
* @param {*} [options] Override http request option.
|
|
985
|
+
* @throws {RequiredError}
|
|
986
|
+
*/
|
|
987
|
+
updateInboxGlobalPreference(updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
988
|
+
|
|
989
|
+
/**
|
|
990
|
+
*
|
|
991
|
+
* @summary PATCH /v1/inbox/preferences/:workflowId
|
|
992
|
+
* @param {string} workflowId Workflow ID
|
|
993
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
994
|
+
* @param {*} [options] Override http request option.
|
|
995
|
+
* @throws {RequiredError}
|
|
996
|
+
*/
|
|
997
|
+
updateInboxWorkflowPreference(workflowId: string, updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
998
|
+
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* InboxApi - object-oriented interface
|
|
1003
|
+
*/
|
|
1004
|
+
export class InboxApi extends BaseAPI implements InboxApiInterface {
|
|
1005
|
+
/**
|
|
1006
|
+
*
|
|
1007
|
+
* @summary POST /v1/inbox/notifications/:id/archive
|
|
1008
|
+
* @param {string} id Notification ID
|
|
1009
|
+
* @param {*} [options] Override http request option.
|
|
1010
|
+
* @throws {RequiredError}
|
|
1011
|
+
*/
|
|
1012
|
+
public archive(id: string, options?: RawAxiosRequestConfig) {
|
|
1013
|
+
return InboxApiFp(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
*
|
|
1018
|
+
* @summary POST /v1/inbox/notifications/archive (archive all)
|
|
1019
|
+
* @param {*} [options] Override http request option.
|
|
1020
|
+
* @throws {RequiredError}
|
|
1021
|
+
*/
|
|
1022
|
+
public archiveAll(options?: RawAxiosRequestConfig) {
|
|
1023
|
+
return InboxApiFp(this.configuration).archiveAll(options).then((request) => request(this.axios, this.basePath));
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
/**
|
|
1027
|
+
* Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
|
|
1028
|
+
* @summary POST /v1/inbox/notifications/:id/actions/:actionType
|
|
1029
|
+
* @param {string} id Notification ID
|
|
1030
|
+
* @param {string} actionType Action type
|
|
1031
|
+
* @param {ActionBody} actionBody
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
public executeAction(id: string, actionType: string, actionBody: ActionBody, options?: RawAxiosRequestConfig) {
|
|
1036
|
+
return InboxApiFp(this.configuration).executeAction(id, actionType, actionBody, options).then((request) => request(this.axios, this.basePath));
|
|
1037
|
+
}
|
|
1038
|
+
|
|
1039
|
+
/**
|
|
1040
|
+
*
|
|
1041
|
+
* @summary GET /v1/inbox/preferences
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @throws {RequiredError}
|
|
1044
|
+
*/
|
|
1045
|
+
public getInboxPreferences(options?: RawAxiosRequestConfig) {
|
|
1046
|
+
return InboxApiFp(this.configuration).getInboxPreferences(options).then((request) => request(this.axios, this.basePath));
|
|
1047
|
+
}
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
|
|
1051
|
+
* @summary GET /v1/inbox/notifications/
|
|
1052
|
+
* @param {number | null} [limit]
|
|
1053
|
+
* @param {string | null} [after]
|
|
1054
|
+
* @param {boolean | null} [read]
|
|
1055
|
+
* @param {boolean | null} [archived]
|
|
1056
|
+
* @param {*} [options] Override http request option.
|
|
1057
|
+
* @throws {RequiredError}
|
|
1058
|
+
*/
|
|
1059
|
+
public inboxListNotifications(limit?: number | null, after?: string | null, read?: boolean | null, archived?: boolean | null, options?: RawAxiosRequestConfig) {
|
|
1060
|
+
return InboxApiFp(this.configuration).inboxListNotifications(limit, after, read, archived, options).then((request) => request(this.axios, this.basePath));
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1063
|
+
/**
|
|
1064
|
+
* Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
|
|
1065
|
+
* @summary POST /v1/inbox/session/
|
|
1066
|
+
* @param {string} xProjectId Project UUID
|
|
1067
|
+
* @param {InitSessionRequest} initSessionRequest
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
public initInboxSession(xProjectId: string, initSessionRequest: InitSessionRequest, options?: RawAxiosRequestConfig) {
|
|
1072
|
+
return InboxApiFp(this.configuration).initInboxSession(xProjectId, initSessionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1073
|
+
}
|
|
1074
|
+
|
|
1075
|
+
/**
|
|
1076
|
+
*
|
|
1077
|
+
* @summary POST /v1/inbox/notifications/read (mark all as read)
|
|
1078
|
+
* @param {*} [options] Override http request option.
|
|
1079
|
+
* @throws {RequiredError}
|
|
1080
|
+
*/
|
|
1081
|
+
public markAllRead(options?: RawAxiosRequestConfig) {
|
|
1082
|
+
return InboxApiFp(this.configuration).markAllRead(options).then((request) => request(this.axios, this.basePath));
|
|
1083
|
+
}
|
|
1084
|
+
|
|
1085
|
+
/**
|
|
1086
|
+
*
|
|
1087
|
+
* @summary POST /v1/inbox/notifications/:id/read
|
|
1088
|
+
* @param {string} id Notification ID
|
|
1089
|
+
* @param {*} [options] Override http request option.
|
|
1090
|
+
* @throws {RequiredError}
|
|
1091
|
+
*/
|
|
1092
|
+
public markRead(id: string, options?: RawAxiosRequestConfig) {
|
|
1093
|
+
return InboxApiFp(this.configuration).markRead(id, options).then((request) => request(this.axios, this.basePath));
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @summary POST /v1/inbox/notifications/:id/unread
|
|
1099
|
+
* @param {string} id Notification ID
|
|
1100
|
+
* @param {*} [options] Override http request option.
|
|
1101
|
+
* @throws {RequiredError}
|
|
1102
|
+
*/
|
|
1103
|
+
public markUnread(id: string, options?: RawAxiosRequestConfig) {
|
|
1104
|
+
return InboxApiFp(this.configuration).markUnread(id, options).then((request) => request(this.axios, this.basePath));
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
*
|
|
1109
|
+
* @summary GET /v1/inbox/notifications/count
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
*/
|
|
1113
|
+
public notificationCount(options?: RawAxiosRequestConfig) {
|
|
1114
|
+
return InboxApiFp(this.configuration).notificationCount(options).then((request) => request(this.axios, this.basePath));
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
/**
|
|
1118
|
+
*
|
|
1119
|
+
* @summary POST /v1/inbox/notifications/:id/unarchive
|
|
1120
|
+
* @param {string} id Notification ID
|
|
1121
|
+
* @param {*} [options] Override http request option.
|
|
1122
|
+
* @throws {RequiredError}
|
|
1123
|
+
*/
|
|
1124
|
+
public unarchive(id: string, options?: RawAxiosRequestConfig) {
|
|
1125
|
+
return InboxApiFp(this.configuration).unarchive(id, options).then((request) => request(this.axios, this.basePath));
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
*
|
|
1130
|
+
* @summary PATCH /v1/inbox/preferences
|
|
1131
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
1132
|
+
* @param {*} [options] Override http request option.
|
|
1133
|
+
* @throws {RequiredError}
|
|
1134
|
+
*/
|
|
1135
|
+
public updateInboxGlobalPreference(updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig) {
|
|
1136
|
+
return InboxApiFp(this.configuration).updateInboxGlobalPreference(updateInboxPreferences, options).then((request) => request(this.axios, this.basePath));
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
/**
|
|
1140
|
+
*
|
|
1141
|
+
* @summary PATCH /v1/inbox/preferences/:workflowId
|
|
1142
|
+
* @param {string} workflowId Workflow ID
|
|
1143
|
+
* @param {UpdateInboxPreferences} updateInboxPreferences
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
*/
|
|
1147
|
+
public updateInboxWorkflowPreference(workflowId: string, updateInboxPreferences: UpdateInboxPreferences, options?: RawAxiosRequestConfig) {
|
|
1148
|
+
return InboxApiFp(this.configuration).updateInboxWorkflowPreference(workflowId, updateInboxPreferences, options).then((request) => request(this.axios, this.basePath));
|
|
1149
|
+
}
|
|
1150
|
+
}
|
|
1151
|
+
|