@emilgroup/payment-sdk 1.16.1-beta.6 → 1.16.1-beta.60

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 (101) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +16 -16
  4. package/api/bank-orders-api.ts +16 -16
  5. package/api/bank-transaction-api.ts +12 -12
  6. package/api/billing-addresses-api.ts +12 -12
  7. package/api/credit-allocation-api.ts +12 -12
  8. package/api/exceeding-credits-api.ts +12 -12
  9. package/api/ibanvalidator-api.ts +165 -0
  10. package/api/payment-methods-api.ts +12 -12
  11. package/api/payment-receipts-api.ts +676 -0
  12. package/api/payment-reminders-api.ts +12 -12
  13. package/api/payment-requests-api.ts +20 -20
  14. package/api/payments-api.ts +12 -12
  15. package/api/payout-methods-api.ts +138 -20
  16. package/api/refunds-api.ts +12 -12
  17. package/api/tenant-bank-account-api.ts +12 -12
  18. package/api.ts +4 -0
  19. package/dist/api/bank-accounts-api.d.ts +16 -16
  20. package/dist/api/bank-accounts-api.js +13 -13
  21. package/dist/api/bank-orders-api.d.ts +16 -16
  22. package/dist/api/bank-orders-api.js +14 -14
  23. package/dist/api/bank-transaction-api.d.ts +12 -12
  24. package/dist/api/bank-transaction-api.js +10 -10
  25. package/dist/api/billing-addresses-api.d.ts +12 -12
  26. package/dist/api/billing-addresses-api.js +10 -10
  27. package/dist/api/credit-allocation-api.d.ts +12 -12
  28. package/dist/api/credit-allocation-api.js +10 -10
  29. package/dist/api/exceeding-credits-api.d.ts +12 -12
  30. package/dist/api/exceeding-credits-api.js +10 -10
  31. package/dist/api/ibanvalidator-api.d.ts +97 -0
  32. package/dist/api/ibanvalidator-api.js +224 -0
  33. package/dist/api/payment-methods-api.d.ts +12 -12
  34. package/dist/api/payment-methods-api.js +10 -10
  35. package/dist/api/payment-receipts-api.d.ts +383 -0
  36. package/dist/api/payment-receipts-api.js +637 -0
  37. package/dist/api/payment-reminders-api.d.ts +12 -12
  38. package/dist/api/payment-reminders-api.js +10 -10
  39. package/dist/api/payment-requests-api.d.ts +20 -20
  40. package/dist/api/payment-requests-api.js +15 -15
  41. package/dist/api/payments-api.d.ts +12 -12
  42. package/dist/api/payments-api.js +10 -10
  43. package/dist/api/payout-methods-api.d.ts +85 -20
  44. package/dist/api/payout-methods-api.js +115 -16
  45. package/dist/api/refunds-api.d.ts +12 -12
  46. package/dist/api/refunds-api.js +10 -10
  47. package/dist/api/tenant-bank-account-api.d.ts +12 -12
  48. package/dist/api/tenant-bank-account-api.js +10 -10
  49. package/dist/api.d.ts +2 -0
  50. package/dist/api.js +2 -0
  51. package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
  52. package/dist/models/bank-account-class.d.ts +6 -0
  53. package/dist/models/bank-data-class.d.ts +36 -0
  54. package/dist/models/bank-data-class.js +15 -0
  55. package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
  56. package/dist/models/create-payment-receipt-request-dto.js +20 -0
  57. package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
  58. package/dist/models/create-payment-receipt-response-class.js +15 -0
  59. package/dist/models/create-payment-request-request-dto.d.ts +48 -11
  60. package/dist/models/create-payment-request-request-dto.js +8 -4
  61. package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
  62. package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
  63. package/dist/models/create-payout-method-request-dto.d.ts +8 -2
  64. package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
  65. package/dist/models/get-payment-receipt-response-class.js +15 -0
  66. package/dist/models/index.d.ts +10 -0
  67. package/dist/models/index.js +10 -0
  68. package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
  69. package/dist/models/list-payment-receipts-response-class.js +15 -0
  70. package/dist/models/payment-receipt-class.d.ts +101 -0
  71. package/dist/models/payment-receipt-class.js +20 -0
  72. package/dist/models/payment-request-class.d.ts +56 -12
  73. package/dist/models/payment-request-class.js +9 -5
  74. package/dist/models/payout-method-class.d.ts +6 -0
  75. package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
  76. package/dist/models/update-payment-receipt-response-class.js +15 -0
  77. package/dist/models/update-payment-request-request-dto.d.ts +2 -2
  78. package/dist/models/update-payment-request-request-dto.js +1 -1
  79. package/dist/models/validate-iban-request-dto.d.ts +24 -0
  80. package/dist/models/validate-iban-request-dto.js +15 -0
  81. package/dist/models/validate-iban-response-class.d.ts +31 -0
  82. package/dist/models/validate-iban-response-class.js +15 -0
  83. package/models/bank-account-class-without-expand-properties.ts +6 -0
  84. package/models/bank-account-class.ts +6 -0
  85. package/models/bank-data-class.ts +42 -0
  86. package/models/create-payment-receipt-request-dto.ts +74 -0
  87. package/models/create-payment-receipt-response-class.ts +31 -0
  88. package/models/create-payment-request-request-dto.ts +47 -11
  89. package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
  90. package/models/create-payout-method-request-dto.ts +8 -2
  91. package/models/get-payment-receipt-response-class.ts +31 -0
  92. package/models/index.ts +10 -0
  93. package/models/list-payment-receipts-response-class.ts +49 -0
  94. package/models/payment-receipt-class.ts +110 -0
  95. package/models/payment-request-class.ts +55 -12
  96. package/models/payout-method-class.ts +6 -0
  97. package/models/update-payment-receipt-response-class.ts +31 -0
  98. package/models/update-payment-request-request-dto.ts +2 -2
  99. package/models/validate-iban-request-dto.ts +30 -0
  100. package/models/validate-iban-response-class.ts +37 -0
  101. package/package.json +2 -2
