@enbbox/api 1.0.0 → 1.1.0

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 (378) 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/dist/esm/models/init-session-response.d.ts +4 -0
  33. package/dist/models/init-session-response.d.ts +4 -0
  34. package/docs/ActionBody.md +21 -0
  35. package/docs/ActionRecord.md +25 -0
  36. package/docs/ActionType.md +17 -0
  37. package/docs/ActivityApi.md +412 -0
  38. package/docs/ActivityChartPoint.md +31 -0
  39. package/docs/ActivityRecord.md +39 -0
  40. package/docs/ActivityRequestRecord.md +31 -0
  41. package/docs/ActivityStats.md +31 -0
  42. package/docs/ActorType.md +15 -0
  43. package/docs/ApiKeyCreated.md +27 -0
  44. package/docs/ApiKeyInfo.md +27 -0
  45. package/docs/AutoConfigureResult.md +21 -0
  46. package/docs/BillingApi.md +375 -0
  47. package/docs/BillingInterval.md +11 -0
  48. package/docs/Branding.md +31 -0
  49. package/docs/BroadcastTrigger.md +27 -0
  50. package/docs/BulkCreateSubscribers.md +21 -0
  51. package/docs/BulkPreferenceItem.md +24 -0
  52. package/docs/BulkPreferences.md +21 -0
  53. package/docs/BulkResult.md +22 -0
  54. package/docs/BulkTrigger.md +21 -0
  55. package/docs/ChannelConnectionRecord.md +31 -0
  56. package/docs/ChannelConnectionsApi.md +276 -0
  57. package/docs/ChannelEndpointRecord.md +33 -0
  58. package/docs/ChannelEndpointsApi.md +276 -0
  59. package/docs/ChannelPreferences.md +29 -0
  60. package/docs/ChannelType.md +17 -0
  61. package/docs/ChartQuery.md +21 -0
  62. package/docs/ChatOauth.md +21 -0
  63. package/docs/ChatOauthRequest.md +22 -0
  64. package/docs/CheckoutSession.md +23 -0
  65. package/docs/ContextRecord.md +29 -0
  66. package/docs/ContextsApi.md +285 -0
  67. package/docs/CreateChannelConnection.md +27 -0
  68. package/docs/CreateChannelEndpoint.md +29 -0
  69. package/docs/CreateCheckout.md +23 -0
  70. package/docs/CreateContext.md +25 -0
  71. package/docs/CreateIntegration.md +31 -0
  72. package/docs/CreateLayout.md +31 -0
  73. package/docs/CreateNotificationGroup.md +21 -0
  74. package/docs/CreateProject.md +21 -0
  75. package/docs/CreateSubscriber.md +37 -0
  76. package/docs/CreateSubscription.md +21 -0
  77. package/docs/CreateTopic.md +23 -0
  78. package/docs/CreateWebhook.md +23 -0
  79. package/docs/CreateWorkflow.md +35 -0
  80. package/docs/CtaType.md +9 -0
  81. package/docs/CursorMeta.md +27 -0
  82. package/docs/CursorPaginatedFeedItem.md +23 -0
  83. package/docs/CursorPaginatedFeedItemDataInner.md +37 -0
  84. package/docs/CursorPaginatedMessageRecord.md +23 -0
  85. package/docs/CursorPaginatedMessageRecordDataInner.md +41 -0
  86. package/docs/CursorPagination.md +25 -0
  87. package/docs/DeleteSubscription.md +20 -0
  88. package/docs/DeliveryAck.md +21 -0
  89. package/docs/DeliveryStatusWebhook.md +27 -0
  90. package/docs/DnsSettings.md +23 -0
  91. package/docs/EngagementStatsResponse.md +27 -0
  92. package/docs/EntitlementItem.md +25 -0
  93. package/docs/Entitlements.md +21 -0
  94. package/docs/ErrorDetail.md +27 -0
  95. package/docs/EventsApi.md +214 -0
  96. package/docs/EventsUsage.md +23 -0
  97. package/docs/FeatureFlagsApi.md +51 -0
  98. package/docs/FeedItem.md +37 -0
  99. package/docs/FeedQuery.md +31 -0
  100. package/docs/HealthApi.md +140 -0
  101. package/docs/InboundParseApi.md +59 -0
  102. package/docs/InboxApi.md +673 -0
  103. package/docs/InboxNotification.md +41 -0
  104. package/docs/InboxPreference.md +23 -0
  105. package/docs/InboxQuery.md +27 -0
  106. package/docs/InitSessionRequest.md +23 -0
  107. package/docs/InitSessionResponse.md +25 -0
  108. package/docs/IntegrationRecord.md +35 -0
  109. package/docs/IntegrationsApi.md +475 -0
  110. package/docs/InviteMember.md +23 -0
  111. package/docs/InviteMemberBody.md +23 -0
  112. package/docs/JobLog.md +33 -0
  113. package/docs/LayoutPreview.md +21 -0
  114. package/docs/LayoutPreviewResult.md +21 -0
  115. package/docs/LayoutRecord.md +31 -0
  116. package/docs/LayoutUsageItem.md +23 -0
  117. package/docs/LayoutsApi.md +484 -0
  118. package/docs/MarkAll.md +21 -0
  119. package/docs/MarkMessages.md +23 -0
  120. package/docs/MarkResult.md +21 -0
  121. package/docs/MemberRecord.md +27 -0
  122. package/docs/MemberRole.md +15 -0
  123. package/docs/MemberStatus.md +13 -0
  124. package/docs/MessageQuery.md +31 -0
  125. package/docs/MessageRecord.md +41 -0
  126. package/docs/MessagesApi.md +175 -0
  127. package/docs/MetricsApi.md +51 -0
  128. package/docs/NotificationCount.md +25 -0
  129. package/docs/NotificationGroupRecord.md +23 -0
  130. package/docs/NotificationGroupsApi.md +209 -0
  131. package/docs/NotificationLog.md +33 -0
  132. package/docs/NotificationQuery.md +25 -0
  133. package/docs/NotificationsApi.md +166 -0
  134. package/docs/OffsetMeta.md +27 -0
  135. package/docs/OffsetPagination.md +27 -0
  136. package/docs/OnlineStatus.md +21 -0
  137. package/docs/PaginatedChannelConnectionRecord.md +23 -0
  138. package/docs/PaginatedChannelConnectionRecordDataInner.md +31 -0
  139. package/docs/PaginatedChannelEndpointRecord.md +23 -0
  140. package/docs/PaginatedChannelEndpointRecordDataInner.md +33 -0
  141. package/docs/PaginatedContextRecord.md +23 -0
  142. package/docs/PaginatedContextRecordDataInner.md +29 -0
  143. package/docs/PaginatedIntegrationRecord.md +23 -0
  144. package/docs/PaginatedIntegrationRecordDataInner.md +35 -0
  145. package/docs/PaginatedLayoutRecord.md +23 -0
  146. package/docs/PaginatedLayoutRecordDataInner.md +31 -0
  147. package/docs/PaginatedSubscriberRecord.md +23 -0
  148. package/docs/PaginatedSubscriberRecordDataInner.md +41 -0
  149. package/docs/PaginatedTopicRecord.md +23 -0
  150. package/docs/PaginatedTopicRecordDataInner.md +24 -0
  151. package/docs/PaginatedTopicSubscriptionRecord.md +23 -0
  152. package/docs/PaginatedTopicSubscriptionRecordDataInner.md +29 -0
  153. package/docs/PaginatedWorkflowRecord.md +23 -0
  154. package/docs/PaginatedWorkflowRecordDataInner.md +37 -0
  155. package/docs/PaginationQuery.md +25 -0
  156. package/docs/PatchCredentials.md +27 -0
  157. package/docs/Plan.md +17 -0
  158. package/docs/PlanLimitsResponse.md +33 -0
  159. package/docs/PortalUrl.md +21 -0
  160. package/docs/PreferenceChannels.md +29 -0
  161. package/docs/PreferenceRecord.md +27 -0
  162. package/docs/PreferencesApi.md +171 -0
  163. package/docs/PreviewResult.md +20 -0
  164. package/docs/PriceInfo.md +27 -0
  165. package/docs/Prices.md +21 -0
  166. package/docs/ProjectRecord.md +27 -0
  167. package/docs/ProjectsApi.md +638 -0
  168. package/docs/SetCredentials.md +27 -0
  169. package/docs/StepPreview.md +21 -0
  170. package/docs/StepRecord.md +29 -0
  171. package/docs/StepType.md +27 -0
  172. package/docs/SubscriberCredential.md +27 -0
  173. package/docs/SubscriberPayload.md +37 -0
  174. package/docs/SubscriberRecord.md +41 -0
  175. package/docs/SubscribersApi.md +887 -0
  176. package/docs/Subscription.md +39 -0
  177. package/docs/SyncWorkflow.md +21 -0
  178. package/docs/SystemAvatarIcon.md +19 -0
  179. package/docs/TopicRecord.md +24 -0
  180. package/docs/TopicSubscribers.md +21 -0
  181. package/docs/TopicSubscription.md +23 -0
  182. package/docs/TopicSubscriptionRecord.md +29 -0
  183. package/docs/TopicsApi.md +777 -0
  184. package/docs/TranslationsApi.md +258 -0
  185. package/docs/TrialInfo.md +27 -0
  186. package/docs/TriggerEvent.md +31 -0
  187. package/docs/TriggerRecipients.md +39 -0
  188. package/docs/TriggerRecipientsOneOf.md +21 -0
  189. package/docs/TriggerResult.md +25 -0
  190. package/docs/TriggerStatus.md +21 -0
  191. package/docs/UnseenCount.md +21 -0
  192. package/docs/UpdateChannelConnection.md +21 -0
  193. package/docs/UpdateChannelEndpoint.md +23 -0
  194. package/docs/UpdateContext.md +21 -0
  195. package/docs/UpdateInboxPreferences.md +29 -0
  196. package/docs/UpdateIntegration.md +27 -0
  197. package/docs/UpdateLayout.md +27 -0
  198. package/docs/UpdateNotificationGroup.md +21 -0
  199. package/docs/UpdatePreference.md +23 -0
  200. package/docs/UpdateProject.md +23 -0
  201. package/docs/UpdateSubscriber.md +35 -0
  202. package/docs/UpdateSubscriptionMeta.md +21 -0
  203. package/docs/UpdateTopic.md +21 -0
  204. package/docs/UpdateWorkflow.md +31 -0
  205. package/docs/Usage.md +35 -0
  206. package/docs/WebhookRecord.md +31 -0
  207. package/docs/WebhooksApi.md +212 -0
  208. package/docs/WidgetSettings.md +21 -0
  209. package/docs/WorkflowRecord.md +37 -0
  210. package/docs/WorkflowRunRecord.md +31 -0
  211. package/docs/WorkflowStatsResponse.md +27 -0
  212. package/docs/WorkflowStatus.md +21 -0
  213. package/docs/WorkflowStepCreate.md +31 -0
  214. package/docs/WorkflowsApi.md +550 -0
  215. package/git_push.sh +57 -0
  216. package/index.ts +18 -0
  217. package/models/action-body.ts +26 -0
  218. package/models/action-record.ts +28 -0
  219. package/models/action-type.ts +32 -0
  220. package/models/activity-chart-point.ts +46 -0
  221. package/models/activity-record.ts +62 -0
  222. package/models/activity-request-record.ts +46 -0
  223. package/models/activity-stats.ts +46 -0
  224. package/models/actor-type.ts +31 -0
  225. package/models/api-key-created.ts +38 -0
  226. package/models/api-key-info.ts +38 -0
  227. package/models/auto-configure-result.ts +23 -0
  228. package/models/billing-interval.ts +29 -0
  229. package/models/branding.ts +46 -0
  230. package/models/broadcast-trigger.ts +29 -0
  231. package/models/bulk-create-subscribers.ts +26 -0
  232. package/models/bulk-preference-item.ts +25 -0
  233. package/models/bulk-preferences.ts +26 -0
  234. package/models/bulk-result.ts +24 -0
  235. package/models/bulk-trigger.ts +29 -0
  236. package/models/channel-connection-record.ts +43 -0
  237. package/models/channel-endpoint-record.ts +47 -0
  238. package/models/channel-preferences.ts +27 -0
  239. package/models/channel-type.ts +32 -0
  240. package/models/chart-query.ts +26 -0
  241. package/models/chat-oauth-request.ts +21 -0
  242. package/models/chat-oauth.ts +23 -0
  243. package/models/checkout-session.ts +35 -0
  244. package/models/context-record.ts +42 -0
  245. package/models/create-channel-connection.ts +35 -0
  246. package/models/create-channel-endpoint.ts +39 -0
  247. package/models/create-checkout.ts +35 -0
  248. package/models/create-context.ts +34 -0
  249. package/models/create-integration.ts +51 -0
  250. package/models/create-layout.ts +34 -0
  251. package/models/create-notification-group.ts +26 -0
  252. package/models/create-project.ts +26 -0
  253. package/models/create-subscriber.ts +58 -0
  254. package/models/create-subscription.ts +23 -0
  255. package/models/create-topic.ts +30 -0
  256. package/models/create-webhook.ts +30 -0
  257. package/models/create-workflow.ts +60 -0
  258. package/models/cta-type.ts +28 -0
  259. package/models/cursor-meta.ts +38 -0
  260. package/models/cursor-paginated-feed-item-data-inner.ts +40 -0
  261. package/models/cursor-paginated-feed-item.ts +36 -0
  262. package/models/cursor-paginated-message-record-data-inner.ts +45 -0
  263. package/models/cursor-paginated-message-record.ts +36 -0
  264. package/models/cursor-pagination.ts +34 -0
  265. package/models/delete-subscription.ts +20 -0
  266. package/models/delivery-ack.ts +23 -0
  267. package/models/delivery-status-webhook.ts +29 -0
  268. package/models/dns-settings.ts +30 -0
  269. package/models/engagement-stats-response.ts +38 -0
  270. package/models/entitlement-item.ts +34 -0
  271. package/models/entitlements.ts +26 -0
  272. package/models/error-detail.ts +38 -0
  273. package/models/events-usage.ts +30 -0
  274. package/models/feed-item.ts +40 -0
  275. package/models/feed-query.ts +28 -0
  276. package/models/inbox-notification.ts +39 -0
  277. package/models/inbox-preference.ts +27 -0
  278. package/models/inbox-query.ts +26 -0
  279. package/models/index.ts +158 -0
  280. package/models/init-session-request.ts +30 -0
  281. package/models/init-session-response.ts +34 -0
  282. package/models/integration-record.ts +59 -0
  283. package/models/invite-member-body.ts +30 -0
  284. package/models/invite-member.ts +30 -0
  285. package/models/job-log.ts +47 -0
  286. package/models/layout-preview-result.ts +23 -0
  287. package/models/layout-preview.ts +23 -0
  288. package/models/layout-record.ts +37 -0
  289. package/models/layout-usage-item.ts +24 -0
  290. package/models/mark-all.ts +23 -0
  291. package/models/mark-messages.ts +24 -0
  292. package/models/mark-result.ts +23 -0
  293. package/models/member-record.ts +38 -0
  294. package/models/member-role.ts +31 -0
  295. package/models/member-status.ts +30 -0
  296. package/models/message-query.ts +46 -0
  297. package/models/message-record.ts +45 -0
  298. package/models/notification-count.ts +25 -0
  299. package/models/notification-group-record.ts +30 -0
  300. package/models/notification-log.ts +41 -0
  301. package/models/notification-query.ts +34 -0
  302. package/models/offset-meta.ts +38 -0
  303. package/models/offset-pagination.ts +38 -0
  304. package/models/online-status.ts +23 -0
  305. package/models/paginated-channel-connection-record-data-inner.ts +43 -0
  306. package/models/paginated-channel-connection-record.ts +36 -0
  307. package/models/paginated-channel-endpoint-record-data-inner.ts +47 -0
  308. package/models/paginated-channel-endpoint-record.ts +36 -0
  309. package/models/paginated-context-record-data-inner.ts +42 -0
  310. package/models/paginated-context-record.ts +36 -0
  311. package/models/paginated-integration-record-data-inner.ts +59 -0
  312. package/models/paginated-integration-record.ts +36 -0
  313. package/models/paginated-layout-record-data-inner.ts +37 -0
  314. package/models/paginated-layout-record.ts +36 -0
  315. package/models/paginated-subscriber-record-data-inner.ts +69 -0
  316. package/models/paginated-subscriber-record.ts +36 -0
  317. package/models/paginated-topic-record-data-inner.ts +28 -0
  318. package/models/paginated-topic-record.ts +36 -0
  319. package/models/paginated-topic-subscription-record-data-inner.ts +39 -0
  320. package/models/paginated-topic-subscription-record.ts +36 -0
  321. package/models/paginated-workflow-record-data-inner.ts +58 -0
  322. package/models/paginated-workflow-record.ts +36 -0
  323. package/models/pagination-query.ts +34 -0
  324. package/models/patch-credentials.ts +29 -0
  325. package/models/plan-limits-response.ts +55 -0
  326. package/models/plan.ts +32 -0
  327. package/models/portal-url.ts +26 -0
  328. package/models/preference-channels.ts +27 -0
  329. package/models/preference-record.ts +32 -0
  330. package/models/preview-result.ts +20 -0
  331. package/models/price-info.ts +38 -0
  332. package/models/prices.ts +26 -0
  333. package/models/project-record.ts +46 -0
  334. package/models/set-credentials.ts +29 -0
  335. package/models/step-preview.ts +23 -0
  336. package/models/step-record.ts +36 -0
  337. package/models/step-type.ts +37 -0
  338. package/models/subscriber-credential.ts +26 -0
  339. package/models/subscriber-payload.ts +24 -0
  340. package/models/subscriber-record.ts +69 -0
  341. package/models/subscription.ts +73 -0
  342. package/models/sync-workflow.ts +26 -0
  343. package/models/system-avatar-icon.ts +33 -0
  344. package/models/topic-record.ts +28 -0
  345. package/models/topic-subscribers.ts +23 -0
  346. package/models/topic-subscription-record.ts +39 -0
  347. package/models/topic-subscription.ts +27 -0
  348. package/models/trial-info.ts +38 -0
  349. package/models/trigger-event.ts +49 -0
  350. package/models/trigger-recipients-one-of.ts +23 -0
  351. package/models/trigger-recipients.ts +29 -0
  352. package/models/trigger-result.ts +39 -0
  353. package/models/trigger-status.ts +34 -0
  354. package/models/unseen-count.ts +23 -0
  355. package/models/update-channel-connection.ts +23 -0
  356. package/models/update-channel-endpoint.ts +27 -0
  357. package/models/update-context.ts +26 -0
  358. package/models/update-inbox-preferences.ts +27 -0
  359. package/models/update-integration.ts +38 -0
  360. package/models/update-layout.ts +29 -0
  361. package/models/update-notification-group.ts +26 -0
  362. package/models/update-preference.ts +27 -0
  363. package/models/update-project.ts +33 -0
  364. package/models/update-subscriber.ts +54 -0
  365. package/models/update-subscription-meta.ts +23 -0
  366. package/models/update-topic.ts +26 -0
  367. package/models/update-workflow.ts +52 -0
  368. package/models/usage.ts +59 -0
  369. package/models/webhook-record.ts +46 -0
  370. package/models/widget-settings.ts +26 -0
  371. package/models/workflow-record.ts +58 -0
  372. package/models/workflow-run-record.ts +46 -0
  373. package/models/workflow-stats-response.ts +38 -0
  374. package/models/workflow-status.ts +26 -0
  375. package/models/workflow-step-create.ts +51 -0
  376. package/package.json +9 -33
  377. package/tsconfig.esm.json +7 -0
  378. package/tsconfig.json +18 -0
