@emilgroup/payment-sdk 1.4.1-beta.3 → 1.4.1-beta.30

package/dist/api/payment-methods-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
@@ -12,10 +12,6 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
-import { CreatePaymentMethodResponseClass } from '../models';
-import { CreatePspPaymentMethodRequestDto } from '../models';
-import { GetPaymentMethodResponseClass } from '../models';
-import { ListPaymentMethodsResponseClass } from '../models';
 /**
  * PaymentMethodsApi - axios parameter creator
  * @export
@@ -23,41 +19,32 @@ import { ListPaymentMethodsResponseClass } from '../models';
 export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * This will create payment method in the database as well as in the PSP.     The newly created payment method will be set as default payment method will be used by the customer     to pay or receive a refund.
-     * @summary Create the payment-method
-     * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
+     * @summary Create the payment method
+     * @param {object} body
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentMethod: (createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Permanently deletes a payment method. Supply the unique payment      method id that was returned when you created the payment method and this will delete      it. It will also delete it on the corresponding payment service provider.
-     * @summary Delete a payment method
-     * @param {number} id Unique identifier for payment method
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deletePaymentMethod: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createPaymentMethod: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves the details of a payment method that was previously created. Supply the unique payment      method code that was returned when you created the payment method and Emil Api will return the corresponding      payment  method information.
-     * @summary Retrieve a payment method
-     * @param {string} code Unique identifier for the object.
+     * @summary Retrieve the payment method
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} expand Fields to expand response by
      * @param {string} [authorization] Bearer Token
-     * @param {string} [expand] Fields to expand response by
-     * @param {string} [expand2] Fields to expand response by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPaymentMethod: (code: string, authorization?: string, expand?: string, expand2?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPaymentMethod: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of payment methods you’ve previously created. The payment methods are returned      in sorted order, with the oldest payment appearing first. For more information about pagination, read the      Pagination documentation.
+     * Returns a list of payment methods you have previously created.        The payment methods are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List payment methods
      * @param {string} [authorization] Bearer Token
      * @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} [search] To search the list by any field, pass search&#x3D;xxx 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.
@@ -73,48 +60,39 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
 export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
     /**
      * This will create payment method in the database as well as in the PSP.     The newly created payment method will be set as default payment method will be used by the customer     to pay or receive a refund.
-     * @summary Create the payment-method
-     * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentMethodResponseClass>>;
-    /**
-     * Permanently deletes a payment method. Supply the unique payment      method id that was returned when you created the payment method and this will delete      it. It will also delete it on the corresponding payment service provider.
-     * @summary Delete a payment method
-     * @param {number} id Unique identifier for payment method
+     * @summary Create the payment method
+     * @param {object} body
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deletePaymentMethod(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    createPaymentMethod(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Retrieves the details of a payment method that was previously created. Supply the unique payment      method code that was returned when you created the payment method and Emil Api will return the corresponding      payment  method information.
-     * @summary Retrieve a payment method
-     * @param {string} code Unique identifier for the object.
+     * @summary Retrieve the payment method
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} expand Fields to expand response by
      * @param {string} [authorization] Bearer Token
-     * @param {string} [expand] Fields to expand response by
-     * @param {string} [expand2] Fields to expand response by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPaymentMethod(code: string, authorization?: string, expand?: string, expand2?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodResponseClass>>;
+    getPaymentMethod(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Returns a list of payment methods you’ve previously created. The payment methods are returned      in sorted order, with the oldest payment appearing first. For more information about pagination, read the      Pagination documentation.
+     * Returns a list of payment methods you have previously created.        The payment methods are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List payment methods
      * @param {string} [authorization] Bearer Token
      * @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} [search] To search the list by any field, pass search&#x3D;xxx 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 {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentMethodsResponseClass>>;
+    listPaymentMethods(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>>;
 };
 /**
  * PaymentMethodsApi - factory interface
@@ -123,48 +101,39 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
 export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      * This will create payment method in the database as well as in the PSP.     The newly created payment method will be set as default payment method will be used by the customer     to pay or receive a refund.
-     * @summary Create the payment-method
-     * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
+     * @summary Create the payment method
+     * @param {object} body
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentMethodResponseClass>;
-    /**
-     * Permanently deletes a payment method. Supply the unique payment      method id that was returned when you created the payment method and this will delete      it. It will also delete it on the corresponding payment service provider.
-     * @summary Delete a payment method
-     * @param {number} id Unique identifier for payment method
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deletePaymentMethod(id: number, authorization?: string, options?: any): AxiosPromise<void>;
+    createPaymentMethod(body: object, authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * Retrieves the details of a payment method that was previously created. Supply the unique payment      method code that was returned when you created the payment method and Emil Api will return the corresponding      payment  method information.
-     * @summary Retrieve a payment method
-     * @param {string} code Unique identifier for the object.
+     * @summary Retrieve the payment method
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} expand Fields to expand response by
      * @param {string} [authorization] Bearer Token
-     * @param {string} [expand] Fields to expand response by
-     * @param {string} [expand2] Fields to expand response by
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPaymentMethod(code: string, authorization?: string, expand?: string, expand2?: string, options?: any): AxiosPromise<GetPaymentMethodResponseClass>;
+    getPaymentMethod(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * Returns a list of payment methods you’ve previously created. The payment methods are returned      in sorted order, with the oldest payment appearing first. For more information about pagination, read the      Pagination documentation.
+     * Returns a list of payment methods you have previously created.        The payment methods are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List payment methods
      * @param {string} [authorization] Bearer Token
      * @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} [search] To search the list by any field, pass search&#x3D;xxx 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 {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPaymentMethodsResponseClass>;
+    listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
 };
 /**
  * Request parameters for createPaymentMethod operation in PaymentMethodsApi.
@@ -174,10 +143,10 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
 export interface PaymentMethodsApiCreatePaymentMethodRequest {
     /**
      *
-     * @type {CreatePspPaymentMethodRequestDto}
+     * @type {object}
      * @memberof PaymentMethodsApiCreatePaymentMethod
      */
