@emilgroup/payment-sdk 1.4.1-beta.4 → 1.4.1-beta.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/.openapi-generator/FILES +15 -7
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +501 -89
  4. package/api/bank-transaction-api.ts +303 -97
  5. package/api/{default-api.ts → health-check-api.ts} +23 -19
  6. package/api/payment-methods-api.ts +62 -243
  7. package/api/payment-reminders-api.ts +58 -100
  8. package/api/payment-setup-api.ts +18 -10
  9. package/api/payments-api.ts +73 -136
  10. package/api/refunds-api.ts +436 -0
  11. package/api/tenant-bank-account-api.ts +100 -102
  12. package/api/webhooks-api.ts +18 -14
  13. package/api.ts +6 -4
  14. package/base.ts +23 -11
  15. package/common.ts +4 -4
  16. package/configuration.ts +2 -2
  17. package/dist/api/bank-accounts-api.d.ts +293 -70
  18. package/dist/api/bank-accounts-api.js +433 -63
  19. package/dist/api/bank-transaction-api.d.ts +193 -83
  20. package/dist/api/bank-transaction-api.js +253 -66
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +32 -28
  23. package/dist/api/payment-methods-api.d.ts +52 -152
  24. package/dist/api/payment-methods-api.js +49 -179
  25. package/dist/api/payment-reminders-api.d.ts +53 -80
  26. package/dist/api/payment-reminders-api.js +45 -63
  27. package/dist/api/payment-setup-api.d.ts +18 -10
  28. package/dist/api/payment-setup-api.js +18 -10
  29. package/dist/api/payments-api.d.ts +63 -99
  30. package/dist/api/payments-api.js +56 -86
  31. package/dist/api/refunds-api.d.ts +251 -0
  32. package/dist/api/refunds-api.js +439 -0
  33. package/dist/api/tenant-bank-account-api.d.ts +94 -89
  34. package/dist/api/tenant-bank-account-api.js +72 -64
  35. package/dist/api/webhooks-api.d.ts +18 -14
  36. package/dist/api/webhooks-api.js +16 -12
  37. package/dist/api.d.ts +4 -3
  38. package/dist/api.js +4 -3
  39. package/dist/base.d.ts +7 -4
  40. package/dist/base.js +32 -23
  41. package/dist/common.d.ts +4 -4
  42. package/dist/common.js +2 -2
  43. package/dist/configuration.d.ts +2 -2
  44. package/dist/configuration.js +2 -2
  45. package/dist/index.d.ts +2 -2
  46. package/dist/index.js +2 -2
  47. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +32 -34
  48. package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +2 -2
  49. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  50. package/dist/models/{get-request-dto.js → create-bank-account-request-dto.js} +2 -2
  51. package/dist/models/create-payment-reminder-request-dto.d.ts +2 -2
  52. package/dist/models/create-payment-reminder-request-dto.js +2 -2
  53. package/dist/models/create-payment-request-dto.d.ts +4 -4
  54. package/dist/models/create-payment-request-dto.js +2 -2
  55. package/dist/models/create-refund-request-dto.d.ts +24 -0
  56. package/dist/models/{get-bank-transactions-response-class.js → create-refund-request-dto.js} +2 -2
  57. package/dist/models/create-tenant-bank-account-request-dto.d.ts +2 -2
  58. package/dist/models/create-tenant-bank-account-request-dto.js +2 -2
  59. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  60. package/dist/models/{list-bank-transactions-response-class.js → create-tenant-bank-account-response-class.js} +2 -2
  61. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +2 -2
  62. package/dist/models/deactivate-payment-reminder-request-dto.js +2 -2
  63. package/dist/models/get-tenant-bank-account-response-class.d.ts +6 -6
  64. package/dist/models/get-tenant-bank-account-response-class.js +2 -2
  65. package/dist/models/index.d.ts +13 -6
  66. package/dist/models/index.js +13 -6
  67. package/dist/models/inline-response200.d.ts +2 -2
  68. package/dist/models/inline-response200.js +2 -2
  69. package/dist/models/inline-response503.d.ts +2 -2
  70. package/dist/models/inline-response503.js +2 -2
  71. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
  72. package/dist/models/link-bank-transaction-request-dto-rest.js +15 -0
  73. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  74. package/dist/models/list-tenant-bank-account-response-class.js +15 -0
  75. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  76. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  77. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +78 -0
  78. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  79. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  80. package/dist/models/tenant-bank-account-class.js +15 -0
  81. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
  82. package/dist/models/unlink-bank-transaction-request-dto-rest.js +15 -0
  83. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  84. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  85. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  86. package/dist/models/update-bank-account-request-dto.js +15 -0
  87. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  88. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  89. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +2 -2
  90. package/dist/models/update-tenant-bank-account-rest-request-dto.js +2 -2
  91. package/dist/models/validate-pspconfig-request-dto.d.ts +2 -2
  92. package/dist/models/validate-pspconfig-request-dto.js +2 -2
  93. package/index.ts +2 -2
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +32 -34
  95. package/models/create-bank-account-request-dto.ts +48 -0
  96. package/models/create-payment-reminder-request-dto.ts +2 -2
  97. package/models/create-payment-request-dto.ts +4 -4
  98. package/models/create-refund-request-dto.ts +30 -0
  99. package/models/create-tenant-bank-account-request-dto.ts +2 -2
  100. package/models/create-tenant-bank-account-response-class.ts +31 -0
  101. package/models/deactivate-payment-reminder-request-dto.ts +2 -2
  102. package/models/get-tenant-bank-account-response-class.ts +6 -6
  103. package/models/index.ts +13 -6
  104. package/models/inline-response200.ts +2 -2
  105. package/models/inline-response503.ts +2 -2
  106. package/models/link-bank-transaction-request-dto-rest.ts +30 -0
  107. package/models/list-tenant-bank-account-response-class.ts +37 -0
  108. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  109. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +24 -12
  110. package/models/tenant-bank-account-class.ts +91 -0
  111. package/models/unlink-bank-transaction-request-dto-rest.ts +30 -0
  112. package/models/update-bank-account-request-dto-rest.ts +36 -0
  113. package/models/update-bank-account-request-dto.ts +42 -0
  114. package/models/update-tenant-bank-account-response-class.ts +31 -0
  115. package/models/update-tenant-bank-account-rest-request-dto.ts +2 -2
  116. package/models/validate-pspconfig-request-dto.ts +2 -2
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  120. package/dist/models/get-request-dto.d.ts +0 -30
  121. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  122. package/dist/models/tenant-bank-account-response-class.d.ts +0 -66
  123. package/dist/models/tenant-bank-account-response-class.js +0 -15
  124. package/dist/models/transaction-class.d.ts +0 -54
  125. package/dist/models/transaction-class.js +0 -15
  126. package/models/get-bank-transactions-response-class.ts +0 -31
  127. package/models/get-request-dto.ts +0 -36
  128. package/models/list-bank-transactions-response-class.ts +0 -37
  129. package/models/transaction-class.ts +0 -60
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Emil Payment Service
3
- * 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
- * Contact: z
6
+ * Contact: kontakt@emil.de
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
@@ -18,7 +18,8 @@ import { RequestArgs, BaseAPI } from '../base';
18
18
  */
