@emilgroup/payment-sdk-node 1.21.1-beta.71 → 1.21.1-beta.73

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 (29) hide show
  1. package/.openapi-generator/FILES +3 -1
  2. package/README.md +2 -2
  3. package/api/bank-transaction-api.ts +14 -31
  4. package/api/payments-api.ts +129 -4
  5. package/dist/api/bank-transaction-api.d.ts +11 -21
  6. package/dist/api/bank-transaction-api.js +12 -19
  7. package/dist/api/payments-api.d.ts +73 -4
  8. package/dist/api/payments-api.js +109 -4
  9. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +7 -12
  10. package/dist/models/bank-transaction-class.d.ts +7 -12
  11. package/dist/models/bank-transaction-invoice-class.d.ts +54 -0
  12. package/dist/models/create-payment-order-dto.d.ts +48 -0
  13. package/{models/unlink-bank-transaction-request-dto-rest.ts → dist/models/create-payment-order-dto.js} +2 -17
  14. package/dist/models/create-payment-order-request-dto.d.ts +48 -0
  15. package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → create-payment-order-request-dto.js} +4 -13
  16. package/dist/models/index.d.ts +3 -1
  17. package/dist/models/index.js +3 -1
  18. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +3 -3
  19. package/dist/models/unlinked-bank-transaction-response-class.d.ts +7 -0
  20. package/models/bank-transaction-class-without-expand-properties.ts +7 -12
  21. package/models/bank-transaction-class.ts +7 -12
  22. package/models/bank-transaction-invoice-class.ts +60 -0
  23. package/models/create-payment-order-dto.ts +54 -0
  24. package/models/create-payment-order-request-dto.ts +54 -0
  25. package/models/index.ts +3 -1
  26. package/models/link-bank-transaction-request-dto-rest.ts +3 -3
  27. package/models/unlinked-bank-transaction-response-class.ts +7 -0
  28. package/package.json +1 -1
  29. /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-transaction-invoice-class.js} +0 -0
@@ -149,7 +149,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
149
149
  * @summary Retrieve the bank transaction
150
150
  * @param {string} code
151
151
  * @param {string} [authorization] Bearer Token
152
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
152
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
153
153
  * @param {*} [options] Override http request option.
154
154
  * @throws {RequiredError}
155
155
  */
@@ -311,7 +311,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
311
311
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
312
312
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
313
313
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
314
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
314
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
315
315
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
316
316
  * @param {*} [options] Override http request option.
317
317
  * @throws {RequiredError}
@@ -378,12 +378,11 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
378
378
  * Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
379
379
  * @summary Unlink bank transaction
380
380
  * @param {string} code Code of the bank transaction to unlink
381
- * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
382
381
  * @param {string} [authorization] Bearer Token
383
382
  * @param {*} [options] Override http request option.
384
383
  * @throws {RequiredError}
385
384
  */
