@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.1-beta.0

package/dist/api/payment-reminders-api.d.ts

@@ -1,6 +1,6 @@
 /**
  * Emil Payment Service
- * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ * This service directly communicates with the various Payment Service Providers (PSPs)   in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -21,7 +21,7 @@ import { DeactivatePaymentReminderRequestDto } from '../models';
 export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * This will create a payment reminder in the database.
-     * @summary Create the payment-reminder
+     * @summary Create the payment reminder
      * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -29,8 +29,8 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
      */
     createPaymentReminder: (createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Deactivates the payment reminder
-     * @summary Update the payment-reminder
+     * This will deactivate the payment reminder
+     * @summary Deactivate payment reminder
      * @param {string} code Unique identifier for the object.
      * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -39,29 +39,26 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
      */
     deactivatePaymentReminder: (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
      * @summary Retrieve the payment reminder
-     * @param {string} code Unique identifier for the object.
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
      * @summary List payment reminders
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPaymentReminders: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listPaymentReminders: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PaymentRemindersApi - functional programming interface
@@ -70,7 +67,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
 export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
     /**
      * This will create a payment reminder in the database.
-     * @summary Create the payment-reminder
+     * @summary Create the payment reminder
      * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -78,8 +75,8 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
      */
     createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Deactivates the payment reminder
-     * @summary Update the payment-reminder
+     * This will deactivate the payment reminder
+     * @summary Deactivate payment reminder
      * @param {string} code Unique identifier for the object.
      * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -88,29 +85,26 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
      */
     deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
      * @summary Retrieve the payment reminder
-     * @param {string} code Unique identifier for the object.
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
      * @summary List payment reminders
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPaymentReminders(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * PaymentRemindersApi - factory interface
@@ -119,7 +113,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
 export declare const PaymentRemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      * This will create a payment reminder in the database.
-     * @summary Create the payment-reminder
+     * @summary Create the payment reminder
      * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -127,8 +121,8 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
      */
     createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * Deactivates the payment reminder
-     * @summary Update the payment-reminder
+     * This will deactivate the payment reminder
+     * @summary Deactivate payment reminder
      * @param {string} code Unique identifier for the object.
      * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -137,29 +131,26 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
      */
     deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
      * @summary Retrieve the payment reminder
-     * @param {string} code Unique identifier for the object.
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
      * @summary List payment reminders
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPaymentReminders(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
+    listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
 };
 /**
  * Request parameters for createPaymentReminder operation in PaymentRemindersApi.
@@ -212,7 +203,7 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
  */
 export interface PaymentRemindersApiGetPolicyRequest {
     /**
-     * Unique identifier for the object.
+     *
      * @type {string}
      * @memberof PaymentRemindersApiGetPolicy
      */
@@ -237,47 +228,29 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
      */
     readonly authorization?: string;
     /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @type {any}
-     * @memberof PaymentRemindersApiListPaymentReminders
-     */
-    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 PaymentRemindersApiListPaymentReminders
-     */
-    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 PaymentRemindersApiListPaymentReminders
-     */
-    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}
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @type {string}
      * @memberof PaymentRemindersApiListPaymentReminders
      */
-    readonly search?: any;
+    readonly filter?: string;
     /**
-     * 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}
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
+     * @type {string}
      * @memberof PaymentRemindersApiListPaymentReminders
      */
-    readonly order?: any;
+    readonly filters?: string;
     /**
-     * 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}
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
      * @memberof PaymentRemindersApiListPaymentReminders
      */
-    readonly expand?: any;
+    readonly order?: string;
     /**
-     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
-     * @type {any}
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @type {string}
      * @memberof PaymentRemindersApiListPaymentReminders
      */
-    readonly filters?: any;
+    readonly expand?: string;
 }
 /**
  * PaymentRemindersApi - object-oriented interface
@@ -288,7 +261,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
 export declare class PaymentRemindersApi extends BaseAPI {
     /**
      * This will create a payment reminder in the database.
-     * @summary Create the payment-reminder
+     * @summary Create the payment reminder
      * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -296,8 +269,8 @@ export declare class PaymentRemindersApi extends BaseAPI {
      */
     createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Deactivates the payment reminder
-     * @summary Update the payment-reminder
+     * This will deactivate the payment reminder
+     * @summary Deactivate payment reminder
      * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -305,7 +278,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
      */
     deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
      * @summary Retrieve the payment reminder
      * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -314,7 +287,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
      */
     getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
      * @summary List payment reminders
      * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/payment-reminders-api.js

@@ -3,7 +3,7 @@
 /* eslint-disable */
 /**
  * Emil Payment Service
- * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ * This service directly communicates with the various Payment Service Providers (PSPs)   in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -94,7 +94,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
     return {
         /**
          * This will create a payment reminder in the database.
-         * @summary Create the payment-reminder
+         * @summary Create the payment reminder
          * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
@@ -142,8 +142,8 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Deactivates the payment reminder
-         * @summary Update the payment-reminder
+         * This will deactivate the payment reminder
+         * @summary Deactivate payment reminder
          * @param {string} code Unique identifier for the object.
          * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -195,9 +195,9 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
          * @summary Retrieve the payment reminder
-         * @param {string} code Unique identifier for the object.
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -243,20 +243,17 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
          * @summary List payment reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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=1,     your subsequent call can include pageToken=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=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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt</i>
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: <i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
+        listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -279,17 +276,11 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
-                            if (pageSize !== undefined) {
-                                localVarQueryParameter['pageSize'] = pageSize;
-                            }
-                            if (pageToken !== undefined) {
-                                localVarQueryParameter['pageToken'] = pageToken;
-                            }
                             if (filter !== undefined) {
                                 localVarQueryParameter['filter'] = filter;
                             }
-                            if (search !== undefined) {
-                                localVarQueryParameter['search'] = search;
+                            if (filters !== undefined) {
+                                localVarQueryParameter['filters'] = filters;
                             }
                             if (order !== undefined) {
                                 localVarQueryParameter['order'] = order;
@@ -297,9 +288,6 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
                             if (expand !== undefined) {
                                 localVarQueryParameter['expand'] = expand;
                             }
-                            if (filters !== undefined) {
-                                localVarQueryParameter['filters'] = filters;
-                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -326,7 +314,7 @@ var PaymentRemindersApiFp = function (configuration) {
     return {
         /**
          * This will create a payment reminder in the database.
-         * @summary Create the payment-reminder
+         * @summary Create the payment reminder
          * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
@@ -346,8 +334,8 @@ var PaymentRemindersApiFp = function (configuration) {
             });
         },
         /**
-         * Deactivates the payment reminder
-         * @summary Update the payment-reminder
+         * This will deactivate the payment reminder
+         * @summary Deactivate payment reminder
          * @param {string} code Unique identifier for the object.
          * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -368,9 +356,9 @@ var PaymentRemindersApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
          * @summary Retrieve the payment reminder
-         * @param {string} code Unique identifier for the object.
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -389,25 +377,22 @@ var PaymentRemindersApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
          * @summary List payment reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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=1,     your subsequent call can include pageToken=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=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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt</i>
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: <i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
+        listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, filter, filters, order, expand, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -427,7 +412,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          * This will create a payment reminder in the database.
-         * @summary Create the payment-reminder
+         * @summary Create the payment reminder
          * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
@@ -437,8 +422,8 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Deactivates the payment reminder
-         * @summary Update the payment-reminder
+         * This will deactivate the payment reminder
+         * @summary Deactivate payment reminder
          * @param {string} code Unique identifier for the object.
          * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -449,9 +434,9 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+         * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
          * @summary Retrieve the payment reminder
-         * @param {string} code Unique identifier for the object.
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -460,21 +445,18 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
          * @summary List payment reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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=1,     your subsequent call can include pageToken=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=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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, id, policyCode, nextReminderDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt</i>
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: <i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
-            return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
+        listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
+            return localVarFp.listPaymentReminders(authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
         },
     };
 };
@@ -492,7 +474,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
     }
     /**
      * This will create a payment reminder in the database.
-     * @summary Create the payment-reminder
+     * @summary Create the payment reminder
      * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -503,8 +485,8 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
         return (0, exports.PaymentRemindersApiFp)(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Deactivates the payment reminder
-     * @summary Update the payment-reminder
+     * This will deactivate the payment reminder
+     * @summary Deactivate payment reminder
      * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -515,7 +497,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
         return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
+     * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code      that was returned when you created it and Emil Api will return the corresponding payment reminder information.
      * @summary Retrieve the payment reminder
      * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -527,7 +509,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
         return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of payment reminders you have previously created.          The payment reminders are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
      * @summary List payment reminders
      * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -537,7 +519,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
     PaymentRemindersApi.prototype.listPaymentReminders = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     return PaymentRemindersApi;
 }(base_1.BaseAPI));