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

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 (93) hide show
  1. package/.openapi-generator/FILES +5 -15
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +34 -38
  4. package/api/bank-transaction-api.ts +73 -77
  5. package/api/{default-api.ts → health-check-api.ts} +21 -17
  6. package/api/payment-methods-api.ts +52 -70
  7. package/api/payment-reminders-api.ts +63 -49
  8. package/api/payment-setup-api.ts +16 -8
  9. package/api/payments-api.ts +52 -70
  10. package/api/refunds-api.ts +76 -88
  11. package/api/tenant-bank-account-api.ts +79 -63
  12. package/api/webhooks-api.ts +16 -12
  13. package/api.ts +2 -2
  14. package/base.ts +15 -7
  15. package/dist/api/bank-accounts-api.d.ts +37 -39
  16. package/dist/api/bank-accounts-api.js +18 -18
  17. package/dist/api/bank-transaction-api.d.ts +77 -79
  18. package/dist/api/bank-transaction-api.js +45 -45
  19. package/dist/api/health-check-api.d.ts +70 -0
  20. package/dist/api/{default-api.js → health-check-api.js} +30 -26
  21. package/dist/api/payment-methods-api.d.ts +49 -58
  22. package/dist/api/payment-methods-api.js +32 -42
  23. package/dist/api/payment-reminders-api.d.ts +55 -46
  24. package/dist/api/payment-reminders-api.js +40 -34
  25. package/dist/api/payment-setup-api.d.ts +16 -8
  26. package/dist/api/payment-setup-api.js +16 -8
  27. package/dist/api/payments-api.d.ts +49 -58
  28. package/dist/api/payments-api.js +32 -42
  29. package/dist/api/refunds-api.d.ts +76 -76
  30. package/dist/api/refunds-api.js +51 -49
  31. package/dist/api/tenant-bank-account-api.d.ts +71 -61
  32. package/dist/api/tenant-bank-account-api.js +51 -45
  33. package/dist/api/webhooks-api.d.ts +16 -12
  34. package/dist/api/webhooks-api.js +14 -10
  35. package/dist/api.d.ts +1 -1
  36. package/dist/api.js +1 -1
  37. package/dist/base.d.ts +3 -1
  38. package/dist/base.js +27 -20
  39. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +20 -34
  40. package/dist/models/create-tenant-bank-account-response-class.d.ts +4 -4
  41. package/dist/models/get-tenant-bank-account-response-class.d.ts +4 -4
  42. package/dist/models/index.d.ts +4 -14
  43. package/dist/models/index.js +4 -14
  44. package/dist/models/list-tenant-bank-account-response-class.d.ts +5 -5
  45. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +10 -10
  46. package/dist/models/tenant-bank-account-class.d.ts +73 -0
  47. package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts} +7 -7
  48. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +20 -34
  49. package/models/create-tenant-bank-account-response-class.ts +4 -4
  50. package/models/get-tenant-bank-account-response-class.ts +4 -4
  51. package/models/index.ts +4 -14
  52. package/models/list-tenant-bank-account-response-class.ts +5 -5
  53. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +10 -10
  54. package/models/tenant-bank-account-class.ts +79 -0
  55. package/models/{create-refund-response-class.ts → update-tenant-bank-account-response-class.ts} +7 -7
  56. package/package.json +1 -1
  57. package/dist/api/default-api.d.ts +0 -66
  58. package/dist/models/bank-account-class.d.ts +0 -73
  59. package/dist/models/create-refund-response-class.d.ts +0 -25
  60. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  61. package/dist/models/get-bank-transactions-response-class.js +0 -15
  62. package/dist/models/get-refund-response-class.d.ts +0 -25
  63. package/dist/models/get-refund-response-class.js +0 -15
  64. package/dist/models/get-request-dto.d.ts +0 -30
  65. package/dist/models/get-request-dto.js +0 -15
  66. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  67. package/dist/models/list-bank-transactions-response-class.js +0 -15
  68. package/dist/models/list-refunds-response-class.d.ts +0 -31
  69. package/dist/models/list-refunds-response-class.js +0 -15
  70. package/dist/models/primary-bank-account-response-class.d.ts +0 -42
  71. package/dist/models/primary-bank-account-response-class.js +0 -15
  72. package/dist/models/refund-class.d.ts +0 -105
  73. package/dist/models/refund-class.js +0 -29
  74. package/dist/models/tenant-bank-account-response-class.js +0 -15
  75. package/dist/models/transaction-class.d.ts +0 -54
  76. package/dist/models/transaction-class.js +0 -15
  77. package/dist/models/update-bank-account-response-class.d.ts +0 -25
  78. package/dist/models/update-bank-account-response-class.js +0 -15
  79. package/models/bank-account-class.ts +0 -79
  80. package/models/get-bank-account-response-class.ts +0 -31
  81. package/models/get-bank-transactions-response-class.ts +0 -31
  82. package/models/get-refund-response-class.ts +0 -31
  83. package/models/get-request-dto.ts +0 -36
  84. package/models/list-bank-transactions-response-class.ts +0 -37
  85. package/models/list-refunds-response-class.ts +0 -37
  86. package/models/primary-bank-account-response-class.ts +0 -48
  87. package/models/refund-class.ts +0 -115
  88. package/models/transaction-class.ts +0 -60
  89. package/models/update-bank-account-response-class.ts +0 -31
  90. /package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +0 -0
  91. /package/dist/models/{bank-transaction-response-class.js → tenant-bank-account-class-without-expand-properties.js} +0 -0
  92. /package/dist/models/{create-refund-response-class.js → tenant-bank-account-class.js} +0 -0
  93. /package/dist/models/{get-bank-account-response-class.js → update-tenant-bank-account-response-class.js} +0 -0
