ch-admin-api-client-typescript 5.27.4 → 5.30.0

package/lib/api/email-webhooks-api.d.ts

@@ -0,0 +1,266 @@
+/**
+ * CloudHospital Admin Api
+ * CloudHospital application with Swagger, Swashbuckle, and API versioning.
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: developer@icloudhospital.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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { EmailRecordModel } from '../models';
+import { EmailStatus } from '../models';
+import { TestEmailModel } from '../models';
+import { TestEmailWebhookCommand } from '../models';
+/**
+ * EmailWebhooksApi - axios parameter creator
+ * @export
+ */
+export declare const EmailWebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Receive email webhooks events
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksInboundPost: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get email records. (from an week ago as default)
+     * @param {Date} [createdFrom]
+     * @param {Date} [createdTo]
+     * @param {Date} [updatedFrom]
+     * @param {Date} [updatedTo]
+     * @param {string} [recipient]
+     * @param {boolean} [includeEvents]
+     * @param {Array<EmailStatus>} [statuses]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsGet: (createdFrom?: Date, createdTo?: Date, updatedFrom?: Date, updatedTo?: Date, recipient?: string, includeEvents?: boolean, statuses?: Array<EmailStatus>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get email record by id with events.
+     * @param {string} recordId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsRecordIdGet: (recordId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Sending test email that follows email webhook steps.
+     * @param {TestEmailWebhookCommand} [testEmailWebhookCommand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksTestPost: (testEmailWebhookCommand?: TestEmailWebhookCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EmailWebhooksApi - functional programming interface
+ * @export
+ */
+export declare const EmailWebhooksApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Receive email webhooks events
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksInboundPost(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     *
+     * @summary Get email records. (from an week ago as default)
+     * @param {Date} [createdFrom]
+     * @param {Date} [createdTo]
+     * @param {Date} [updatedFrom]
+     * @param {Date} [updatedTo]
+     * @param {string} [recipient]
+     * @param {boolean} [includeEvents]
+     * @param {Array<EmailStatus>} [statuses]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsGet(createdFrom?: Date, createdTo?: Date, updatedFrom?: Date, updatedTo?: Date, recipient?: string, includeEvents?: boolean, statuses?: Array<EmailStatus>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailRecordModel>>>;
+    /**
+     *
+     * @summary Get email record by id with events.
+     * @param {string} recordId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsRecordIdGet(recordId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailRecordModel>>;
+    /**
+     *
+     * @summary Sending test email that follows email webhook steps.
+     * @param {TestEmailWebhookCommand} [testEmailWebhookCommand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksTestPost(testEmailWebhookCommand?: TestEmailWebhookCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestEmailModel>>;
+};
+/**
+ * EmailWebhooksApi - factory interface
+ * @export
+ */
+export declare const EmailWebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Receive email webhooks events
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksInboundPost(options?: any): AxiosPromise<object>;
+    /**
+     *
+     * @summary Get email records. (from an week ago as default)
+     * @param {Date} [createdFrom]
+     * @param {Date} [createdTo]
+     * @param {Date} [updatedFrom]
+     * @param {Date} [updatedTo]
+     * @param {string} [recipient]
+     * @param {boolean} [includeEvents]
+     * @param {Array<EmailStatus>} [statuses]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsGet(createdFrom?: Date, createdTo?: Date, updatedFrom?: Date, updatedTo?: Date, recipient?: string, includeEvents?: boolean, statuses?: Array<EmailStatus>, options?: any): AxiosPromise<Array<EmailRecordModel>>;
+    /**
+     *
+     * @summary Get email record by id with events.
+     * @param {string} recordId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksRecordsRecordIdGet(recordId: string, options?: any): AxiosPromise<EmailRecordModel>;
+    /**
+     *
+     * @summary Sending test email that follows email webhook steps.
+     * @param {TestEmailWebhookCommand} [testEmailWebhookCommand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1EmailwebhooksTestPost(testEmailWebhookCommand?: TestEmailWebhookCommand, options?: any): AxiosPromise<TestEmailModel>;
+};
+/**
+ * Request parameters for apiV1EmailwebhooksRecordsGet operation in EmailWebhooksApi.
+ * @export
+ * @interface EmailWebhooksApiApiV1EmailwebhooksRecordsGetRequest
+ */
+export interface EmailWebhooksApiApiV1EmailwebhooksRecordsGetRequest {
+    /**
+     *
+     * @type {Date}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly createdFrom?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly createdTo?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly updatedFrom?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly updatedTo?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly recipient?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly includeEvents?: boolean;
+    /**
+     *
+     * @type {Array<EmailStatus>}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsGet
+     */
+    readonly statuses?: Array<EmailStatus>;
+}
+/**
+ * Request parameters for apiV1EmailwebhooksRecordsRecordIdGet operation in EmailWebhooksApi.
+ * @export
+ * @interface EmailWebhooksApiApiV1EmailwebhooksRecordsRecordIdGetRequest
+ */
+export interface EmailWebhooksApiApiV1EmailwebhooksRecordsRecordIdGetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksRecordsRecordIdGet
+     */
+    readonly recordId: string;
+}
+/**
+ * Request parameters for apiV1EmailwebhooksTestPost operation in EmailWebhooksApi.
+ * @export
+ * @interface EmailWebhooksApiApiV1EmailwebhooksTestPostRequest
+ */
+export interface EmailWebhooksApiApiV1EmailwebhooksTestPostRequest {
+    /**
+     *
+     * @type {TestEmailWebhookCommand}
+     * @memberof EmailWebhooksApiApiV1EmailwebhooksTestPost
+     */
+    readonly testEmailWebhookCommand?: TestEmailWebhookCommand;
+}
+/**
+ * EmailWebhooksApi - object-oriented interface
+ * @export
+ * @class EmailWebhooksApi
+ * @extends {BaseAPI}
+ */
+export declare class EmailWebhooksApi extends BaseAPI {
+    /**
+     *
+     * @summary Receive email webhooks events
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailWebhooksApi
+     */
+    apiV1EmailwebhooksInboundPost(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     *
+     * @summary Get email records. (from an week ago as default)
+     * @param {EmailWebhooksApiApiV1EmailwebhooksRecordsGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailWebhooksApi
+     */
+    apiV1EmailwebhooksRecordsGet(requestParameters?: EmailWebhooksApiApiV1EmailwebhooksRecordsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailRecordModel[], any>>;
+    /**
+     *
+     * @summary Get email record by id with events.
+     * @param {EmailWebhooksApiApiV1EmailwebhooksRecordsRecordIdGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailWebhooksApi
+     */
+    apiV1EmailwebhooksRecordsRecordIdGet(requestParameters: EmailWebhooksApiApiV1EmailwebhooksRecordsRecordIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailRecordModel, any>>;
+    /**
+     *
+     * @summary Sending test email that follows email webhook steps.
+     * @param {EmailWebhooksApiApiV1EmailwebhooksTestPostRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailWebhooksApi
+     */
+    apiV1EmailwebhooksTestPost(requestParameters?: EmailWebhooksApiApiV1EmailwebhooksTestPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestEmailModel, any>>;
+}
+//# sourceMappingURL=email-webhooks-api.d.ts.map

package/lib/api/email-webhooks-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-webhooks-api.d.ts","sourceRoot":"","sources":["../../src/api/email-webhooks-api.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAoB,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAKjD,OAAO,EAAiC,WAAW,EAAE,OAAO,EAAiB,MAAM,SAAS,CAAC;AAE7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpD;;;GAGG;AACH,eAAO,MAAM,iCAAiC,mBAA6B,aAAa;IAEhF;;;;;OAKG;8CAC4C,kBAAkB,KAAQ,QAAQ,WAAW,CAAC;IA4B7F;;;;;;;;;;;;OAYG;iDACgD,IAAI,cAAc,IAAI,gBAAgB,IAAI,cAAc,IAAI,cAAc,MAAM,kBAAkB,OAAO,aAAa,MAAM,WAAW,CAAC,YAAW,kBAAkB,KAAQ,QAAQ,WAAW,CAAC;IAgEpP;;;;;;OAMG;qDACoD,MAAM,YAAW,kBAAkB,KAAQ,QAAQ,WAAW,CAAC;IA+BtH;;;;;;OAMG;2DAC0D,uBAAuB,YAAW,kBAAkB,KAAQ,QAAQ,WAAW,CAAC;CAgCpJ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,mBAA4B,aAAa;IAGhE;;;;;OAKG;4CAC2C,kBAAkB,oBAAoB,aAAa,aAAa,MAAM,KAAK,aAAa,MAAM,CAAC;IAI7I;;;;;;;;;;;;OAYG;+CAC8C,IAAI,cAAc,IAAI,gBAAgB,IAAI,cAAc,IAAI,cAAc,MAAM,kBAAkB,OAAO,aAAa,MAAM,WAAW,CAAC,YAAY,kBAAkB,oBAAoB,aAAa,aAAa,MAAM,KAAK,aAAa,MAAM,gBAAgB,CAAC,CAAC;IAIrT;;;;;;OAMG;mDACkD,MAAM,YAAY,kBAAkB,oBAAoB,aAAa,aAAa,MAAM,KAAK,aAAa,gBAAgB,CAAC;IAIhL;;;;;;OAMG;yDACwD,uBAAuB,YAAY,kBAAkB,oBAAoB,aAAa,aAAa,MAAM,KAAK,aAAa,cAAc,CAAC;CAK5M,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,mBAA6B,aAAa,aAAa,MAAM,UAAU,aAAa;IAGhH;;;;;OAKG;4CACqC,GAAG,GAAG,aAAa,MAAM,CAAC;IAGlE;;;;;;;;;;;;OAYG;+CACwC,IAAI,cAAc,IAAI,gBAAgB,IAAI,cAAc,IAAI,cAAc,MAAM,kBAAkB,OAAO,aAAa,MAAM,WAAW,CAAC,YAAY,GAAG,GAAG,aAAa,MAAM,gBAAgB,CAAC,CAAC;IAG1O;;;;;;OAMG;mDAC4C,MAAM,YAAY,GAAG,GAAG,aAAa,gBAAgB,CAAC;IAGrG;;;;;;OAMG;yDACkD,uBAAuB,YAAY,GAAG,GAAG,aAAa,cAAc,CAAC;CAIjI,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,mDAAmD;IAChE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,2DAA2D;IACxE;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,iDAAiD;IAC9D;;;;OAIG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;CAC7D;AAED;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,OAAO;IACzC;;;;;;OAMG;IACI,6BAA6B,CAAC,OAAO,CAAC,EAAE,kBAAkB;IAIjE;;;;;;;OAOG;IACI,4BAA4B,CAAC,iBAAiB,GAAE,mDAAwD,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAI7I;;;;;;;OAOG;IACI,oCAAoC,CAAC,iBAAiB,EAAE,2DAA2D,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAIxJ;;;;;;;OAOG;IACI,0BAA0B,CAAC,iBAAiB,GAAE,iDAAsD,EAAE,OAAO,CAAC,EAAE,kBAAkB;CAG5I"}