@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.
- 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/dist/esm/models/init-session-response.d.ts +4 -0
- package/dist/models/init-session-response.d.ts +4 -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 +25 -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 +34 -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,534 @@
|
|
|
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 { ContextRecord } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { CreateContext } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { PaginatedContextRecord } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { UpdateContext } from '../models';
|
|
32
|
+
/**
|
|
33
|
+
* ContextsApi - axios parameter creator
|
|
34
|
+
*/
|
|
35
|
+
export const ContextsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @summary POST /v1/contexts
|
|
40
|
+
* @param {CreateContext} createContext
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
createContext: async (createContext: CreateContext, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45
|
+
// verify required parameter 'createContext' is not null or undefined
|
|
46
|
+
assertParamExists('createContext', 'createContext', createContext)
|
|
47
|
+
const localVarPath = `/v1/contexts/`;
|
|
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(createContext, localVarRequestOptions, configuration)
|
|
70
|
+
|
|
71
|
+
return {
|
|
72
|
+
url: toPathString(localVarUrlObj),
|
|
73
|
+
options: localVarRequestOptions,
|
|
74
|
+
};
|
|
75
|
+
},
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @summary DELETE /v1/contexts/:type/:id
|
|
79
|
+
* @param {string} type
|
|
80
|
+
* @param {string} id
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
deleteContext: async (type: string, id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
85
|
+
// verify required parameter 'type' is not null or undefined
|
|
86
|
+
assertParamExists('deleteContext', 'type', type)
|
|
87
|
+
// verify required parameter 'id' is not null or undefined
|
|
88
|
+
assertParamExists('deleteContext', 'id', id)
|
|
89
|
+
const localVarPath = `/v1/contexts/{type}/{id}/`
|
|
90
|
+
.replace(`{${"type"}}`, encodeURIComponent(String(type)))
|
|
91
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
92
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
93
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
94
|
+
let baseOptions;
|
|
95
|
+
if (configuration) {
|
|
96
|
+
baseOptions = configuration.baseOptions;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
100
|
+
const localVarHeaderParameter = {} as any;
|
|
101
|
+
const localVarQueryParameter = {} as any;
|
|
102
|
+
|
|
103
|
+
// authentication bearer_auth required
|
|
104
|
+
// http bearer authentication required
|
|
105
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
109
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
110
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
111
|
+
|
|
112
|
+
return {
|
|
113
|
+
url: toPathString(localVarUrlObj),
|
|
114
|
+
options: localVarRequestOptions,
|
|
115
|
+
};
|
|
116
|
+
},
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @summary GET /v1/contexts/:type/:id
|
|
120
|
+
* @param {string} type Context type
|
|
121
|
+
* @param {string} id Context ID
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
getContext: async (type: string, id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
126
|
+
// verify required parameter 'type' is not null or undefined
|
|
127
|
+
assertParamExists('getContext', 'type', type)
|
|
128
|
+
// verify required parameter 'id' is not null or undefined
|
|
129
|
+
assertParamExists('getContext', 'id', id)
|
|
130
|
+
const localVarPath = `/v1/contexts/{type}/{id}/`
|
|
131
|
+
.replace(`{${"type"}}`, encodeURIComponent(String(type)))
|
|
132
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
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: 'GET', ...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['Accept'] = 'application/json';
|
|
149
|
+
|
|
150
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
151
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
153
|
+
|
|
154
|
+
return {
|
|
155
|
+
url: toPathString(localVarUrlObj),
|
|
156
|
+
options: localVarRequestOptions,
|
|
157
|
+
};
|
|
158
|
+
},
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @summary GET /v1/contexts — list contexts
|
|
162
|
+
* @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
|
|
163
|
+
* @param {number | null} [offset] Number of items to skip before returning results (default: 0).
|
|
164
|
+
* @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
|
|
165
|
+
* @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
listContexts: async (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
170
|
+
const localVarPath = `/v1/contexts/`;
|
|
171
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
172
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
173
|
+
let baseOptions;
|
|
174
|
+
if (configuration) {
|
|
175
|
+
baseOptions = configuration.baseOptions;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
179
|
+
const localVarHeaderParameter = {} as any;
|
|
180
|
+
const localVarQueryParameter = {} as any;
|
|
181
|
+
|
|
182
|
+
// authentication bearer_auth required
|
|
183
|
+
// http bearer authentication required
|
|
184
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
185
|
+
|
|
186
|
+
if (limit !== undefined) {
|
|
187
|
+
localVarQueryParameter['limit'] = limit;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
if (offset !== undefined) {
|
|
191
|
+
localVarQueryParameter['offset'] = offset;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
if (q !== undefined) {
|
|
195
|
+
localVarQueryParameter['q'] = q;
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
if (filterBy !== undefined) {
|
|
199
|
+
localVarQueryParameter['filter_by'] = filterBy;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
203
|
+
|
|
204
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
205
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
206
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
207
|
+
|
|
208
|
+
return {
|
|
209
|
+
url: toPathString(localVarUrlObj),
|
|
210
|
+
options: localVarRequestOptions,
|
|
211
|
+
};
|
|
212
|
+
},
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @summary PATCH /v1/contexts/:type/:id
|
|
216
|
+
* @param {string} type
|
|
217
|
+
* @param {string} id
|
|
218
|
+
* @param {UpdateContext} updateContext
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
updateContext: async (type: string, id: string, updateContext: UpdateContext, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
223
|
+
// verify required parameter 'type' is not null or undefined
|
|
224
|
+
assertParamExists('updateContext', 'type', type)
|
|
225
|
+
// verify required parameter 'id' is not null or undefined
|
|
226
|
+
assertParamExists('updateContext', 'id', id)
|
|
227
|
+
// verify required parameter 'updateContext' is not null or undefined
|
|
228
|
+
assertParamExists('updateContext', 'updateContext', updateContext)
|
|
229
|
+
const localVarPath = `/v1/contexts/{type}/{id}/`
|
|
230
|
+
.replace(`{${"type"}}`, encodeURIComponent(String(type)))
|
|
231
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
232
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
233
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
234
|
+
let baseOptions;
|
|
235
|
+
if (configuration) {
|
|
236
|
+
baseOptions = configuration.baseOptions;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
240
|
+
const localVarHeaderParameter = {} as any;
|
|
241
|
+
const localVarQueryParameter = {} as any;
|
|
242
|
+
|
|
243
|
+
// authentication bearer_auth required
|
|
244
|
+
// http bearer authentication required
|
|
245
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
246
|
+
|
|
247
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
248
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
249
|
+
|
|
250
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
251
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
252
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
253
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateContext, localVarRequestOptions, configuration)
|
|
254
|
+
|
|
255
|
+
return {
|
|
256
|
+
url: toPathString(localVarUrlObj),
|
|
257
|
+
options: localVarRequestOptions,
|
|
258
|
+
};
|
|
259
|
+
},
|
|
260
|
+
}
|
|
261
|
+
};
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* ContextsApi - functional programming interface
|
|
265
|
+
*/
|
|
266
|
+
export const ContextsApiFp = function(configuration?: Configuration) {
|
|
267
|
+
const localVarAxiosParamCreator = ContextsApiAxiosParamCreator(configuration)
|
|
268
|
+
return {
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @summary POST /v1/contexts
|
|
272
|
+
* @param {CreateContext} createContext
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
async createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>> {
|
|
277
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createContext(createContext, options);
|
|
278
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
279
|
+
const localVarOperationServerBasePath = operationServerMap['ContextsApi.createContext']?.[localVarOperationServerIndex]?.url;
|
|
280
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
281
|
+
},
|
|
282
|
+
/**
|
|
283
|
+
*
|
|
284
|
+
* @summary DELETE /v1/contexts/:type/:id
|
|
285
|
+
* @param {string} type
|
|
286
|
+
* @param {string} id
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
*/
|
|
290
|
+
async deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
291
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteContext(type, id, options);
|
|
292
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
293
|
+
const localVarOperationServerBasePath = operationServerMap['ContextsApi.deleteContext']?.[localVarOperationServerIndex]?.url;
|
|
294
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
295
|
+
},
|
|
296
|
+
/**
|
|
297
|
+
*
|
|
298
|
+
* @summary GET /v1/contexts/:type/:id
|
|
299
|
+
* @param {string} type Context type
|
|
300
|
+
* @param {string} id Context ID
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
async getContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>> {
|
|
305
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getContext(type, id, options);
|
|
306
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
307
|
+
const localVarOperationServerBasePath = operationServerMap['ContextsApi.getContext']?.[localVarOperationServerIndex]?.url;
|
|
308
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
309
|
+
},
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @summary GET /v1/contexts — list contexts
|
|
313
|
+
* @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
|
|
314
|
+
* @param {number | null} [offset] Number of items to skip before returning results (default: 0).
|
|
315
|
+
* @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
|
|
316
|
+
* @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`.
|
|
317
|
+
* @param {*} [options] Override http request option.
|
|
318
|
+
* @throws {RequiredError}
|
|
319
|
+
*/
|
|
320
|
+
async listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedContextRecord>> {
|
|
321
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listContexts(limit, offset, q, filterBy, options);
|
|
322
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
323
|
+
const localVarOperationServerBasePath = operationServerMap['ContextsApi.listContexts']?.[localVarOperationServerIndex]?.url;
|
|
324
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
325
|
+
},
|
|
326
|
+
/**
|
|
327
|
+
*
|
|
328
|
+
* @summary PATCH /v1/contexts/:type/:id
|
|
329
|
+
* @param {string} type
|
|
330
|
+
* @param {string} id
|
|
331
|
+
* @param {UpdateContext} updateContext
|
|
332
|
+
* @param {*} [options] Override http request option.
|
|
333
|
+
* @throws {RequiredError}
|
|
334
|
+
*/
|
|
335
|
+
async updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>> {
|
|
336
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateContext(type, id, updateContext, options);
|
|
337
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
338
|
+
const localVarOperationServerBasePath = operationServerMap['ContextsApi.updateContext']?.[localVarOperationServerIndex]?.url;
|
|
339
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
340
|
+
},
|
|
341
|
+
}
|
|
342
|
+
};
|
|
343
|
+
|
|
344
|
+
/**
|
|
345
|
+
* ContextsApi - factory interface
|
|
346
|
+
*/
|
|
347
|
+
export const ContextsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
348
|
+
const localVarFp = ContextsApiFp(configuration)
|
|
349
|
+
return {
|
|
350
|
+
/**
|
|
351
|
+
*
|
|
352
|
+
* @summary POST /v1/contexts
|
|
353
|
+
* @param {CreateContext} createContext
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord> {
|
|
358
|
+
return localVarFp.createContext(createContext, options).then((request) => request(axios, basePath));
|
|
359
|
+
},
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @summary DELETE /v1/contexts/:type/:id
|
|
363
|
+
* @param {string} type
|
|
364
|
+
* @param {string} id
|
|
365
|
+
* @param {*} [options] Override http request option.
|
|
366
|
+
* @throws {RequiredError}
|
|
367
|
+
*/
|
|
368
|
+
deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
369
|
+
return localVarFp.deleteContext(type, id, options).then((request) => request(axios, basePath));
|
|
370
|
+
},
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @summary GET /v1/contexts/:type/:id
|
|
374
|
+
* @param {string} type Context type
|
|
375
|
+
* @param {string} id Context ID
|
|
376
|
+
* @param {*} [options] Override http request option.
|
|
377
|
+
* @throws {RequiredError}
|
|
378
|
+
*/
|
|
379
|
+
getContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord> {
|
|
380
|
+
return localVarFp.getContext(type, id, options).then((request) => request(axios, basePath));
|
|
381
|
+
},
|
|
382
|
+
/**
|
|
383
|
+
*
|
|
384
|
+
* @summary GET /v1/contexts — list contexts
|
|
385
|
+
* @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
|
|
386
|
+
* @param {number | null} [offset] Number of items to skip before returning results (default: 0).
|
|
387
|
+
* @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
|
|
388
|
+
* @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`.
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedContextRecord> {
|
|
393
|
+
return localVarFp.listContexts(limit, offset, q, filterBy, options).then((request) => request(axios, basePath));
|
|
394
|
+
},
|
|
395
|
+
/**
|
|
396
|
+
*
|
|
397
|
+
* @summary PATCH /v1/contexts/:type/:id
|
|
398
|
+
* @param {string} type
|
|
399
|
+
* @param {string} id
|
|
400
|
+
* @param {UpdateContext} updateContext
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord> {
|
|
405
|
+
return localVarFp.updateContext(type, id, updateContext, options).then((request) => request(axios, basePath));
|
|
406
|
+
},
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* ContextsApi - interface
|
|
412
|
+
*/
|
|
413
|
+
export interface ContextsApiInterface {
|
|
414
|
+
/**
|
|
415
|
+
*
|
|
416
|
+
* @summary POST /v1/contexts
|
|
417
|
+
* @param {CreateContext} createContext
|
|
418
|
+
* @param {*} [options] Override http request option.
|
|
419
|
+
* @throws {RequiredError}
|
|
420
|
+
*/
|
|
421
|
+
createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
*
|
|
425
|
+
* @summary DELETE /v1/contexts/:type/:id
|
|
426
|
+
* @param {string} type
|
|
427
|
+
* @param {string} id
|
|
428
|
+
* @param {*} [options] Override http request option.
|
|
429
|
+
* @throws {RequiredError}
|
|
430
|
+
*/
|
|
431
|
+
deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @summary GET /v1/contexts/:type/:id
|
|
436
|
+
* @param {string} type Context type
|
|
437
|
+
* @param {string} id Context ID
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
*/
|
|
441
|
+
getContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
*
|
|
445
|
+
* @summary GET /v1/contexts — list contexts
|
|
446
|
+
* @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
|
|
447
|
+
* @param {number | null} [offset] Number of items to skip before returning results (default: 0).
|
|
448
|
+
* @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
|
|
449
|
+
* @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`.
|
|
450
|
+
* @param {*} [options] Override http request option.
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
*/
|
|
453
|
+
listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedContextRecord>;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @summary PATCH /v1/contexts/:type/:id
|
|
458
|
+
* @param {string} type
|
|
459
|
+
* @param {string} id
|
|
460
|
+
* @param {UpdateContext} updateContext
|
|
461
|
+
* @param {*} [options] Override http request option.
|
|
462
|
+
* @throws {RequiredError}
|
|
463
|
+
*/
|
|
464
|
+
updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
|
|
465
|
+
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* ContextsApi - object-oriented interface
|
|
470
|
+
*/
|
|
471
|
+
export class ContextsApi extends BaseAPI implements ContextsApiInterface {
|
|
472
|
+
/**
|
|
473
|
+
*
|
|
474
|
+
* @summary POST /v1/contexts
|
|
475
|
+
* @param {CreateContext} createContext
|
|
476
|
+
* @param {*} [options] Override http request option.
|
|
477
|
+
* @throws {RequiredError}
|
|
478
|
+
*/
|
|
479
|
+
public createContext(createContext: CreateContext, options?: RawAxiosRequestConfig) {
|
|
480
|
+
return ContextsApiFp(this.configuration).createContext(createContext, options).then((request) => request(this.axios, this.basePath));
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
*
|
|
485
|
+
* @summary DELETE /v1/contexts/:type/:id
|
|
486
|
+
* @param {string} type
|
|
487
|
+
* @param {string} id
|
|
488
|
+
* @param {*} [options] Override http request option.
|
|
489
|
+
* @throws {RequiredError}
|
|
490
|
+
*/
|
|
491
|
+
public deleteContext(type: string, id: string, options?: RawAxiosRequestConfig) {
|
|
492
|
+
return ContextsApiFp(this.configuration).deleteContext(type, id, options).then((request) => request(this.axios, this.basePath));
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
/**
|
|
496
|
+
*
|
|
497
|
+
* @summary GET /v1/contexts/:type/:id
|
|
498
|
+
* @param {string} type Context type
|
|
499
|
+
* @param {string} id Context ID
|
|
500
|
+
* @param {*} [options] Override http request option.
|
|
501
|
+
* @throws {RequiredError}
|
|
502
|
+
*/
|
|
503
|
+
public getContext(type: string, id: string, options?: RawAxiosRequestConfig) {
|
|
504
|
+
return ContextsApiFp(this.configuration).getContext(type, id, options).then((request) => request(this.axios, this.basePath));
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @summary GET /v1/contexts — list contexts
|
|
510
|
+
* @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
|
|
511
|
+
* @param {number | null} [offset] Number of items to skip before returning results (default: 0).
|
|
512
|
+
* @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
|
|
513
|
+
* @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`.
|
|
514
|
+
* @param {*} [options] Override http request option.
|
|
515
|
+
* @throws {RequiredError}
|
|
516
|
+
*/
|
|
517
|
+
public listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) {
|
|
518
|
+
return ContextsApiFp(this.configuration).listContexts(limit, offset, q, filterBy, options).then((request) => request(this.axios, this.basePath));
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @summary PATCH /v1/contexts/:type/:id
|
|
524
|
+
* @param {string} type
|
|
525
|
+
* @param {string} id
|
|
526
|
+
* @param {UpdateContext} updateContext
|
|
527
|
+
* @param {*} [options] Override http request option.
|
|
528
|
+
* @throws {RequiredError}
|
|
529
|
+
*/
|
|
530
|
+
public updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig) {
|
|
531
|
+
return ContextsApiFp(this.configuration).updateContext(type, id, updateContext, options).then((request) => request(this.axios, this.basePath));
|
|
532
|
+
}
|
|
533
|
+
}
|
|
534
|
+
|