@@ -27,7 +27,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
28
28
  return {
29
29
  /**
30
- *
30
+ * 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.
31
+ * @summary Complete a payment setup
31
32
  * @param {object} body
32
33
  * @param {string} [authorization] Bearer Token
33
34
  * @param {*} [options] Override http request option.
@@ -73,7 +74,8 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
73
74
  };
74
75
  },
75
76
  /**
76
- *
77
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
78
+ * @summary Initiate a payment setup
77
79
  * @param {object} body
78
80
  * @param {string} [authorization] Bearer Token
79
81
  * @param {*} [options] Override http request option.
@@ -129,7 +131,8 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
129
131
  const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
130
132
  return {
131
133
  /**
132
- *
134
+ * 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.
135
+ * @summary Complete a payment setup
133
136
  * @param {object} body
134
137
  * @param {string} [authorization] Bearer Token
135
138
  * @param {*} [options] Override http request option.
@@ -140,7 +143,8 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
140
143
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
141
144
  },
142
145
  /**
143
- *
146
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
147
+ * @summary Initiate a payment setup
144
148
  * @param {object} body
145
149
  * @param {string} [authorization] Bearer Token
146
150
  * @param {*} [options] Override http request option.
@@ -161,7 +165,8 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
161
165
  const localVarFp = PaymentSetupApiFp(configuration)
162
166
  return {
163
167
  /**
164
- *
168
+ * 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.
169
+ * @summary Complete a payment setup
165
170
  * @param {object} body
166
171
  * @param {string} [authorization] Bearer Token
167
172
  * @param {*} [options] Override http request option.
@@ -171,7 +176,8 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
171
176
  return localVarFp.completePaymentSetup(body, authorization, options).then((request) => request(axios, basePath));
172
177
  },
173
178
  /**
174
- *
179
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
180
+ * @summary Initiate a payment setup
175
181
  * @param {object} body
176
182
  * @param {string} [authorization] Bearer Token
177
183
  * @param {*} [options] Override http request option.
@@ -233,7 +239,8 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
233
239
  */
234
240
  export class PaymentSetupApi extends BaseAPI {
235
241
  /**
236
- *
242
+ * 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.
243
+ * @summary Complete a payment setup
237
244
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
238
245
  * @param {*} [options] Override http request option.
239
246
  * @throws {RequiredError}
@@ -244,7 +251,8 @@ export class PaymentSetupApi extends BaseAPI {
244
251
  }
245
252
 
246
253
  /**
247
- *
254
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
255
+ * @summary Initiate a payment setup
248
256
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
249
257
  * @param {*} [options] Override http request option.
250
258
  * @throws {RequiredError}
@@ -29,7 +29,7 @@ import { CreatePaymentRequestDto } from '../models';
29
29
  export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
30
30
  return {
31
31
  /**
32
- * Creates a payment for a specified account. This function is idempotent.
32
+ * This will create a payment for a specified account. This function is idempotent.
33
33
  * @summary Create the payment
34
34
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
35
35
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -85,20 +85,15 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
85
85
  /**
86
86
  * 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.
87
87
  * @summary Retrieve the payment
88
- * @param {string} code
89
- * @param {string} code2 Unique identifier for the object.
90
- * @param {string} expand Fields to expand response by
88
+ * @param {string} code Unique identifier for the object.
91
89
  * @param {string} [authorization] Bearer Token
90
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
92
91
  * @param {*} [options] Override http request option.
93
92
  * @throws {RequiredError}
94
93
  */
95
- getPayment: async (code: string, code2: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
94
+ getPayment: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
96
95
  // verify required parameter 'code' is not null or undefined
97
96
  assertParamExists('getPayment', 'code', code)
98
- // verify required parameter 'code2' is not null or undefined
99
- assertParamExists('getPayment', 'code2', code2)
100
- // verify required parameter 'expand' is not null or undefined
101
- assertParamExists('getPayment', 'expand', expand)
102
97
  const localVarPath = `/paymentservice/v1/payments/{code}`
103
98
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
104
99
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -118,10 +113,6 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
118
113
  // http bearer authentication required
119
114
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
120
115
 
121
- if (code2 !== undefined) {
122
- localVarQueryParameter['code'] = code2;
123
- }
124
-
125
116
  if (expand !== undefined) {
126
117
  localVarQueryParameter['expand'] = expand;
127
118
  }
@@ -142,20 +133,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
142
133
  };
143
134
  },
144
135
  /**
145
- * 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.
136
+ * 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.
146
137
  * @summary List payments
147
138
  * @param {string} [authorization] Bearer Token
148
139
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
149
140
  * @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.
150
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
141
+ * @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;
151
142
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
152
- * @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.
153
- * @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.
154
- * @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.
143
+ * @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;
144
+ * @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;
145
+ * @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;
155
146
  * @param {*} [options] Override http request option.
156
147
  * @throws {RequiredError}
157
148
  */
158
- listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
149
+ listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
159
150
  const localVarPath = `/paymentservice/v1/payments`;
160
151
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
161
152
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -228,7 +219,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
228
219
  const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
229
220
  return {
230
221
  /**
231
- * Creates a payment for a specified account. This function is idempotent.
222
+ * This will create a payment for a specified account. This function is idempotent.
232
223
  * @summary Create the payment
233
224
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
234
225
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -243,32 +234,31 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
243
234
  /**
244
235
  * 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.
245
236
  * @summary Retrieve the payment
246
- * @param {string} code
247
- * @param {string} code2 Unique identifier for the object.
248
- * @param {string} expand Fields to expand response by
237
+ * @param {string} code Unique identifier for the object.
249
238
  * @param {string} [authorization] Bearer Token
239
+ * @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;
250
240
  * @param {*} [options] Override http request option.
251
241
  * @throws {RequiredError}
252
242
  */
253
- async getPayment(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
254
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, code2, expand, authorization, options);
243
+ async getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
244
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, authorization, expand, options);
255
245
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
256
246
  },
