@enbbox/api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +375 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +2 -2
- package/api/activity-api.ts +756 -0
- package/api/billing-api.ts +673 -0
- package/api/channel-connections-api.ts +510 -0
- package/api/channel-endpoints-api.ts +510 -0
- package/api/contexts-api.ts +534 -0
- package/api/events-api.ts +394 -0
- package/api/feature-flags-api.ts +132 -0
- package/api/health-api.ts +264 -0
- package/api/inbound-parse-api.ts +137 -0
- package/api/inbox-api.ts +1151 -0
- package/api/integrations-api.ts +833 -0
- package/api/layouts-api.ts +849 -0
- package/api/messages-api.ts +349 -0
- package/api/metrics-api.ts +128 -0
- package/api/notification-groups-api.ts +391 -0
- package/api/notifications-api.ts +326 -0
- package/api/preferences-api.ts +333 -0
- package/api/projects-api.ts +1075 -0
- package/api/subscribers-api.ts +1542 -0
- package/api/topics-api.ts +1352 -0
- package/api/translations-api.ts +462 -0
- package/api/webhooks-api.ts +397 -0
- package/api/workflows-api.ts +970 -0
- package/api.ts +40 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/docs/ActionBody.md +21 -0
- package/docs/ActionRecord.md +25 -0
- package/docs/ActionType.md +17 -0
- package/docs/ActivityApi.md +412 -0
- package/docs/ActivityChartPoint.md +31 -0
- package/docs/ActivityRecord.md +39 -0
- package/docs/ActivityRequestRecord.md +31 -0
- package/docs/ActivityStats.md +31 -0
- package/docs/ActorType.md +15 -0
- package/docs/ApiKeyCreated.md +27 -0
- package/docs/ApiKeyInfo.md +27 -0
- package/docs/AutoConfigureResult.md +21 -0
- package/docs/BillingApi.md +375 -0
- package/docs/BillingInterval.md +11 -0
- package/docs/Branding.md +31 -0
- package/docs/BroadcastTrigger.md +27 -0
- package/docs/BulkCreateSubscribers.md +21 -0
- package/docs/BulkPreferenceItem.md +24 -0
- package/docs/BulkPreferences.md +21 -0
- package/docs/BulkResult.md +22 -0
- package/docs/BulkTrigger.md +21 -0
- package/docs/ChannelConnectionRecord.md +31 -0
- package/docs/ChannelConnectionsApi.md +276 -0
- package/docs/ChannelEndpointRecord.md +33 -0
- package/docs/ChannelEndpointsApi.md +276 -0
- package/docs/ChannelPreferences.md +29 -0
- package/docs/ChannelType.md +17 -0
- package/docs/ChartQuery.md +21 -0
- package/docs/ChatOauth.md +21 -0
- package/docs/ChatOauthRequest.md +22 -0
- package/docs/CheckoutSession.md +23 -0
- package/docs/ContextRecord.md +29 -0
- package/docs/ContextsApi.md +285 -0
- package/docs/CreateChannelConnection.md +27 -0
- package/docs/CreateChannelEndpoint.md +29 -0
- package/docs/CreateCheckout.md +23 -0
- package/docs/CreateContext.md +25 -0
- package/docs/CreateIntegration.md +31 -0
- package/docs/CreateLayout.md +31 -0
- package/docs/CreateNotificationGroup.md +21 -0
- package/docs/CreateProject.md +21 -0
- package/docs/CreateSubscriber.md +37 -0
- package/docs/CreateSubscription.md +21 -0
- package/docs/CreateTopic.md +23 -0
- package/docs/CreateWebhook.md +23 -0
- package/docs/CreateWorkflow.md +35 -0
- package/docs/CtaType.md +9 -0
- package/docs/CursorMeta.md +27 -0
- package/docs/CursorPaginatedFeedItem.md +23 -0
- package/docs/CursorPaginatedFeedItemDataInner.md +37 -0
- package/docs/CursorPaginatedMessageRecord.md +23 -0
- package/docs/CursorPaginatedMessageRecordDataInner.md +41 -0
- package/docs/CursorPagination.md +25 -0
- package/docs/DeleteSubscription.md +20 -0
- package/docs/DeliveryAck.md +21 -0
- package/docs/DeliveryStatusWebhook.md +27 -0
- package/docs/DnsSettings.md +23 -0
- package/docs/EngagementStatsResponse.md +27 -0
- package/docs/EntitlementItem.md +25 -0
- package/docs/Entitlements.md +21 -0
- package/docs/ErrorDetail.md +27 -0
- package/docs/EventsApi.md +214 -0
- package/docs/EventsUsage.md +23 -0
- package/docs/FeatureFlagsApi.md +51 -0
- package/docs/FeedItem.md +37 -0
- package/docs/FeedQuery.md +31 -0
- package/docs/HealthApi.md +140 -0
- package/docs/InboundParseApi.md +59 -0
- package/docs/InboxApi.md +673 -0
- package/docs/InboxNotification.md +41 -0
- package/docs/InboxPreference.md +23 -0
- package/docs/InboxQuery.md +27 -0
- package/docs/InitSessionRequest.md +23 -0
- package/docs/InitSessionResponse.md +23 -0
- package/docs/IntegrationRecord.md +35 -0
- package/docs/IntegrationsApi.md +475 -0
- package/docs/InviteMember.md +23 -0
- package/docs/InviteMemberBody.md +23 -0
- package/docs/JobLog.md +33 -0
- package/docs/LayoutPreview.md +21 -0
- package/docs/LayoutPreviewResult.md +21 -0
- package/docs/LayoutRecord.md +31 -0
- package/docs/LayoutUsageItem.md +23 -0
- package/docs/LayoutsApi.md +484 -0
- package/docs/MarkAll.md +21 -0
- package/docs/MarkMessages.md +23 -0
- package/docs/MarkResult.md +21 -0
- package/docs/MemberRecord.md +27 -0
- package/docs/MemberRole.md +15 -0
- package/docs/MemberStatus.md +13 -0
- package/docs/MessageQuery.md +31 -0
- package/docs/MessageRecord.md +41 -0
- package/docs/MessagesApi.md +175 -0
- package/docs/MetricsApi.md +51 -0
- package/docs/NotificationCount.md +25 -0
- package/docs/NotificationGroupRecord.md +23 -0
- package/docs/NotificationGroupsApi.md +209 -0
- package/docs/NotificationLog.md +33 -0
- package/docs/NotificationQuery.md +25 -0
- package/docs/NotificationsApi.md +166 -0
- package/docs/OffsetMeta.md +27 -0
- package/docs/OffsetPagination.md +27 -0
- package/docs/OnlineStatus.md +21 -0
- package/docs/PaginatedChannelConnectionRecord.md +23 -0
- package/docs/PaginatedChannelConnectionRecordDataInner.md +31 -0
- package/docs/PaginatedChannelEndpointRecord.md +23 -0
- package/docs/PaginatedChannelEndpointRecordDataInner.md +33 -0
- package/docs/PaginatedContextRecord.md +23 -0
- package/docs/PaginatedContextRecordDataInner.md +29 -0
- package/docs/PaginatedIntegrationRecord.md +23 -0
- package/docs/PaginatedIntegrationRecordDataInner.md +35 -0
- package/docs/PaginatedLayoutRecord.md +23 -0
- package/docs/PaginatedLayoutRecordDataInner.md +31 -0
- package/docs/PaginatedSubscriberRecord.md +23 -0
- package/docs/PaginatedSubscriberRecordDataInner.md +41 -0
- package/docs/PaginatedTopicRecord.md +23 -0
- package/docs/PaginatedTopicRecordDataInner.md +24 -0
- package/docs/PaginatedTopicSubscriptionRecord.md +23 -0
- package/docs/PaginatedTopicSubscriptionRecordDataInner.md +29 -0
- package/docs/PaginatedWorkflowRecord.md +23 -0
- package/docs/PaginatedWorkflowRecordDataInner.md +37 -0
- package/docs/PaginationQuery.md +25 -0
- package/docs/PatchCredentials.md +27 -0
- package/docs/Plan.md +17 -0
- package/docs/PlanLimitsResponse.md +33 -0
- package/docs/PortalUrl.md +21 -0
- package/docs/PreferenceChannels.md +29 -0
- package/docs/PreferenceRecord.md +27 -0
- package/docs/PreferencesApi.md +171 -0
- package/docs/PreviewResult.md +20 -0
- package/docs/PriceInfo.md +27 -0
- package/docs/Prices.md +21 -0
- package/docs/ProjectRecord.md +27 -0
- package/docs/ProjectsApi.md +638 -0
- package/docs/SetCredentials.md +27 -0
- package/docs/StepPreview.md +21 -0
- package/docs/StepRecord.md +29 -0
- package/docs/StepType.md +27 -0
- package/docs/SubscriberCredential.md +27 -0
- package/docs/SubscriberPayload.md +37 -0
- package/docs/SubscriberRecord.md +41 -0
- package/docs/SubscribersApi.md +887 -0
- package/docs/Subscription.md +39 -0
- package/docs/SyncWorkflow.md +21 -0
- package/docs/SystemAvatarIcon.md +19 -0
- package/docs/TopicRecord.md +24 -0
- package/docs/TopicSubscribers.md +21 -0
- package/docs/TopicSubscription.md +23 -0
- package/docs/TopicSubscriptionRecord.md +29 -0
- package/docs/TopicsApi.md +777 -0
- package/docs/TranslationsApi.md +258 -0
- package/docs/TrialInfo.md +27 -0
- package/docs/TriggerEvent.md +31 -0
- package/docs/TriggerRecipients.md +39 -0
- package/docs/TriggerRecipientsOneOf.md +21 -0
- package/docs/TriggerResult.md +25 -0
- package/docs/TriggerStatus.md +21 -0
- package/docs/UnseenCount.md +21 -0
- package/docs/UpdateChannelConnection.md +21 -0
- package/docs/UpdateChannelEndpoint.md +23 -0
- package/docs/UpdateContext.md +21 -0
- package/docs/UpdateInboxPreferences.md +29 -0
- package/docs/UpdateIntegration.md +27 -0
- package/docs/UpdateLayout.md +27 -0
- package/docs/UpdateNotificationGroup.md +21 -0
- package/docs/UpdatePreference.md +23 -0
- package/docs/UpdateProject.md +23 -0
- package/docs/UpdateSubscriber.md +35 -0
- package/docs/UpdateSubscriptionMeta.md +21 -0
- package/docs/UpdateTopic.md +21 -0
- package/docs/UpdateWorkflow.md +31 -0
- package/docs/Usage.md +35 -0
- package/docs/WebhookRecord.md +31 -0
- package/docs/WebhooksApi.md +212 -0
- package/docs/WidgetSettings.md +21 -0
- package/docs/WorkflowRecord.md +37 -0
- package/docs/WorkflowRunRecord.md +31 -0
- package/docs/WorkflowStatsResponse.md +27 -0
- package/docs/WorkflowStatus.md +21 -0
- package/docs/WorkflowStepCreate.md +31 -0
- package/docs/WorkflowsApi.md +550 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/models/action-body.ts +26 -0
- package/models/action-record.ts +28 -0
- package/models/action-type.ts +32 -0
- package/models/activity-chart-point.ts +46 -0
- package/models/activity-record.ts +62 -0
- package/models/activity-request-record.ts +46 -0
- package/models/activity-stats.ts +46 -0
- package/models/actor-type.ts +31 -0
- package/models/api-key-created.ts +38 -0
- package/models/api-key-info.ts +38 -0
- package/models/auto-configure-result.ts +23 -0
- package/models/billing-interval.ts +29 -0
- package/models/branding.ts +46 -0
- package/models/broadcast-trigger.ts +29 -0
- package/models/bulk-create-subscribers.ts +26 -0
- package/models/bulk-preference-item.ts +25 -0
- package/models/bulk-preferences.ts +26 -0
- package/models/bulk-result.ts +24 -0
- package/models/bulk-trigger.ts +29 -0
- package/models/channel-connection-record.ts +43 -0
- package/models/channel-endpoint-record.ts +47 -0
- package/models/channel-preferences.ts +27 -0
- package/models/channel-type.ts +32 -0
- package/models/chart-query.ts +26 -0
- package/models/chat-oauth-request.ts +21 -0
- package/models/chat-oauth.ts +23 -0
- package/models/checkout-session.ts +35 -0
- package/models/context-record.ts +42 -0
- package/models/create-channel-connection.ts +35 -0
- package/models/create-channel-endpoint.ts +39 -0
- package/models/create-checkout.ts +35 -0
- package/models/create-context.ts +34 -0
- package/models/create-integration.ts +51 -0
- package/models/create-layout.ts +34 -0
- package/models/create-notification-group.ts +26 -0
- package/models/create-project.ts +26 -0
- package/models/create-subscriber.ts +58 -0
- package/models/create-subscription.ts +23 -0
- package/models/create-topic.ts +30 -0
- package/models/create-webhook.ts +30 -0
- package/models/create-workflow.ts +60 -0
- package/models/cta-type.ts +28 -0
- package/models/cursor-meta.ts +38 -0
- package/models/cursor-paginated-feed-item-data-inner.ts +40 -0
- package/models/cursor-paginated-feed-item.ts +36 -0
- package/models/cursor-paginated-message-record-data-inner.ts +45 -0
- package/models/cursor-paginated-message-record.ts +36 -0
- package/models/cursor-pagination.ts +34 -0
- package/models/delete-subscription.ts +20 -0
- package/models/delivery-ack.ts +23 -0
- package/models/delivery-status-webhook.ts +29 -0
- package/models/dns-settings.ts +30 -0
- package/models/engagement-stats-response.ts +38 -0
- package/models/entitlement-item.ts +34 -0
- package/models/entitlements.ts +26 -0
- package/models/error-detail.ts +38 -0
- package/models/events-usage.ts +30 -0
- package/models/feed-item.ts +40 -0
- package/models/feed-query.ts +28 -0
- package/models/inbox-notification.ts +39 -0
- package/models/inbox-preference.ts +27 -0
- package/models/inbox-query.ts +26 -0
- package/models/index.ts +158 -0
- package/models/init-session-request.ts +30 -0
- package/models/init-session-response.ts +30 -0
- package/models/integration-record.ts +59 -0
- package/models/invite-member-body.ts +30 -0
- package/models/invite-member.ts +30 -0
- package/models/job-log.ts +47 -0
- package/models/layout-preview-result.ts +23 -0
- package/models/layout-preview.ts +23 -0
- package/models/layout-record.ts +37 -0
- package/models/layout-usage-item.ts +24 -0
- package/models/mark-all.ts +23 -0
- package/models/mark-messages.ts +24 -0
- package/models/mark-result.ts +23 -0
- package/models/member-record.ts +38 -0
- package/models/member-role.ts +31 -0
- package/models/member-status.ts +30 -0
- package/models/message-query.ts +46 -0
- package/models/message-record.ts +45 -0
- package/models/notification-count.ts +25 -0
- package/models/notification-group-record.ts +30 -0
- package/models/notification-log.ts +41 -0
- package/models/notification-query.ts +34 -0
- package/models/offset-meta.ts +38 -0
- package/models/offset-pagination.ts +38 -0
- package/models/online-status.ts +23 -0
- package/models/paginated-channel-connection-record-data-inner.ts +43 -0
- package/models/paginated-channel-connection-record.ts +36 -0
- package/models/paginated-channel-endpoint-record-data-inner.ts +47 -0
- package/models/paginated-channel-endpoint-record.ts +36 -0
- package/models/paginated-context-record-data-inner.ts +42 -0
- package/models/paginated-context-record.ts +36 -0
- package/models/paginated-integration-record-data-inner.ts +59 -0
- package/models/paginated-integration-record.ts +36 -0
- package/models/paginated-layout-record-data-inner.ts +37 -0
- package/models/paginated-layout-record.ts +36 -0
- package/models/paginated-subscriber-record-data-inner.ts +69 -0
- package/models/paginated-subscriber-record.ts +36 -0
- package/models/paginated-topic-record-data-inner.ts +28 -0
- package/models/paginated-topic-record.ts +36 -0
- package/models/paginated-topic-subscription-record-data-inner.ts +39 -0
- package/models/paginated-topic-subscription-record.ts +36 -0
- package/models/paginated-workflow-record-data-inner.ts +58 -0
- package/models/paginated-workflow-record.ts +36 -0
- package/models/pagination-query.ts +34 -0
- package/models/patch-credentials.ts +29 -0
- package/models/plan-limits-response.ts +55 -0
- package/models/plan.ts +32 -0
- package/models/portal-url.ts +26 -0
- package/models/preference-channels.ts +27 -0
- package/models/preference-record.ts +32 -0
- package/models/preview-result.ts +20 -0
- package/models/price-info.ts +38 -0
- package/models/prices.ts +26 -0
- package/models/project-record.ts +46 -0
- package/models/set-credentials.ts +29 -0
- package/models/step-preview.ts +23 -0
- package/models/step-record.ts +36 -0
- package/models/step-type.ts +37 -0
- package/models/subscriber-credential.ts +26 -0
- package/models/subscriber-payload.ts +24 -0
- package/models/subscriber-record.ts +69 -0
- package/models/subscription.ts +73 -0
- package/models/sync-workflow.ts +26 -0
- package/models/system-avatar-icon.ts +33 -0
- package/models/topic-record.ts +28 -0
- package/models/topic-subscribers.ts +23 -0
- package/models/topic-subscription-record.ts +39 -0
- package/models/topic-subscription.ts +27 -0
- package/models/trial-info.ts +38 -0
- package/models/trigger-event.ts +49 -0
- package/models/trigger-recipients-one-of.ts +23 -0
- package/models/trigger-recipients.ts +29 -0
- package/models/trigger-result.ts +39 -0
- package/models/trigger-status.ts +34 -0
- package/models/unseen-count.ts +23 -0
- package/models/update-channel-connection.ts +23 -0
- package/models/update-channel-endpoint.ts +27 -0
- package/models/update-context.ts +26 -0
- package/models/update-inbox-preferences.ts +27 -0
- package/models/update-integration.ts +38 -0
- package/models/update-layout.ts +29 -0
- package/models/update-notification-group.ts +26 -0
- package/models/update-preference.ts +27 -0
- package/models/update-project.ts +33 -0
- package/models/update-subscriber.ts +54 -0
- package/models/update-subscription-meta.ts +23 -0
- package/models/update-topic.ts +26 -0
- package/models/update-workflow.ts +52 -0
- package/models/usage.ts +59 -0
- package/models/webhook-record.ts +46 -0
- package/models/widget-settings.ts +26 -0
- package/models/workflow-record.ts +58 -0
- package/models/workflow-run-record.ts +46 -0
- package/models/workflow-stats-response.ts +38 -0
- package/models/workflow-status.ts +26 -0
- package/models/workflow-step-create.ts +51 -0
- package/package.json +9 -33
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -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: `identifier:=acme-corp` or `name:=General`.
|
|
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: `identifier:=acme-corp` or `name:=General`.
|
|
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: `identifier:=acme-corp` or `name:=General`.
|
|
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: `identifier:=acme-corp` or `name:=General`.
|
|
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: `identifier:=acme-corp` or `name:=General`.
|
|
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
|
+
|