19
19
  export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- *
21
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
22
+ * @summary Complete a payment setup
22
23
  * @param {object} body
23
24
  * @param {string} [authorization] Bearer Token
24
25
  * @param {*} [options] Override http request option.
@@ -26,7 +27,8 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
26
27
  */
27
28
  completePaymentSetup: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
28
29
  /**
29
- *
30
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
31
+ * @summary Initiate a payment setup
30
32
  * @param {object} body
31
33
  * @param {string} [authorization] Bearer Token
32
34
  * @param {*} [options] Override http request option.
@@ -40,7 +42,8 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
40
42
  */
41
43
  export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
42
44
  /**
43
- *
45
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
46
+ * @summary Complete a payment setup
44
47
  * @param {object} body
45
48
  * @param {string} [authorization] Bearer Token
46
49
  * @param {*} [options] Override http request option.
@@ -48,7 +51,8 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
48
51
  */
49
52
  completePaymentSetup(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
50
53
  /**
51
- *
54
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
55
+ * @summary Initiate a payment setup
52
56
  * @param {object} body
53
57
  * @param {string} [authorization] Bearer Token
54
58
  * @param {*} [options] Override http request option.
@@ -62,7 +66,8 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
62
66
  */
63
67
  export declare const PaymentSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
64
68
  /**
65
- *
69
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
70
+ * @summary Complete a payment setup
66
71
  * @param {object} body
67
72
  * @param {string} [authorization] Bearer Token
68
73
  * @param {*} [options] Override http request option.
@@ -70,7 +75,8 @@ export declare const PaymentSetupApiFactory: (configuration?: Configuration, bas
70
75
  */
71
76
  completePaymentSetup(body: object, authorization?: string, options?: any): AxiosPromise<void>;
72
77
  /**
73
- *
78
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
79
+ * @summary Initiate a payment setup
74
80
  * @param {object} body
75
81
  * @param {string} [authorization] Bearer Token
76
82
  * @param {*} [options] Override http request option.
@@ -124,7 +130,8 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
124
130
  */
125
131
  export declare class PaymentSetupApi extends BaseAPI {
126
132
  /**
127
- *
133
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
134
+ * @summary Complete a payment setup
128
135
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
129
136
  * @param {*} [options] Override http request option.
130
137
  * @throws {RequiredError}
@@ -132,7 +139,8 @@ export declare class PaymentSetupApi extends BaseAPI {
132
139
  */
133
140
  completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
134
141
  /**
135
- *
142
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
143
+ * @summary Initiate a payment setup
136
144
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
137
145
  * @param {*} [options] Override http request option.
138
146
  * @throws {RequiredError}
@@ -3,10 +3,10 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Emil Payment Service
6
- * 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.
6
+ * 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.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0
9
- * Contact: z
9
+ * Contact: kontakt@emil.de
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
12
  * https://openapi-generator.tech
@@ -93,7 +93,8 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- *
96
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
97
+ * @summary Complete a payment setup
97
98
  * @param {object} body
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- *
145
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
146
+ * @summary Initiate a payment setup
145
147
  * @param {object} body
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -199,7 +201,8 @@ var PaymentSetupApiFp = function (configuration) {
199
201
  var localVarAxiosParamCreator = (0, exports.PaymentSetupApiAxiosParamCreator)(configuration);
200
202
  return {
201
203
  /**
202
- *
204
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
205
+ * @summary Complete a payment setup
203
206
  * @param {object} body
204
207
  * @param {string} [authorization] Bearer Token
205
208
  * @param {*} [options] Override http request option.
@@ -219,7 +222,8 @@ var PaymentSetupApiFp = function (configuration) {
219
222
  });
220
223
  },
221
224
  /**
222
- *
225
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
226
+ * @summary Initiate a payment setup
223
227
  * @param {object} body
224
228
  * @param {string} [authorization] Bearer Token
225
229
  * @param {*} [options] Override http request option.
@@ -249,7 +253,8 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
249
253
  var localVarFp = (0, exports.PaymentSetupApiFp)(configuration);
250
254
  return {
251
255
  /**
252
- *
256
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
257
+ * @summary Complete a payment setup
253
258
  * @param {object} body
254
259
  * @param {string} [authorization] Bearer Token
255
260
  * @param {*} [options] Override http request option.
@@ -259,7 +264,8 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
259
264
  return localVarFp.completePaymentSetup(body, authorization, options).then(function (request) { return request(axios, basePath); });
260
265
  },
261
266
  /**
262
- *
267
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
268
+ * @summary Initiate a payment setup
263
269
  * @param {object} body
264
270
  * @param {string} [authorization] Bearer Token
265
271
  * @param {*} [options] Override http request option.
@@ -283,7 +289,8 @@ var PaymentSetupApi = /** @class */ (function (_super) {
283
289
  return _super !== null && _super.apply(this, arguments) || this;
284
290
  }
285
291
  /**
286
- *
292
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
293
+ * @summary Complete a payment setup
287
294
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
288
295
  * @param {*} [options] Override http request option.
289
296
  * @throws {RequiredError}
@@ -294,7 +301,8 @@ var PaymentSetupApi = /** @class */ (function (_super) {
294
301
  return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.body, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
295
302
  };
296
303
  /**
297
- *
304
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
305
+ * @summary Initiate a payment setup
298
306
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
299
307
  * @param {*} [options] Override http request option.
300
308
  * @throws {RequiredError}
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Emil Payment Service
3
- * 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
- * Contact: z
6
+ * Contact: kontakt@emil.de
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
@@ -19,8 +19,8 @@ import { CreatePaymentRequestDto } from '../models';
19
19
  */
20
20
  export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- * Creates a payment for a specified account. This function is idempotent.
23
- * @summary Create a payment
22
+ * This will create a payment for a specified account. This function is idempotent.
23
+ * @summary Create the payment
24
24
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
25
25
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
26
26
  * @param {string} [authorization] Bearer Token
@@ -29,31 +29,27 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
29
29
  */
30
30
  createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
31
  /**
32
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
33
- * @summary Retrieve a payment
34
- * @param {string} code Unique identifier for the object.
35
- * @param {string} expand Fields to expand response by
36
- * @param {string} expand2 Fields to expand response by
32
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
33
+ * @summary Retrieve the payment
34
+ * @param {string} code
37
35
  * @param {string} [authorization] Bearer Token
36
+ * @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: transactions&lt;i&gt;
38
37
  * @param {*} [options] Override http request option.
39
38
  * @throws {RequiredError}
40
39
  */
41
- getPayment: (code: string, expand: string, expand2: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
+ getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
41
  /**
43
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
42
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
44
43
  * @summary List payments
45
44
  * @param {string} [authorization] Bearer Token
46
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
47
- * @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.
48
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
49
- * @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.
50
- * @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.
51
- * @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.
52
- * @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.
45
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
46
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
47
+ * @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, code, amount&lt;/i&gt;
48
+ * @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: transactions&lt;i&gt;
53
49
  * @param {*} [options] Override http request option.
54
50
  * @throws {RequiredError}
55
51
  */
56
- listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
+ listPayments: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
53
  };
58
54
  /**
59
55
  * PaymentsApi - functional programming interface
@@ -61,8 +57,8 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
61
57
  */
62
58
  export declare const PaymentsApiFp: (configuration?: Configuration) => {
63
59
  /**
64
- * Creates a payment for a specified account. This function is idempotent.
65
- * @summary Create a payment
60
+ * This will create a payment for a specified account. This function is idempotent.
61
+ * @summary Create the payment
66
62
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
67
63
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
68
64
  * @param {string} [authorization] Bearer Token
@@ -71,31 +67,27 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
71
67
  */
72
68
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
73
69
  /**
74
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
75
- * @summary Retrieve a payment
76
- * @param {string} code Unique identifier for the object.
77
- * @param {string} expand Fields to expand response by
78
- * @param {string} expand2 Fields to expand response by
70
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
71
+ * @summary Retrieve the payment
72
+ * @param {string} code
79
73
  * @param {string} [authorization] Bearer Token
74
+ * @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: transactions&lt;i&gt;
80
75
  * @param {*} [options] Override http request option.
81
76
  * @throws {RequiredError}
82
77
  */
83
- getPayment(code: string, expand: string, expand2: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
78
+ getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
84
79
  /**
85
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
80
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
86
81
  * @summary List payments
87
82
  * @param {string} [authorization] Bearer Token
88
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
89
- * @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.
90
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
91
- * @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.
92
- * @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.
93
- * @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.
94
- * @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.
83
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
84
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
85
+ * @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, code, amount&lt;/i&gt;
86
+ * @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: transactions&lt;i&gt;
95
87
  * @param {*} [options] Override http request option.
96
88
  * @throws {RequiredError}
97
89
  */
98
- listPayments(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>>;
90
+ listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
99
91
  };
100
92
  /**
101
93
  * PaymentsApi - factory interface
@@ -103,8 +95,8 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
103
95
  */
104
96
  export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
105
97
  /**
106
- * Creates a payment for a specified account. This function is idempotent.
107
- * @summary Create a payment
98
+ * This will create a payment for a specified account. This function is idempotent.
99
+ * @summary Create the payment
108
100
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
109
101
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
110
102
  * @param {string} [authorization] Bearer Token
@@ -113,31 +105,27 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
113
105
  */
114
106
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
115
107
  /**
116
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
117
- * @summary Retrieve a payment
118
- * @param {string} code Unique identifier for the object.
119
- * @param {string} expand Fields to expand response by
120
- * @param {string} expand2 Fields to expand response by
108
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
109
+ * @summary Retrieve the payment
110
+ * @param {string} code
121
111
  * @param {string} [authorization] Bearer Token
112
+ * @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: transactions&lt;i&gt;
122
113
  * @param {*} [options] Override http request option.
123
114
  * @throws {RequiredError}
124
115
  */
125
- getPayment(code: string, expand: string, expand2: string, authorization?: string, options?: any): AxiosPromise<void>;
116
+ getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
126
117
  /**
127
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
118
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
128
119
  * @summary List payments
129
120
  * @param {string} [authorization] Bearer Token
130
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
131
- * @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.
132
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
133
- * @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.
134
- * @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.
135
- * @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.
136
- * @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.
121
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
122
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
123
+ * @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, code, amount&lt;/i&gt;
124
+ * @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: transactions&lt;i&gt;
137
125
  * @param {*} [options] Override http request option.
138
126
  * @throws {RequiredError}
139
127
  */
140
- listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
128
+ listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
141
129
  };
142
130
  /**
143
131
  * Request parameters for createPayment operation in PaymentsApi.
@@ -171,29 +159,23 @@ export interface PaymentsApiCreatePaymentRequest {
171
159
  */
172
160
  export interface PaymentsApiGetPaymentRequest {
173
161
  /**
174
- * Unique identifier for the object.
162
+ *
175
163
  * @type {string}
176
164
  * @memberof PaymentsApiGetPayment
177
165
  */
178
166
  readonly code: string;
179
167
  /**
180
- * Fields to expand response by
181
- * @type {string}
182
- * @memberof PaymentsApiGetPayment
183
- */
184
- readonly expand: string;
185
- /**
186
- * Fields to expand response by
168
+ * Bearer Token
187
169
  * @type {string}
188
170
  * @memberof PaymentsApiGetPayment
189
171
  */
190
- readonly expand2: string;
172
+ readonly authorization?: string;
191
173
  /**
192
- * Bearer Token
174
+ * 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: transactions&lt;i&gt;
193
175
  * @type {string}
194
176
  * @memberof PaymentsApiGetPayment
195
177
  */
196
- readonly authorization?: string;
178
+ readonly expand?: string;
197
179
  }
198
180
  /**
199
181
  * Request parameters for listPayments operation in PaymentsApi.
@@ -208,47 +190,29 @@ export interface PaymentsApiListPaymentsRequest {
208
190
  */
209
191
  readonly authorization?: string;
210
192
  /**
211
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
212
- * @type {any}
213
- * @memberof PaymentsApiListPayments
214
- */
215
- readonly pageSize?: any;
216
- /**
217
- * 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.
218
- * @type {any}
219
- * @memberof PaymentsApiListPayments
220
- */
221
- readonly pageToken?: any;
222
- /**
223
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
224
- * @type {any}
225
- * @memberof PaymentsApiListPayments
226
- */
227
- readonly filter?: any;
228
- /**
229
- * 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.
230
- * @type {any}
193
+ * 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
194
+ * @type {string}
231
195
  * @memberof PaymentsApiListPayments
232
196
  */
233
- readonly search?: any;
197
+ readonly filter?: string;
234
198
  /**
235
- * 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.
236
- * @type {any}
199
+ * 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber&lt;/i&gt;
200
+ * @type {string}
237
201
  * @memberof PaymentsApiListPayments
238
202
  */
239
- readonly order?: any;
203
+ readonly filters?: string;
240
204
  /**
241
- * 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.
242
- * @type {any}
205
+ * 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, code, amount&lt;/i&gt;
206
+ * @type {string}
243
207
  * @memberof PaymentsApiListPayments
244
208
  */
245
- readonly expand?: any;
209
+ readonly order?: string;
246
210
  /**
247
- * 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.
248
- * @type {any}
211
+ * 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: transactions&lt;i&gt;
212
+ * @type {string}
249
213
  * @memberof PaymentsApiListPayments
250
214
  */
251
- readonly filters?: any;
215
+ readonly expand?: string;
252
216
  }
253
217
  /**
254
218
  * PaymentsApi - object-oriented interface
@@ -258,8 +222,8 @@ export interface PaymentsApiListPaymentsRequest {
258
222
  */
259
223
  export declare class PaymentsApi extends BaseAPI {
260
224
  /**
261
- * Creates a payment for a specified account. This function is idempotent.
262
- * @summary Create a payment
225
+ * This will create a payment for a specified account. This function is idempotent.
226
+ * @summary Create the payment
263
227
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
264
228
  * @param {*} [options] Override http request option.
265
229
  * @throws {RequiredError}
@@ -267,8 +231,8 @@ export declare class PaymentsApi extends BaseAPI {
267
231
  */
268
232
  createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
269
233
  /**
270
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
271
- * @summary Retrieve a payment
234
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
235
+ * @summary Retrieve the payment
272
236
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
273
237
  * @param {*} [options] Override http request option.
274
238
  * @throws {RequiredError}
@@ -276,7 +240,7 @@ export declare class PaymentsApi extends BaseAPI {
276
240
  */
277
241
  getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
278
242
  /**
279
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
243
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
280
244
  * @summary List payments
281
245
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
282
246
  * @param {*} [options] Override http request option.