@emilgroup/payment-sdk 1.13.1-beta.13 → 1.13.1-beta.131

package/dist/api/policy-payment-methods-api.d.ts

@@ -0,0 +1,272 @@
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 { ActivatePolicyPaymentMethodRequestDto } from '../models';
+import { CreatePolicyPaymentMethodRequestDto } from '../models';
+import { CreatePolicyPaymentMethodResponseClass } from '../models';
+import { ListPolicyPaymentMethodsResponseClass } from '../models';
+/**
+ * PolicyPaymentMethodsApi - axios parameter creator
+ * @export
+ */
+export declare const PolicyPaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Activates the requested policy payment method and automatically deactivates      any currently active policy payment method for the same policy.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Activate the policy payment method
+     * @param {string} code
+     * @param {ActivatePolicyPaymentMethodRequestDto} activatePolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activatePolicyPaymentMethod: (code: string, activatePolicyPaymentMethodRequestDto: ActivatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Attaches a payment method to a policy by creating a policy payment method and setting it as active.      Any previous payment method attachment will be deactivated.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the policy payment method
+     * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPaymentMethod: (createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List policy payment methods  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the policy payment methods
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {string} [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 {string} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPaymentMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PolicyPaymentMethodsApi - functional programming interface
+ * @export
+ */
+export declare const PolicyPaymentMethodsApiFp: (configuration?: Configuration) => {
+    /**
+     * Activates the requested policy payment method and automatically deactivates      any currently active policy payment method for the same policy.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Activate the policy payment method
+     * @param {string} code
+     * @param {ActivatePolicyPaymentMethodRequestDto} activatePolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activatePolicyPaymentMethod(code: string, activatePolicyPaymentMethodRequestDto: ActivatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Attaches a payment method to a policy by creating a policy payment method and setting it as active.      Any previous payment method attachment will be deactivated.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the policy payment method
+     * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyPaymentMethodResponseClass>>;
+    /**
+     * List policy payment methods  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the policy payment methods
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {string} [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 {string} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyPaymentMethodsResponseClass>>;
+};
+/**
+ * PolicyPaymentMethodsApi - factory interface
+ * @export
+ */
+export declare const PolicyPaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Activates the requested policy payment method and automatically deactivates      any currently active policy payment method for the same policy.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Activate the policy payment method
+     * @param {string} code
+     * @param {ActivatePolicyPaymentMethodRequestDto} activatePolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    activatePolicyPaymentMethod(code: string, activatePolicyPaymentMethodRequestDto: ActivatePolicyPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Attaches a payment method to a policy by creating a policy payment method and setting it as active.      Any previous payment method attachment will be deactivated.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the policy payment method
+     * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyPaymentMethodResponseClass>;
+    /**
+     * List policy payment methods  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the policy payment methods
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {string} [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 {string} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyPaymentMethodsResponseClass>;
+};
+/**
+ * Request parameters for activatePolicyPaymentMethod operation in PolicyPaymentMethodsApi.
+ * @export
+ * @interface PolicyPaymentMethodsApiActivatePolicyPaymentMethodRequest
+ */
+export interface PolicyPaymentMethodsApiActivatePolicyPaymentMethodRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiActivatePolicyPaymentMethod
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {ActivatePolicyPaymentMethodRequestDto}
+     * @memberof PolicyPaymentMethodsApiActivatePolicyPaymentMethod
+     */
+    readonly activatePolicyPaymentMethodRequestDto: ActivatePolicyPaymentMethodRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiActivatePolicyPaymentMethod
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createPolicyPaymentMethod operation in PolicyPaymentMethodsApi.
+ * @export
+ * @interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest
+ */
+export interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest {
+    /**
+     *
+     * @type {CreatePolicyPaymentMethodRequestDto}
+     * @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
+     */
+    readonly createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPolicyPaymentMethods operation in PolicyPaymentMethodsApi.
+ * @export
+ * @interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest
+ */
+export interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly search?: 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 {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly order?: 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 {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly expand?: 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 {string}
+     * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
+     */
+    readonly filters?: string;
+}
+/**
+ * PolicyPaymentMethodsApi - object-oriented interface
+ * @export
+ * @class PolicyPaymentMethodsApi
+ * @extends {BaseAPI}
+ */
+export declare class PolicyPaymentMethodsApi extends BaseAPI {
+    /**
+     * Activates the requested policy payment method and automatically deactivates      any currently active policy payment method for the same policy.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Activate the policy payment method
+     * @param {PolicyPaymentMethodsApiActivatePolicyPaymentMethodRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPaymentMethodsApi
+     */
+    activatePolicyPaymentMethod(requestParameters: PolicyPaymentMethodsApiActivatePolicyPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Attaches a payment method to a policy by creating a policy payment method and setting it as active.      Any previous payment method attachment will be deactivated.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the policy payment method
+     * @param {PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPaymentMethodsApi
+     */
+    createPolicyPaymentMethod(requestParameters: PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyPaymentMethodResponseClass, any>>;
+    /**
+     * List policy payment methods  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the policy payment methods
+     * @param {PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPaymentMethodsApi
+     */
+    listPolicyPaymentMethods(requestParameters?: PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyPaymentMethodsResponseClass, any>>;
+}