257
247
  /**
258
- * 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.
248
+ * 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.
259
249
  * @summary List payments
260
250
  * @param {string} [authorization] Bearer Token
261
251
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
262
252
  * @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.
263
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
253
+ * @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;
264
254
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
265
- * @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.
266
- * @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.
267
- * @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.
255
+ * @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;
256
+ * @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;
257
+ * @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;
268
258
  * @param {*} [options] Override http request option.
269
259
  * @throws {RequiredError}
270
260
  */
271
- async 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>> {
261
+ async listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
272
262
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
273
263
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
274
264
  },
@@ -283,7 +273,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
283
273
  const localVarFp = PaymentsApiFp(configuration)
284
274
  return {
285
275
  /**
286
- * Creates a payment for a specified account. This function is idempotent.
276
+ * This will create a payment for a specified account. This function is idempotent.
287
277
  * @summary Create the payment
288
278
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
289
279
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -297,31 +287,30 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
297
287
  /**
298
288
  * 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.
299
289
  * @summary Retrieve the payment
300
- * @param {string} code
301
- * @param {string} code2 Unique identifier for the object.
302
- * @param {string} expand Fields to expand response by
290
+ * @param {string} code Unique identifier for the object.
303
291
  * @param {string} [authorization] Bearer Token
292
+ * @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;
304
293
  * @param {*} [options] Override http request option.
305
294
  * @throws {RequiredError}
306
295
  */
307
- getPayment(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
308
- return localVarFp.getPayment(code, code2, expand, authorization, options).then((request) => request(axios, basePath));
296
+ getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
297
+ return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
309
298
  },
310
299
  /**
311
- * 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.
300
+ * 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.
312
301
  * @summary List payments
313
302
  * @param {string} [authorization] Bearer Token
314
303
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
315
304
  * @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.
316
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
305
+ * @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;
317
306
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
318
- * @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.
319
- * @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.
320
- * @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.
307
+ * @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;
308
+ * @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;
309
+ * @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;
321
310
  * @param {*} [options] Override http request option.
322
311
  * @throws {RequiredError}
323
312
  */
324
- listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void> {
313
+ listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
325
314
  return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
326
315
  },
327
316
  };
