@zyphr-dev/node-sdk 0.1.0 → 0.1.1

package/src/src/apis/WaaSDeliveriesApi.ts

@@ -0,0 +1,361 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ListWaaSEndpointDeliveries200Response,
+} from '../models/index';
+import {
+    ListWaaSEndpointDeliveries200ResponseFromJSON,
+    ListWaaSEndpointDeliveries200ResponseToJSON,
+} from '../models/index';
+
+export interface WaaSDeliveriesApiGetWaaSDeliveryRequest {
+    appId: string;
+    deliveryId: string;
+}
+
+export interface WaaSDeliveriesApiListWaaSDeliveriesRequest {
+    appId: string;
+    limit?: number;
+    offset?: number;
+    tenantId?: string;
+    eventType?: string;
+    status?: ListWaaSDeliveriesStatusEnum;
+}
+
+export interface WaaSDeliveriesApiListWaaSEndpointDeliveriesRequest {
+    appId: string;
+    endpointId: string;
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+
+export interface WaaSDeliveriesApiRetryWaaSDeliveryRequest {
+    appId: string;
+    deliveryId: string;
+}
+
+/**
+ * WaaSDeliveriesApi - interface
+ * 
+ * @export
+ * @interface WaaSDeliveriesApiInterface
+ */
+export interface WaaSDeliveriesApiInterface {
+    /**
+     * Get full delivery details including request/response data.
+     * @summary Get delivery detail
+     * @param {string} appId 
+     * @param {string} deliveryId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSDeliveriesApiInterface
+     */
+    getWaaSDeliveryRaw(requestParameters: WaaSDeliveriesApiGetWaaSDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Get full delivery details including request/response data.
+     * Get delivery detail
+     */
+    getWaaSDelivery(appId: string, deliveryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * List delivery records for a WaaS application. Filter by tenant, event type, or status.
+     * @summary List deliveries
+     * @param {string} appId 
+     * @param {number} [limit] 
+     * @param {number} [offset] 
+     * @param {string} [tenantId] 
+     * @param {string} [eventType] 
+     * @param {'pending' | 'delivering' | 'delivered' | 'failed' | 'retrying' | 'exhausted'} [status] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSDeliveriesApiInterface
+     */
+    listWaaSDeliveriesRaw(requestParameters: WaaSDeliveriesApiListWaaSDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpointDeliveries200Response>>;
+
+    /**
+     * List delivery records for a WaaS application. Filter by tenant, event type, or status.
+     * List deliveries
+     */
+    listWaaSDeliveries(appId: string, limit?: number, offset?: number, tenantId?: string, eventType?: string, status?: ListWaaSDeliveriesStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpointDeliveries200Response>;
+
+    /**
+     * List deliveries for a specific endpoint.
+     * @summary List endpoint deliveries
+     * @param {string} appId 
+     * @param {string} endpointId 
+     * @param {number} [limit] 
+     * @param {number} [offset] 
+     * @param {string} [status] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSDeliveriesApiInterface
+     */
+    listWaaSEndpointDeliveriesRaw(requestParameters: WaaSDeliveriesApiListWaaSEndpointDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpointDeliveries200Response>>;
+
+    /**
+     * List deliveries for a specific endpoint.
+     * List endpoint deliveries
+     */
+    listWaaSEndpointDeliveries(appId: string, endpointId: string, limit?: number, offset?: number, status?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpointDeliveries200Response>;
+
+    /**
+     * Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+     * @summary Retry a delivery
+     * @param {string} appId 
+     * @param {string} deliveryId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSDeliveriesApiInterface
+     */
+    retryWaaSDeliveryRaw(requestParameters: WaaSDeliveriesApiRetryWaaSDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+     * Retry a delivery
+     */
+    retryWaaSDelivery(appId: string, deliveryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class WaaSDeliveriesApi extends runtime.BaseAPI implements WaaSDeliveriesApiInterface {
+
+    /**
+     * Get full delivery details including request/response data.
+     * Get delivery detail
+     */
+    async getWaaSDeliveryRaw(requestParameters: WaaSDeliveriesApiGetWaaSDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling getWaaSDelivery().'
+            );
+        }
+
+        if (requestParameters['deliveryId'] == null) {
+            throw new runtime.RequiredError(
+                'deliveryId',
+                'Required parameter "deliveryId" was null or undefined when calling getWaaSDelivery().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/waas/applications/{appId}/deliveries/{deliveryId}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"deliveryId"}}`, encodeURIComponent(String(requestParameters['deliveryId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Get full delivery details including request/response data.
+     * Get delivery detail
+     */
+    async getWaaSDelivery(appId: string, deliveryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getWaaSDeliveryRaw({ appId: appId, deliveryId: deliveryId }, initOverrides);
+    }
+
+    /**
+     * List delivery records for a WaaS application. Filter by tenant, event type, or status.
+     * List deliveries
+     */
+    async listWaaSDeliveriesRaw(requestParameters: WaaSDeliveriesApiListWaaSDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpointDeliveries200Response>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling listWaaSDeliveries().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['tenantId'] != null) {
+            queryParameters['tenant_id'] = requestParameters['tenantId'];
+        }
+
+        if (requestParameters['eventType'] != null) {
+            queryParameters['event_type'] = requestParameters['eventType'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/waas/applications/{appId}/deliveries`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWaaSEndpointDeliveries200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List delivery records for a WaaS application. Filter by tenant, event type, or status.
+     * List deliveries
+     */
+    async listWaaSDeliveries(appId: string, limit?: number, offset?: number, tenantId?: string, eventType?: string, status?: ListWaaSDeliveriesStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpointDeliveries200Response> {
+        const response = await this.listWaaSDeliveriesRaw({ appId: appId, limit: limit, offset: offset, tenantId: tenantId, eventType: eventType, status: status }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List deliveries for a specific endpoint.
+     * List endpoint deliveries
+     */
+    async listWaaSEndpointDeliveriesRaw(requestParameters: WaaSDeliveriesApiListWaaSEndpointDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpointDeliveries200Response>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling listWaaSEndpointDeliveries().'
+            );
+        }
+
+        if (requestParameters['endpointId'] == null) {
+            throw new runtime.RequiredError(
+                'endpointId',
+                'Required parameter "endpointId" was null or undefined when calling listWaaSEndpointDeliveries().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/waas/applications/{appId}/endpoints/{endpointId}/deliveries`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWaaSEndpointDeliveries200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List deliveries for a specific endpoint.
+     * List endpoint deliveries
+     */
+    async listWaaSEndpointDeliveries(appId: string, endpointId: string, limit?: number, offset?: number, status?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpointDeliveries200Response> {
+        const response = await this.listWaaSEndpointDeliveriesRaw({ appId: appId, endpointId: endpointId, limit: limit, offset: offset, status: status }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+     * Retry a delivery
+     */
+    async retryWaaSDeliveryRaw(requestParameters: WaaSDeliveriesApiRetryWaaSDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling retryWaaSDelivery().'
+            );
+        }
+
+        if (requestParameters['deliveryId'] == null) {
+            throw new runtime.RequiredError(
+                'deliveryId',
+                'Required parameter "deliveryId" was null or undefined when calling retryWaaSDelivery().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/waas/applications/{appId}/deliveries/{deliveryId}/retry`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"deliveryId"}}`, encodeURIComponent(String(requestParameters['deliveryId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+     * Retry a delivery
+     */
+    async retryWaaSDelivery(appId: string, deliveryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.retryWaaSDeliveryRaw({ appId: appId, deliveryId: deliveryId }, initOverrides);
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListWaaSDeliveriesStatusEnum = {
+    PENDING: 'pending',
+    DELIVERING: 'delivering',
+    DELIVERED: 'delivered',
+    FAILED: 'failed',
+    RETRYING: 'retrying',
+    EXHAUSTED: 'exhausted'
+} as const;
+export type ListWaaSDeliveriesStatusEnum = typeof ListWaaSDeliveriesStatusEnum[keyof typeof ListWaaSDeliveriesStatusEnum];