386
- unlinkBankTransaction: function (code, unlinkBankTransactionRequestDtoRest, authorization, options) {
385
+ unlinkBankTransaction: function (code, authorization, options) {
387
386
  if (options === void 0) { options = {}; }
388
387
  return __awaiter(_this, void 0, void 0, function () {
389
388
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -392,8 +391,6 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
392
391
  case 0:
393
392
  // verify required parameter 'code' is not null or undefined
394
393
  (0, common_1.assertParamExists)('unlinkBankTransaction', 'code', code);
395
- // verify required parameter 'unlinkBankTransactionRequestDtoRest' is not null or undefined
396
- (0, common_1.assertParamExists)('unlinkBankTransaction', 'unlinkBankTransactionRequestDtoRest', unlinkBankTransactionRequestDtoRest);
397
394
  localVarPath = "/paymentservice/v1/tenant/bank-transactions/{code}/unlink"
398
395
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
399
396
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -414,11 +411,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
414
411
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
415
412
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
416
413
  }
417
- localVarHeaderParameter['Content-Type'] = 'application/json';
418
414
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
419
415
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
420
416
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
421
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(unlinkBankTransactionRequestDtoRest, localVarRequestOptions, configuration);
422
417
  return [2 /*return*/, {
423
418
  url: (0, common_1.toPathString)(localVarUrlObj),
424
419
  options: localVarRequestOptions,
@@ -463,7 +458,7 @@ var BankTransactionApiFp = function (configuration) {
463
458
  * @summary Retrieve the bank transaction
464
459
  * @param {string} code
465
460
  * @param {string} [authorization] Bearer Token
466
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
461
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
467
462
  * @param {*} [options] Override http request option.
468
463
  * @throws {RequiredError}
469
464
  */
@@ -532,7 +527,7 @@ var BankTransactionApiFp = function (configuration) {
532
527
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
533
528
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
534
529
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
535
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
530
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
536
531
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
537
532
  * @param {*} [options] Override http request option.
538
533
  * @throws {RequiredError}
@@ -554,17 +549,16 @@ var BankTransactionApiFp = function (configuration) {
554
549
  * Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
555
550
  * @summary Unlink bank transaction
556
551
  * @param {string} code Code of the bank transaction to unlink
557
- * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
558
552
  * @param {string} [authorization] Bearer Token
559
553
  * @param {*} [options] Override http request option.
560
554
  * @throws {RequiredError}
561
555
  */
562
- unlinkBankTransaction: function (code, unlinkBankTransactionRequestDtoRest, authorization, options) {
556
+ unlinkBankTransaction: function (code, authorization, options) {
563
557
  return __awaiter(this, void 0, void 0, function () {
564
558
  var localVarAxiosArgs;
565
559
  return __generator(this, function (_a) {
566
560
  switch (_a.label) {
567
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.unlinkBankTransaction(code, unlinkBankTransactionRequestDtoRest, authorization, options)];
561
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.unlinkBankTransaction(code, authorization, options)];
568
562
  case 1:
569
563
  localVarAxiosArgs = _a.sent();
570
564
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -598,7 +592,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
598
592
  * @summary Retrieve the bank transaction
599
593
  * @param {string} code
600
594
  * @param {string} [authorization] Bearer Token
601
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
595
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
602
596
  * @param {*} [options] Override http request option.
603
597
  * @throws {RequiredError}
604
598
  */
@@ -637,7 +631,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
637
631
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
638
632
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
639
633
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
640
- * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
634
+ * @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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
641
635
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
642
636
  * @param {*} [options] Override http request option.
643
637
  * @throws {RequiredError}
@@ -649,13 +643,12 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
649
643
  * Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
650
644
  * @summary Unlink bank transaction
651
645
  * @param {string} code Code of the bank transaction to unlink
652
- * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
653
646
  * @param {string} [authorization] Bearer Token
654
647
  * @param {*} [options] Override http request option.
655
648
  * @throws {RequiredError}
656
649
  */
657
- unlinkBankTransaction: function (code, unlinkBankTransactionRequestDtoRest, authorization, options) {
658
- return localVarFp.unlinkBankTransaction(code, unlinkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
650
+ unlinkBankTransaction: function (code, authorization, options) {
651
+ return localVarFp.unlinkBankTransaction(code, authorization, options).then(function (request) { return request(axios, basePath); });
659
652
  },
660
653
  };
661
654
  };
@@ -742,7 +735,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
742
735
  */
743
736
  BankTransactionApi.prototype.unlinkBankTransaction = function (requestParameters, options) {
744
737
  var _this = this;
745
- return (0, exports.BankTransactionApiFp)(this.configuration).unlinkBankTransaction(requestParameters.code, requestParameters.unlinkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
738
+ return (0, exports.BankTransactionApiFp)(this.configuration).unlinkBankTransaction(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
746
739
  };
747
740
  return BankTransactionApi;
748
741
  }(base_1.BaseAPI));
@@ -12,6 +12,7 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreatePaymentOrderDto } from '../models';
15
16
  import { CreatePaymentRequestDto } from '../models';
16
17
  import { CreatePaymentResponseClass } from '../models';
17
18
  import { GetPaymentResponseClass } from '../models';
@@ -22,15 +23,26 @@ import { ListPaymentsResponseClass } from '../models';
22
23
  */
23
24
  export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
24
25
  /**
25
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
26
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
26
27
  * @summary Create the payment
27
28
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
28
29
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
29
30
  * @param {string} [authorization] Bearer Token
30
31
  * @param {*} [options] Override http request option.
32
+ * @deprecated
31
33
  * @throws {RequiredError}
32
34
  */
33
35
  createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
38
+ * @summary Create the payment
39
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
40
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ createPaymentOrder: (idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
46
  /**
35
47
  * 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. **Required Permissions** \"payment-management.payments.view\"
36
48
  * @summary Retrieve the payment
@@ -63,15 +75,26 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
63
75
  */
64
76
  export declare const PaymentsApiFp: (configuration?: Configuration) => {
65
77
  /**
66
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
78
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
67
79
  * @summary Create the payment
68
80
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
69
81
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
70
82
  * @param {string} [authorization] Bearer Token
71
83
  * @param {*} [options] Override http request option.
84
+ * @deprecated
72
85
  * @throws {RequiredError}
73
86
  */
74
87
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
88
+ /**
89
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
90
+ * @summary Create the payment
91
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
92
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
93
+ * @param {string} [authorization] Bearer Token
94
+ * @param {*} [options] Override http request option.
95
+ * @throws {RequiredError}
96
+ */
97
+ createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
75
98
  /**
76
99
  * 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. **Required Permissions** \"payment-management.payments.view\"
77
100
  * @summary Retrieve the payment
@@ -104,15 +127,26 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
104
127
  */
105
128
  export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
106
129
  /**
107
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
130
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
108
131
  * @summary Create the payment
109
132
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
110
133
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
111
134
  * @param {string} [authorization] Bearer Token
112
135
  * @param {*} [options] Override http request option.
136
+ * @deprecated
113
137
  * @throws {RequiredError}
114
138
  */
115
139
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
140
+ /**
141
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
142
+ * @summary Create the payment
143
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
144
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
145
+ * @param {string} [authorization] Bearer Token
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
116
150
  /**
117
151
  * 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. **Required Permissions** \"payment-management.payments.view\"
118
152
  * @summary Retrieve the payment
@@ -164,6 +198,31 @@ export interface PaymentsApiCreatePaymentRequest {
164
198
  */
165
199
  readonly authorization?: string;
166
200
  }
201
+ /**
202
+ * Request parameters for createPaymentOrder operation in PaymentsApi.
203
+ * @export
204
+ * @interface PaymentsApiCreatePaymentOrderRequest
205
+ */
206
+ export interface PaymentsApiCreatePaymentOrderRequest {
207
+ /**
208
+ * Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
209
+ * @type {string}
210
+ * @memberof PaymentsApiCreatePaymentOrder
211
+ */
212
+ readonly idempotencyKey: string;
213
+ /**
214
+ *
215
+ * @type {CreatePaymentOrderDto}
216
+ * @memberof PaymentsApiCreatePaymentOrder
217
+ */
218
+ readonly createPaymentOrderDto: CreatePaymentOrderDto;
219
+ /**
220
+ * Bearer Token
221
+ * @type {string}
222
+ * @memberof PaymentsApiCreatePaymentOrder
223
+ */
224
+ readonly authorization?: string;
225
+ }
167
226
  /**
168
227
  * Request parameters for getPayment operation in PaymentsApi.
169
228
  * @export
@@ -252,14 +311,24 @@ export interface PaymentsApiListPaymentsRequest {
252
311
  */
253
312
  export declare class PaymentsApi extends BaseAPI {
254
313
  /**
255
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
314
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
256
315
  * @summary Create the payment
257
316
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
258
317
  * @param {*} [options] Override http request option.
318
+ * @deprecated
259
319
  * @throws {RequiredError}
260
320
  * @memberof PaymentsApi
261
321
  */
262
322
  createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
323
+ /**
324
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
325
+ * @summary Create the payment
326
+ * @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ * @memberof PaymentsApi
330
+ */
331
+ createPaymentOrder(requestParameters: PaymentsApiCreatePaymentOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
263
332
  /**
264
333
  * 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. **Required Permissions** \"payment-management.payments.view\"
265
334
  * @summary Retrieve the payment
@@ -97,12 +97,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
100
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
101
101
  * @summary Create the payment
102
102
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
103
103
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
104
104
  * @param {string} [authorization] Bearer Token
105
105
  * @param {*} [options] Override http request option.
106
+ * @deprecated
106
107
  * @throws {RequiredError}
107
108
  */
108
109
  createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
@@ -151,6 +152,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
151
152
  });
152
153
  });
153
154
  },
155
+ /**
156
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
157
+ * @summary Create the payment
158
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
159
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
160
+ * @param {string} [authorization] Bearer Token
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
165
+ if (options === void 0) { options = {}; }
166
+ return __awaiter(_this, void 0, void 0, function () {
167
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
168
+ return __generator(this, function (_a) {
169
+ switch (_a.label) {
170
+ case 0:
171
+ // verify required parameter 'idempotencyKey' is not null or undefined
172
+ (0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
173
+ // verify required parameter 'createPaymentOrderDto' is not null or undefined
174
+ (0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
175
+ localVarPath = "/paymentservice/v1/payments/order";
176
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
177
+ if (configuration) {
178
+ baseOptions = configuration.baseOptions;
179
+ baseAccessToken = configuration.accessToken;
180
+ }
181
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
182
+ localVarHeaderParameter = {};
183
+ localVarQueryParameter = {};
184
+ // authentication bearer required
185
+ // http bearer authentication required
186
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
187
+ case 1:
188
+ // authentication bearer required
189
+ // http bearer authentication required
190
+ _a.sent();
191
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
192
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
193
+ }
194
+ if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
195
+ localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
196
+ }
197
+ localVarHeaderParameter['Content-Type'] = 'application/json';
198
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
199
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
200
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
201
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
202
+ return [2 /*return*/, {
203
+ url: (0, common_1.toPathString)(localVarUrlObj),
204
+ options: localVarRequestOptions,
205
+ }];
206
+ }
207
+ });
208
+ });
209
+ },
154
210
  /**
155
211
  * 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. **Required Permissions** \"payment-management.payments.view\"
156
212
  * @summary Retrieve the payment
@@ -286,12 +342,13 @@ var PaymentsApiFp = function (configuration) {
286
342
  var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
287
343
  return {
288
344
  /**
289
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
345
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
290
346
  * @summary Create the payment
291
347
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
292
348
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
293
349
  * @param {string} [authorization] Bearer Token
294
350
  * @param {*} [options] Override http request option.
351
+ * @deprecated
295
352
  * @throws {RequiredError}
296
353
  */
297
354
  createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
@@ -307,6 +364,28 @@ var PaymentsApiFp = function (configuration) {
307
364
  });
308
365
  });