@@ -361,33 +350,26 @@ export interface PaymentsApiCreatePaymentRequest {
361
350
  * @interface PaymentsApiGetPaymentRequest
362
351
  */
363
352
  export interface PaymentsApiGetPaymentRequest {
364
- /**
365
- *
366
- * @type {string}
367
- * @memberof PaymentsApiGetPayment
368
- */
369
- readonly code: string
370
-
371
353
  /**
372
354
  * Unique identifier for the object.
373
355
  * @type {string}
374
356
  * @memberof PaymentsApiGetPayment
375
357
  */
376
- readonly code2: string
358
+ readonly code: string
377
359
 
378
360
  /**
379
- * Fields to expand response by
361
+ * Bearer Token
380
362
  * @type {string}
381
363
  * @memberof PaymentsApiGetPayment
382
364
  */
383
- readonly expand: string
365
+ readonly authorization?: string
384
366
 
385
367
  /**
386
- * Bearer Token
368
+ * 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;
387
369
  * @type {string}
388
370
  * @memberof PaymentsApiGetPayment
389
371
  */
390
- readonly authorization?: string
372
+ readonly expand?: string
391
373
  }
392
374
 
393
375
  /**
@@ -418,11 +400,11 @@ export interface PaymentsApiListPaymentsRequest {
418
400
  readonly pageToken?: any
419
401
 
420
402
  /**
421
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
422
- * @type {any}
403
+ * 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;
404
+ * @type {string}
423
405
  * @memberof PaymentsApiListPayments
424
406
  */
425
- readonly filter?: any
407
+ readonly filter?: string
426
408
 
427
409
  /**
428
410
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -432,25 +414,25 @@ export interface PaymentsApiListPaymentsRequest {
432
414
  readonly search?: any
433
415
 
434
416
  /**
435
- * 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.
436
- * @type {any}
417
+ * 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;
418
+ * @type {string}
437
419
  * @memberof PaymentsApiListPayments
438
420
  */
439
- readonly order?: any
421
+ readonly order?: string
440
422
 
441
423
  /**
442
- * 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.
443
- * @type {any}
424
+ * 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;
425
+ * @type {string}
444
426
  * @memberof PaymentsApiListPayments
445
427
  */
446
- readonly expand?: any
428
+ readonly expand?: string
447
429
 
448
430
  /**
449
- * 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.
450
- * @type {any}
431
+ * 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;
432
+ * @type {string}
451
433
  * @memberof PaymentsApiListPayments
452
434
  */
453
- readonly filters?: any
435
+ readonly filters?: string
454
436
  }
455
437
 
456
438
  /**
@@ -461,7 +443,7 @@ export interface PaymentsApiListPaymentsRequest {
461
443
  */
462
444
  export class PaymentsApi extends BaseAPI {
463
445
  /**
464
- * Creates a payment for a specified account. This function is idempotent.
446
+ * This will create a payment for a specified account. This function is idempotent.
465
447
  * @summary Create the payment
466
448
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
467
449
  * @param {*} [options] Override http request option.
@@ -481,11 +463,11 @@ export class PaymentsApi extends BaseAPI {
481
463
  * @memberof PaymentsApi
482
464
  */
483
465
  public getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig) {
484
- return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
466
+ return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
485
467
  }
486
468
 
487
469
  /**
488
- * 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.
470
+ * 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.
489
471
  * @summary List payments
490
472
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
491
473
  * @param {*} [options] Override http request option.