@enbbox/api 1.0.0

package/dist/esm/api/integrations-api.d.ts

@@ -0,0 +1,420 @@
+/**
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { ChatOauth } from '../models';
+import type { ChatOauthRequest } from '../models';
+import type { CreateIntegration } from '../models';
+import type { IntegrationRecord } from '../models';
+import type { PaginatedIntegrationRecord } from '../models';
+import type { UpdateIntegration } from '../models';
+/**
+ * IntegrationsApi - axios parameter creator
+ */
+export declare const IntegrationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    autoConfigure: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+     * @param {ChatOauthRequest} chatOauthRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    chatOauth: (chatOauthRequest: ChatOauthRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/integrations
+     * @param {CreateIntegration} createIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createIntegration: (createIntegration: CreateIntegration, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteIntegration: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegration: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/integrations/active — list only active integrations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActiveIntegrations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/integrations
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listIntegrations: (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id/set-primary
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimary: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {UpdateIntegration} updateIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntegration: (id: string, updateIntegration: UpdateIntegration, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * IntegrationsApi - functional programming interface
+ */
+export declare const IntegrationsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    autoConfigure(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationRecord>>;
+    /**
+     *
+     * @summary POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+     * @param {ChatOauthRequest} chatOauthRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    chatOauth(chatOauthRequest: ChatOauthRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatOauth>>;
+    /**
+     *
+     * @summary POST /v1/integrations
+     * @param {CreateIntegration} createIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createIntegration(createIntegration: CreateIntegration, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationRecord>>;
+    /**
+     *
+     * @summary DELETE /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteIntegration(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary GET /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegration(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationRecord>>;
+    /**
+     *
+     * @summary GET /v1/integrations/active — list only active integrations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActiveIntegrations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IntegrationRecord>>>;
+    /**
+     *
+     * @summary GET /v1/integrations
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listIntegrations(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedIntegrationRecord>>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id/set-primary
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimary(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationRecord>>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {UpdateIntegration} updateIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntegration(id: string, updateIntegration: UpdateIntegration, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationRecord>>;
+};
+/**
+ * IntegrationsApi - factory interface
+ */
+export declare const IntegrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    autoConfigure(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+     * @param {ChatOauthRequest} chatOauthRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    chatOauth(chatOauthRequest: ChatOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatOauth>;
+    /**
+     *
+     * @summary POST /v1/integrations
+     * @param {CreateIntegration} createIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createIntegration(createIntegration: CreateIntegration, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary DELETE /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteIntegration(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegration(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary GET /v1/integrations/active — list only active integrations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActiveIntegrations(options?: RawAxiosRequestConfig): AxiosPromise<Array<IntegrationRecord>>;
+    /**
+     *
+     * @summary GET /v1/integrations
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listIntegrations(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedIntegrationRecord>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id/set-primary
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimary(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {UpdateIntegration} updateIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntegration(id: string, updateIntegration: UpdateIntegration, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+};
+/**
+ * IntegrationsApi - interface
+ */
+export interface IntegrationsApiInterface {
+    /**
+     *
+     * @summary POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    autoConfigure(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+     * @param {ChatOauthRequest} chatOauthRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    chatOauth(chatOauthRequest: ChatOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatOauth>;
+    /**
+     *
+     * @summary POST /v1/integrations
+     * @param {CreateIntegration} createIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createIntegration(createIntegration: CreateIntegration, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary DELETE /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteIntegration(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegration(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary GET /v1/integrations/active — list only active integrations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActiveIntegrations(options?: RawAxiosRequestConfig): AxiosPromise<Array<IntegrationRecord>>;
+    /**
+     *
+     * @summary GET /v1/integrations
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listIntegrations(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedIntegrationRecord>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id/set-primary
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimary(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {UpdateIntegration} updateIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntegration(id: string, updateIntegration: UpdateIntegration, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationRecord>;
+}
+/**
+ * IntegrationsApi - object-oriented interface
+ */
+export declare class IntegrationsApi extends BaseAPI implements IntegrationsApiInterface {
+    /**
+     *
+     * @summary POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    autoConfigure(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers
+     * @param {ChatOauthRequest} chatOauthRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    chatOauth(chatOauthRequest: ChatOauthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatOauth, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/integrations
+     * @param {CreateIntegration} createIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createIntegration(createIntegration: CreateIntegration, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteIntegration(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIntegration(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/integrations/active — list only active integrations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActiveIntegrations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/integrations
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listIntegrations(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedIntegrationRecord, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id/set-primary
+     * @param {string} id Integration ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimary(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/integrations/:id
+     * @param {string} id Integration ID
+     * @param {UpdateIntegration} updateIntegration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntegration(id: string, updateIntegration: UpdateIntegration, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationRecord, any, {}>>;
+}