309
366
  },
367
+ /**
368
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
369
+ * @summary Create the payment
370
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
371
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
372
+ * @param {string} [authorization] Bearer Token
373
+ * @param {*} [options] Override http request option.
374
+ * @throws {RequiredError}
375
+ */
376
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
377
+ return __awaiter(this, void 0, void 0, function () {
378
+ var localVarAxiosArgs;
379
+ return __generator(this, function (_a) {
380
+ switch (_a.label) {
381
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
382
+ case 1:
383
+ localVarAxiosArgs = _a.sent();
384
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
385
+ }
386
+ });
387
+ });
388
+ },
310
389
  /**
311
390
  * 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. **Required Permissions** \"payment-management.payments.view\"
312
391
  * @summary Retrieve the payment
@@ -367,17 +446,30 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
367
446
  var localVarFp = (0, exports.PaymentsApiFp)(configuration);
368
447
  return {
369
448
  /**
370
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
449
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
371
450
  * @summary Create the payment
372
451
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
373
452
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
374
453
  * @param {string} [authorization] Bearer Token
375
454
  * @param {*} [options] Override http request option.
455
+ * @deprecated
376
456
  * @throws {RequiredError}
377
457
  */
378
458
  createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
379
459
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
380
460
  },
461
+ /**
462
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
463
+ * @summary Create the payment
464
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
465
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
466
+ * @param {string} [authorization] Bearer Token
467
+ * @param {*} [options] Override http request option.
468
+ * @throws {RequiredError}
469
+ */
470
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
471
+ return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
472
+ },
381
473
  /**
382
474
  * 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. **Required Permissions** \"payment-management.payments.view\"
383
475
  * @summary Retrieve the payment
@@ -422,10 +514,11 @@ var PaymentsApi = /** @class */ (function (_super) {
422
514
  return _super !== null && _super.apply(this, arguments) || this;
423
515
  }
424
516
  /**
425
- * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
517
+ * This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
426
518
  * @summary Create the payment
427
519
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
428
520
  * @param {*} [options] Override http request option.
521
+ * @deprecated
429
522
  * @throws {RequiredError}
430
523
  * @memberof PaymentsApi
431
524
  */
@@ -433,6 +526,18 @@ var PaymentsApi = /** @class */ (function (_super) {
433
526
  var _this = this;
434
527
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
435
528
  };
529
+ /**
530
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
531
+ * @summary Create the payment
532
+ * @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
533
+ * @param {*} [options] Override http request option.
534
+ * @throws {RequiredError}
535
+ * @memberof PaymentsApi
536
+ */
537
+ PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
538
+ var _this = this;
539
+ return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
540
+ };
436
541
  /**
437
542
  * 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. **Required Permissions** \"payment-management.payments.view\"
438
543
  * @summary Retrieve the payment
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { BankOrderClass } from './bank-order-class';
13
+ import { BankTransactionInvoiceClass } from './bank-transaction-invoice-class';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -94,24 +95,18 @@ export interface BankTransactionClassWithoutExpandProperties {
94
95
  * @memberof BankTransactionClassWithoutExpandProperties
95
96
  */
96
97
  'linkedTransactionId'?: number;
97
- /**
98
- * The code of the invoice that this bank transaction is linked to
99
- * @type {string}
100
- * @memberof BankTransactionClassWithoutExpandProperties
101
- */
102
- 'linkedInvoiceCode'?: string;
103
- /**
104
- * The identifying invoice number that this bank transaction is linked to
105
- * @type {string}
106
- * @memberof BankTransactionClassWithoutExpandProperties
107
- */
108
- 'linkedInvoiceNumber'?: string;
109
98
  /**
110
99
  * Boolean flag to indicate if the bank transaction is linked to an invoice - defaults to false
111
100
  * @type {boolean}
112
101
  * @memberof BankTransactionClassWithoutExpandProperties
113
102
  */
114
103
  'isLinked': boolean;
104
+ /**
105
+ * The bank transaction invoices that this bank transaction is linked to
106
+ * @type {Array<BankTransactionInvoiceClass>}
107
+ * @memberof BankTransactionClassWithoutExpandProperties
108
+ */
109
+ 'bankTransactionInvoices'?: Array<BankTransactionInvoiceClass>;
115
110
  /**
116
111
  * The linked bank order object
117
112
  * @type {BankOrderClass}
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { BankOrderClass } from './bank-order-class';
13
+ import { BankTransactionInvoiceClass } from './bank-transaction-invoice-class';
13
14
  import { InvoiceMatchSuggestionClass } from './invoice-match-suggestion-class';
14
15
  import { SharedTransactionClass } from './shared-transaction-class';
15
16
  import { SuggestionGenerationProgressClass } from './suggestion-generation-progress-class';
@@ -98,24 +99,18 @@ export interface BankTransactionClass {
98
99
  * @memberof BankTransactionClass
99
100
  */
100
101
  'linkedTransactionId'?: number;
101
- /**
102
- * The code of the invoice that this bank transaction is linked to
103
- * @type {string}
104
- * @memberof BankTransactionClass
105
- */
106
- 'linkedInvoiceCode'?: string;
107
- /**
108
- * The identifying invoice number that this bank transaction is linked to
109
- * @type {string}
110
- * @memberof BankTransactionClass
111
- */
112
- 'linkedInvoiceNumber'?: string;
113
102
  /**
114
103
  * Boolean flag to indicate if the bank transaction is linked to an invoice - defaults to false
115
104
  * @type {boolean}
116
105
  * @memberof BankTransactionClass
117
106
  */
118
107
  'isLinked': boolean;
108
+ /**
109
+ * The bank transaction invoices that this bank transaction is linked to
110
+ * @type {Array<BankTransactionInvoiceClass>}
111
+ * @memberof BankTransactionClass
112
+ */
113
+ 'bankTransactionInvoices'?: Array<BankTransactionInvoiceClass>;
119
114
  /**
120
115
  * The bank account object that this transaction is belongs to
121
116
  * @type {TenantBankAccountClassWithoutExpandProperties}
@@ -0,0 +1,54 @@
1
+ /**
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.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface BankTransactionInvoiceClass
16
+ */
17
+ export interface BankTransactionInvoiceClass {
18
+ /**
19
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
20
+ * @type {number}
21
+ * @memberof BankTransactionInvoiceClass
22
+ */
23
+ 'id': number;
24
+ /**
25
+ * Unique identifier for the object.
26
+ * @type {string}
27
+ * @memberof BankTransactionInvoiceClass
28
+ */
29
+ 'code': string;
30
+ /**
31
+ * Bank transaction id
32
+ * @type {number}
33
+ * @memberof BankTransactionInvoiceClass
34
+ */
35
+ 'bankTransactionId': number;
36
+ /**
37
+ * Invoice code of the bank transaction invoice
38
+ * @type {string}
39
+ * @memberof BankTransactionInvoiceClass
40
+ */
41
+ 'invoiceCode': string;
42
+ /**
43
+ * Invoice number of the bank transaction invoice
44
+ * @type {string}
45
+ * @memberof BankTransactionInvoiceClass
46
+ */
47
+ 'invoiceNumber': string;
48
+ /**
49
+ * Time at which the object was created.
50
+ * @type {string}
51
+ * @memberof BankTransactionInvoiceClass
52
+ */
53
+ 'createdAt': string;
54
+ }