@@ -0,0 +1,676 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * 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
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CreatePaymentReceiptRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreatePaymentReceiptResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetPaymentReceiptResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListPaymentReceiptsResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { UpdatePaymentReceiptResponseClass } from '../models';
33
+ /**
34
+ * PaymentReceiptsApi - axios parameter creator
35
+ * @export
36
+ */
37
+ export const PaymentReceiptsApiAxiosParamCreator = function (configuration?: Configuration) {
38
+ return {
39
+ /**
40
+ * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
41
+ * @summary Create the payment receipt
42
+ * @param {CreatePaymentReceiptRequestDto} createPaymentReceiptRequestDto
43
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ createPaymentReceipt: async (createPaymentReceiptRequestDto: CreatePaymentReceiptRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
48
+ // verify required parameter 'createPaymentReceiptRequestDto' is not null or undefined
49
+ assertParamExists('createPaymentReceipt', 'createPaymentReceiptRequestDto', createPaymentReceiptRequestDto)
50
+ const localVarPath = `/paymentservice/v1/payment-receipts`;
51
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
53
+ let baseOptions;
54
+ let baseAccessToken;
55
+ if (configuration) {
56
+ baseOptions = configuration.baseOptions;
57
+ baseAccessToken = configuration.accessToken;
58
+ }
59
+
60
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
61
+ const localVarHeaderParameter = {} as any;
62
+ const localVarQueryParameter = {} as any;
63
+
64
+ // authentication bearer required
65
+ // http bearer authentication required
66
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
67
+
68
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
69
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
70
+ }
71
+
72
+
73
+
74
+ localVarHeaderParameter['Content-Type'] = 'application/json';
75
+
76
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
78
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
79
+ localVarRequestOptions.data = serializeDataIfNeeded(createPaymentReceiptRequestDto, localVarRequestOptions, configuration)
80
+
81
+ return {
82
+ url: toPathString(localVarUrlObj),
83
+ options: localVarRequestOptions,
84
+ };
85
+ },
86
+ /**
87
+ * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
88
+ * @summary Delete the payment receipt
89
+ * @param {string} code Unique identifier for the object.
90
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ deletePaymentReceipt: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
95
+ // verify required parameter 'code' is not null or undefined
96
+ assertParamExists('deletePaymentReceipt', 'code', code)
97
+ const localVarPath = `/paymentservice/v1/payment-receipts/{code}`
98
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
99
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
100
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
101
+ let baseOptions;
102
+ let baseAccessToken;
103
+ if (configuration) {
104
+ baseOptions = configuration.baseOptions;
105
+ baseAccessToken = configuration.accessToken;
106
+ }
107
+
108
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
109
+ const localVarHeaderParameter = {} as any;
110
+ const localVarQueryParameter = {} as any;
111
+
112
+ // authentication bearer required
113
+ // http bearer authentication required
114
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
115
+
116
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
117
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
118
+ }
119
+
120
+
121
+
122
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
123
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
124
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
125
+
126
+ return {
127
+ url: toPathString(localVarUrlObj),
128
+ options: localVarRequestOptions,
129
+ };
130
+ },
131
+ /**
132
+ * This will get payment receipt. **Required Permissions** \"payment-management.payments.view\"
133
+ * @summary Retrieve the payment receipt
134
+ * @param {string} code
135
+ * @param {string} expand
136
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ getPaymentReceipt: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
141
+ // verify required parameter 'code' is not null or undefined
142
+ assertParamExists('getPaymentReceipt', 'code', code)
143
+ // verify required parameter 'expand' is not null or undefined
144
+ assertParamExists('getPaymentReceipt', 'expand', expand)
145
+ const localVarPath = `/paymentservice/v1/payment-receipts/{code}`
146
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
147
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
148
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
149
+ let baseOptions;
150
+ let baseAccessToken;
151
+ if (configuration) {
152
+ baseOptions = configuration.baseOptions;
153
+ baseAccessToken = configuration.accessToken;
154
+ }
155
+
156
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
157
+ const localVarHeaderParameter = {} as any;
158
+ const localVarQueryParameter = {} as any;
159
+
160
+ // authentication bearer required
161
+ // http bearer authentication required
162
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
163
+
164
+ if (expand !== undefined) {
165
+ localVarQueryParameter['expand'] = expand;
166
+ }
167
+
168
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
169
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
170
+ }
171
+
172
+
173
+
174
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
175
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
176
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
177
+
178
+ return {
179
+ url: toPathString(localVarUrlObj),
180
+ options: localVarRequestOptions,
181
+ };
182
+ },
183
+ /**
184
+ * Retrieves a list of paymentreceipts. **Required Permissions** \"payment-management.payments.view\"
185
+ * @summary List payment receipts
186
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
187
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
188
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
189
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
190
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
191
+ * @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, amount&lt;/i&gt;
192
+ * @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;
193
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ listPaymentReceipts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
198
+ const localVarPath = `/paymentservice/v1/payment-receipts`;
199
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
200
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
201
+ let baseOptions;
202
+ let baseAccessToken;
203
+ if (configuration) {
204
+ baseOptions = configuration.baseOptions;
205
+ baseAccessToken = configuration.accessToken;
206
+ }
207
+
208
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
209
+ const localVarHeaderParameter = {} as any;
210
+ const localVarQueryParameter = {} as any;
211
+
212
+ // authentication bearer required
213
+ // http bearer authentication required
214
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
215
+
216
+ if (pageSize !== undefined) {
217
+ localVarQueryParameter['pageSize'] = pageSize;
218
+ }
219
+
220
+ if (pageToken !== undefined) {
221
+ localVarQueryParameter['pageToken'] = pageToken;
222
+ }
223
+
224
+ if (filter !== undefined) {
225
+ localVarQueryParameter['filter'] = filter;
226
+ }
227
+
228
+ if (search !== undefined) {
229
+ localVarQueryParameter['search'] = search;
230
+ }
231
+
232
+ if (order !== undefined) {
233
+ localVarQueryParameter['order'] = order;
234
+ }
235
+
236
+ if (expand !== undefined) {
237
+ localVarQueryParameter['expand'] = expand;
238
+ }
239
+
240
+ if (filters !== undefined) {
241
+ localVarQueryParameter['filters'] = filters;
242
+ }
243
+
244
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
245
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
246
+ }
247
+
248
+
249
+
250
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
251
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
252
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
253
+
254
+ return {
255
+ url: toPathString(localVarUrlObj),
256
+ options: localVarRequestOptions,
257
+ };
258
+ },
259
+ /**
260
+ * This will update payment receipt. **Required Permissions** \"payment-management.payments.update\"
261
+ * @summary Update the payment receipt
262
+ * @param {string} code
263
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ updatePaymentReceipt: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
268
+ // verify required parameter 'code' is not null or undefined
269
+ assertParamExists('updatePaymentReceipt', 'code', code)
270
+ const localVarPath = `/paymentservice/v1/payment-receipts/{code}`
271
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
272
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
273
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
274
+ let baseOptions;
275
+ let baseAccessToken;
276
+ if (configuration) {
277
+ baseOptions = configuration.baseOptions;
278
+ baseAccessToken = configuration.accessToken;
279
+ }
280
+
281
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
282
+ const localVarHeaderParameter = {} as any;
283
+ const localVarQueryParameter = {} as any;
284
+
285
+ // authentication bearer required
286
+ // http bearer authentication required
287
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
288
+
289
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
290
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
291
+ }
292
+
293
+
294
+
295
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
296
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
297
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
298
+
299
+ return {
300
+ url: toPathString(localVarUrlObj),
301
+ options: localVarRequestOptions,
302
+ };
303
+ },
304
+ }
305
+ };
306
+
307
+ /**
308
+ * PaymentReceiptsApi - functional programming interface
309
+ * @export
310
+ */
311
+ export const PaymentReceiptsApiFp = function(configuration?: Configuration) {
312
+ const localVarAxiosParamCreator = PaymentReceiptsApiAxiosParamCreator(configuration)
313
+ return {
314
+ /**
315
+ * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
316
+ * @summary Create the payment receipt
317
+ * @param {CreatePaymentReceiptRequestDto} createPaymentReceiptRequestDto
318
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
319
+ * @param {*} [options] Override http request option.
320
+ * @throws {RequiredError}
321
+ */
322
+ async createPaymentReceipt(createPaymentReceiptRequestDto: CreatePaymentReceiptRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentReceiptResponseClass>> {
323
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentReceipt(createPaymentReceiptRequestDto, authorization, options);
324
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
325
+ },
326
+ /**
327
+ * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
328
+ * @summary Delete the payment receipt
329
+ * @param {string} code Unique identifier for the object.
330
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ async deletePaymentReceipt(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
335
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deletePaymentReceipt(code, authorization, options);
336
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
337
+ },
338
+ /**
339
+ * This will get payment receipt. **Required Permissions** \"payment-management.payments.view\"
340
+ * @summary Retrieve the payment receipt
341
+ * @param {string} code
342
+ * @param {string} expand
343
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ */
347
+ async getPaymentReceipt(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReceiptResponseClass>> {
348
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReceipt(code, expand, authorization, options);
349
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
+ },
351
+ /**
352
+ * Retrieves a list of paymentreceipts. **Required Permissions** \"payment-management.payments.view\"
353
+ * @summary List payment receipts
354
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
357
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
358
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
359
+ * @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, amount&lt;/i&gt;
360
+ * @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;
361
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ async listPaymentReceipts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentReceiptsResponseClass>> {
366
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReceipts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
367
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
368
+ },
369
+ /**
370
+ * This will update payment receipt. **Required Permissions** \"payment-management.payments.update\"
371
+ * @summary Update the payment receipt
372
+ * @param {string} code
373
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
374
+ * @param {*} [options] Override http request option.
375
+ * @throws {RequiredError}
376
+ */
377
+ async updatePaymentReceipt(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePaymentReceiptResponseClass>> {
378
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updatePaymentReceipt(code, authorization, options);
379
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
380
+ },
381
+ }
382
+ };
383
+
384
+ /**
385
+ * PaymentReceiptsApi - factory interface
386
+ * @export
387
+ */
388
+ export const PaymentReceiptsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
389
+ const localVarFp = PaymentReceiptsApiFp(configuration)
390
+ return {
391
+ /**
392
+ * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
393
+ * @summary Create the payment receipt
394
+ * @param {CreatePaymentReceiptRequestDto} createPaymentReceiptRequestDto
395
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
396
+ * @param {*} [options] Override http request option.
397
+ * @throws {RequiredError}
398
+ */
399
+ createPaymentReceipt(createPaymentReceiptRequestDto: CreatePaymentReceiptRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentReceiptResponseClass> {
400
+ return localVarFp.createPaymentReceipt(createPaymentReceiptRequestDto, authorization, options).then((request) => request(axios, basePath));
401
+ },
402
+ /**
403
+ * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
404
+ * @summary Delete the payment receipt
405
+ * @param {string} code Unique identifier for the object.
406
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
407
+ * @param {*} [options] Override http request option.
408
+ * @throws {RequiredError}
409
+ */
410
+ deletePaymentReceipt(code: string, authorization?: string, options?: any): AxiosPromise<void> {
411
+ return localVarFp.deletePaymentReceipt(code, authorization, options).then((request) => request(axios, basePath));
412
+ },
413
+ /**
414
+ * This will get payment receipt. **Required Permissions** \"payment-management.payments.view\"
415
+ * @summary Retrieve the payment receipt
416
+ * @param {string} code
417
+ * @param {string} expand
418
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
419
+ * @param {*} [options] Override http request option.
420
+ * @throws {RequiredError}
421
+ */
422
+ getPaymentReceipt(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReceiptResponseClass> {
423
+ return localVarFp.getPaymentReceipt(code, expand, authorization, options).then((request) => request(axios, basePath));
424
+ },
425
+ /**
426
+ * Retrieves a list of paymentreceipts. **Required Permissions** \"payment-management.payments.view\"
427
+ * @summary List payment receipts
428
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
431
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
432
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
433
+ * @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, amount&lt;/i&gt;
434
+ * @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;
435
+ * @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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ */
439
+ listPaymentReceipts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentReceiptsResponseClass> {
440
+ return localVarFp.listPaymentReceipts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
441
+ },
442
+ /**
443
+ * This will update payment receipt. **Required Permissions** \"payment-management.payments.update\"
444
+ * @summary Update the payment receipt
445
+ * @param {string} code
446
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
447
+ * @param {*} [options] Override http request option.
448
+ * @throws {RequiredError}
449
+ */
450
+ updatePaymentReceipt(code: string, authorization?: string, options?: any): AxiosPromise<UpdatePaymentReceiptResponseClass> {
451
+ return localVarFp.updatePaymentReceipt(code, authorization, options).then((request) => request(axios, basePath));
452
+ },
453
+ };
454
+ };
455
+
456
+ /**
457
+ * Request parameters for createPaymentReceipt operation in PaymentReceiptsApi.
458
+ * @export
459
+ * @interface PaymentReceiptsApiCreatePaymentReceiptRequest
460
+ */
461
+ export interface PaymentReceiptsApiCreatePaymentReceiptRequest {
462
+ /**
463
+ *
464
+ * @type {CreatePaymentReceiptRequestDto}
465
+ * @memberof PaymentReceiptsApiCreatePaymentReceipt
466
+ */
467
+ readonly createPaymentReceiptRequestDto: CreatePaymentReceiptRequestDto
468
+
469
+ /**
470
+ * Bearer Token: provided by the login endpoint under the name accessToken.
471
+ * @type {string}
472
+ * @memberof PaymentReceiptsApiCreatePaymentReceipt
473
+ */
474
+ readonly authorization?: string
475
+ }
476
+
477
+ /**
478
+ * Request parameters for deletePaymentReceipt operation in PaymentReceiptsApi.
479
+ * @export
480
+ * @interface PaymentReceiptsApiDeletePaymentReceiptRequest
481
+ */
482
+ export interface PaymentReceiptsApiDeletePaymentReceiptRequest {
483
+ /**
484
+ * Unique identifier for the object.
485
+ * @type {string}
486
+ * @memberof PaymentReceiptsApiDeletePaymentReceipt
487
+ */
488
+ readonly code: string
489
+
490
+ /**
491
+ * Bearer Token: provided by the login endpoint under the name accessToken.
492
+ * @type {string}
493
+ * @memberof PaymentReceiptsApiDeletePaymentReceipt
494
+ */
495
+ readonly authorization?: string
496
+ }
497
+
498
+ /**
499
+ * Request parameters for getPaymentReceipt operation in PaymentReceiptsApi.
500
+ * @export
501
+ * @interface PaymentReceiptsApiGetPaymentReceiptRequest
502
+ */
503
+ export interface PaymentReceiptsApiGetPaymentReceiptRequest {
504
+ /**
505
+ *
506
+ * @type {string}
507
+ * @memberof PaymentReceiptsApiGetPaymentReceipt
508
+ */
509
+ readonly code: string
510
+
511
+ /**
512
+ *
513
+ * @type {string}
514
+ * @memberof PaymentReceiptsApiGetPaymentReceipt
515
+ */
516
+ readonly expand: string
517
+
518
+ /**
519
+ * Bearer Token: provided by the login endpoint under the name accessToken.
520
+ * @type {string}
521
+ * @memberof PaymentReceiptsApiGetPaymentReceipt
522
+ */
523
+ readonly authorization?: string
524
+ }
525
+
526
+ /**
527
+ * Request parameters for listPaymentReceipts operation in PaymentReceiptsApi.
528
+ * @export
529
+ * @interface PaymentReceiptsApiListPaymentReceiptsRequest
530
+ */
531
+ export interface PaymentReceiptsApiListPaymentReceiptsRequest {
532
+ /**
533
+ * Bearer Token: provided by the login endpoint under the name accessToken.
534
+ * @type {string}
535
+ * @memberof PaymentReceiptsApiListPaymentReceipts
536
+ */
537
+ readonly authorization?: string
538
+
539
+ /**
540
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
541
+ * @type {number}
542
+ * @memberof PaymentReceiptsApiListPaymentReceipts
543
+ */
544
+ readonly pageSize?: number
545
+
546
+ /**
547
+ * 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.
548
+ * @type {string}
549
+ * @memberof PaymentReceiptsApiListPaymentReceipts
550
+ */
551
+ readonly pageToken?: string
552
+
553
+ /**
554
+ * 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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
555
+ * @type {string}
556
+ * @memberof PaymentReceiptsApiListPaymentReceipts
557
+ */
558
+ readonly filter?: string
559
+
560
+ /**
561
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
562
+ * @type {string}
563
+ * @memberof PaymentReceiptsApiListPaymentReceipts
564
+ */
565
+ readonly search?: string
566
+
567
+ /**
568
+ * 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, amount&lt;/i&gt;
569
+ * @type {string}
570
+ * @memberof PaymentReceiptsApiListPaymentReceipts
571
+ */
572
+ readonly order?: string
573
+
574
+ /**
575
+ * 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;
576
+ * @type {string}
577
+ * @memberof PaymentReceiptsApiListPaymentReceipts
578
+ */
579
+ readonly expand?: string
580
+
581
+ /**
582
+ * 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: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
583
+ * @type {string}
584
+ * @memberof PaymentReceiptsApiListPaymentReceipts
585
+ */
586
+ readonly filters?: string
587
+ }
588
+
589
+ /**
590
+ * Request parameters for updatePaymentReceipt operation in PaymentReceiptsApi.
591
+ * @export
592
+ * @interface PaymentReceiptsApiUpdatePaymentReceiptRequest
593
+ */
594
+ export interface PaymentReceiptsApiUpdatePaymentReceiptRequest {
595
+ /**
596
+ *
597
+ * @type {string}
598
+ * @memberof PaymentReceiptsApiUpdatePaymentReceipt
599
+ */
600
+ readonly code: string
601
+
602
+ /**
603
+ * Bearer Token: provided by the login endpoint under the name accessToken.
604
+ * @type {string}
605
+ * @memberof PaymentReceiptsApiUpdatePaymentReceipt
606
+ */
607
+ readonly authorization?: string
608
+ }
609
+
610
+ /**
611
+ * PaymentReceiptsApi - object-oriented interface
612
+ * @export
613
+ * @class PaymentReceiptsApi
614
+ * @extends {BaseAPI}
615
+ */
616
+ export class PaymentReceiptsApi extends BaseAPI {
617
+ /**
618
+ * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
619
+ * @summary Create the payment receipt
620
+ * @param {PaymentReceiptsApiCreatePaymentReceiptRequest} requestParameters Request parameters.
621
+ * @param {*} [options] Override http request option.
622
+ * @throws {RequiredError}
623
+ * @memberof PaymentReceiptsApi
624
+ */
625
+ public createPaymentReceipt(requestParameters: PaymentReceiptsApiCreatePaymentReceiptRequest, options?: AxiosRequestConfig) {
626
+ return PaymentReceiptsApiFp(this.configuration).createPaymentReceipt(requestParameters.createPaymentReceiptRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
627
+ }
628
+
629
+ /**
630
+ * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
631
+ * @summary Delete the payment receipt
632
+ * @param {PaymentReceiptsApiDeletePaymentReceiptRequest} requestParameters Request parameters.
633
+ * @param {*} [options] Override http request option.
634
+ * @throws {RequiredError}
635
+ * @memberof PaymentReceiptsApi
636
+ */
637
+ public deletePaymentReceipt(requestParameters: PaymentReceiptsApiDeletePaymentReceiptRequest, options?: AxiosRequestConfig) {
638
+ return PaymentReceiptsApiFp(this.configuration).deletePaymentReceipt(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
639
+ }
640
+
641
+ /**
642
+ * This will get payment receipt. **Required Permissions** \"payment-management.payments.view\"
643
+ * @summary Retrieve the payment receipt
644
+ * @param {PaymentReceiptsApiGetPaymentReceiptRequest} requestParameters Request parameters.
645
+ * @param {*} [options] Override http request option.
646
+ * @throws {RequiredError}
647
+ * @memberof PaymentReceiptsApi
648
+ */
649
+ public getPaymentReceipt(requestParameters: PaymentReceiptsApiGetPaymentReceiptRequest, options?: AxiosRequestConfig) {
650
+ return PaymentReceiptsApiFp(this.configuration).getPaymentReceipt(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
651
+ }
652
+
653
+ /**
654
+ * Retrieves a list of paymentreceipts. **Required Permissions** \"payment-management.payments.view\"
655
+ * @summary List payment receipts
656
+ * @param {PaymentReceiptsApiListPaymentReceiptsRequest} requestParameters Request parameters.
657
+ * @param {*} [options] Override http request option.
658
+ * @throws {RequiredError}
659
+ * @memberof PaymentReceiptsApi
660
+ */
661
+ public listPaymentReceipts(requestParameters: PaymentReceiptsApiListPaymentReceiptsRequest = {}, options?: AxiosRequestConfig) {
662
+ return PaymentReceiptsApiFp(this.configuration).listPaymentReceipts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
663
+ }
664
+
665
+ /**
666
+ * This will update payment receipt. **Required Permissions** \"payment-management.payments.update\"
667
+ * @summary Update the payment receipt
668
+ * @param {PaymentReceiptsApiUpdatePaymentReceiptRequest} requestParameters Request parameters.
669
+ * @param {*} [options] Override http request option.
670
+ * @throws {RequiredError}
671
+ * @memberof PaymentReceiptsApi
672
+ */
673
+ public updatePaymentReceipt(requestParameters: PaymentReceiptsApiUpdatePaymentReceiptRequest, options?: AxiosRequestConfig) {
674
+ return PaymentReceiptsApiFp(this.configuration).updatePaymentReceipt(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
675
+ }
676
+ }