@emilgroup/payment-sdk 1.22.1-beta.80 → 1.22.1-beta.82

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.
@@ -81,6 +81,8 @@ models/create-policy-payment-method-response-class.ts
81
81
  models/create-psp-payment-method-request-dto.ts
82
82
  models/create-refund-request-dto.ts
83
83
  models/create-refund-response-class.ts
84
+ models/create-return-premium-credits-request-dto.ts
85
+ models/create-return-premium-credits-response-class.ts
84
86
  models/create-tenant-bank-account-request-dto.ts
85
87
  models/create-tenant-bank-account-response-class.ts
86
88
  models/credit-allocation-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/payment-sdk@1.22.1-beta.80 --save
20
+ npm install @emilgroup/payment-sdk@1.22.1-beta.82 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.22.1-beta.80
24
+ yarn add @emilgroup/payment-sdk@1.22.1-beta.82
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -263,7 +263,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
263
263
  };
264
264
  },
265
265
  /**
266
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
266
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
267
267
  * @summary Link bank transaction to payment requests
268
268
  * @param {string} code Code of the outgoing bank transaction to link
269
269
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -510,7 +510,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
510
510
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
511
511
  },
512
512
  /**
513
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
513
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
514
514
  * @summary Link bank transaction to payment requests
515
515
  * @param {string} code Code of the outgoing bank transaction to link
516
516
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -609,7 +609,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
609
609
  return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
610
610
  },
611
611
  /**
612
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
612
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
613
613
  * @summary Link bank transaction to payment requests
614
614
  * @param {string} code Code of the outgoing bank transaction to link
615
615
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -917,7 +917,7 @@ export class BankTransactionApi extends BaseAPI {
917
917
  }
918
918
 
919
919
  /**
920
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
920
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
921
921
  * @summary Link bank transaction to payment requests
922
922
  * @param {BankTransactionApiLinkBankTransactionPaymentRequestsRequest} requestParameters Request parameters.
923
923
  * @param {*} [options] Override http request option.
@@ -25,6 +25,10 @@ import { CreateExceedingCreditRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateExceedingCreditResponseClass } from '../models';
27
27
  // @ts-ignore
28
+ import { CreateReturnPremiumCreditsRequestDto } from '../models';
29
+ // @ts-ignore
30
+ import { CreateReturnPremiumCreditsResponseClass } from '../models';
31
+ // @ts-ignore
28
32
  import { GetExceedingCreditResponseClass } from '../models';
29
33
  // @ts-ignore
30
34
  import { ListExceedingCreditsResponseClass } from '../models';
@@ -86,6 +90,58 @@ export const ExceedingCreditsApiAxiosParamCreator = function (configuration?: Co
86
90
  options: localVarRequestOptions,
87
91
  };
88
92
  },
93
+ /**
94
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
95
+ * @summary Create the return-premium credits
96
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ createReturnPremiumCredits: async (createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
102
+ // verify required parameter 'createReturnPremiumCreditsRequestDto' is not null or undefined
103
+ assertParamExists('createReturnPremiumCredits', 'createReturnPremiumCreditsRequestDto', createReturnPremiumCreditsRequestDto)
104
+ const localVarPath = `/paymentservice/v1/exceeding-credits/return-premium`;
105
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
106
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
107
+ let baseOptions;
108
+ let baseAccessToken;
109
+ if (configuration) {
110
+ baseOptions = configuration.baseOptions;
111
+ baseAccessToken = configuration.accessToken;
112
+ }
113
+
114
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
115
+ const localVarHeaderParameter = {} as any;
116
+ const localVarQueryParameter = {} as any;
117
+
118
+ // authentication bearer required
119
+ // http bearer authentication required
120
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
+
122
+ // Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
123
+ // no token is stored, so a refused call still refreshes; a session call (account header) sends none.
124
+ const authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
125
+ const authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
126
+ const authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !baseOptions?.headers?.['X-Emil-Account'];
127
+ if (authorizationValue || authorizationKeepEmpty) {
128
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
129
+ }
130
+
131
+
132
+
133
+ localVarHeaderParameter['Content-Type'] = 'application/json';
134
+
135
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
136
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
138
+ localVarRequestOptions.data = serializeDataIfNeeded(createReturnPremiumCreditsRequestDto, localVarRequestOptions, configuration)
139
+
140
+ return {
141
+ url: toPathString(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ };
144
+ },
89
145
  /**
90
146
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
91
147
  * @summary Retrieve the exceeding credit
@@ -239,6 +295,18 @@ export const ExceedingCreditsApiFp = function(configuration?: Configuration) {
239
295
  const localVarAxiosArgs = await localVarAxiosParamCreator.createExceedingCredit(createExceedingCreditRequestDto, authorization, options);
240
296
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
241
297
  },
298
+ /**
299
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
300
+ * @summary Create the return-premium credits
301
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
302
+ * @param {string} [authorization] Bearer Token
303
+ * @param {*} [options] Override http request option.
304
+ * @throws {RequiredError}
305
+ */
306
+ async createReturnPremiumCredits(createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReturnPremiumCreditsResponseClass>> {
307
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createReturnPremiumCredits(createReturnPremiumCreditsRequestDto, authorization, options);
308
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
309
+ },
242
310
  /**
243
311
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
244
312
  * @summary Retrieve the exceeding credit
@@ -290,6 +358,17 @@ export const ExceedingCreditsApiFactory = function (configuration?: Configuratio
290
358
  createExceedingCredit(createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: any): AxiosPromise<CreateExceedingCreditResponseClass> {
291
359
  return localVarFp.createExceedingCredit(createExceedingCreditRequestDto, authorization, options).then((request) => request(axios, basePath));
292
360
  },
361
+ /**
362
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
363
+ * @summary Create the return-premium credits
364
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
365
+ * @param {string} [authorization] Bearer Token
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ */
369
+ createReturnPremiumCredits(createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReturnPremiumCreditsResponseClass> {
370
+ return localVarFp.createReturnPremiumCredits(createReturnPremiumCreditsRequestDto, authorization, options).then((request) => request(axios, basePath));
371
+ },
293
372
  /**
294
373
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
295
374
  * @summary Retrieve the exceeding credit
@@ -342,6 +421,27 @@ export interface ExceedingCreditsApiCreateExceedingCreditRequest {
342
421
  readonly authorization?: string
343
422
  }
344
423
 
424
+ /**
425
+ * Request parameters for createReturnPremiumCredits operation in ExceedingCreditsApi.
426
+ * @export
427
+ * @interface ExceedingCreditsApiCreateReturnPremiumCreditsRequest
428
+ */
429
+ export interface ExceedingCreditsApiCreateReturnPremiumCreditsRequest {
430
+ /**
431
+ *
432
+ * @type {CreateReturnPremiumCreditsRequestDto}
433
+ * @memberof ExceedingCreditsApiCreateReturnPremiumCredits
434
+ */
435
+ readonly createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto
436
+
437
+ /**
438
+ * Bearer Token
439
+ * @type {string}
440
+ * @memberof ExceedingCreditsApiCreateReturnPremiumCredits
441
+ */
442
+ readonly authorization?: string
443
+ }
444
+
345
445
  /**
346
446
  * Request parameters for getExceedingCredit operation in ExceedingCreditsApi.
347
447
  * @export
@@ -445,6 +545,18 @@ export class ExceedingCreditsApi extends BaseAPI {
445
545
  return ExceedingCreditsApiFp(this.configuration).createExceedingCredit(requestParameters.createExceedingCreditRequestDto, requestParameters.authorization, this.withOwner(options)).then((request) => request(this.axios, this.basePath));
446
546
  }
447
547
 
548
+ /**
549
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
550
+ * @summary Create the return-premium credits
551
+ * @param {ExceedingCreditsApiCreateReturnPremiumCreditsRequest} requestParameters Request parameters.
552
+ * @param {*} [options] Override http request option.
553
+ * @throws {RequiredError}
554
+ * @memberof ExceedingCreditsApi
555
+ */
556
+ public createReturnPremiumCredits(requestParameters: ExceedingCreditsApiCreateReturnPremiumCreditsRequest, options?: AxiosRequestConfig) {
557
+ return ExceedingCreditsApiFp(this.configuration).createReturnPremiumCredits(requestParameters.createReturnPremiumCreditsRequestDto, requestParameters.authorization, this.withOwner(options)).then((request) => request(this.axios, this.basePath));
558
+ }
559
+
448
560
  /**
449
561
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
450
562
  * @summary Retrieve the exceeding credit
@@ -65,7 +65,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
65
65
  */
66
66
  linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
67
  /**
68
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
68
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
69
69
  * @summary Link bank transaction to payment requests
70
70
  * @param {string} code Code of the outgoing bank transaction to link
71
71
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -143,7 +143,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
143
143
  */
144
144
  linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkBankTransactionsResponseClass>>;
145
145
  /**
146
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
146
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
147
147
  * @summary Link bank transaction to payment requests
148
148
  * @param {string} code Code of the outgoing bank transaction to link
149
149
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -221,7 +221,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
221
221
  */
222
222
  linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionsResponseClass>;
223
223
  /**
224
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
224
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
225
225
  * @summary Link bank transaction to payment requests
226
226
  * @param {string} code Code of the outgoing bank transaction to link
227
227
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -486,7 +486,7 @@ export declare class BankTransactionApi extends BaseAPI {
486
486
  */
487
487
  linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionsResponseClass, any, {}, any>>;
488
488
  /**
489
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
489
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
490
490
  * @summary Link bank transaction to payment requests
491
491
  * @param {BankTransactionApiLinkBankTransactionPaymentRequestsRequest} requestParameters Request parameters.
492
492
  * @param {*} [options] Override http request option.
@@ -323,7 +323,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
323
323
  });
324
324
  },
325
325
  /**
326
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
326
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
327
327
  * @summary Link bank transaction to payment requests
328
328
  * @param {string} code Code of the outgoing bank transaction to link
329
329
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -610,7 +610,7 @@ var BankTransactionApiFp = function (configuration) {
610
610
  });
611
611
  },
612
612
  /**
613
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
613
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
614
614
  * @summary Link bank transaction to payment requests
615
615
  * @param {string} code Code of the outgoing bank transaction to link
616
616
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -736,7 +736,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
736
736
  return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
737
737
  },
738
738
  /**
739
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
739
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
740
740
  * @summary Link bank transaction to payment requests
741
741
  * @param {string} code Code of the outgoing bank transaction to link
742
742
  * @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
@@ -838,7 +838,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
838
838
  return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
839
839
  };
840
840
  /**
841
- * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
841
+ * Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
842
842
  * @summary Link bank transaction to payment requests
843
843
  * @param {BankTransactionApiLinkBankTransactionPaymentRequestsRequest} requestParameters Request parameters.
844
844
  * @param {*} [options] Override http request option.
@@ -14,6 +14,8 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateExceedingCreditRequestDto } from '../models';
16
16
  import { CreateExceedingCreditResponseClass } from '../models';
17
+ import { CreateReturnPremiumCreditsRequestDto } from '../models';
18
+ import { CreateReturnPremiumCreditsResponseClass } from '../models';
17
19
  import { GetExceedingCreditResponseClass } from '../models';
18
20
  import { ListExceedingCreditsResponseClass } from '../models';
19
21
  /**
@@ -30,6 +32,15 @@ export declare const ExceedingCreditsApiAxiosParamCreator: (configuration?: Conf
30
32
  * @throws {RequiredError}
31
33
  */
32
34
  createExceedingCredit: (createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
37
+ * @summary Create the return-premium credits
38
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
39
+ * @param {string} [authorization] Bearer Token
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ createReturnPremiumCredits: (createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
44
  /**
34
45
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
35
46
  * @summary Retrieve the exceeding credit
@@ -69,6 +80,15 @@ export declare const ExceedingCreditsApiFp: (configuration?: Configuration) => {
69
80
  * @throws {RequiredError}
70
81
  */
71
82
  createExceedingCredit(createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateExceedingCreditResponseClass>>;
83
+ /**
84
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
85
+ * @summary Create the return-premium credits
86
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
87
+ * @param {string} [authorization] Bearer Token
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ createReturnPremiumCredits(createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReturnPremiumCreditsResponseClass>>;
72
92
  /**
73
93
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
74
94
  * @summary Retrieve the exceeding credit
@@ -108,6 +128,15 @@ export declare const ExceedingCreditsApiFactory: (configuration?: Configuration,
108
128
  * @throws {RequiredError}
109
129
  */
110
130
  createExceedingCredit(createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: any): AxiosPromise<CreateExceedingCreditResponseClass>;
131
+ /**
132
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
133
+ * @summary Create the return-premium credits
134
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
135
+ * @param {string} [authorization] Bearer Token
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ createReturnPremiumCredits(createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReturnPremiumCreditsResponseClass>;
111
140
  /**
112
141
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
113
142
  * @summary Retrieve the exceeding credit
@@ -152,6 +181,25 @@ export interface ExceedingCreditsApiCreateExceedingCreditRequest {
152
181
  */
153
182
  readonly authorization?: string;
154
183
  }
184
+ /**
185
+ * Request parameters for createReturnPremiumCredits operation in ExceedingCreditsApi.
186
+ * @export
187
+ * @interface ExceedingCreditsApiCreateReturnPremiumCreditsRequest
188
+ */
189
+ export interface ExceedingCreditsApiCreateReturnPremiumCreditsRequest {
190
+ /**
191
+ *
192
+ * @type {CreateReturnPremiumCreditsRequestDto}
193
+ * @memberof ExceedingCreditsApiCreateReturnPremiumCredits
194
+ */
195
+ readonly createReturnPremiumCreditsRequestDto: CreateReturnPremiumCreditsRequestDto;
196
+ /**
197
+ * Bearer Token
198
+ * @type {string}
199
+ * @memberof ExceedingCreditsApiCreateReturnPremiumCredits
200
+ */
201
+ readonly authorization?: string;
202
+ }
155
203
  /**
156
204
  * Request parameters for getExceedingCredit operation in ExceedingCreditsApi.
157
205
  * @export
@@ -242,6 +290,15 @@ export declare class ExceedingCreditsApi extends BaseAPI {
242
290
  * @memberof ExceedingCreditsApi
243
291
  */
244
292
  createExceedingCredit(requestParameters: ExceedingCreditsApiCreateExceedingCreditRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateExceedingCreditResponseClass, any, {}, any>>;
293
+ /**
294
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
295
+ * @summary Create the return-premium credits
296
+ * @param {ExceedingCreditsApiCreateReturnPremiumCreditsRequest} requestParameters Request parameters.
297
+ * @param {*} [options] Override http request option.
298
+ * @throws {RequiredError}
299
+ * @memberof ExceedingCreditsApi
300
+ */
301
+ createReturnPremiumCredits(requestParameters: ExceedingCreditsApiCreateReturnPremiumCreditsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReturnPremiumCreditsResponseClass, any, {}, any>>;
245
302
  /**
246
303
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
247
304
  * @summary Retrieve the exceeding credit
@@ -148,6 +148,62 @@ var ExceedingCreditsApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  });
150
150
  },
151
+ /**
152
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
153
+ * @summary Create the return-premium credits
154
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
155
+ * @param {string} [authorization] Bearer Token
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ createReturnPremiumCredits: function (createReturnPremiumCreditsRequestDto, authorization, options) {
160
+ if (options === void 0) { options = {}; }
161
+ return __awaiter(_this, void 0, void 0, function () {
162
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
163
+ var _a;
164
+ return __generator(this, function (_b) {
165
+ switch (_b.label) {
166
+ case 0:
167
+ // verify required parameter 'createReturnPremiumCreditsRequestDto' is not null or undefined
168
+ (0, common_1.assertParamExists)('createReturnPremiumCredits', 'createReturnPremiumCreditsRequestDto', createReturnPremiumCreditsRequestDto);
169
+ localVarPath = "/paymentservice/v1/exceeding-credits/return-premium";
170
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
171
+ if (configuration) {
172
+ baseOptions = configuration.baseOptions;
173
+ baseAccessToken = configuration.accessToken;
174
+ }
175
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
176
+ localVarHeaderParameter = {};
177
+ localVarQueryParameter = {};
178
+ // authentication bearer required
179
+ // http bearer authentication required
180
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
181
+ // Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
182
+ // no token is stored, so a refused call still refreshes; a session call (account header) sends none.
183
+ ];
184
+ case 1:
185
+ // authentication bearer required
186
+ // http bearer authentication required
187
+ _b.sent();
188
+ authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
189
+ authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
190
+ authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
191
+ if (authorizationValue || authorizationKeepEmpty) {
192
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
193
+ }
194
+ localVarHeaderParameter['Content-Type'] = 'application/json';
195
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
196
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
197
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
198
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createReturnPremiumCreditsRequestDto, localVarRequestOptions, configuration);
199
+ return [2 /*return*/, {
200
+ url: (0, common_1.toPathString)(localVarUrlObj),
201
+ options: localVarRequestOptions,
202
+ }];
203
+ }
204
+ });
205
+ });
206
+ },
151
207
  /**
152
208
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
153
209
  * @summary Retrieve the exceeding credit
@@ -310,6 +366,27 @@ var ExceedingCreditsApiFp = function (configuration) {
310
366
  });
311
367
  });
312
368
  },
369
+ /**
370
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
371
+ * @summary Create the return-premium credits
372
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
373
+ * @param {string} [authorization] Bearer Token
374
+ * @param {*} [options] Override http request option.
375
+ * @throws {RequiredError}
376
+ */
377
+ createReturnPremiumCredits: function (createReturnPremiumCreditsRequestDto, authorization, options) {
378
+ return __awaiter(this, void 0, void 0, function () {
379
+ var localVarAxiosArgs;
380
+ return __generator(this, function (_a) {
381
+ switch (_a.label) {
382
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createReturnPremiumCredits(createReturnPremiumCreditsRequestDto, authorization, options)];
383
+ case 1:
384
+ localVarAxiosArgs = _a.sent();
385
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
386
+ }
387
+ });
388
+ });
389
+ },
313
390
  /**
314
391
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
315
392
  * @summary Retrieve the exceeding credit
@@ -379,6 +456,17 @@ var ExceedingCreditsApiFactory = function (configuration, basePath, axios) {
379
456
  createExceedingCredit: function (createExceedingCreditRequestDto, authorization, options) {
380
457
  return localVarFp.createExceedingCredit(createExceedingCreditRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
381
458
  },
459
+ /**
460
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
461
+ * @summary Create the return-premium credits
462
+ * @param {CreateReturnPremiumCreditsRequestDto} createReturnPremiumCreditsRequestDto
463
+ * @param {string} [authorization] Bearer Token
464
+ * @param {*} [options] Override http request option.
465
+ * @throws {RequiredError}
466
+ */
467
+ createReturnPremiumCredits: function (createReturnPremiumCreditsRequestDto, authorization, options) {
468
+ return localVarFp.createReturnPremiumCredits(createReturnPremiumCreditsRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
469
+ },
382
470
  /**
383
471
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
384
472
  * @summary Retrieve the exceeding credit
@@ -433,6 +521,18 @@ var ExceedingCreditsApi = /** @class */ (function (_super) {
433
521
  var _this = this;
434
522
  return (0, exports.ExceedingCreditsApiFp)(this.configuration).createExceedingCredit(requestParameters.createExceedingCreditRequestDto, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
435
523
  };
524
+ /**
525
+ * Create the return-premium credits of a reversing document (withdrawal, correction or final invoice). Already created credits are returned unchanged, so this also replays a lost invoice event. **Required Permissions** \"payment-management.payments.create\"
526
+ * @summary Create the return-premium credits
527
+ * @param {ExceedingCreditsApiCreateReturnPremiumCreditsRequest} requestParameters Request parameters.
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ * @memberof ExceedingCreditsApi
531
+ */
532
+ ExceedingCreditsApi.prototype.createReturnPremiumCredits = function (requestParameters, options) {
533
+ var _this = this;
534
+ return (0, exports.ExceedingCreditsApiFp)(this.configuration).createReturnPremiumCredits(requestParameters.createReturnPremiumCreditsRequestDto, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
535
+ };
436
536
  /**
437
537
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
438
538
  * @summary Retrieve the exceeding credit
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CreatePaymentReceiptRequestDto {
18
18
  /**
19
- * amount
19
+ * Amount in cents, always positive. In the payment request\'s direction it pays the request, at most what it still has open; in the opposite direction it records money that came back, at most what its receipts have paid.
20
20
  * @type {number}
21
21
  * @memberof CreatePaymentReceiptRequestDto
22
22
  */
@@ -28,7 +28,7 @@ export interface CreatePaymentReceiptRequestDto {
28
28
  */
29
29
  'currency': string;
30
30
  /**
31
- * The flow of the payment: disburse or collect
31
+ * The flow of the payment: disburse or collect. The payment request\'s own direction pays it; the opposite direction records money that came back, for example a returned payout is collect on a disburse request.
32
32
  * @type {string}
33
33
  * @memberof CreatePaymentReceiptRequestDto
34
34
  */
@@ -0,0 +1,24 @@
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 CreateReturnPremiumCreditsRequestDto
16
+ */
17
+ export interface CreateReturnPremiumCreditsRequestDto {
18
+ /**
19
+ * The code of the reversing document (withdrawal, correction or final invoice) to create the return-premium credits for
20
+ * @type {string}
21
+ * @memberof CreateReturnPremiumCreditsRequestDto
22
+ */
23
+ 'reversingInvoiceCode': string;
24
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,25 @@
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
+ import { ExceedingCreditClass } from './exceeding-credit-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface CreateReturnPremiumCreditsResponseClass
17
+ */
18
+ export interface CreateReturnPremiumCreditsResponseClass {
19
+ /**
20
+ * The return-premium credits of the reversing document, one per reversed invoice that gets money back
21
+ * @type {Array<ExceedingCreditClass>}
22
+ * @memberof CreateReturnPremiumCreditsResponseClass
23
+ */
24
+ 'exceedingCredits': Array<ExceedingCreditClass>;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -28,11 +28,29 @@ export interface ExceedingCreditClass {
28
28
  */
29
29
  'currency'?: ExceedingCreditClassCurrencyEnum;
30
30
  /**
31
- * The bank transaction code of the credit
31
+ * The bank transaction code of the credit; empty on a return-premium credit, which no bank transaction caused
32
32
  * @type {string}
33
33
  * @memberof ExceedingCreditClass
34
34
  */
35
- 'bankTransactionCode': string;
35
+ 'bankTransactionCode'?: string;
36
+ /**
37
+ * Where the credit comes from: overpayment (the customer paid more than invoiced) or return_premium (a reversing document gave back more than the customer still owes)
38
+ * @type {string}
39
+ * @memberof ExceedingCreditClass
40
+ */
41
+ 'origin': ExceedingCreditClassOriginEnum;
42
+ /**
43
+ * The withdrawal, correction or termination invoice that caused a return-premium credit
44
+ * @type {string}
45
+ * @memberof ExceedingCreditClass
46
+ */
47
+ 'reversingInvoiceCode'?: string;
48
+ /**
49
+ * The number of the invoice that caused a return-premium credit
50
+ * @type {string}
51
+ * @memberof ExceedingCreditClass
52
+ */
53
+ 'reversingInvoiceNumber'?: string;
36
54
  /**
37
55
  * The description of the credit
38
56
  * @type {string}
@@ -120,3 +138,8 @@ export declare const ExceedingCreditClassCurrencyEnum: {
120
138
  readonly Sek: "SEK";
121
139
  };
122
140
  export type ExceedingCreditClassCurrencyEnum = typeof ExceedingCreditClassCurrencyEnum[keyof typeof ExceedingCreditClassCurrencyEnum];
141
+ export declare const ExceedingCreditClassOriginEnum: {
142
+ readonly Overpayment: "overpayment";
143
+ readonly ReturnPremium: "return_premium";
144
+ };
145
+ export type ExceedingCreditClassOriginEnum = typeof ExceedingCreditClassOriginEnum[keyof typeof ExceedingCreditClassOriginEnum];
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ExceedingCreditClassCurrencyEnum = void 0;
16
+ exports.ExceedingCreditClassOriginEnum = exports.ExceedingCreditClassCurrencyEnum = void 0;
17
17
  exports.ExceedingCreditClassCurrencyEnum = {
18
18
  Eur: 'EUR',
19
19
  Usd: 'USD',
@@ -27,3 +27,7 @@ exports.ExceedingCreditClassCurrencyEnum = {
27
27
  Nok: 'NOK',
28
28
  Sek: 'SEK'
29
29
  };
30
+ exports.ExceedingCreditClassOriginEnum = {
31
+ Overpayment: 'overpayment',
32
+ ReturnPremium: 'return_premium'
33
+ };
@@ -58,19 +58,37 @@ export interface ExceedingCreditEntity {
58
58
  * @type {number}
59
59
  * @memberof ExceedingCreditEntity
60
60
  */
61
- 'bankTransactionId': number;
61
+ 'bankTransactionId'?: number;
62
62
  /**
63
63
  *
64
64
  * @type {BankTransactionEntity}
65
65
  * @memberof ExceedingCreditEntity
66
66
  */
67
- 'bankTransaction': BankTransactionEntity;
67
+ 'bankTransaction'?: BankTransactionEntity;
68
68
  /**
69
69
  *
70
70
  * @type {string}
71
71
  * @memberof ExceedingCreditEntity
72
72
  */
73
73
  'bankTransactionCode': string;
74
+ /**
75
+ *
76
+ * @type {string}
77
+ * @memberof ExceedingCreditEntity
78
+ */
79
+ 'origin': ExceedingCreditEntityOriginEnum;
80
+ /**
81
+ *
82
+ * @type {string}
83
+ * @memberof ExceedingCreditEntity
84
+ */
85
+ 'reversingInvoiceCode'?: string;
86
+ /**
87
+ *
88
+ * @type {string}
89
+ * @memberof ExceedingCreditEntity
90
+ */
91
+ 'reversingInvoiceNumber'?: string;
74
92
  /**
75
93
  *
76
94
  * @type {string}
@@ -152,3 +170,8 @@ export declare const ExceedingCreditEntityCurrencyEnum: {
152
170
  readonly Sek: "SEK";
153
171
  };
154
172
  export type ExceedingCreditEntityCurrencyEnum = typeof ExceedingCreditEntityCurrencyEnum[keyof typeof ExceedingCreditEntityCurrencyEnum];
173
+ export declare const ExceedingCreditEntityOriginEnum: {
174
+ readonly Overpayment: "overpayment";
175
+ readonly ReturnPremium: "return_premium";
176
+ };
177
+ export type ExceedingCreditEntityOriginEnum = typeof ExceedingCreditEntityOriginEnum[keyof typeof ExceedingCreditEntityOriginEnum];
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ExceedingCreditEntityCurrencyEnum = void 0;
16
+ exports.ExceedingCreditEntityOriginEnum = exports.ExceedingCreditEntityCurrencyEnum = void 0;
17
17
  exports.ExceedingCreditEntityCurrencyEnum = {
18
18
  Eur: 'EUR',
19
19
  Usd: 'USD',
@@ -27,3 +27,7 @@ exports.ExceedingCreditEntityCurrencyEnum = {
27
27
  Nok: 'NOK',
28
28
  Sek: 'SEK'
29
29
  };
30
+ exports.ExceedingCreditEntityOriginEnum = {
31
+ Overpayment: 'overpayment',
32
+ ReturnPremium: 'return_premium'
33
+ };
@@ -52,6 +52,8 @@ export * from './create-policy-payment-method-response-class';
52
52
  export * from './create-psp-payment-method-request-dto';
53
53
  export * from './create-refund-request-dto';
54
54
  export * from './create-refund-response-class';
55
+ export * from './create-return-premium-credits-request-dto';
56
+ export * from './create-return-premium-credits-response-class';
55
57
  export * from './create-tenant-bank-account-request-dto';
56
58
  export * from './create-tenant-bank-account-response-class';
57
59
  export * from './credit-allocation-class';
@@ -68,6 +68,8 @@ __exportStar(require("./create-policy-payment-method-response-class"), exports);
68
68
  __exportStar(require("./create-psp-payment-method-request-dto"), exports);
69
69
  __exportStar(require("./create-refund-request-dto"), exports);
70
70
  __exportStar(require("./create-refund-response-class"), exports);
71
+ __exportStar(require("./create-return-premium-credits-request-dto"), exports);
72
+ __exportStar(require("./create-return-premium-credits-response-class"), exports);
71
73
  __exportStar(require("./create-tenant-bank-account-request-dto"), exports);
72
74
  __exportStar(require("./create-tenant-bank-account-response-class"), exports);
73
75
  __exportStar(require("./credit-allocation-class"), exports);
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface CreatePaymentReceiptRequestDto {
23
23
  /**
24
- * amount
24
+ * Amount in cents, always positive. In the payment request\'s direction it pays the request, at most what it still has open; in the opposite direction it records money that came back, at most what its receipts have paid.
25
25
  * @type {number}
26
26
  * @memberof CreatePaymentReceiptRequestDto
27
27
  */
@@ -33,7 +33,7 @@ export interface CreatePaymentReceiptRequestDto {
33
33
  */
34
34
  'currency': string;
35
35
  /**
36
- * The flow of the payment: disburse or collect
36
+ * The flow of the payment: disburse or collect. The payment request\'s own direction pays it; the opposite direction records money that came back, for example a returned payout is collect on a disburse request.
37
37
  * @type {string}
38
38
  * @memberof CreatePaymentReceiptRequestDto
39
39
  */
@@ -0,0 +1,30 @@
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
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CreateReturnPremiumCreditsRequestDto
21
+ */
22
+ export interface CreateReturnPremiumCreditsRequestDto {
23
+ /**
24
+ * The code of the reversing document (withdrawal, correction or final invoice) to create the return-premium credits for
25
+ * @type {string}
26
+ * @memberof CreateReturnPremiumCreditsRequestDto
27
+ */
28
+ 'reversingInvoiceCode': string;
29
+ }
30
+
@@ -0,0 +1,31 @@
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 { ExceedingCreditClass } from './exceeding-credit-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface CreateReturnPremiumCreditsResponseClass
22
+ */
23
+ export interface CreateReturnPremiumCreditsResponseClass {
24
+ /**
25
+ * The return-premium credits of the reversing document, one per reversed invoice that gets money back
26
+ * @type {Array<ExceedingCreditClass>}
27
+ * @memberof CreateReturnPremiumCreditsResponseClass
28
+ */
29
+ 'exceedingCredits': Array<ExceedingCreditClass>;
30
+ }
31
+
@@ -33,11 +33,29 @@ export interface ExceedingCreditClass {
33
33
  */
34
34
  'currency'?: ExceedingCreditClassCurrencyEnum;
35
35
  /**
36
- * The bank transaction code of the credit
36
+ * The bank transaction code of the credit; empty on a return-premium credit, which no bank transaction caused
37
37
  * @type {string}
38
38
  * @memberof ExceedingCreditClass
39
39
  */
40
- 'bankTransactionCode': string;
40
+ 'bankTransactionCode'?: string;
41
+ /**
42
+ * Where the credit comes from: overpayment (the customer paid more than invoiced) or return_premium (a reversing document gave back more than the customer still owes)
43
+ * @type {string}
44
+ * @memberof ExceedingCreditClass
45
+ */
46
+ 'origin': ExceedingCreditClassOriginEnum;
47
+ /**
48
+ * The withdrawal, correction or termination invoice that caused a return-premium credit
49
+ * @type {string}
50
+ * @memberof ExceedingCreditClass
51
+ */
52
+ 'reversingInvoiceCode'?: string;
53
+ /**
54
+ * The number of the invoice that caused a return-premium credit
55
+ * @type {string}
56
+ * @memberof ExceedingCreditClass
57
+ */
58
+ 'reversingInvoiceNumber'?: string;
41
59
  /**
42
60
  * The description of the credit
43
61
  * @type {string}
@@ -127,5 +145,11 @@ export const ExceedingCreditClassCurrencyEnum = {
127
145
  } as const;
128
146
 
129
147
  export type ExceedingCreditClassCurrencyEnum = typeof ExceedingCreditClassCurrencyEnum[keyof typeof ExceedingCreditClassCurrencyEnum];
148
+ export const ExceedingCreditClassOriginEnum = {
149
+ Overpayment: 'overpayment',
150
+ ReturnPremium: 'return_premium'
151
+ } as const;
152
+
153
+ export type ExceedingCreditClassOriginEnum = typeof ExceedingCreditClassOriginEnum[keyof typeof ExceedingCreditClassOriginEnum];
130
154
 
131
155
 
@@ -63,19 +63,37 @@ export interface ExceedingCreditEntity {
63
63
  * @type {number}
64
64
  * @memberof ExceedingCreditEntity
65
65
  */
66
- 'bankTransactionId': number;
66
+ 'bankTransactionId'?: number;
67
67
  /**
68
68
  *
69
69
  * @type {BankTransactionEntity}
70
70
  * @memberof ExceedingCreditEntity
71
71
  */
72
- 'bankTransaction': BankTransactionEntity;
72
+ 'bankTransaction'?: BankTransactionEntity;
73
73
  /**
74
74
  *
75
75
  * @type {string}
76
76
  * @memberof ExceedingCreditEntity
77
77
  */
78
78
  'bankTransactionCode': string;
79
+ /**
80
+ *
81
+ * @type {string}
82
+ * @memberof ExceedingCreditEntity
83
+ */
84
+ 'origin': ExceedingCreditEntityOriginEnum;
85
+ /**
86
+ *
87
+ * @type {string}
88
+ * @memberof ExceedingCreditEntity
89
+ */
90
+ 'reversingInvoiceCode'?: string;
91
+ /**
92
+ *
93
+ * @type {string}
94
+ * @memberof ExceedingCreditEntity
95
+ */
96
+ 'reversingInvoiceNumber'?: string;
79
97
  /**
80
98
  *
81
99
  * @type {string}
@@ -159,5 +177,11 @@ export const ExceedingCreditEntityCurrencyEnum = {
159
177
  } as const;
160
178
 
161
179
  export type ExceedingCreditEntityCurrencyEnum = typeof ExceedingCreditEntityCurrencyEnum[keyof typeof ExceedingCreditEntityCurrencyEnum];
180
+ export const ExceedingCreditEntityOriginEnum = {
181
+ Overpayment: 'overpayment',
182
+ ReturnPremium: 'return_premium'
183
+ } as const;
184
+
185
+ export type ExceedingCreditEntityOriginEnum = typeof ExceedingCreditEntityOriginEnum[keyof typeof ExceedingCreditEntityOriginEnum];
162
186
 
163
187
 
package/models/index.ts CHANGED
@@ -52,6 +52,8 @@ export * from './create-policy-payment-method-response-class';
52
52
  export * from './create-psp-payment-method-request-dto';
53
53
  export * from './create-refund-request-dto';
54
54
  export * from './create-refund-response-class';
55
+ export * from './create-return-premium-credits-request-dto';
56
+ export * from './create-return-premium-credits-response-class';
55
57
  export * from './create-tenant-bank-account-request-dto';
56
58
  export * from './create-tenant-bank-account-response-class';
57
59
  export * from './credit-allocation-class';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/payment-sdk",
3
- "version": "1.22.1-beta.80",
3
+ "version": "1.22.1-beta.82",
4
4
  "description": "OpenAPI client for @emilgroup/payment-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [