@emilgroup/payment-sdk 1.22.1-beta.72 → 1.22.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 (30) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +2 -2
  3. package/api/bank-transaction-api.ts +130 -8
  4. package/dist/api/bank-transaction-api.d.ts +74 -8
  5. package/dist/api/bank-transaction-api.js +108 -6
  6. package/dist/models/bank-transaction-class.d.ts +7 -0
  7. package/dist/models/bank-transaction-entity.d.ts +7 -0
  8. package/dist/models/index.d.ts +4 -0
  9. package/dist/models/index.js +4 -0
  10. package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.d.ts +30 -0
  11. package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.js +15 -0
  12. package/dist/models/link-bank-transaction-payment-requests-response-class.d.ts +25 -0
  13. package/dist/models/link-bank-transaction-payment-requests-response-class.js +15 -0
  14. package/dist/models/payment-receipt-class.d.ts +12 -0
  15. package/dist/models/payment-receipt-entity.d.ts +139 -0
  16. package/dist/models/payment-receipt-entity.js +20 -0
  17. package/dist/models/payment-request-class.d.ts +1 -0
  18. package/dist/models/payment-request-class.js +1 -0
  19. package/dist/models/payment-request-entity.d.ts +223 -0
  20. package/dist/models/payment-request-entity.js +39 -0
  21. package/models/bank-transaction-class.ts +7 -0
  22. package/models/bank-transaction-entity.ts +7 -0
  23. package/models/index.ts +4 -0
  24. package/models/link-bank-transaction-payment-requests-request-dto-rest.ts +36 -0
  25. package/models/link-bank-transaction-payment-requests-response-class.ts +31 -0
  26. package/models/payment-receipt-class.ts +12 -0
  27. package/models/payment-receipt-entity.ts +148 -0
  28. package/models/payment-request-class.ts +1 -0
  29. package/models/payment-request-entity.ts +233 -0
  30. package/package.json +1 -1
