@enbbox/api 1.0.0 → 1.1.0

package/api/webhooks-api.ts

@@ -0,0 +1,397 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { CreateWebhook } from '../models';
+// @ts-ignore
+import type { DeliveryAck } from '../models';
+// @ts-ignore
+import type { DeliveryStatusWebhook } from '../models';
+// @ts-ignore
+import type { WebhookRecord } from '../models';
+/**
+ * WebhooksApi - axios parameter creator
+ */
+export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary DELETE /v1/webhooks/:id
+         * @param {string} id Webhook ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteWebhook: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteWebhook', 'id', id)
+            const localVarPath = `/v1/webhooks/{id}/`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+         * @param {string} projectId 
+         * @param {string} integrationId 
+         * @param {DeliveryStatusWebhook} deliveryStatusWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        inboundDeliveryWebhook: async (projectId: string, integrationId: string, deliveryStatusWebhook: DeliveryStatusWebhook, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'projectId' is not null or undefined
+            assertParamExists('inboundDeliveryWebhook', 'projectId', projectId)
+            // verify required parameter 'integrationId' is not null or undefined
+            assertParamExists('inboundDeliveryWebhook', 'integrationId', integrationId)
+            // verify required parameter 'deliveryStatusWebhook' is not null or undefined
+            assertParamExists('inboundDeliveryWebhook', 'deliveryStatusWebhook', deliveryStatusWebhook)
+            const localVarPath = `/v1/inbound-webhooks/delivery-providers/{project_id}/{integration_id}/`
+                .replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)))
+                .replace(`{${"integration_id"}}`, encodeURIComponent(String(integrationId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(deliveryStatusWebhook, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary GET /v1/webhooks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listWebhooks: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/v1/webhooks/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary POST /v1/webhooks
+         * @param {CreateWebhook} createWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        registerWebhook: async (createWebhook: CreateWebhook, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createWebhook' is not null or undefined
+            assertParamExists('registerWebhook', 'createWebhook', createWebhook)
+            const localVarPath = `/v1/webhooks/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createWebhook, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * WebhooksApi - functional programming interface
+ */
+export const WebhooksApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary DELETE /v1/webhooks/:id
+         * @param {string} id Webhook ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWebhook(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['WebhooksApi.deleteWebhook']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+         * @param {string} projectId 
+         * @param {string} integrationId 
+         * @param {DeliveryStatusWebhook} deliveryStatusWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async inboundDeliveryWebhook(projectId: string, integrationId: string, deliveryStatusWebhook: DeliveryStatusWebhook, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeliveryAck>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.inboundDeliveryWebhook(projectId, integrationId, deliveryStatusWebhook, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['WebhooksApi.inboundDeliveryWebhook']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary GET /v1/webhooks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listWebhooks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WebhookRecord>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listWebhooks(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['WebhooksApi.listWebhooks']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary POST /v1/webhooks
+         * @param {CreateWebhook} createWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async registerWebhook(createWebhook: CreateWebhook, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRecord>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.registerWebhook(createWebhook, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['WebhooksApi.registerWebhook']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * WebhooksApi - factory interface
+ */
+export const WebhooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = WebhooksApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary DELETE /v1/webhooks/:id
+         * @param {string} id Webhook ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteWebhook(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+         * @param {string} projectId 
+         * @param {string} integrationId 
+         * @param {DeliveryStatusWebhook} deliveryStatusWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        inboundDeliveryWebhook(projectId: string, integrationId: string, deliveryStatusWebhook: DeliveryStatusWebhook, options?: RawAxiosRequestConfig): AxiosPromise<DeliveryAck> {
+            return localVarFp.inboundDeliveryWebhook(projectId, integrationId, deliveryStatusWebhook, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary GET /v1/webhooks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<Array<WebhookRecord>> {
+            return localVarFp.listWebhooks(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary POST /v1/webhooks
+         * @param {CreateWebhook} createWebhook 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        registerWebhook(createWebhook: CreateWebhook, options?: RawAxiosRequestConfig): AxiosPromise<WebhookRecord> {
+            return localVarFp.registerWebhook(createWebhook, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * WebhooksApi - interface
+ */
+export interface WebhooksApiInterface {
+    /**
+     * 
+     * @summary DELETE /v1/webhooks/:id
+     * @param {string} id Webhook ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
+    /**
+     * 
+     * @summary POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+     * @param {string} projectId 
+     * @param {string} integrationId 
+     * @param {DeliveryStatusWebhook} deliveryStatusWebhook 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inboundDeliveryWebhook(projectId: string, integrationId: string, deliveryStatusWebhook: DeliveryStatusWebhook, options?: RawAxiosRequestConfig): AxiosPromise<DeliveryAck>;
+
+    /**
+     * 
+     * @summary GET /v1/webhooks
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<Array<WebhookRecord>>;
+
+    /**
+     * 
+     * @summary POST /v1/webhooks
+     * @param {CreateWebhook} createWebhook 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    registerWebhook(createWebhook: CreateWebhook, options?: RawAxiosRequestConfig): AxiosPromise<WebhookRecord>;
+
+}
+
+/**
+ * WebhooksApi - object-oriented interface
+ */
+export class WebhooksApi extends BaseAPI implements WebhooksApiInterface {
+    /**
+     * 
+     * @summary DELETE /v1/webhooks/:id
+     * @param {string} id Webhook ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public deleteWebhook(id: string, options?: RawAxiosRequestConfig) {
+        return WebhooksApiFp(this.configuration).deleteWebhook(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id
+     * @param {string} projectId 
+     * @param {string} integrationId 
+     * @param {DeliveryStatusWebhook} deliveryStatusWebhook 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public inboundDeliveryWebhook(projectId: string, integrationId: string, deliveryStatusWebhook: DeliveryStatusWebhook, options?: RawAxiosRequestConfig) {
+        return WebhooksApiFp(this.configuration).inboundDeliveryWebhook(projectId, integrationId, deliveryStatusWebhook, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary GET /v1/webhooks
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listWebhooks(options?: RawAxiosRequestConfig) {
+        return WebhooksApiFp(this.configuration).listWebhooks(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary POST /v1/webhooks
+     * @param {CreateWebhook} createWebhook 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public registerWebhook(createWebhook: CreateWebhook, options?: RawAxiosRequestConfig) {
+        return WebhooksApiFp(this.configuration).registerWebhook(createWebhook, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+