@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-alpha

package/src/brevo/generated/apis/WebhooksApi.ts

@@ -0,0 +1,393 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * 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.js';
+import type { CreateModel, CreateWebhook, GetWebhook, GetWebhooks, UpdateWebhook } from '../models/index.js';
+import { CreateModelFromJSON, CreateWebhookToJSON, GetWebhookFromJSON, GetWebhooksFromJSON, UpdateWebhookToJSON } from '../models/index.js';
+
+export interface CreateWebhookRequest {
+  createWebhook: CreateWebhook;
+}
+
+export interface DeleteWebhookRequest {
+  webhookId: number;
+}
+
+export interface GetWebhookRequest {
+  webhookId: number;
+}
+
+export interface GetWebhooksRequest {
+  type?: GetWebhooksTypeEnum;
+  sort?: GetWebhooksSortEnum;
+}
+
+export interface UpdateWebhookRequest {
+  webhookId: number;
+  updateWebhook: UpdateWebhook;
+}
+
+/**
+ * WebhooksApi - interface
+ *
+ * @export
+ * @interface WebhooksApiInterface
+ */
+export interface WebhooksApiInterface {
+  /**
+   *
+   * @summary Create a webhook
+   * @param {CreateWebhook} createWebhook Values to create a webhook
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof WebhooksApiInterface
+   */
+  createWebhookRaw(
+    requestParameters: CreateWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<CreateModel>>;
+
+  /**
+   * Create a webhook
+   */
+  createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
+
+  /**
+   *
+   * @summary Delete a webhook
+   * @param {number} webhookId Id of the webhook
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof WebhooksApiInterface
+   */
+  deleteWebhookRaw(
+    requestParameters: DeleteWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<void>>;
+
+  /**
+   * Delete a webhook
+   */
+  deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+  /**
+   *
+   * @summary Get a webhook details
+   * @param {number} webhookId Id of the webhook
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof WebhooksApiInterface
+   */
+  getWebhookRaw(
+    requestParameters: GetWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GetWebhook>>;
+
+  /**
+   * Get a webhook details
+   */
+  getWebhook(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWebhook>;
+
+  /**
+   *
+   * @summary Get all webhooks
+   * @param {'marketing' | 'transactional'} [type] Filter on webhook type
+   * @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of webhook creation
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof WebhooksApiInterface
+   */
+  getWebhooksRaw(
+    requestParameters: GetWebhooksRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GetWebhooks>>;
+
+  /**
+   * Get all webhooks
+   */
+  getWebhooks(requestParameters: GetWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWebhooks>;
+
+  /**
+   *
+   * @summary Update a webhook
+   * @param {number} webhookId Id of the webhook
+   * @param {UpdateWebhook} updateWebhook Values to update a webhook
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof WebhooksApiInterface
+   */
+  updateWebhookRaw(
+    requestParameters: UpdateWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<void>>;
+
+  /**
+   * Update a webhook
+   */
+  updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+
+/**
+ *
+ */
+export class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
+  /**
+   * Create a webhook
+   */
+  async createWebhookRaw(
+    requestParameters: CreateWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<CreateModel>> {
+    if (requestParameters.createWebhook === null || requestParameters.createWebhook === undefined) {
+      throw new runtime.RequiredError(
+        'createWebhook',
+        'Required parameter requestParameters.createWebhook was null or undefined when calling createWebhook.',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/webhooks`,
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: CreateWebhookToJSON(requestParameters.createWebhook),
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
+  }
+
+  /**
+   * Create a webhook
+   */
+  async createWebhook(
+    requestParameters: CreateWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<CreateModel> {
+    const response = await this.createWebhookRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   * Delete a webhook
+   */
+  async deleteWebhookRaw(
+    requestParameters: DeleteWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<void>> {
+    if (requestParameters.webhookId === null || requestParameters.webhookId === undefined) {
+      throw new runtime.RequiredError(
+        'webhookId',
+        'Required parameter requestParameters.webhookId was null or undefined when calling deleteWebhook.',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/webhooks/{webhookId}`.replace(`{${'webhookId'}}`, encodeURIComponent(String(requestParameters.webhookId))),
+        method: 'DELETE',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.VoidApiResponse(response);
+  }
+
+  /**
+   * Delete a webhook
+   */
+  async deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+    await this.deleteWebhookRaw(requestParameters, initOverrides);
+  }
+
+  /**
+   * Get a webhook details
+   */
+  async getWebhookRaw(
+    requestParameters: GetWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GetWebhook>> {
+    if (requestParameters.webhookId === null || requestParameters.webhookId === undefined) {
+      throw new runtime.RequiredError(
+        'webhookId',
+        'Required parameter requestParameters.webhookId was null or undefined when calling getWebhook.',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/webhooks/{webhookId}`.replace(`{${'webhookId'}}`, encodeURIComponent(String(requestParameters.webhookId))),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) => GetWebhookFromJSON(jsonValue));
+  }
+
+  /**
+   * Get a webhook details
+   */
+  async getWebhook(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWebhook> {
+    const response = await this.getWebhookRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   * Get all webhooks
+   */
+  async getWebhooksRaw(
+    requestParameters: GetWebhooksRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GetWebhooks>> {
+    const queryParameters: any = {};
+
+    if (requestParameters.type !== undefined) {
+      queryParameters['type'] = requestParameters.type;
+    }
+
+    if (requestParameters.sort !== undefined) {
+      queryParameters['sort'] = requestParameters.sort;
+    }
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/webhooks`,
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) => GetWebhooksFromJSON(jsonValue));
+  }
+
+  /**
+   * Get all webhooks
+   */
+  async getWebhooks(
+    requestParameters: GetWebhooksRequest = {},
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<GetWebhooks> {
+    const response = await this.getWebhooksRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   * Update a webhook
+   */
+  async updateWebhookRaw(
+    requestParameters: UpdateWebhookRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<void>> {
+    if (requestParameters.webhookId === null || requestParameters.webhookId === undefined) {
+      throw new runtime.RequiredError(
+        'webhookId',
+        'Required parameter requestParameters.webhookId was null or undefined when calling updateWebhook.',
+      );
+    }
+
+    if (requestParameters.updateWebhook === null || requestParameters.updateWebhook === undefined) {
+      throw new runtime.RequiredError(
+        'updateWebhook',
+        'Required parameter requestParameters.updateWebhook was null or undefined when calling updateWebhook.',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/webhooks/{webhookId}`.replace(`{${'webhookId'}}`, encodeURIComponent(String(requestParameters.webhookId))),
+        method: 'PUT',
+        headers: headerParameters,
+        query: queryParameters,
+        body: UpdateWebhookToJSON(requestParameters.updateWebhook),
+      },
+      initOverrides,
+    );
+
+    return new runtime.VoidApiResponse(response);
+  }
+
+  /**
+   * Update a webhook
+   */
+  async updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+    await this.updateWebhookRaw(requestParameters, initOverrides);
+  }
+}
+
+/**
+ * @export
+ * @enum {string}
+ */
+export enum GetWebhooksTypeEnum {
+  Marketing = 'marketing',
+  Transactional = 'transactional',
+}
+/**
+ * @export
+ * @enum {string}
+ */
+export enum GetWebhooksSortEnum {
+  Asc = 'asc',
+  Desc = 'desc',
+}