@@ -0,0 +1,223 @@
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 { CreditAllocationEntity } from './credit-allocation-entity';
13
+ import { PaymentReceiptEntity } from './payment-receipt-entity';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface PaymentRequestEntity
18
+ */
19
+ export interface PaymentRequestEntity {
20
+ /**
21
+ *
22
+ * @type {number}
23
+ * @memberof PaymentRequestEntity
24
+ */
25
+ 'id': number;
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof PaymentRequestEntity
30
+ */
31
+ 'code': string;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof PaymentRequestEntity
36
+ */
37
+ 'paymentRequestNumber': string;
38
+ /**
39
+ *
40
+ * @type {number}
41
+ * @memberof PaymentRequestEntity
42
+ */
43
+ 'amount': number;
44
+ /**
45
+ *
46
+ * @type {string}
47
+ * @memberof PaymentRequestEntity
48
+ */
49
+ 'currency': string;
50
+ /**
51
+ *
52
+ * @type {string}
53
+ * @memberof PaymentRequestEntity
54
+ */
55
+ 'direction': PaymentRequestEntityDirectionEnum;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof PaymentRequestEntity
60
+ */
61
+ 'financialEntityCode': string;
62
+ /**
63
+ *
64
+ * @type {string}
65
+ * @memberof PaymentRequestEntity
66
+ */
67
+ 'financialEntityNumber': string;
68
+ /**
69
+ *
70
+ * @type {string}
71
+ * @memberof PaymentRequestEntity
72
+ */
73
+ 'financialEntityType': PaymentRequestEntityFinancialEntityTypeEnum;
74
+ /**
75
+ *
76
+ * @type {string}
77
+ * @memberof PaymentRequestEntity
78
+ */
79
+ 'domainEntityCode': string;
80
+ /**
81
+ *
82
+ * @type {string}
83
+ * @memberof PaymentRequestEntity
84
+ */
85
+ 'domainEntityNumber': string;
86
+ /**
87
+ *
88
+ * @type {string}
89
+ * @memberof PaymentRequestEntity
90
+ */
91
+ 'domainEntityType': PaymentRequestEntityDomainEntityTypeEnum;
92
+ /**
93
+ *
94
+ * @type {string}
95
+ * @memberof PaymentRequestEntity
96
+ */
97
+ 'status': PaymentRequestEntityStatusEnum;
98
+ /**
99
+ *
100
+ * @type {string}
101
+ * @memberof PaymentRequestEntity
102
+ */
103
+ 'partnerCode': string;
104
+ /**
105
+ *
106
+ * @type {string}
107
+ * @memberof PaymentRequestEntity
108
+ */
109
+ 'paymentMethodCode'?: string;
110
+ /**
111
+ *
112
+ * @type {string}
113
+ * @memberof PaymentRequestEntity
114
+ */
115
+ 'paymentMethodType'?: string;
116
+ /**
117
+ *
118
+ * @type {string}
119
+ * @memberof PaymentRequestEntity
120
+ */
121
+ 'paymentMethodPsp'?: string;
122
+ /**
123
+ *
124
+ * @type {string}
125
+ * @memberof PaymentRequestEntity
126
+ */
127
+ 'settlementCode'?: string;
128
+ /**
129
+ *
130
+ * @type {string}
131
+ * @memberof PaymentRequestEntity
132
+ */
133
+ 'bankOrderCode'?: string;
134
+ /**
135
+ *
136
+ * @type {string}
137
+ * @memberof PaymentRequestEntity
138
+ */
139
+ 'bankOrderNumber'?: string;
140
+ /**
141
+ *
142
+ * @type {boolean}
143
+ * @memberof PaymentRequestEntity
144
+ */
145
+ 'recipientHasBankDetails'?: boolean;
146
+ /**
147
+ *
148
+ * @type {Array<PaymentReceiptEntity>}
149
+ * @memberof PaymentRequestEntity
150
+ */
151
+ 'paymentReceipts': Array<PaymentReceiptEntity>;
152
+ /**
153
+ *
154
+ * @type {CreditAllocationEntity}
155
+ * @memberof PaymentRequestEntity
156
+ */
157
+ 'creditAllocation'?: CreditAllocationEntity;
158
+ /**
159
+ *
160
+ * @type {{ [key: string]: object; }}
161
+ * @memberof PaymentRequestEntity
162
+ */
163
+ 'metadata'?: {
164
+ [key: string]: object;
165
+ };
166
+ /**
167
+ *
168
+ * @type {string}
169
+ * @memberof PaymentRequestEntity
170
+ */
171
+ 'createdAt': string;
172
+ /**
173
+ *
174
+ * @type {string}
175
+ * @memberof PaymentRequestEntity
176
+ */
177
+ 'updatedAt': string;
178
+ /**
179
+ *
180
+ * @type {string}
181
+ * @memberof PaymentRequestEntity
182
+ */
183
+ 'deletedAt'?: string;
184
+ /**
185
+ *
186
+ * @type {string}
187
+ * @memberof PaymentRequestEntity
188
+ */
189
+ 'owner': string;
190
+ /**
191
+ *
192
+ * @type {string}
193
+ * @memberof PaymentRequestEntity
194
+ */
195
+ 'tenantHierarchy': string;
196
+ }
197
+ export declare const PaymentRequestEntityDirectionEnum: {
198
+ readonly Collect: "collect";
199
+ readonly Disburse: "disburse";
200
+ };
201
+ export type PaymentRequestEntityDirectionEnum = typeof PaymentRequestEntityDirectionEnum[keyof typeof PaymentRequestEntityDirectionEnum];
202
+ export declare const PaymentRequestEntityFinancialEntityTypeEnum: {
203
+ readonly ClaimRegulation: "claim_regulation";
204
+ readonly RefundAllocation: "refund_allocation";
205
+ readonly CommissionSettlement: "commission_settlement";
206
+ readonly Other: "other";
207
+ };
208
+ export type PaymentRequestEntityFinancialEntityTypeEnum = typeof PaymentRequestEntityFinancialEntityTypeEnum[keyof typeof PaymentRequestEntityFinancialEntityTypeEnum];
209
+ export declare const PaymentRequestEntityDomainEntityTypeEnum: {
210
+ readonly Other: "other";
211
+ readonly Claim: "claim";
212
+ readonly Policy: "policy";
213
+ };
214
+ export type PaymentRequestEntityDomainEntityTypeEnum = typeof PaymentRequestEntityDomainEntityTypeEnum[keyof typeof PaymentRequestEntityDomainEntityTypeEnum];
215
+ export declare const PaymentRequestEntityStatusEnum: {
216
+ readonly Open: "open";
217
+ readonly Approved: "approved";
218
+ readonly Pending: "pending";
219
+ readonly Paid: "paid";
220
+ readonly Failed: "failed";
221
+ readonly Withdrawn: "withdrawn";
222
+ };
223
+ export type PaymentRequestEntityStatusEnum = typeof PaymentRequestEntityStatusEnum[keyof typeof PaymentRequestEntityStatusEnum];
@@ -0,0 +1,39 @@
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 });
16
+ exports.PaymentRequestEntityStatusEnum = exports.PaymentRequestEntityDomainEntityTypeEnum = exports.PaymentRequestEntityFinancialEntityTypeEnum = exports.PaymentRequestEntityDirectionEnum = void 0;
17
+ exports.PaymentRequestEntityDirectionEnum = {
18
+ Collect: 'collect',
19
+ Disburse: 'disburse'
20
+ };
21
+ exports.PaymentRequestEntityFinancialEntityTypeEnum = {
22
+ ClaimRegulation: 'claim_regulation',
23
+ RefundAllocation: 'refund_allocation',
24
+ CommissionSettlement: 'commission_settlement',
25
+ Other: 'other'
26
+ };
27
+ exports.PaymentRequestEntityDomainEntityTypeEnum = {
28
+ Other: 'other',
29
+ Claim: 'claim',
30
+ Policy: 'policy'
31
+ };
32
+ exports.PaymentRequestEntityStatusEnum = {
33
+ Open: 'open',
34
+ Approved: 'approved',
35
+ Pending: 'pending',
36
+ Paid: 'paid',
37
+ Failed: 'failed',
38
+ Withdrawn: 'withdrawn'
39
+ };
@@ -16,6 +16,7 @@
16
16
  import { BankOrderClass } from './bank-order-class';
