@emilgroup/notification-sdk-node 1.0.0-beta.0

package/dist/api/notification-templates-api.d.ts

@@ -0,0 +1,373 @@
+/**
+ * EMIL NotificationService
+ * The EMIL NotificationService API description
+ *
+ * The version of the OpenAPI document: 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateNotificationTemplateRequestDto } from '../models';
+import { CreateNotificationTemplateResponseClass } from '../models';
+import { GetNotificationTemplateResponseClass } from '../models';
+import { ListNotificationTemplatesResponseClass } from '../models';
+import { UpdateNotificationTemplateRequestDto } from '../models';
+import { UpdateNotificationTemplateResponseClass } from '../models';
+/**
+ * NotificationTemplatesApi - axios parameter creator
+ * @export
+ */
+export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id
+     * @param {number} id2
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotificationTemplates: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateNotificationTemplate: (id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NotificationTemplatesApi - functional programming interface
+ * @export
+ */
+export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     *
+     * @param {number} id
+     * @param {number} id2
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotificationTemplates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateNotificationTemplate(id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateNotificationTemplateResponseClass>>;
+};
+/**
+ * NotificationTemplatesApi - factory interface
+ * @export
+ */
+export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     *
+     * @param {number} id
+     * @param {number} id2
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotificationTemplates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateNotificationTemplate(id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateNotificationTemplateResponseClass>;
+};
+/**
+ * Request parameters for createNotificationTemplate operation in NotificationTemplatesApi.
+ * @export
+ * @interface NotificationTemplatesApiCreateNotificationTemplateRequest
+ */
+export interface NotificationTemplatesApiCreateNotificationTemplateRequest {
+    /**
+     *
+     * @type {CreateNotificationTemplateRequestDto}
+     * @memberof NotificationTemplatesApiCreateNotificationTemplate
+     */
+    readonly createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof NotificationTemplatesApiCreateNotificationTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteNotificationTemplate operation in NotificationTemplatesApi.
+ * @export
+ * @interface NotificationTemplatesApiDeleteNotificationTemplateRequest
+ */
+export interface NotificationTemplatesApiDeleteNotificationTemplateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationTemplatesApiDeleteNotificationTemplate
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof NotificationTemplatesApiDeleteNotificationTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getNotificationTemplate operation in NotificationTemplatesApi.
+ * @export
+ * @interface NotificationTemplatesApiGetNotificationTemplateRequest
+ */
+export interface NotificationTemplatesApiGetNotificationTemplateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationTemplatesApiGetNotificationTemplate
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationTemplatesApiGetNotificationTemplate
+     */
+    readonly id2: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof NotificationTemplatesApiGetNotificationTemplate
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationTemplatesApiGetNotificationTemplate
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listNotificationTemplates operation in NotificationTemplatesApi.
+ * @export
+ * @interface NotificationTemplatesApiListNotificationTemplatesRequest
+ */
+export interface NotificationTemplatesApiListNotificationTemplatesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly pageSize?: any;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly filter?: any;
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly search?: any;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly order?: any;
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof NotificationTemplatesApiListNotificationTemplates
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for updateNotificationTemplate operation in NotificationTemplatesApi.
+ * @export
+ * @interface NotificationTemplatesApiUpdateNotificationTemplateRequest
+ */
+export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationTemplatesApiUpdateNotificationTemplate
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdateNotificationTemplateRequestDto}
+     * @memberof NotificationTemplatesApiUpdateNotificationTemplate
+     */
+    readonly updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof NotificationTemplatesApiUpdateNotificationTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * NotificationTemplatesApi - object-oriented interface
+ * @export
+ * @class NotificationTemplatesApi
+ * @extends {BaseAPI}
+ */
+export declare class NotificationTemplatesApi extends BaseAPI {
+    /**
+     *
+     * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationTemplatesApi
+     */
+    createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any>>;
+    /**
+     *
+     * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationTemplatesApi
+     */
+    deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     *
+     * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationTemplatesApi
+     */
+    getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any>>;
+    /**
+     *
+     * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationTemplatesApi
+     */
+    listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any>>;
+    /**
+     *
+     * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationTemplatesApi
+     */
+    updateNotificationTemplate(requestParameters: NotificationTemplatesApiUpdateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateNotificationTemplateResponseClass, any>>;
+}