@@ -0,0 +1,510 @@
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 { ChannelEndpointRecord } from '../models';
26
+ // @ts-ignore
27
+ import type { CreateChannelEndpoint } from '../models';
28
+ // @ts-ignore
29
+ import type { PaginatedChannelEndpointRecord } from '../models';
30
+ // @ts-ignore
31
+ import type { UpdateChannelEndpoint } from '../models';
32
+ /**
33
+ * ChannelEndpointsApi - axios parameter creator
34
+ */
35
+ export const ChannelEndpointsApiAxiosParamCreator = function (configuration?: Configuration) {
36
+ return {
37
+ /**
38
+ *
39
+ * @summary POST /v1/channel-endpoints
40
+ * @param {CreateChannelEndpoint} createChannelEndpoint
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ createEndpoint: async (createChannelEndpoint: CreateChannelEndpoint, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
45
+ // verify required parameter 'createChannelEndpoint' is not null or undefined
46
+ assertParamExists('createEndpoint', 'createChannelEndpoint', createChannelEndpoint)
47
+ const localVarPath = `/v1/channel-endpoints/`;
48
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
49
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
50
+ let baseOptions;
51
+ if (configuration) {
52
+ baseOptions = configuration.baseOptions;
53
+ }
54
+
55
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
56
+ const localVarHeaderParameter = {} as any;
57
+ const localVarQueryParameter = {} as any;
58
+
59
+ // authentication bearer_auth required
60
+ // http bearer authentication required
61
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
62
+
63
+ localVarHeaderParameter['Content-Type'] = 'application/json';
64
+ localVarHeaderParameter['Accept'] = 'application/json';
65
+
66
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
67
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
68
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
69
+ localVarRequestOptions.data = serializeDataIfNeeded(createChannelEndpoint, localVarRequestOptions, configuration)
70
+
71
+ return {
72
+ url: toPathString(localVarUrlObj),
73
+ options: localVarRequestOptions,
74
+ };
75
+ },
76
+ /**
77
+ *
78
+ * @summary DELETE /v1/channel-endpoints/:identifier
79
+ * @param {string} id Channel endpoint ID
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ deleteEndpoint: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
84
+ // verify required parameter 'id' is not null or undefined
85
+ assertParamExists('deleteEndpoint', 'id', id)
86
+ const localVarPath = `/v1/channel-endpoints/{id}/`
87
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
88
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
89
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90
+ let baseOptions;
91
+ if (configuration) {
92
+ baseOptions = configuration.baseOptions;
93
+ }
94
+
95
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
96
+ const localVarHeaderParameter = {} as any;
97
+ const localVarQueryParameter = {} as any;
98
+
99
+ // authentication bearer_auth required
100
+ // http bearer authentication required
101
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
102
+
103
+
104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
+
108
+ return {
109
+ url: toPathString(localVarUrlObj),
110
+ options: localVarRequestOptions,
111
+ };
112
+ },
113
+ /**
114
+ *
115
+ * @summary GET /v1/channel-endpoints/:identifier
116
+ * @param {string} id Channel endpoint ID
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ getEndpoint: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
121
+ // verify required parameter 'id' is not null or undefined
122
+ assertParamExists('getEndpoint', 'id', id)
123
+ const localVarPath = `/v1/channel-endpoints/{id}/`
124
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
125
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
126
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
127
+ let baseOptions;
128
+ if (configuration) {
129
+ baseOptions = configuration.baseOptions;
130
+ }
131
+
132
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
133
+ const localVarHeaderParameter = {} as any;
134
+ const localVarQueryParameter = {} as any;
135
+
136
+ // authentication bearer_auth required
137
+ // http bearer authentication required
138
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
139
+
140
+ localVarHeaderParameter['Accept'] = 'application/json';
141
+
142
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
143
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
144
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
145
+
146
+ return {
147
+ url: toPathString(localVarUrlObj),
148
+ options: localVarRequestOptions,
149
+ };
150
+ },
151
+ /**
152
+ *
153
+ * @summary GET /v1/channel-endpoints
154
+ * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
155
+ * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
156
+ * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
157
+ * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ listEndpoints: async (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
162
+ const localVarPath = `/v1/channel-endpoints/`;
163
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
164
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
165
+ let baseOptions;
166
+ if (configuration) {
167
+ baseOptions = configuration.baseOptions;
168
+ }
169
+
170
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
171
+ const localVarHeaderParameter = {} as any;
172
+ const localVarQueryParameter = {} as any;
173
+
174
+ // authentication bearer_auth required
175
+ // http bearer authentication required
176
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
177
+
178
+ if (limit !== undefined) {
179
+ localVarQueryParameter['limit'] = limit;
180
+ }
181
+
182
+ if (offset !== undefined) {
183
+ localVarQueryParameter['offset'] = offset;
184
+ }
185
+
186
+ if (q !== undefined) {
187
+ localVarQueryParameter['q'] = q;
188
+ }
189
+
190
+ if (filterBy !== undefined) {
191
+ localVarQueryParameter['filter_by'] = filterBy;
192
+ }
193
+
194
+ localVarHeaderParameter['Accept'] = 'application/json';
195
+
196
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
197
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
198
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
199
+
200
+ return {
201
+ url: toPathString(localVarUrlObj),
202
+ options: localVarRequestOptions,
203
+ };
204
+ },
205
+ /**
206
+ *
207
+ * @summary PATCH /v1/channel-endpoints/:identifier
208
+ * @param {string} id Channel endpoint ID
209
+ * @param {UpdateChannelEndpoint} updateChannelEndpoint
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ */
213
+ updateEndpoint: async (id: string, updateChannelEndpoint: UpdateChannelEndpoint, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
214
+ // verify required parameter 'id' is not null or undefined
215
+ assertParamExists('updateEndpoint', 'id', id)
216
+ // verify required parameter 'updateChannelEndpoint' is not null or undefined
217
+ assertParamExists('updateEndpoint', 'updateChannelEndpoint', updateChannelEndpoint)
218
+ const localVarPath = `/v1/channel-endpoints/{id}/`
219
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
220
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
221
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
222
+ let baseOptions;
223
+ if (configuration) {
224
+ baseOptions = configuration.baseOptions;
225
+ }
226
+
227
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
228
+ const localVarHeaderParameter = {} as any;
229
+ const localVarQueryParameter = {} as any;
230
+
231
+ // authentication bearer_auth required
232
+ // http bearer authentication required
233
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
234
+
235
+ localVarHeaderParameter['Content-Type'] = 'application/json';
236
+ localVarHeaderParameter['Accept'] = 'application/json';
237
+
238
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
239
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
240
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
241
+ localVarRequestOptions.data = serializeDataIfNeeded(updateChannelEndpoint, localVarRequestOptions, configuration)
242
+
243
+ return {
244
+ url: toPathString(localVarUrlObj),
245
+ options: localVarRequestOptions,
246
+ };
247
+ },
248
+ }
249
+ };
250
+
251
+ /**
252
+ * ChannelEndpointsApi - functional programming interface
253
+ */
254
+ export const ChannelEndpointsApiFp = function(configuration?: Configuration) {
255
+ const localVarAxiosParamCreator = ChannelEndpointsApiAxiosParamCreator(configuration)
256
+ return {
257
+ /**
258
+ *
259
+ * @summary POST /v1/channel-endpoints
260
+ * @param {CreateChannelEndpoint} createChannelEndpoint
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ */
264
+ async createEndpoint(createChannelEndpoint: CreateChannelEndpoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelEndpointRecord>> {
265
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createEndpoint(createChannelEndpoint, options);
266
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
267
+ const localVarOperationServerBasePath = operationServerMap['ChannelEndpointsApi.createEndpoint']?.[localVarOperationServerIndex]?.url;
268
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
269
+ },
270
+ /**
271
+ *
272
+ * @summary DELETE /v1/channel-endpoints/:identifier
273
+ * @param {string} id Channel endpoint ID
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ async deleteEndpoint(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
278
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteEndpoint(id, options);
279
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
280
+ const localVarOperationServerBasePath = operationServerMap['ChannelEndpointsApi.deleteEndpoint']?.[localVarOperationServerIndex]?.url;
281
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
282
+ },
283
+ /**
284
+ *
285
+ * @summary GET /v1/channel-endpoints/:identifier
286
+ * @param {string} id Channel endpoint ID
287
+ * @param {*} [options] Override http request option.
288
+ * @throws {RequiredError}
289
+ */
290
+ async getEndpoint(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelEndpointRecord>> {
291
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEndpoint(id, options);
292
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
293
+ const localVarOperationServerBasePath = operationServerMap['ChannelEndpointsApi.getEndpoint']?.[localVarOperationServerIndex]?.url;
294
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
295
+ },
296
+ /**
297
+ *
298
+ * @summary GET /v1/channel-endpoints
299
+ * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
300
+ * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
301
+ * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
302
+ * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
303
+ * @param {*} [options] Override http request option.
304
+ * @throws {RequiredError}
305
+ */
306
+ async listEndpoints(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedChannelEndpointRecord>> {
307
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEndpoints(limit, offset, q, filterBy, options);
308
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
309
+ const localVarOperationServerBasePath = operationServerMap['ChannelEndpointsApi.listEndpoints']?.[localVarOperationServerIndex]?.url;
310
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
311
+ },
312
+ /**
313
+ *
314
+ * @summary PATCH /v1/channel-endpoints/:identifier
315
+ * @param {string} id Channel endpoint ID
316
+ * @param {UpdateChannelEndpoint} updateChannelEndpoint
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ async updateEndpoint(id: string, updateChannelEndpoint: UpdateChannelEndpoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelEndpointRecord>> {
321
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateEndpoint(id, updateChannelEndpoint, options);
322
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
323
+ const localVarOperationServerBasePath = operationServerMap['ChannelEndpointsApi.updateEndpoint']?.[localVarOperationServerIndex]?.url;
324
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
325
+ },
326
+ }
327
+ };
328
+
329
+ /**
330
+ * ChannelEndpointsApi - factory interface
331
+ */
332
+ export const ChannelEndpointsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
333
+ const localVarFp = ChannelEndpointsApiFp(configuration)
334
+ return {
335
+ /**
336
+ *
337
+ * @summary POST /v1/channel-endpoints
338
+ * @param {CreateChannelEndpoint} createChannelEndpoint
339
+ * @param {*} [options] Override http request option.
340
+ * @throws {RequiredError}
341
+ */
342
+ createEndpoint(createChannelEndpoint: CreateChannelEndpoint, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord> {
343
+ return localVarFp.createEndpoint(createChannelEndpoint, options).then((request) => request(axios, basePath));
344
+ },
345
+ /**
346
+ *
347
+ * @summary DELETE /v1/channel-endpoints/:identifier
348
+ * @param {string} id Channel endpoint ID
349
+ * @param {*} [options] Override http request option.
350
+ * @throws {RequiredError}
351
+ */
352
+ deleteEndpoint(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
353
+ return localVarFp.deleteEndpoint(id, options).then((request) => request(axios, basePath));
354
+ },
355
+ /**
356
+ *
357
+ * @summary GET /v1/channel-endpoints/:identifier
358
+ * @param {string} id Channel endpoint ID
359
+ * @param {*} [options] Override http request option.
360
+ * @throws {RequiredError}
361
+ */
362
+ getEndpoint(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord> {
363
+ return localVarFp.getEndpoint(id, options).then((request) => request(axios, basePath));
364
+ },
365
+ /**
366
+ *
367
+ * @summary GET /v1/channel-endpoints
368
+ * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
369
+ * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
370
+ * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
371
+ * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
372
+ * @param {*} [options] Override http request option.
373
+ * @throws {RequiredError}
374
+ */
375
+ listEndpoints(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedChannelEndpointRecord> {
376
+ return localVarFp.listEndpoints(limit, offset, q, filterBy, options).then((request) => request(axios, basePath));
377
+ },
378
+ /**
379
+ *
380
+ * @summary PATCH /v1/channel-endpoints/:identifier
381
+ * @param {string} id Channel endpoint ID
382
+ * @param {UpdateChannelEndpoint} updateChannelEndpoint
383
+ * @param {*} [options] Override http request option.
384
+ * @throws {RequiredError}
385
+ */
386
+ updateEndpoint(id: string, updateChannelEndpoint: UpdateChannelEndpoint, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord> {
387
+ return localVarFp.updateEndpoint(id, updateChannelEndpoint, options).then((request) => request(axios, basePath));
388
+ },
389
+ };
390
+ };
391
+
392
+ /**
393
+ * ChannelEndpointsApi - interface
394
+ */
395
+ export interface ChannelEndpointsApiInterface {
396
+ /**
397
+ *
398
+ * @summary POST /v1/channel-endpoints
399
+ * @param {CreateChannelEndpoint} createChannelEndpoint
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ */
403
+ createEndpoint(createChannelEndpoint: CreateChannelEndpoint, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord>;
404
+
405
+ /**
406
+ *
407
+ * @summary DELETE /v1/channel-endpoints/:identifier
408
+ * @param {string} id Channel endpoint ID
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ */
412
+ deleteEndpoint(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
413
+
414
+ /**
415
+ *
416
+ * @summary GET /v1/channel-endpoints/:identifier
417
+ * @param {string} id Channel endpoint ID
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ */
421
+ getEndpoint(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord>;
422
+
423
+ /**
424
+ *
425
+ * @summary GET /v1/channel-endpoints
426
+ * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
427
+ * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
428
+ * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
429
+ * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
430
+ * @param {*} [options] Override http request option.
431
+ * @throws {RequiredError}
432
+ */
433
+ listEndpoints(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedChannelEndpointRecord>;
434
+
435
+ /**
436
+ *
437
+ * @summary PATCH /v1/channel-endpoints/:identifier
438
+ * @param {string} id Channel endpoint ID
439
+ * @param {UpdateChannelEndpoint} updateChannelEndpoint
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ updateEndpoint(id: string, updateChannelEndpoint: UpdateChannelEndpoint, options?: RawAxiosRequestConfig): AxiosPromise<ChannelEndpointRecord>;
444
+
445
+ }
446
+
447
+ /**
448
+ * ChannelEndpointsApi - object-oriented interface
449
+ */
450
+ export class ChannelEndpointsApi extends BaseAPI implements ChannelEndpointsApiInterface {
451
+ /**
452
+ *
453
+ * @summary POST /v1/channel-endpoints
454
+ * @param {CreateChannelEndpoint} createChannelEndpoint
455
+ * @param {*} [options] Override http request option.
456
+ * @throws {RequiredError}
457
+ */
458
+ public createEndpoint(createChannelEndpoint: CreateChannelEndpoint, options?: RawAxiosRequestConfig) {
459
+ return ChannelEndpointsApiFp(this.configuration).createEndpoint(createChannelEndpoint, options).then((request) => request(this.axios, this.basePath));
460
+ }
461
+
462
+ /**
463
+ *
464
+ * @summary DELETE /v1/channel-endpoints/:identifier
465
+ * @param {string} id Channel endpoint ID
466
+ * @param {*} [options] Override http request option.
467
+ * @throws {RequiredError}
468
+ */
469
+ public deleteEndpoint(id: string, options?: RawAxiosRequestConfig) {
470
+ return ChannelEndpointsApiFp(this.configuration).deleteEndpoint(id, options).then((request) => request(this.axios, this.basePath));
471
+ }
472
+
473
+ /**
474
+ *
475
+ * @summary GET /v1/channel-endpoints/:identifier
476
+ * @param {string} id Channel endpoint ID
477
+ * @param {*} [options] Override http request option.
478
+ * @throws {RequiredError}
479
+ */
480
+ public getEndpoint(id: string, options?: RawAxiosRequestConfig) {
481
+ return ChannelEndpointsApiFp(this.configuration).getEndpoint(id, options).then((request) => request(this.axios, this.basePath));
482
+ }
483
+
484
+ /**
485
+ *
486
+ * @summary GET /v1/channel-endpoints
487
+ * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
488
+ * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
489
+ * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
490
+ * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
491
+ * @param {*} [options] Override http request option.
492
+ * @throws {RequiredError}
493
+ */
494
+ public listEndpoints(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) {
495
+ return ChannelEndpointsApiFp(this.configuration).listEndpoints(limit, offset, q, filterBy, options).then((request) => request(this.axios, this.basePath));
496
+ }
497
+
498
+ /**
499
+ *
500
+ * @summary PATCH /v1/channel-endpoints/:identifier
501
+ * @param {string} id Channel endpoint ID
502
+ * @param {UpdateChannelEndpoint} updateChannelEndpoint
503
+ * @param {*} [options] Override http request option.
504
+ * @throws {RequiredError}
505
+ */
506
+ public updateEndpoint(id: string, updateChannelEndpoint: UpdateChannelEndpoint, options?: RawAxiosRequestConfig) {
507
+ return ChannelEndpointsApiFp(this.configuration).updateEndpoint(id, updateChannelEndpoint, options).then((request) => request(this.axios, this.basePath));
508
+ }
509
+ }
510
+