17
17
  import { BankTransactionInvoiceClass } from './bank-transaction-invoice-class';
18
18
  import { InvoiceMatchSuggestionClass } from './invoice-match-suggestion-class';
19
+ import { PaymentReceiptClass } from './payment-receipt-class';
19
20
  import { SuggestionGenerationProgressClass } from './suggestion-generation-progress-class';
20
21
  import { TenantBankAccountClassWithoutExpandProperties } from './tenant-bank-account-class-without-expand-properties';
21
22
 
@@ -157,6 +158,12 @@ export interface BankTransactionClass {
157
158
  * @memberof BankTransactionClass
158
159
  */
159
160
  'suggestionGenerationProgress'?: SuggestionGenerationProgressClass;
161
+ /**
162
+ * Payment receipts created by linking this outgoing transaction to payment requests
163
+ * @type {Array<PaymentReceiptClass>}
164
+ * @memberof BankTransactionClass
165
+ */
166
+ 'paymentReceipts'?: Array<PaymentReceiptClass>;
160
167
  }
161
168
 
162
169
  export const BankTransactionClassLabelEnum = {
@@ -17,6 +17,7 @@ import { BankOrderEntity } from './bank-order-entity';
17
17
  import { BankTransactionInvoiceEntity } from './bank-transaction-invoice-entity';
18
18
  import { ExceedingCreditEntity } from './exceeding-credit-entity';
19
19
  import { InvoiceMatchSuggestionEntity } from './invoice-match-suggestion-entity';
20
+ import { PaymentReceiptEntity } from './payment-receipt-entity';
20
21
  import { SuggestionGenerationProgressEntity } from './suggestion-generation-progress-entity';
21
22
  import { TenantBankAccountEntity } from './tenant-bank-account-entity';
22
23
 
@@ -140,6 +141,12 @@ export interface BankTransactionEntity {
140
141
  * @memberof BankTransactionEntity
141
142
  */
142
143
  'exceedingCredits': Array<ExceedingCreditEntity>;
144
+ /**
145
+ *
146
+ * @type {Array<PaymentReceiptEntity>}
147
+ * @memberof BankTransactionEntity
148
+ */
149
+ 'paymentReceipts': Array<PaymentReceiptEntity>;
143
150
  /**
144
151
  *
145
152
  * @type {string}
package/models/index.ts CHANGED
@@ -92,6 +92,8 @@ export * from './inline-response503';
92
92
  export * from './invoice-allocation-dto';
93
93
  export * from './invoice-match-suggestion-class';
94
94
  export * from './invoice-match-suggestion-entity';
95
+ export * from './link-bank-transaction-payment-requests-request-dto-rest';
96
+ export * from './link-bank-transaction-payment-requests-response-class';
95
97
  export * from './link-bank-transaction-request-dto-rest';
96
98
  export * from './link-bank-transactions-response-class';
97
99
  export * from './list-bank-accounts-response-class';
@@ -117,8 +119,10 @@ export * from './payment-class-without-expand-properties';
117
119
  export * from './payment-entity';
118
120
  export * from './payment-method-class';
119
121
  export * from './payment-receipt-class';
122
+ export * from './payment-receipt-entity';
120
123
  export * from './payment-reminder-class';
121
124
  export * from './payment-request-class';
125
+ export * from './payment-request-entity';
122
126
  export * from './payout-method-class';
123
127
  export * from './policy-payment-method-class';
124
128
  export * from './primary-bank-account-response-class';
@@ -0,0 +1,36 @@
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 LinkBankTransactionPaymentRequestsRequestDtoRest
21
+ */
22
+ export interface LinkBankTransactionPaymentRequestsRequestDtoRest {
23
+ /**
24
+ * Codes of the open payout payment requests the outgoing bank transaction paid; up to 1000, no duplicates, empty when only bank orders are linked. Together with the payment requests of the bank orders their amounts must add up to the transaction amount.
25
+ * @type {Array<string>}
26
+ * @memberof LinkBankTransactionPaymentRequestsRequestDtoRest
27
+ */
28
+ 'paymentRequestCodes': Array<string>;
29
+ /**
30
+ * Codes of payout bank orders the transaction paid whole: the link pays every open payment request each order holds in the transaction currency. Up to 1000, no duplicates; a payment request may not also be listed in paymentRequestCodes.
31
+ * @type {Array<string>}
32
+ * @memberof LinkBankTransactionPaymentRequestsRequestDtoRest
33
+ */
34
+ 'bankOrderCodes'?: Array<string>;
35
+ }
36
+
@@ -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 { BankTransactionClass } from './bank-transaction-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface LinkBankTransactionPaymentRequestsResponseClass
22
+ */
23
+ export interface LinkBankTransactionPaymentRequestsResponseClass {
24
+ /**
25
+ * The linked bank transaction, with the payment receipts the link created
26
+ * @type {BankTransactionClass}
27
+ * @memberof LinkBankTransactionPaymentRequestsResponseClass
28
+ */
29
+ 'bankTransaction': BankTransactionClass;
30
+ }
31
+
@@ -62,6 +62,12 @@ export interface PaymentReceiptClass {
62
62
  * @memberof PaymentReceiptClass
63
63
  */
64
64
  'paymentRequestCode'?: string;
65
+ /**
66
+ * The number of the payment request the payment receipt pays; read from the payment request, not stored on the receipt.
67
+ * @type {string}
68
+ * @memberof PaymentReceiptClass
69
+ */
70
+ 'paymentRequestNumber'?: string;
65
71
  /**
66
72
  * The payment service provider that produced the payment receipt.
67
73
  * @type {string}
@@ -74,6 +80,12 @@ export interface PaymentReceiptClass {
74
80
  * @memberof PaymentReceiptClass
75
81
  */
76
82
  'comment'?: string;
83
+ /**
84
+ * The code of the bank transaction whose link created the payment receipt; unset for a receipt created by hand.
85
+ * @type {string}
86
+ * @memberof PaymentReceiptClass
87
+ */
88
+ 'bankTransactionCode'?: string;
77
89
  /**
78
90
  * Time at which the object was created.
79
91
  * @type {string}
@@ -0,0 +1,148 @@
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 { BankTransactionEntity } from './bank-transaction-entity';
17
+ import { PaymentRequestEntity } from './payment-request-entity';
18
+
19
+ /**
20
+ *
21
+ * @export
22
+ * @interface PaymentReceiptEntity
23
+ */
24
+ export interface PaymentReceiptEntity {
25
+ /**
26
+ *
27
+ * @type {number}
28
+ * @memberof PaymentReceiptEntity
29
+ */
30
+ 'id': number;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof PaymentReceiptEntity
35
+ */
36
+ 'code': string;
37
+ /**
38
+ *
39
+ * @type {number}
40
+ * @memberof PaymentReceiptEntity
41
+ */
42
+ 'amount': number;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof PaymentReceiptEntity
47
+ */
48
+ 'currency': string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof PaymentReceiptEntity
53
+ */
54
+ 'direction': PaymentReceiptEntityDirectionEnum;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof PaymentReceiptEntity
59
+ */
60
+ 'dateOfPayment': string;
61
+ /**
62
+ *
63
+ * @type {string}
64
+ * @memberof PaymentReceiptEntity
65
+ */
66
+ 'paymentRequestCode'?: string;
67
+ /**
68
+ *
69
+ * @type {string}
70
+ * @memberof PaymentReceiptEntity
71
+ */
72
+ 'psp'?: string;
73
+ /**
74
+ *
75
+ * @type {string}
76
+ * @memberof PaymentReceiptEntity
77
+ */
78
+ 'comment'?: string;
79
+ /**
80
+ *
81
+ * @type {string}
82
+ * @memberof PaymentReceiptEntity
83
+ */
84
+ 'paymentRequestNumber'?: string;
85
+ /**
86
+ *
87
+ * @type {PaymentRequestEntity}
88
+ * @memberof PaymentReceiptEntity
89
+ */
90
+ 'paymentRequest'?: PaymentRequestEntity;
91
+ /**
92
+ *
93
+ * @type {number}
94
+ * @memberof PaymentReceiptEntity
95
+ */
96
+ 'bankTransactionId'?: number;
97
+ /**
98
+ *
99
+ * @type {string}
100
+ * @memberof PaymentReceiptEntity
101
+ */
102
+ 'bankTransactionCode'?: string;
103
+ /**
104
+ *
105
+ * @type {BankTransactionEntity}
106
+ * @memberof PaymentReceiptEntity
107
+ */
108
+ 'bankTransaction'?: BankTransactionEntity;
109
+ /**
110
+ *
111
+ * @type {string}
112
+ * @memberof PaymentReceiptEntity
113
+ */
114
+ 'createdAt'?: string;
115
+ /**
116
+ *
117
+ * @type {string}
118
+ * @memberof PaymentReceiptEntity
119
+ */
120
+ 'updatedAt'?: string;
121
+ /**
122
+ *
123
+ * @type {string}
124
+ * @memberof PaymentReceiptEntity
125
+ */
126
+ 'deletedAt'?: string;
127
+ /**
128
+ *
129
+ * @type {string}
130
+ * @memberof PaymentReceiptEntity
131
+ */
132
+ 'owner': string;
133
+ /**
134
+ *
135
+ * @type {string}
136
+ * @memberof PaymentReceiptEntity
137
+ */
138
+ 'tenantHierarchy': string;
139
+ }
140
+
141
+ export const PaymentReceiptEntityDirectionEnum = {
142
+ Collect: 'collect',
143
+ Disburse: 'disburse'
144
+ } as const;
145
+
146
+ export type PaymentReceiptEntityDirectionEnum = typeof PaymentReceiptEntityDirectionEnum[keyof typeof PaymentReceiptEntityDirectionEnum];
147
+
148
+
@@ -170,6 +170,7 @@ export type PaymentRequestClassDirectionEnum = typeof PaymentRequestClassDirecti
170
170
  export const PaymentRequestClassFinancialEntityTypeEnum = {
171
171
  ClaimRegulation: 'claim_regulation',
172
172
  RefundAllocation: 'refund_allocation',
173
+ CommissionSettlement: 'commission_settlement',
173
174
  Other: 'other'
174
175
  } as const;
175
176