-    readonly createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto;
+    readonly body: object;
     /**
      * Bearer Token
      * @type {string}
@@ -185,25 +154,6 @@ export interface PaymentMethodsApiCreatePaymentMethodRequest {
      */
     readonly authorization?: string;
 }
-/**
- * Request parameters for deletePaymentMethod operation in PaymentMethodsApi.
- * @export
- * @interface PaymentMethodsApiDeletePaymentMethodRequest
- */
-export interface PaymentMethodsApiDeletePaymentMethodRequest {
-    /**
-     * Unique identifier for payment method
-     * @type {number}
-     * @memberof PaymentMethodsApiDeletePaymentMethod
-     */
-    readonly id: number;
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof PaymentMethodsApiDeletePaymentMethod
-     */
-    readonly authorization?: string;
-}
 /**
  * Request parameters for getPaymentMethod operation in PaymentMethodsApi.
  * @export
@@ -211,29 +161,29 @@ export interface PaymentMethodsApiDeletePaymentMethodRequest {
  */
 export interface PaymentMethodsApiGetPaymentMethodRequest {
     /**
-     * Unique identifier for the object.
+     *
      * @type {string}
      * @memberof PaymentMethodsApiGetPaymentMethod
      */
     readonly code: string;
     /**
-     * Bearer Token
+     * Unique identifier for the object.
      * @type {string}
      * @memberof PaymentMethodsApiGetPaymentMethod
      */
-    readonly authorization?: string;
+    readonly code2: string;
     /**
      * Fields to expand response by
      * @type {string}
      * @memberof PaymentMethodsApiGetPaymentMethod
      */
-    readonly expand?: string;
+    readonly expand: string;
     /**
-     * Fields to expand response by
+     * Bearer Token
      * @type {string}
      * @memberof PaymentMethodsApiGetPaymentMethod
      */
-    readonly expand2?: string;
+    readonly authorization?: string;
 }
 /**
  * Request parameters for listPaymentMethods operation in PaymentMethodsApi.
@@ -266,7 +216,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
      */
     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.
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {any}
      * @memberof PaymentMethodsApiListPaymentMethods
      */
@@ -299,38 +249,29 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
 export declare class PaymentMethodsApi extends BaseAPI {
     /**
      * This will create payment method in the database as well as in the PSP.     The newly created payment method will be set as default payment method will be used by the customer     to pay or receive a refund.
-     * @summary Create the payment-method
+     * @summary Create the payment method
      * @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PaymentMethodsApi
      */
-    createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentMethodResponseClass, any>>;
-    /**
-     * Permanently deletes a payment method. Supply the unique payment      method id that was returned when you created the payment method and this will delete      it. It will also delete it on the corresponding payment service provider.
-     * @summary Delete a payment method
-     * @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PaymentMethodsApi
-     */
-    deletePaymentMethod(requestParameters: PaymentMethodsApiDeletePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Retrieves the details of a payment method that was previously created. Supply the unique payment      method code that was returned when you created the payment method and Emil Api will return the corresponding      payment  method information.
-     * @summary Retrieve a payment method
+     * @summary Retrieve the payment method
      * @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PaymentMethodsApi
      */
-    getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentMethodResponseClass, any>>;
+    getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Returns a list of payment methods you’ve previously created. The payment methods are returned      in sorted order, with the oldest payment appearing first. For more information about pagination, read the      Pagination documentation.
+     * Returns a list of payment methods you have previously created.        The payment methods are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List payment methods
      * @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PaymentMethodsApi
      */
-    listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentMethodsResponseClass, any>>;
+    listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }