@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.
Files changed (376) hide show
  1. package/.openapi-generator/FILES +375 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +2 -2
  5. package/api/activity-api.ts +756 -0
  6. package/api/billing-api.ts +673 -0
  7. package/api/channel-connections-api.ts +510 -0
  8. package/api/channel-endpoints-api.ts +510 -0
  9. package/api/contexts-api.ts +534 -0
  10. package/api/events-api.ts +394 -0
  11. package/api/feature-flags-api.ts +132 -0
  12. package/api/health-api.ts +264 -0
  13. package/api/inbound-parse-api.ts +137 -0
  14. package/api/inbox-api.ts +1151 -0
  15. package/api/integrations-api.ts +833 -0
  16. package/api/layouts-api.ts +849 -0
  17. package/api/messages-api.ts +349 -0
  18. package/api/metrics-api.ts +128 -0
  19. package/api/notification-groups-api.ts +391 -0
  20. package/api/notifications-api.ts +326 -0
  21. package/api/preferences-api.ts +333 -0
  22. package/api/projects-api.ts +1075 -0
  23. package/api/subscribers-api.ts +1542 -0
  24. package/api/topics-api.ts +1352 -0
  25. package/api/translations-api.ts +462 -0
  26. package/api/webhooks-api.ts +397 -0
  27. package/api/workflows-api.ts +970 -0
  28. package/api.ts +40 -0
  29. package/base.ts +62 -0
  30. package/common.ts +127 -0
  31. package/configuration.ts +121 -0
  32. package/docs/ActionBody.md +21 -0
  33. package/docs/ActionRecord.md +25 -0
  34. package/docs/ActionType.md +17 -0
  35. package/docs/ActivityApi.md +412 -0
  36. package/docs/ActivityChartPoint.md +31 -0
  37. package/docs/ActivityRecord.md +39 -0
  38. package/docs/ActivityRequestRecord.md +31 -0
  39. package/docs/ActivityStats.md +31 -0
  40. package/docs/ActorType.md +15 -0
  41. package/docs/ApiKeyCreated.md +27 -0
  42. package/docs/ApiKeyInfo.md +27 -0
  43. package/docs/AutoConfigureResult.md +21 -0
  44. package/docs/BillingApi.md +375 -0
  45. package/docs/BillingInterval.md +11 -0
  46. package/docs/Branding.md +31 -0
  47. package/docs/BroadcastTrigger.md +27 -0
  48. package/docs/BulkCreateSubscribers.md +21 -0
  49. package/docs/BulkPreferenceItem.md +24 -0
  50. package/docs/BulkPreferences.md +21 -0
  51. package/docs/BulkResult.md +22 -0
  52. package/docs/BulkTrigger.md +21 -0
  53. package/docs/ChannelConnectionRecord.md +31 -0
  54. package/docs/ChannelConnectionsApi.md +276 -0
  55. package/docs/ChannelEndpointRecord.md +33 -0
  56. package/docs/ChannelEndpointsApi.md +276 -0
  57. package/docs/ChannelPreferences.md +29 -0
  58. package/docs/ChannelType.md +17 -0
  59. package/docs/ChartQuery.md +21 -0
  60. package/docs/ChatOauth.md +21 -0
  61. package/docs/ChatOauthRequest.md +22 -0
  62. package/docs/CheckoutSession.md +23 -0
  63. package/docs/ContextRecord.md +29 -0
  64. package/docs/ContextsApi.md +285 -0
  65. package/docs/CreateChannelConnection.md +27 -0
  66. package/docs/CreateChannelEndpoint.md +29 -0
  67. package/docs/CreateCheckout.md +23 -0
  68. package/docs/CreateContext.md +25 -0
  69. package/docs/CreateIntegration.md +31 -0
  70. package/docs/CreateLayout.md +31 -0
  71. package/docs/CreateNotificationGroup.md +21 -0
  72. package/docs/CreateProject.md +21 -0
  73. package/docs/CreateSubscriber.md +37 -0
  74. package/docs/CreateSubscription.md +21 -0
  75. package/docs/CreateTopic.md +23 -0
  76. package/docs/CreateWebhook.md +23 -0
  77. package/docs/CreateWorkflow.md +35 -0
  78. package/docs/CtaType.md +9 -0
  79. package/docs/CursorMeta.md +27 -0
  80. package/docs/CursorPaginatedFeedItem.md +23 -0
  81. package/docs/CursorPaginatedFeedItemDataInner.md +37 -0
  82. package/docs/CursorPaginatedMessageRecord.md +23 -0
  83. package/docs/CursorPaginatedMessageRecordDataInner.md +41 -0
  84. package/docs/CursorPagination.md +25 -0
  85. package/docs/DeleteSubscription.md +20 -0
  86. package/docs/DeliveryAck.md +21 -0
  87. package/docs/DeliveryStatusWebhook.md +27 -0
  88. package/docs/DnsSettings.md +23 -0
  89. package/docs/EngagementStatsResponse.md +27 -0
  90. package/docs/EntitlementItem.md +25 -0
  91. package/docs/Entitlements.md +21 -0
  92. package/docs/ErrorDetail.md +27 -0
  93. package/docs/EventsApi.md +214 -0
  94. package/docs/EventsUsage.md +23 -0
  95. package/docs/FeatureFlagsApi.md +51 -0
  96. package/docs/FeedItem.md +37 -0
  97. package/docs/FeedQuery.md +31 -0
  98. package/docs/HealthApi.md +140 -0
  99. package/docs/InboundParseApi.md +59 -0
  100. package/docs/InboxApi.md +673 -0
  101. package/docs/InboxNotification.md +41 -0
  102. package/docs/InboxPreference.md +23 -0
  103. package/docs/InboxQuery.md +27 -0
  104. package/docs/InitSessionRequest.md +23 -0
  105. package/docs/InitSessionResponse.md +23 -0
  106. package/docs/IntegrationRecord.md +35 -0
  107. package/docs/IntegrationsApi.md +475 -0
  108. package/docs/InviteMember.md +23 -0
  109. package/docs/InviteMemberBody.md +23 -0
  110. package/docs/JobLog.md +33 -0
  111. package/docs/LayoutPreview.md +21 -0
  112. package/docs/LayoutPreviewResult.md +21 -0
  113. package/docs/LayoutRecord.md +31 -0
  114. package/docs/LayoutUsageItem.md +23 -0
  115. package/docs/LayoutsApi.md +484 -0
  116. package/docs/MarkAll.md +21 -0
  117. package/docs/MarkMessages.md +23 -0
  118. package/docs/MarkResult.md +21 -0
  119. package/docs/MemberRecord.md +27 -0
  120. package/docs/MemberRole.md +15 -0
  121. package/docs/MemberStatus.md +13 -0
  122. package/docs/MessageQuery.md +31 -0
  123. package/docs/MessageRecord.md +41 -0
  124. package/docs/MessagesApi.md +175 -0
  125. package/docs/MetricsApi.md +51 -0
  126. package/docs/NotificationCount.md +25 -0
  127. package/docs/NotificationGroupRecord.md +23 -0
  128. package/docs/NotificationGroupsApi.md +209 -0
  129. package/docs/NotificationLog.md +33 -0
  130. package/docs/NotificationQuery.md +25 -0
  131. package/docs/NotificationsApi.md +166 -0
  132. package/docs/OffsetMeta.md +27 -0
  133. package/docs/OffsetPagination.md +27 -0
  134. package/docs/OnlineStatus.md +21 -0
  135. package/docs/PaginatedChannelConnectionRecord.md +23 -0
  136. package/docs/PaginatedChannelConnectionRecordDataInner.md +31 -0
  137. package/docs/PaginatedChannelEndpointRecord.md +23 -0
  138. package/docs/PaginatedChannelEndpointRecordDataInner.md +33 -0
  139. package/docs/PaginatedContextRecord.md +23 -0
  140. package/docs/PaginatedContextRecordDataInner.md +29 -0
  141. package/docs/PaginatedIntegrationRecord.md +23 -0
  142. package/docs/PaginatedIntegrationRecordDataInner.md +35 -0
  143. package/docs/PaginatedLayoutRecord.md +23 -0
  144. package/docs/PaginatedLayoutRecordDataInner.md +31 -0
  145. package/docs/PaginatedSubscriberRecord.md +23 -0
  146. package/docs/PaginatedSubscriberRecordDataInner.md +41 -0
  147. package/docs/PaginatedTopicRecord.md +23 -0
  148. package/docs/PaginatedTopicRecordDataInner.md +24 -0
  149. package/docs/PaginatedTopicSubscriptionRecord.md +23 -0
  150. package/docs/PaginatedTopicSubscriptionRecordDataInner.md +29 -0
  151. package/docs/PaginatedWorkflowRecord.md +23 -0
  152. package/docs/PaginatedWorkflowRecordDataInner.md +37 -0
  153. package/docs/PaginationQuery.md +25 -0
  154. package/docs/PatchCredentials.md +27 -0
  155. package/docs/Plan.md +17 -0
  156. package/docs/PlanLimitsResponse.md +33 -0
  157. package/docs/PortalUrl.md +21 -0
  158. package/docs/PreferenceChannels.md +29 -0
  159. package/docs/PreferenceRecord.md +27 -0
  160. package/docs/PreferencesApi.md +171 -0
  161. package/docs/PreviewResult.md +20 -0
  162. package/docs/PriceInfo.md +27 -0
  163. package/docs/Prices.md +21 -0
  164. package/docs/ProjectRecord.md +27 -0
  165. package/docs/ProjectsApi.md +638 -0
  166. package/docs/SetCredentials.md +27 -0
  167. package/docs/StepPreview.md +21 -0
  168. package/docs/StepRecord.md +29 -0
  169. package/docs/StepType.md +27 -0
  170. package/docs/SubscriberCredential.md +27 -0
  171. package/docs/SubscriberPayload.md +37 -0
  172. package/docs/SubscriberRecord.md +41 -0
  173. package/docs/SubscribersApi.md +887 -0
  174. package/docs/Subscription.md +39 -0
  175. package/docs/SyncWorkflow.md +21 -0
  176. package/docs/SystemAvatarIcon.md +19 -0
  177. package/docs/TopicRecord.md +24 -0
  178. package/docs/TopicSubscribers.md +21 -0
  179. package/docs/TopicSubscription.md +23 -0
  180. package/docs/TopicSubscriptionRecord.md +29 -0
  181. package/docs/TopicsApi.md +777 -0
  182. package/docs/TranslationsApi.md +258 -0
  183. package/docs/TrialInfo.md +27 -0
  184. package/docs/TriggerEvent.md +31 -0
  185. package/docs/TriggerRecipients.md +39 -0
  186. package/docs/TriggerRecipientsOneOf.md +21 -0
  187. package/docs/TriggerResult.md +25 -0
  188. package/docs/TriggerStatus.md +21 -0
  189. package/docs/UnseenCount.md +21 -0
  190. package/docs/UpdateChannelConnection.md +21 -0
  191. package/docs/UpdateChannelEndpoint.md +23 -0
  192. package/docs/UpdateContext.md +21 -0
  193. package/docs/UpdateInboxPreferences.md +29 -0
  194. package/docs/UpdateIntegration.md +27 -0
  195. package/docs/UpdateLayout.md +27 -0
  196. package/docs/UpdateNotificationGroup.md +21 -0
  197. package/docs/UpdatePreference.md +23 -0
  198. package/docs/UpdateProject.md +23 -0
  199. package/docs/UpdateSubscriber.md +35 -0
  200. package/docs/UpdateSubscriptionMeta.md +21 -0
  201. package/docs/UpdateTopic.md +21 -0
  202. package/docs/UpdateWorkflow.md +31 -0
  203. package/docs/Usage.md +35 -0
  204. package/docs/WebhookRecord.md +31 -0
  205. package/docs/WebhooksApi.md +212 -0
  206. package/docs/WidgetSettings.md +21 -0
  207. package/docs/WorkflowRecord.md +37 -0
  208. package/docs/WorkflowRunRecord.md +31 -0
  209. package/docs/WorkflowStatsResponse.md +27 -0
  210. package/docs/WorkflowStatus.md +21 -0
  211. package/docs/WorkflowStepCreate.md +31 -0
  212. package/docs/WorkflowsApi.md +550 -0
  213. package/git_push.sh +57 -0
  214. package/index.ts +18 -0
  215. package/models/action-body.ts +26 -0
  216. package/models/action-record.ts +28 -0
  217. package/models/action-type.ts +32 -0
  218. package/models/activity-chart-point.ts +46 -0
  219. package/models/activity-record.ts +62 -0
  220. package/models/activity-request-record.ts +46 -0
  221. package/models/activity-stats.ts +46 -0
  222. package/models/actor-type.ts +31 -0
  223. package/models/api-key-created.ts +38 -0
  224. package/models/api-key-info.ts +38 -0
  225. package/models/auto-configure-result.ts +23 -0
  226. package/models/billing-interval.ts +29 -0
  227. package/models/branding.ts +46 -0
  228. package/models/broadcast-trigger.ts +29 -0
  229. package/models/bulk-create-subscribers.ts +26 -0
  230. package/models/bulk-preference-item.ts +25 -0
  231. package/models/bulk-preferences.ts +26 -0
  232. package/models/bulk-result.ts +24 -0
  233. package/models/bulk-trigger.ts +29 -0
  234. package/models/channel-connection-record.ts +43 -0
  235. package/models/channel-endpoint-record.ts +47 -0
  236. package/models/channel-preferences.ts +27 -0
  237. package/models/channel-type.ts +32 -0
  238. package/models/chart-query.ts +26 -0
  239. package/models/chat-oauth-request.ts +21 -0
  240. package/models/chat-oauth.ts +23 -0
  241. package/models/checkout-session.ts +35 -0
  242. package/models/context-record.ts +42 -0
  243. package/models/create-channel-connection.ts +35 -0
  244. package/models/create-channel-endpoint.ts +39 -0
  245. package/models/create-checkout.ts +35 -0
  246. package/models/create-context.ts +34 -0
  247. package/models/create-integration.ts +51 -0
  248. package/models/create-layout.ts +34 -0
  249. package/models/create-notification-group.ts +26 -0
  250. package/models/create-project.ts +26 -0
  251. package/models/create-subscriber.ts +58 -0
  252. package/models/create-subscription.ts +23 -0
  253. package/models/create-topic.ts +30 -0
  254. package/models/create-webhook.ts +30 -0
  255. package/models/create-workflow.ts +60 -0
  256. package/models/cta-type.ts +28 -0
  257. package/models/cursor-meta.ts +38 -0
  258. package/models/cursor-paginated-feed-item-data-inner.ts +40 -0
  259. package/models/cursor-paginated-feed-item.ts +36 -0
  260. package/models/cursor-paginated-message-record-data-inner.ts +45 -0
  261. package/models/cursor-paginated-message-record.ts +36 -0
  262. package/models/cursor-pagination.ts +34 -0
  263. package/models/delete-subscription.ts +20 -0
  264. package/models/delivery-ack.ts +23 -0
  265. package/models/delivery-status-webhook.ts +29 -0
  266. package/models/dns-settings.ts +30 -0
  267. package/models/engagement-stats-response.ts +38 -0
  268. package/models/entitlement-item.ts +34 -0
  269. package/models/entitlements.ts +26 -0
  270. package/models/error-detail.ts +38 -0
  271. package/models/events-usage.ts +30 -0
  272. package/models/feed-item.ts +40 -0
  273. package/models/feed-query.ts +28 -0
  274. package/models/inbox-notification.ts +39 -0
  275. package/models/inbox-preference.ts +27 -0
  276. package/models/inbox-query.ts +26 -0
  277. package/models/index.ts +158 -0
  278. package/models/init-session-request.ts +30 -0
  279. package/models/init-session-response.ts +30 -0
  280. package/models/integration-record.ts +59 -0
  281. package/models/invite-member-body.ts +30 -0
  282. package/models/invite-member.ts +30 -0
  283. package/models/job-log.ts +47 -0
  284. package/models/layout-preview-result.ts +23 -0
  285. package/models/layout-preview.ts +23 -0
  286. package/models/layout-record.ts +37 -0
  287. package/models/layout-usage-item.ts +24 -0
  288. package/models/mark-all.ts +23 -0
  289. package/models/mark-messages.ts +24 -0
  290. package/models/mark-result.ts +23 -0
  291. package/models/member-record.ts +38 -0
  292. package/models/member-role.ts +31 -0
  293. package/models/member-status.ts +30 -0
  294. package/models/message-query.ts +46 -0
  295. package/models/message-record.ts +45 -0
  296. package/models/notification-count.ts +25 -0
  297. package/models/notification-group-record.ts +30 -0
  298. package/models/notification-log.ts +41 -0
  299. package/models/notification-query.ts +34 -0
  300. package/models/offset-meta.ts +38 -0
  301. package/models/offset-pagination.ts +38 -0
  302. package/models/online-status.ts +23 -0
  303. package/models/paginated-channel-connection-record-data-inner.ts +43 -0
  304. package/models/paginated-channel-connection-record.ts +36 -0
  305. package/models/paginated-channel-endpoint-record-data-inner.ts +47 -0
  306. package/models/paginated-channel-endpoint-record.ts +36 -0
  307. package/models/paginated-context-record-data-inner.ts +42 -0
  308. package/models/paginated-context-record.ts +36 -0
  309. package/models/paginated-integration-record-data-inner.ts +59 -0
  310. package/models/paginated-integration-record.ts +36 -0
  311. package/models/paginated-layout-record-data-inner.ts +37 -0
  312. package/models/paginated-layout-record.ts +36 -0
  313. package/models/paginated-subscriber-record-data-inner.ts +69 -0
  314. package/models/paginated-subscriber-record.ts +36 -0
  315. package/models/paginated-topic-record-data-inner.ts +28 -0
  316. package/models/paginated-topic-record.ts +36 -0
  317. package/models/paginated-topic-subscription-record-data-inner.ts +39 -0
  318. package/models/paginated-topic-subscription-record.ts +36 -0
  319. package/models/paginated-workflow-record-data-inner.ts +58 -0
  320. package/models/paginated-workflow-record.ts +36 -0
  321. package/models/pagination-query.ts +34 -0
  322. package/models/patch-credentials.ts +29 -0
  323. package/models/plan-limits-response.ts +55 -0
  324. package/models/plan.ts +32 -0
  325. package/models/portal-url.ts +26 -0
  326. package/models/preference-channels.ts +27 -0
  327. package/models/preference-record.ts +32 -0
  328. package/models/preview-result.ts +20 -0
  329. package/models/price-info.ts +38 -0
  330. package/models/prices.ts +26 -0
  331. package/models/project-record.ts +46 -0
  332. package/models/set-credentials.ts +29 -0
  333. package/models/step-preview.ts +23 -0
  334. package/models/step-record.ts +36 -0
  335. package/models/step-type.ts +37 -0
  336. package/models/subscriber-credential.ts +26 -0
  337. package/models/subscriber-payload.ts +24 -0
  338. package/models/subscriber-record.ts +69 -0
  339. package/models/subscription.ts +73 -0
  340. package/models/sync-workflow.ts +26 -0
  341. package/models/system-avatar-icon.ts +33 -0
  342. package/models/topic-record.ts +28 -0
  343. package/models/topic-subscribers.ts +23 -0
  344. package/models/topic-subscription-record.ts +39 -0
  345. package/models/topic-subscription.ts +27 -0
  346. package/models/trial-info.ts +38 -0
  347. package/models/trigger-event.ts +49 -0
  348. package/models/trigger-recipients-one-of.ts +23 -0
  349. package/models/trigger-recipients.ts +29 -0
  350. package/models/trigger-result.ts +39 -0
  351. package/models/trigger-status.ts +34 -0
  352. package/models/unseen-count.ts +23 -0
  353. package/models/update-channel-connection.ts +23 -0
  354. package/models/update-channel-endpoint.ts +27 -0
  355. package/models/update-context.ts +26 -0
  356. package/models/update-inbox-preferences.ts +27 -0
  357. package/models/update-integration.ts +38 -0
  358. package/models/update-layout.ts +29 -0
  359. package/models/update-notification-group.ts +26 -0
  360. package/models/update-preference.ts +27 -0
  361. package/models/update-project.ts +33 -0
  362. package/models/update-subscriber.ts +54 -0
  363. package/models/update-subscription-meta.ts +23 -0
  364. package/models/update-topic.ts +26 -0
  365. package/models/update-workflow.ts +52 -0
  366. package/models/usage.ts +59 -0
  367. package/models/webhook-record.ts +46 -0
  368. package/models/widget-settings.ts +26 -0
  369. package/models/workflow-record.ts +58 -0
  370. package/models/workflow-run-record.ts +46 -0
  371. package/models/workflow-stats-response.ts +38 -0
  372. package/models/workflow-status.ts +26 -0
  373. package/models/workflow-step-create.ts +51 -0
  374. package/package.json +9 -33
  375. package/tsconfig.esm.json +7 -0
  376. package/tsconfig.json +18 -0
