@enbbox/api 1.0.0

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

@@ -0,0 +1,278 @@
+/**
+ * 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 { ContextRecord } from '../models';
+import type { CreateContext } from '../models';
+import type { PaginatedContextRecord } from '../models';
+import type { UpdateContext } from '../models';
+/**
+ * ContextsApi - axios parameter creator
+ */
+export declare const ContextsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/contexts
+     * @param {CreateContext} createContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createContext: (createContext: CreateContext, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteContext: (type: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/contexts/:type/:id
+     * @param {string} type Context type
+     * @param {string} id Context ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getContext: (type: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/contexts — list contexts
+     * @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}
+     */
+    listContexts: (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {UpdateContext} updateContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateContext: (type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ContextsApi - functional programming interface
+ */
+export declare const ContextsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/contexts
+     * @param {CreateContext} createContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>>;
+    /**
+     *
+     * @summary DELETE /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary GET /v1/contexts/:type/:id
+     * @param {string} type Context type
+     * @param {string} id Context ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>>;
+    /**
+     *
+     * @summary GET /v1/contexts — list contexts
+     * @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}
+     */
+    listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedContextRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {UpdateContext} updateContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextRecord>>;
+};
+/**
+ * ContextsApi - factory interface
+ */
+export declare const ContextsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary POST /v1/contexts
+     * @param {CreateContext} createContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+    /**
+     *
+     * @summary DELETE /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/contexts/:type/:id
+     * @param {string} type Context type
+     * @param {string} id Context ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+    /**
+     *
+     * @summary GET /v1/contexts — list contexts
+     * @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}
+     */
+    listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedContextRecord>;
+    /**
+     *
+     * @summary PATCH /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {UpdateContext} updateContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+};
+/**
+ * ContextsApi - interface
+ */
+export interface ContextsApiInterface {
+    /**
+     *
+     * @summary POST /v1/contexts
+     * @param {CreateContext} createContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+    /**
+     *
+     * @summary DELETE /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/contexts/:type/:id
+     * @param {string} type Context type
+     * @param {string} id Context ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getContext(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+    /**
+     *
+     * @summary GET /v1/contexts — list contexts
+     * @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}
+     */
+    listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedContextRecord>;
+    /**
+     *
+     * @summary PATCH /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {UpdateContext} updateContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): AxiosPromise<ContextRecord>;
+}
+/**
+ * ContextsApi - object-oriented interface
+ */
+export declare class ContextsApi extends BaseAPI implements ContextsApiInterface {
+    /**
+     *
+     * @summary POST /v1/contexts
+     * @param {CreateContext} createContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createContext(createContext: CreateContext, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextRecord, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/contexts/:type/:id
+     * @param {string} type Context type
+     * @param {string} id Context ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getContext(type: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/contexts — list contexts
+     * @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}
+     */
+    listContexts(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedContextRecord, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/contexts/:type/:id
+     * @param {string} type
+     * @param {string} id
+     * @param {UpdateContext} updateContext
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateContext(type: string, id: string, updateContext: UpdateContext, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextRecord, any, {}>>;
+}