@enbbox/api 1.0.0

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

@@ -0,0 +1,381 @@
+/**
+ * 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 { ActivityChartPoint } from '../models';
+import type { ActivityRecord } from '../models';
+import type { ActivityRequestRecord } from '../models';
+import type { ActivityStats } from '../models';
+import type { EngagementStatsResponse } from '../models';
+import type { WorkflowRunRecord } from '../models';
+import type { WorkflowStatsResponse } from '../models';
+/**
+ * ActivityApi - axios parameter creator
+ */
+export declare const ActivityApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/activity/chart — activity chart data
+     * @param {number | null} [days] Number of days to include in the chart (1–365, default: 30).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityChart: (days?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/engagement — subscriber engagement stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    engagementStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/:notificationId
+     * @param {string} notificationId Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivityByNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivity: (limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/requests — list trigger requests
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityRequests: (limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/workflow-runs — list workflow executions
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflowRuns: (limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/activity/workflows/stats — workflow execution stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    workflowStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ActivityApi - functional programming interface
+ */
+export declare const ActivityApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/activity/chart — activity chart data
+     * @param {number | null} [days] Number of days to include in the chart (1–365, default: 30).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityChart(days?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ActivityChartPoint>>>;
+    /**
+     *
+     * @summary GET /v1/activity/stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityStats>>;
+    /**
+     *
+     * @summary GET /v1/activity/engagement — subscriber engagement stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    engagementStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EngagementStatsResponse>>;
+    /**
+     *
+     * @summary GET /v1/activity/:notificationId
+     * @param {string} notificationId Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivityByNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ActivityRecord>>>;
+    /**
+     *
+     * @summary GET /v1/activity
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivity(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ActivityRecord>>>;
+    /**
+     *
+     * @summary GET /v1/activity/requests — list trigger requests
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityRequests(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ActivityRequestRecord>>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflow-runs — list workflow executions
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflowRuns(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRunRecord>>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflows/stats — workflow execution stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    workflowStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowStatsResponse>>;
+};
+/**
+ * ActivityApi - factory interface
+ */
+export declare const ActivityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary GET /v1/activity/chart — activity chart data
+     * @param {number | null} [days] Number of days to include in the chart (1–365, default: 30).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityChart(days?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityChartPoint>>;
+    /**
+     *
+     * @summary GET /v1/activity/stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityStats(options?: RawAxiosRequestConfig): AxiosPromise<ActivityStats>;
+    /**
+     *
+     * @summary GET /v1/activity/engagement — subscriber engagement stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    engagementStats(options?: RawAxiosRequestConfig): AxiosPromise<EngagementStatsResponse>;
+    /**
+     *
+     * @summary GET /v1/activity/:notificationId
+     * @param {string} notificationId Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivityByNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivity(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/requests — list trigger requests
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityRequests(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRequestRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflow-runs — list workflow executions
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflowRuns(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRunRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflows/stats — workflow execution stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    workflowStats(options?: RawAxiosRequestConfig): AxiosPromise<WorkflowStatsResponse>;
+};
+/**
+ * ActivityApi - interface
+ */
+export interface ActivityApiInterface {
+    /**
+     *
+     * @summary GET /v1/activity/chart — activity chart data
+     * @param {number | null} [days] Number of days to include in the chart (1–365, default: 30).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityChart(days?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityChartPoint>>;
+    /**
+     *
+     * @summary GET /v1/activity/stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityStats(options?: RawAxiosRequestConfig): AxiosPromise<ActivityStats>;
+    /**
+     *
+     * @summary GET /v1/activity/engagement — subscriber engagement stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    engagementStats(options?: RawAxiosRequestConfig): AxiosPromise<EngagementStatsResponse>;
+    /**
+     *
+     * @summary GET /v1/activity/:notificationId
+     * @param {string} notificationId Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivityByNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivity(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/requests — list trigger requests
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityRequests(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ActivityRequestRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflow-runs — list workflow executions
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflowRuns(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRunRecord>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflows/stats — workflow execution stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    workflowStats(options?: RawAxiosRequestConfig): AxiosPromise<WorkflowStatsResponse>;
+}
+/**
+ * ActivityApi - object-oriented interface
+ */
+export declare class ActivityApi extends BaseAPI implements ActivityApiInterface {
+    /**
+     *
+     * @summary GET /v1/activity/chart — activity chart data
+     * @param {number | null} [days] Number of days to include in the chart (1–365, default: 30).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityChart(days?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityChartPoint[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activityStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityStats, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/engagement — subscriber engagement stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    engagementStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EngagementStatsResponse, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/:notificationId
+     * @param {string} notificationId Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivityByNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityRecord[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivity(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityRecord[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/requests — list trigger requests
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityRequests(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityRequestRecord[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflow-runs — list workflow executions
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflowRuns(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRunRecord[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/activity/workflows/stats — workflow execution stats
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    workflowStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowStatsResponse, any, {}>>;
+}