@@ -0,0 +1,326 @@
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 { JobLog } from '../models';
26
+ // @ts-ignore
27
+ import type { NotificationLog } from '../models';
28
+ /**
29
+ * NotificationsApi - axios parameter creator
30
+ */
31
+ export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ *
35
+ * @summary GET /v1/notifications/:id
36
+ * @param {string} id Notification ID
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ getNotification: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
+ // verify required parameter 'id' is not null or undefined
42
+ assertParamExists('getNotification', 'id', id)
43
+ const localVarPath = `/v1/notifications/{id}/`
44
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication bearer_auth required
57
+ // http bearer authentication required
58
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = 'application/json';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
71
+ /**
72
+ *
73
+ * @summary GET /v1/notifications/:id/jobs
74
+ * @param {string} id Notification ID
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ getNotificationJobs: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
79
+ // verify required parameter 'id' is not null or undefined
80
+ assertParamExists('getNotificationJobs', 'id', id)
81
+ const localVarPath = `/v1/notifications/{id}/jobs/`
82
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
83
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
84
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
85
+ let baseOptions;
86
+ if (configuration) {
87
+ baseOptions = configuration.baseOptions;
88
+ }
89
+
90
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
91
+ const localVarHeaderParameter = {} as any;
92
+ const localVarQueryParameter = {} as any;
93
+
94
+ // authentication bearer_auth required
95
+ // http bearer authentication required
96
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
97
+
98
+ localVarHeaderParameter['Accept'] = 'application/json';
99
+
100
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
101
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
102
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
103
+
104
+ return {
105
+ url: toPathString(localVarUrlObj),
106
+ options: localVarRequestOptions,
107
+ };
108
+ },
109
+ /**
110
+ *
111
+ * @summary GET /v1/notifications
112
+ * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
113
+ * @param {number | null} [page] Zero-based page index (default: 0).
114
+ * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ listNotifications: async (limit?: number | null, page?: number | null, q?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
119
+ const localVarPath = `/v1/notifications/`;
120
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
121
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
122
+ let baseOptions;
123
+ if (configuration) {
124
+ baseOptions = configuration.baseOptions;
125
+ }
126
+
127
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
128
+ const localVarHeaderParameter = {} as any;
129
+ const localVarQueryParameter = {} as any;
130
+
131
+ // authentication bearer_auth required
132
+ // http bearer authentication required
133
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
134
+
135
+ if (limit !== undefined) {
136
+ localVarQueryParameter['limit'] = limit;
137
+ }
138
+
139
+ if (page !== undefined) {
140
+ localVarQueryParameter['page'] = page;
141
+ }
142
+
143
+ if (q !== undefined) {
144
+ localVarQueryParameter['q'] = q;
145
+ }
146
+
147
+ localVarHeaderParameter['Accept'] = 'application/json';
148
+
149
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
150
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
151
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
152
+
153
+ return {
154
+ url: toPathString(localVarUrlObj),
155
+ options: localVarRequestOptions,
156
+ };
157
+ },
158
+ }
159
+ };
160
+
161
+ /**
162
+ * NotificationsApi - functional programming interface
163
+ */
164
+ export const NotificationsApiFp = function(configuration?: Configuration) {
165
+ const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
166
+ return {
167
+ /**
168
+ *
169
+ * @summary GET /v1/notifications/:id
170
+ * @param {string} id Notification ID
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ */
174
+ async getNotification(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationLog>> {
175
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getNotification(id, options);
176
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
177
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotification']?.[localVarOperationServerIndex]?.url;
178
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
179
+ },
180
+ /**
181
+ *
182
+ * @summary GET /v1/notifications/:id/jobs
183
+ * @param {string} id Notification ID
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ */
187
+ async getNotificationJobs(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<JobLog>>> {
188
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationJobs(id, options);
189
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
190
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationJobs']?.[localVarOperationServerIndex]?.url;
191
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
192
+ },
193
+ /**
194
+ *
195
+ * @summary GET /v1/notifications
196
+ * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
197
+ * @param {number | null} [page] Zero-based page index (default: 0).
198
+ * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ async listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NotificationLog>>> {
203
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listNotifications(limit, page, q, options);
204
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
205
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotifications']?.[localVarOperationServerIndex]?.url;
206
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
207
+ },
208
+ }
209
+ };
210
+
211
+ /**
212
+ * NotificationsApi - factory interface
213
+ */
214
+ export const NotificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
215
+ const localVarFp = NotificationsApiFp(configuration)
216
+ return {
217
+ /**
218
+ *
219
+ * @summary GET /v1/notifications/:id
220
+ * @param {string} id Notification ID
221
+ * @param {*} [options] Override http request option.
222
+ * @throws {RequiredError}
223
+ */
224
+ getNotification(id: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationLog> {
225
+ return localVarFp.getNotification(id, options).then((request) => request(axios, basePath));
226
+ },
227
+ /**
228
+ *
229
+ * @summary GET /v1/notifications/:id/jobs
230
+ * @param {string} id Notification ID
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ getNotificationJobs(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<JobLog>> {
235
+ return localVarFp.getNotificationJobs(id, options).then((request) => request(axios, basePath));
236
+ },
237
+ /**
238
+ *
239
+ * @summary GET /v1/notifications
240
+ * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
241
+ * @param {number | null} [page] Zero-based page index (default: 0).
242
+ * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<NotificationLog>> {
247
+ return localVarFp.listNotifications(limit, page, q, options).then((request) => request(axios, basePath));
248
+ },
249
+ };
250
+ };
251
+
252
+ /**
253
+ * NotificationsApi - interface
254
+ */
255
+ export interface NotificationsApiInterface {
256
+ /**
257
+ *
258
+ * @summary GET /v1/notifications/:id
259
+ * @param {string} id Notification ID
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ */
263
+ getNotification(id: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationLog>;
264
+
265
+ /**
266
+ *
267
+ * @summary GET /v1/notifications/:id/jobs
268
+ * @param {string} id Notification ID
269
+ * @param {*} [options] Override http request option.
270
+ * @throws {RequiredError}
271
+ */
272
+ getNotificationJobs(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<JobLog>>;
273
+
274
+ /**
275
+ *
276
+ * @summary GET /v1/notifications
277
+ * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
278
+ * @param {number | null} [page] Zero-based page index (default: 0).
279
+ * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
280
+ * @param {*} [options] Override http request option.
281
+ * @throws {RequiredError}
282
+ */
283
+ listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<NotificationLog>>;
284
+
285
+ }
286
+
287
+ /**
288
+ * NotificationsApi - object-oriented interface
289
+ */
290
+ export class NotificationsApi extends BaseAPI implements NotificationsApiInterface {
291
+ /**
292
+ *
293
+ * @summary GET /v1/notifications/:id
294
+ * @param {string} id Notification ID
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ public getNotification(id: string, options?: RawAxiosRequestConfig) {
299
+ return NotificationsApiFp(this.configuration).getNotification(id, options).then((request) => request(this.axios, this.basePath));
300
+ }
301
+
302
+ /**
303
+ *
304
+ * @summary GET /v1/notifications/:id/jobs
305
+ * @param {string} id Notification ID
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ */
309
+ public getNotificationJobs(id: string, options?: RawAxiosRequestConfig) {
310
+ return NotificationsApiFp(this.configuration).getNotificationJobs(id, options).then((request) => request(this.axios, this.basePath));
311
+ }
312
+
313
+ /**
314
+ *
315
+ * @summary GET /v1/notifications
316
+ * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
317
+ * @param {number | null} [page] Zero-based page index (default: 0).
318
+ * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
319
+ * @param {*} [options] Override http request option.
320
+ * @throws {RequiredError}
321
+ */
322
+ public listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig) {
323
+ return NotificationsApiFp(this.configuration).listNotifications(limit, page, q, options).then((request) => request(this.axios, this.basePath));
324
+ }
325
+ }
326
+
@@ -0,0 +1,333 @@
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 { PreferenceRecord } from '../models';
26
+ // @ts-ignore
27
+ import type { UpdatePreference } from '../models';
28
+ /**
29
+ * PreferencesApi - axios parameter creator
30
+ */
31
+ export const PreferencesApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ *
35
+ * @summary GET /v1/subscribers/:id/preferences
36
+ * @param {string} id Subscriber ID
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ listPreferences: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
+ // verify required parameter 'id' is not null or undefined
42
+ assertParamExists('listPreferences', 'id', id)
43
+ const localVarPath = `/v1/subscribers/{id}/preferences/`
44
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication bearer_auth required
57
+ // http bearer authentication required
58
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = 'application/json';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
71
+ /**
72
+ *
73
+ * @summary PATCH /v1/subscribers/:id/preferences
74
+ * @param {string} id Subscriber ID
75
+ * @param {UpdatePreference} updatePreference
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ updateGlobalPreference: async (id: string, updatePreference: UpdatePreference, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
80
+ // verify required parameter 'id' is not null or undefined
81
+ assertParamExists('updateGlobalPreference', 'id', id)
82
+ // verify required parameter 'updatePreference' is not null or undefined
83
+ assertParamExists('updateGlobalPreference', 'updatePreference', updatePreference)
84
+ const localVarPath = `/v1/subscribers/{id}/preferences/`
85
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
86
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
88
+ let baseOptions;
89
+ if (configuration) {
90
+ baseOptions = configuration.baseOptions;
91
+ }
92
+
93
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
94
+ const localVarHeaderParameter = {} as any;
95
+ const localVarQueryParameter = {} as any;
96
+
97
+ // authentication bearer_auth required
98
+ // http bearer authentication required
99
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
100
+
101
+ localVarHeaderParameter['Content-Type'] = 'application/json';
102
+ localVarHeaderParameter['Accept'] = 'application/json';
103
+
104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
+ localVarRequestOptions.data = serializeDataIfNeeded(updatePreference, localVarRequestOptions, configuration)
108
+
109
+ return {
110
+ url: toPathString(localVarUrlObj),
111
+ options: localVarRequestOptions,
112
+ };
113
+ },
114
+ /**
115
+ *
116
+ * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
117
+ * @param {string} id Subscriber ID
118
+ * @param {string} workflowId Workflow ID
119
+ * @param {UpdatePreference} updatePreference
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ updateWorkflowPreference: async (id: string, workflowId: string, updatePreference: UpdatePreference, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
124
+ // verify required parameter 'id' is not null or undefined
125
+ assertParamExists('updateWorkflowPreference', 'id', id)
126
+ // verify required parameter 'workflowId' is not null or undefined
127
+ assertParamExists('updateWorkflowPreference', 'workflowId', workflowId)
128
+ // verify required parameter 'updatePreference' is not null or undefined
129
+ assertParamExists('updateWorkflowPreference', 'updatePreference', updatePreference)
130
+ const localVarPath = `/v1/subscribers/{id}/preferences/{workflow_id}/`
131
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
132
+ .replace(`{${"workflow_id"}}`, encodeURIComponent(String(workflowId)));
133
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
134
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
135
+ let baseOptions;
136
+ if (configuration) {
137
+ baseOptions = configuration.baseOptions;
138
+ }
139
+
140
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
141
+ const localVarHeaderParameter = {} as any;
142
+ const localVarQueryParameter = {} as any;
143
+
144
+ // authentication bearer_auth required
145
+ // http bearer authentication required
146
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
147
+
148
+ localVarHeaderParameter['Content-Type'] = 'application/json';
149
+ localVarHeaderParameter['Accept'] = 'application/json';
150
+
151
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
152
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
153
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
154
+ localVarRequestOptions.data = serializeDataIfNeeded(updatePreference, localVarRequestOptions, configuration)
155
+
156
+ return {
157
+ url: toPathString(localVarUrlObj),
158
+ options: localVarRequestOptions,
159
+ };
160
+ },
161
+ }
162
+ };
163
+
164
+ /**
165
+ * PreferencesApi - functional programming interface
166
+ */
167
+ export const PreferencesApiFp = function(configuration?: Configuration) {
168
+ const localVarAxiosParamCreator = PreferencesApiAxiosParamCreator(configuration)
169
+ return {
170
+ /**
171
+ *
172
+ * @summary GET /v1/subscribers/:id/preferences
173
+ * @param {string} id Subscriber ID
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ async listPreferences(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PreferenceRecord>>> {
178
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPreferences(id, options);
179
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
180
+ const localVarOperationServerBasePath = operationServerMap['PreferencesApi.listPreferences']?.[localVarOperationServerIndex]?.url;
181
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
182
+ },
183
+ /**
184
+ *
185
+ * @summary PATCH /v1/subscribers/:id/preferences
186
+ * @param {string} id Subscriber ID
187
+ * @param {UpdatePreference} updatePreference
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ async updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferenceRecord>> {
192
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateGlobalPreference(id, updatePreference, options);
193
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
194
+ const localVarOperationServerBasePath = operationServerMap['PreferencesApi.updateGlobalPreference']?.[localVarOperationServerIndex]?.url;
195
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
196
+ },
197
+ /**
198
+ *
199
+ * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
200
+ * @param {string} id Subscriber ID
201
+ * @param {string} workflowId Workflow ID
202
+ * @param {UpdatePreference} updatePreference
203
+ * @param {*} [options] Override http request option.
204
+ * @throws {RequiredError}
205
+ */
206
+ async updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferenceRecord>> {
207
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkflowPreference(id, workflowId, updatePreference, options);
208
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
209
+ const localVarOperationServerBasePath = operationServerMap['PreferencesApi.updateWorkflowPreference']?.[localVarOperationServerIndex]?.url;
210
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
211
+ },
212
+ }
213
+ };
214
+
215
+ /**
216
+ * PreferencesApi - factory interface
217
+ */
218
+ export const PreferencesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
219
+ const localVarFp = PreferencesApiFp(configuration)
220
+ return {
221
+ /**
222
+ *
223
+ * @summary GET /v1/subscribers/:id/preferences
224
+ * @param {string} id Subscriber ID
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ */
228
+ listPreferences(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PreferenceRecord>> {
229
+ return localVarFp.listPreferences(id, options).then((request) => request(axios, basePath));
230
+ },
231
+ /**
232
+ *
233
+ * @summary PATCH /v1/subscribers/:id/preferences
234
+ * @param {string} id Subscriber ID
235
+ * @param {UpdatePreference} updatePreference
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ */
239
+ updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord> {
240
+ return localVarFp.updateGlobalPreference(id, updatePreference, options).then((request) => request(axios, basePath));
241
+ },
242
+ /**
243
+ *
244
+ * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
245
+ * @param {string} id Subscriber ID
246
+ * @param {string} workflowId Workflow ID
247
+ * @param {UpdatePreference} updatePreference
248
+ * @param {*} [options] Override http request option.
249
+ * @throws {RequiredError}
250
+ */
251
+ updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord> {
252
+ return localVarFp.updateWorkflowPreference(id, workflowId, updatePreference, options).then((request) => request(axios, basePath));
253
+ },
254
+ };
255
+ };
256
+
257
+ /**
258
+ * PreferencesApi - interface
259
+ */
260
+ export interface PreferencesApiInterface {
261
+ /**
262
+ *
263
+ * @summary GET /v1/subscribers/:id/preferences
264
+ * @param {string} id Subscriber ID
265
+ * @param {*} [options] Override http request option.
266
+ * @throws {RequiredError}
267
+ */
268
+ listPreferences(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PreferenceRecord>>;
269
+
270
+ /**
271
+ *
272
+ * @summary PATCH /v1/subscribers/:id/preferences
273
+ * @param {string} id Subscriber ID
274
+ * @param {UpdatePreference} updatePreference
275
+ * @param {*} [options] Override http request option.
276
+ * @throws {RequiredError}
277
+ */
278
+ updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
279
+
280
+ /**
281
+ *
282
+ * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
283
+ * @param {string} id Subscriber ID
284
+ * @param {string} workflowId Workflow ID
285
+ * @param {UpdatePreference} updatePreference
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
290
+
291
+ }
292
+
293
+ /**
294
+ * PreferencesApi - object-oriented interface
295
+ */
296
+ export class PreferencesApi extends BaseAPI implements PreferencesApiInterface {
297
+ /**
298
+ *
299
+ * @summary GET /v1/subscribers/:id/preferences
300
+ * @param {string} id Subscriber ID
301
+ * @param {*} [options] Override http request option.
302
+ * @throws {RequiredError}
303
+ */
304
+ public listPreferences(id: string, options?: RawAxiosRequestConfig) {
305
+ return PreferencesApiFp(this.configuration).listPreferences(id, options).then((request) => request(this.axios, this.basePath));
306
+ }
307
+
308
+ /**
309
+ *
310
+ * @summary PATCH /v1/subscribers/:id/preferences
311
+ * @param {string} id Subscriber ID
312
+ * @param {UpdatePreference} updatePreference
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ */
316
+ public updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig) {
317
+ return PreferencesApiFp(this.configuration).updateGlobalPreference(id, updatePreference, options).then((request) => request(this.axios, this.basePath));
318
+ }
319
+
320
+ /**
321
+ *
322
+ * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
323
+ * @param {string} id Subscriber ID
324
+ * @param {string} workflowId Workflow ID
325
+ * @param {UpdatePreference} updatePreference
326
+ * @param {*} [options] Override http request option.
327
+ * @throws {RequiredError}
328
+ */
329
+ public updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig) {
330
+ return PreferencesApiFp(this.configuration).updateWorkflowPreference(id, workflowId, updatePreference, options).then((request) => request(this.axios, this.basePath));
331
+ }
332
+ }
333
+