@zyphr-dev/node-sdk 0.1.0 → 0.1.1

package/src/src/apis/WaaSApplicationsApi.ts

@@ -0,0 +1,438 @@
+/* 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 {
+  CreateWaaSApplication201Response,
+  CreateWaaSApplicationRequest,
+  GetWaaSUsage200Response,
+  ListWaaSApplications200Response,
+  UpdateWaaSApplicationRequest,
+} from '../models/index';
+import {
+    CreateWaaSApplication201ResponseFromJSON,
+    CreateWaaSApplication201ResponseToJSON,
+    CreateWaaSApplicationRequestFromJSON,
+    CreateWaaSApplicationRequestToJSON,
+    GetWaaSUsage200ResponseFromJSON,
+    GetWaaSUsage200ResponseToJSON,
+    ListWaaSApplications200ResponseFromJSON,
+    ListWaaSApplications200ResponseToJSON,
+    UpdateWaaSApplicationRequestFromJSON,
+    UpdateWaaSApplicationRequestToJSON,
+} from '../models/index';
+
+export interface WaaSApplicationsApiCreateWaaSApplicationOperationRequest {
+    createWaaSApplicationRequest: CreateWaaSApplicationRequest;
+}
+
+export interface WaaSApplicationsApiDeleteWaaSApplicationRequest {
+    appId: string;
+}
+
+export interface WaaSApplicationsApiGetWaaSApplicationRequest {
+    appId: string;
+}
+
+export interface WaaSApplicationsApiGetWaaSUsageRequest {
+    appId: string;
+}
+
+export interface WaaSApplicationsApiListWaaSApplicationsRequest {
+    limit?: number;
+    offset?: number;
+    status?: ListWaaSApplicationsStatusEnum;
+}
+
+export interface WaaSApplicationsApiUpdateWaaSApplicationOperationRequest {
+    appId: string;
+    updateWaaSApplicationRequest: UpdateWaaSApplicationRequest;
+}
+
+/**
+ * WaaSApplicationsApi - interface
+ * 
+ * @export
+ * @interface WaaSApplicationsApiInterface
+ */
+export interface WaaSApplicationsApiInterface {
+    /**
+     * Create a new Webhooks-as-a-Service application.
+     * @summary Create a WaaS application
+     * @param {CreateWaaSApplicationRequest} createWaaSApplicationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    createWaaSApplicationRaw(requestParameters: WaaSApplicationsApiCreateWaaSApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>>;
+
+    /**
+     * Create a new Webhooks-as-a-Service application.
+     * Create a WaaS application
+     */
+    createWaaSApplication(createWaaSApplicationRequest: CreateWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response>;
+
+    /**
+     * Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+     * @summary Delete a WaaS application
+     * @param {string} appId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    deleteWaaSApplicationRaw(requestParameters: WaaSApplicationsApiDeleteWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+     * Delete a WaaS application
+     */
+    deleteWaaSApplication(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a specific Webhooks-as-a-Service application by ID.
+     * @summary Get a WaaS application
+     * @param {string} appId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    getWaaSApplicationRaw(requestParameters: WaaSApplicationsApiGetWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>>;
+
+    /**
+     * Get a specific Webhooks-as-a-Service application by ID.
+     * Get a WaaS application
+     */
+    getWaaSApplication(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response>;
+
+    /**
+     * Get current usage counts and plan limits for WaaS resources.
+     * @summary Get WaaS usage
+     * @param {string} appId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    getWaaSUsageRaw(requestParameters: WaaSApplicationsApiGetWaaSUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWaaSUsage200Response>>;
+
+    /**
+     * Get current usage counts and plan limits for WaaS resources.
+     * Get WaaS usage
+     */
+    getWaaSUsage(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWaaSUsage200Response>;
+
+    /**
+     * List all Webhooks-as-a-Service applications in the workspace.
+     * @summary List WaaS applications
+     * @param {number} [limit] 
+     * @param {number} [offset] 
+     * @param {'active' | 'paused' | 'disabled'} [status] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    listWaaSApplicationsRaw(requestParameters: WaaSApplicationsApiListWaaSApplicationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSApplications200Response>>;
+
+    /**
+     * List all Webhooks-as-a-Service applications in the workspace.
+     * List WaaS applications
+     */
+    listWaaSApplications(limit?: number, offset?: number, status?: ListWaaSApplicationsStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSApplications200Response>;
+
+    /**
+     * Update the name, description, or status of a WaaS application.
+     * @summary Update a WaaS application
+     * @param {string} appId 
+     * @param {UpdateWaaSApplicationRequest} updateWaaSApplicationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WaaSApplicationsApiInterface
+     */
+    updateWaaSApplicationRaw(requestParameters: WaaSApplicationsApiUpdateWaaSApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>>;
+
+    /**
+     * Update the name, description, or status of a WaaS application.
+     * Update a WaaS application
+     */
+    updateWaaSApplication(appId: string, updateWaaSApplicationRequest: UpdateWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response>;
+
+}
+
+/**
+ * 
+ */
+export class WaaSApplicationsApi extends runtime.BaseAPI implements WaaSApplicationsApiInterface {
+
+    /**
+     * Create a new Webhooks-as-a-Service application.
+     * Create a WaaS application
+     */
+    async createWaaSApplicationRaw(requestParameters: WaaSApplicationsApiCreateWaaSApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>> {
+        if (requestParameters['createWaaSApplicationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createWaaSApplicationRequest',
+                'Required parameter "createWaaSApplicationRequest" was null or undefined when calling createWaaSApplication().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateWaaSApplicationRequestToJSON(requestParameters['createWaaSApplicationRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWaaSApplication201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new Webhooks-as-a-Service application.
+     * Create a WaaS application
+     */
+    async createWaaSApplication(createWaaSApplicationRequest: CreateWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response> {
+        const response = await this.createWaaSApplicationRaw({ createWaaSApplicationRequest: createWaaSApplicationRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+     * Delete a WaaS application
+     */
+    async deleteWaaSApplicationRaw(requestParameters: WaaSApplicationsApiDeleteWaaSApplicationRequest, 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 deleteWaaSApplication().'
+            );
+        }
+
+        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}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+     * Delete a WaaS application
+     */
+    async deleteWaaSApplication(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteWaaSApplicationRaw({ appId: appId }, initOverrides);
+    }
+
+    /**
+     * Get a specific Webhooks-as-a-Service application by ID.
+     * Get a WaaS application
+     */
+    async getWaaSApplicationRaw(requestParameters: WaaSApplicationsApiGetWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling getWaaSApplication().'
+            );
+        }
+
+        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}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWaaSApplication201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a specific Webhooks-as-a-Service application by ID.
+     * Get a WaaS application
+     */
+    async getWaaSApplication(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response> {
+        const response = await this.getWaaSApplicationRaw({ appId: appId }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get current usage counts and plan limits for WaaS resources.
+     * Get WaaS usage
+     */
+    async getWaaSUsageRaw(requestParameters: WaaSApplicationsApiGetWaaSUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWaaSUsage200Response>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling getWaaSUsage().'
+            );
+        }
+
+        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}/usage`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetWaaSUsage200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get current usage counts and plan limits for WaaS resources.
+     * Get WaaS usage
+     */
+    async getWaaSUsage(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWaaSUsage200Response> {
+        const response = await this.getWaaSUsageRaw({ appId: appId }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all Webhooks-as-a-Service applications in the workspace.
+     * List WaaS applications
+     */
+    async listWaaSApplicationsRaw(requestParameters: WaaSApplicationsApiListWaaSApplicationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSApplications200Response>> {
+        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`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWaaSApplications200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all Webhooks-as-a-Service applications in the workspace.
+     * List WaaS applications
+     */
+    async listWaaSApplications(limit?: number, offset?: number, status?: ListWaaSApplicationsStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSApplications200Response> {
+        const response = await this.listWaaSApplicationsRaw({ limit: limit, offset: offset, status: status }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update the name, description, or status of a WaaS application.
+     * Update a WaaS application
+     */
+    async updateWaaSApplicationRaw(requestParameters: WaaSApplicationsApiUpdateWaaSApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSApplication201Response>> {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError(
+                'appId',
+                'Required parameter "appId" was null or undefined when calling updateWaaSApplication().'
+            );
+        }
+
+        if (requestParameters['updateWaaSApplicationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateWaaSApplicationRequest',
+                'Required parameter "updateWaaSApplicationRequest" was null or undefined when calling updateWaaSApplication().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateWaaSApplicationRequestToJSON(requestParameters['updateWaaSApplicationRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWaaSApplication201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update the name, description, or status of a WaaS application.
+     * Update a WaaS application
+     */
+    async updateWaaSApplication(appId: string, updateWaaSApplicationRequest: UpdateWaaSApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSApplication201Response> {
+        const response = await this.updateWaaSApplicationRaw({ appId: appId, updateWaaSApplicationRequest: updateWaaSApplicationRequest }, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListWaaSApplicationsStatusEnum = {
+    ACTIVE: 'active',
+    PAUSED: 'paused',
+    DISABLED: 'disabled'
+} as const;
+export type ListWaaSApplicationsStatusEnum = typeof ListWaaSApplicationsStatusEnum[keyof typeof ListWaaSApplicationsStatusEnum];