@emilgroup/payment-sdk 1.22.1-beta.84 → 1.22.1-beta.86

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 (34) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/bank-order-texts-api.ts +265 -0
  4. package/api/payment-receipts-api.ts +120 -12
  5. package/api.ts +2 -0
  6. package/dist/api/bank-order-texts-api.d.ts +144 -0
  7. package/dist/api/bank-order-texts-api.js +325 -0
  8. package/dist/api/payment-receipts-api.d.ts +68 -12
  9. package/dist/api/payment-receipts-api.js +109 -10
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/bank-order-texts-class.d.ts +42 -0
  13. package/dist/models/bank-order-texts-class.js +15 -0
  14. package/dist/models/cancel-payment-receipt-response-class.d.ts +25 -0
  15. package/dist/models/cancel-payment-receipt-response-class.js +15 -0
  16. package/dist/models/get-bank-order-texts-response-class.d.ts +25 -0
  17. package/dist/models/get-bank-order-texts-response-class.js +15 -0
  18. package/dist/models/index.d.ts +5 -0
  19. package/dist/models/index.js +5 -0
  20. package/dist/models/payment-receipt-class.d.ts +12 -0
  21. package/dist/models/payment-receipt-entity.d.ts +18 -0
  22. package/dist/models/update-bank-order-texts-request-dto.d.ts +32 -0
  23. package/dist/models/update-bank-order-texts-request-dto.js +15 -0
  24. package/dist/models/update-bank-order-texts-response-class.d.ts +25 -0
  25. package/dist/models/update-bank-order-texts-response-class.js +15 -0
  26. package/models/bank-order-texts-class.ts +48 -0
  27. package/models/cancel-payment-receipt-response-class.ts +31 -0
  28. package/models/get-bank-order-texts-response-class.ts +31 -0
  29. package/models/index.ts +5 -0
  30. package/models/payment-receipt-class.ts +12 -0
  31. package/models/payment-receipt-entity.ts +18 -0
  32. package/models/update-bank-order-texts-request-dto.ts +36 -0
  33. package/models/update-bank-order-texts-response-class.ts +31 -0
  34. package/package.json +1 -1
@@ -4,6 +4,7 @@
4
4
  README.md
5
5
  api.ts
6
6
  api/bank-accounts-api.ts
7
+ api/bank-order-texts-api.ts
7
8
  api/bank-orders-api.ts
8
9
  api/bank-transaction-api.ts
9
10
  api/billing-addresses-api.ts
@@ -33,6 +34,7 @@ models/bank-account-class.ts
33
34
  models/bank-data-class.ts
34
35
  models/bank-order-class.ts
35
36
  models/bank-order-entity.ts
37
+ models/bank-order-texts-class.ts
36
38
  models/bank-order-xml-file-class.ts
37
39
  models/bank-order-xml-file-entity.ts
38
40
  models/bank-transaction-class-without-expand-properties.ts
@@ -45,6 +47,7 @@ models/billing-address-class.ts
45
47
  models/billing-address-dto.ts
46
48
  models/billing-profile-dto.ts
47
49
  models/billing-profile-limited-response-dto.ts
50
+ models/cancel-payment-receipt-response-class.ts
48
51
  models/card-details-dto.ts
49
52
  models/complete-adyen-payment-setup-request-dto.ts
50
53
  models/complete-braintree-payment-setup-request-dto.ts
@@ -96,6 +99,7 @@ models/exceeding-credit-entity.ts
96
99
  models/generate-invoice-match-suggestions-response-class.ts
97
100
  models/get-bank-account-response-class.ts
98
101
  models/get-bank-order-response-class.ts
102
+ models/get-bank-order-texts-response-class.ts
99
103
  models/get-bank-transactions-response-class.ts
100
104
  models/get-billing-address-response-class.ts
101
105
  models/get-credit-allocation-response-class.ts
@@ -177,6 +181,8 @@ models/update-bank-account-request-dto.ts
177
181
  models/update-bank-account-response-class.ts
178
182
  models/update-bank-order-request-dto.ts
179
183
  models/update-bank-order-response-class.ts
184
+ models/update-bank-order-texts-request-dto.ts
185
+ models/update-bank-order-texts-response-class.ts
180
186
  models/update-billing-address-request-dto.ts
181
187
  models/update-billing-address-response-class.ts
182
188
  models/update-payment-receipt-response-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.84 --save
20
+ npm install @emilgroup/payment-sdk@1.22.1-beta.86 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.22.1-beta.84
24
+ yarn add @emilgroup/payment-sdk@1.22.1-beta.86
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -0,0 +1,265 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { GetBankOrderTextsResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { UpdateBankOrderTextsRequestDto } from '../models';
27
+ // @ts-ignore
28
+ import { UpdateBankOrderTextsResponseClass } from '../models';
29
+ /**
30
+ * BankOrderTextsApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export const BankOrderTextsApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ * Returns the remittance information templates of the tenant per bank order type, with the version and the last change. 404 when nothing is configured. **Required Permissions** \"payment-management.bank-orders.view\"
37
+ * @summary Retrieve the bank order texts
38
+ * @param {string} [authorization] Bearer Token
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getBankOrderTexts: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ const localVarPath = `/paymentservice/v1/bank-order-texts`;
44
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
45
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
46
+ let baseOptions;
47
+ let baseAccessToken;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ baseAccessToken = configuration.accessToken;
51
+ }
52
+
53
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
54
+ const localVarHeaderParameter = {} as any;
55
+ const localVarQueryParameter = {} as any;
56
+
57
+ // authentication bearer required
58
+ // http bearer authentication required
59
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
60
+
61
+ // Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
62
+ // no token is stored, so a refused call still refreshes; a session call (account header) sends none.
63
+ const authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
64
+ const authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
65
+ const authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !baseOptions?.headers?.['X-Emil-Account'];
66
+ if (authorizationValue || authorizationKeepEmpty) {
67
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
68
+ }
69
+
70
+
71
+
72
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
73
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
74
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
75
+
76
+ return {
77
+ url: toPathString(localVarUrlObj),
78
+ options: localVarRequestOptions,
79
+ };
80
+ },
81
+ /**
82
+ * Saves the remittance information templates of the tenant. Every template is checked against the rules of its bank order type (400 with field errors). A save against an older version is refused (409). **Required Permissions** \"payment-management.bank-orders.update\"
83
+ * @summary Save the bank order texts
84
+ * @param {UpdateBankOrderTextsRequestDto} updateBankOrderTextsRequestDto
85
+ * @param {string} [authorization] Bearer Token
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ updateBankOrderTexts: async (updateBankOrderTextsRequestDto: UpdateBankOrderTextsRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
90
+ // verify required parameter 'updateBankOrderTextsRequestDto' is not null or undefined
91
+ assertParamExists('updateBankOrderTexts', 'updateBankOrderTextsRequestDto', updateBankOrderTextsRequestDto)
92
+ const localVarPath = `/paymentservice/v1/bank-order-texts`;
93
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
94
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
95
+ let baseOptions;
96
+ let baseAccessToken;
97
+ if (configuration) {
98
+ baseOptions = configuration.baseOptions;
99
+ baseAccessToken = configuration.accessToken;
100
+ }
101
+
102
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
103
+ const localVarHeaderParameter = {} as any;
104
+ const localVarQueryParameter = {} as any;
105
+
106
+ // authentication bearer required
107
+ // http bearer authentication required
108
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
109
+
110
+ // Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
111
+ // no token is stored, so a refused call still refreshes; a session call (account header) sends none.
112
+ const authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
113
+ const authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
114
+ const authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !baseOptions?.headers?.['X-Emil-Account'];
115
+ if (authorizationValue || authorizationKeepEmpty) {
116
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
117
+ }
118
+
119
+
120
+
121
+ localVarHeaderParameter['Content-Type'] = 'application/json';
122
+
123
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
124
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
125
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
126
+ localVarRequestOptions.data = serializeDataIfNeeded(updateBankOrderTextsRequestDto, localVarRequestOptions, configuration)
127
+
128
+ return {
129
+ url: toPathString(localVarUrlObj),
130
+ options: localVarRequestOptions,
131
+ };
132
+ },
133
+ }
134
+ };
135
+
136
+ /**
137
+ * BankOrderTextsApi - functional programming interface
138
+ * @export
139
+ */
140
+ export const BankOrderTextsApiFp = function(configuration?: Configuration) {
141
+ const localVarAxiosParamCreator = BankOrderTextsApiAxiosParamCreator(configuration)
142
+ return {
143
+ /**
144
+ * Returns the remittance information templates of the tenant per bank order type, with the version and the last change. 404 when nothing is configured. **Required Permissions** \"payment-management.bank-orders.view\"
145
+ * @summary Retrieve the bank order texts
146
+ * @param {string} [authorization] Bearer Token
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ async getBankOrderTexts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderTextsResponseClass>> {
151
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBankOrderTexts(authorization, options);
152
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
153
+ },
154
+ /**
155
+ * Saves the remittance information templates of the tenant. Every template is checked against the rules of its bank order type (400 with field errors). A save against an older version is refused (409). **Required Permissions** \"payment-management.bank-orders.update\"
156
+ * @summary Save the bank order texts
157
+ * @param {UpdateBankOrderTextsRequestDto} updateBankOrderTextsRequestDto
158
+ * @param {string} [authorization] Bearer Token
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ async updateBankOrderTexts(updateBankOrderTextsRequestDto: UpdateBankOrderTextsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBankOrderTextsResponseClass>> {
163
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateBankOrderTexts(updateBankOrderTextsRequestDto, authorization, options);
164
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
165
+ },
166
+ }
167
+ };
168
+
169
+ /**
170
+ * BankOrderTextsApi - factory interface
171
+ * @export
172
+ */
173
+ export const BankOrderTextsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
174
+ const localVarFp = BankOrderTextsApiFp(configuration)
175
+ return {
176
+ /**
177
+ * Returns the remittance information templates of the tenant per bank order type, with the version and the last change. 404 when nothing is configured. **Required Permissions** \"payment-management.bank-orders.view\"
178
+ * @summary Retrieve the bank order texts
179
+ * @param {string} [authorization] Bearer Token
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ getBankOrderTexts(authorization?: string, options?: any): AxiosPromise<GetBankOrderTextsResponseClass> {
184
+ return localVarFp.getBankOrderTexts(authorization, options).then((request) => request(axios, basePath));
185
+ },
186
+ /**
187
+ * Saves the remittance information templates of the tenant. Every template is checked against the rules of its bank order type (400 with field errors). A save against an older version is refused (409). **Required Permissions** \"payment-management.bank-orders.update\"
188
+ * @summary Save the bank order texts
189
+ * @param {UpdateBankOrderTextsRequestDto} updateBankOrderTextsRequestDto
190
+ * @param {string} [authorization] Bearer Token
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ updateBankOrderTexts(updateBankOrderTextsRequestDto: UpdateBankOrderTextsRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBankOrderTextsResponseClass> {
195
+ return localVarFp.updateBankOrderTexts(updateBankOrderTextsRequestDto, authorization, options).then((request) => request(axios, basePath));
196
+ },
197
+ };
198
+ };
199
+
200
+ /**
201
+ * Request parameters for getBankOrderTexts operation in BankOrderTextsApi.
202
+ * @export
203
+ * @interface BankOrderTextsApiGetBankOrderTextsRequest
204
+ */
205
+ export interface BankOrderTextsApiGetBankOrderTextsRequest {
206
+ /**
207
+ * Bearer Token
208
+ * @type {string}
209
+ * @memberof BankOrderTextsApiGetBankOrderTexts
210
+ */
211
+ readonly authorization?: string
212
+ }
213
+
214
+ /**
215
+ * Request parameters for updateBankOrderTexts operation in BankOrderTextsApi.
216
+ * @export
217
+ * @interface BankOrderTextsApiUpdateBankOrderTextsRequest
218
+ */
219
+ export interface BankOrderTextsApiUpdateBankOrderTextsRequest {
220
+ /**
221
+ *
222
+ * @type {UpdateBankOrderTextsRequestDto}
223
+ * @memberof BankOrderTextsApiUpdateBankOrderTexts
224
+ */
225
+ readonly updateBankOrderTextsRequestDto: UpdateBankOrderTextsRequestDto
226
+
227
+ /**
228
+ * Bearer Token
229
+ * @type {string}
230
+ * @memberof BankOrderTextsApiUpdateBankOrderTexts
231
+ */
232
+ readonly authorization?: string
233
+ }
234
+
235
+ /**
236
+ * BankOrderTextsApi - object-oriented interface
237
+ * @export
238
+ * @class BankOrderTextsApi
239
+ * @extends {BaseAPI}
240
+ */
241
+ export class BankOrderTextsApi extends BaseAPI {
242
+ /**
243
+ * Returns the remittance information templates of the tenant per bank order type, with the version and the last change. 404 when nothing is configured. **Required Permissions** \"payment-management.bank-orders.view\"
244
+ * @summary Retrieve the bank order texts
245
+ * @param {BankOrderTextsApiGetBankOrderTextsRequest} requestParameters Request parameters.
246
+ * @param {*} [options] Override http request option.
247
+ * @throws {RequiredError}
248
+ * @memberof BankOrderTextsApi
249
+ */
250
+ public getBankOrderTexts(requestParameters: BankOrderTextsApiGetBankOrderTextsRequest = {}, options?: AxiosRequestConfig) {
251
+ return BankOrderTextsApiFp(this.configuration).getBankOrderTexts(requestParameters.authorization, this.withOwner(options)).then((request) => request(this.axios, this.basePath));
252
+ }
253
+
254
+ /**
255
+ * Saves the remittance information templates of the tenant. Every template is checked against the rules of its bank order type (400 with field errors). A save against an older version is refused (409). **Required Permissions** \"payment-management.bank-orders.update\"
256
+ * @summary Save the bank order texts
257
+ * @param {BankOrderTextsApiUpdateBankOrderTextsRequest} requestParameters Request parameters.
258
+ * @param {*} [options] Override http request option.
259
+ * @throws {RequiredError}
260
+ * @memberof BankOrderTextsApi
261
+ */
262
+ public updateBankOrderTexts(requestParameters: BankOrderTextsApiUpdateBankOrderTextsRequest, options?: AxiosRequestConfig) {
263
+ return BankOrderTextsApiFp(this.configuration).updateBankOrderTexts(requestParameters.updateBankOrderTextsRequestDto, requestParameters.authorization, this.withOwner(options)).then((request) => request(this.axios, this.basePath));
264
+ }
265
+ }
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { CancelPaymentReceiptResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { CreatePaymentReceiptRequestDto } from '../models';
25
27
  // @ts-ignore
26
28
  import { CreatePaymentReceiptResponseClass } from '../models';
@@ -36,6 +38,56 @@ import { UpdatePaymentReceiptResponseClass } from '../models';
36
38
  */
37
39
  export const PaymentReceiptsApiAxiosParamCreator = function (configuration?: Configuration) {
38
40
  return {
41
+ /**
42
+ * Cancels a payment receipt recorded by hand: the receipt stays as the trail but no longer counts as paid. Its payment request is recomputed from the receipts left, a closed bank order of that request goes back to processing, and payment.receipt.cancelled is published under the tenant that owns the receipt. A receipt is cancelled once; one recorded by linking a bank transaction is cancelled by undoing that link. **Required Permissions** \"payment-management.payments.delete\"
43
+ * @summary Cancel the payment receipt
44
+ * @param {string} code Unique identifier for the object.
45
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ cancelPaymentReceipt: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ // verify required parameter 'code' is not null or undefined
51
+ assertParamExists('cancelPaymentReceipt', 'code', code)
52
+ const localVarPath = `/paymentservice/v1/payment-receipts/{code}/cancel`
53
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
54
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
55
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
56
+ let baseOptions;
57
+ let baseAccessToken;
58
+ if (configuration) {
59
+ baseOptions = configuration.baseOptions;
60
+ baseAccessToken = configuration.accessToken;
61
+ }
62
+
63
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
64
+ const localVarHeaderParameter = {} as any;
65
+ const localVarQueryParameter = {} as any;
66
+
67
+ // authentication bearer required
68
+ // http bearer authentication required
69
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
70
+
71
+ // Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
72
+ // no token is stored, so a refused call still refreshes; a session call (account header) sends none.
73
+ const authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
74
+ const authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
75
+ const authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !baseOptions?.headers?.['X-Emil-Account'];
76
+ if (authorizationValue || authorizationKeepEmpty) {
77
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
78
+ }
79
+
80
+
81
+
82
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
83
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
84
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
85
+
86
+ return {
87
+ url: toPathString(localVarUrlObj),
88
+ options: localVarRequestOptions,
89
+ };
90
+ },
39
91
  /**
40
92
  * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
41
93
  * @summary Create the payment receipt
@@ -89,7 +141,7 @@ export const PaymentReceiptsApiAxiosParamCreator = function (configuration?: Con
89
141
  };
90
142
  },
91
143
  /**
92
- * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
144
+ * Refused for every payment receipt: a receipt records money that moved, so it is cancelled with a trail and never deleted. Use POST /paymentservice/v1/payment-receipts/{code}/cancel instead. **Required Permissions** \"payment-management.payments.delete\"
93
145
  * @summary Delete the payment receipt
94
146
  * @param {string} code Unique identifier for the object.
95
147
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -201,11 +253,11 @@ export const PaymentReceiptsApiAxiosParamCreator = function (configuration?: Con
201
253
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
254
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
203
255
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
204
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
256
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
205
257
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
206
258
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount&lt;/i&gt;
207
259
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
208
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
260
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
209
261
  * @param {*} [options] Override http request option.
210
262
  * @throws {RequiredError}
211
263
  */
@@ -336,6 +388,18 @@ export const PaymentReceiptsApiAxiosParamCreator = function (configuration?: Con
336
388
  export const PaymentReceiptsApiFp = function(configuration?: Configuration) {
337
389
  const localVarAxiosParamCreator = PaymentReceiptsApiAxiosParamCreator(configuration)
338
390
  return {
391
+ /**
392
+ * Cancels a payment receipt recorded by hand: the receipt stays as the trail but no longer counts as paid. Its payment request is recomputed from the receipts left, a closed bank order of that request goes back to processing, and payment.receipt.cancelled is published under the tenant that owns the receipt. A receipt is cancelled once; one recorded by linking a bank transaction is cancelled by undoing that link. **Required Permissions** \"payment-management.payments.delete\"
393
+ * @summary Cancel the payment receipt
394
+ * @param {string} code Unique identifier for the object.
395
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
396
+ * @param {*} [options] Override http request option.
397
+ * @throws {RequiredError}
398
+ */
399
+ async cancelPaymentReceipt(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelPaymentReceiptResponseClass>> {
400
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelPaymentReceipt(code, authorization, options);
401
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
402
+ },
339
403
  /**
340
404
  * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
341
405
  * @summary Create the payment receipt
@@ -349,7 +413,7 @@ export const PaymentReceiptsApiFp = function(configuration?: Configuration) {
349
413
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
414
  },
351
415
  /**
352
- * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
416
+ * Refused for every payment receipt: a receipt records money that moved, so it is cancelled with a trail and never deleted. Use POST /paymentservice/v1/payment-receipts/{code}/cancel instead. **Required Permissions** \"payment-management.payments.delete\"
353
417
  * @summary Delete the payment receipt
354
418
  * @param {string} code Unique identifier for the object.
355
419
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -379,11 +443,11 @@ export const PaymentReceiptsApiFp = function(configuration?: Configuration) {
379
443
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
380
444
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
381
445
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
382
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
446
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
383
447
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
384
448
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount&lt;/i&gt;
385
449
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
386
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
450
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
387
451
  * @param {*} [options] Override http request option.
388
452
  * @throws {RequiredError}
389
453
  */
@@ -413,6 +477,17 @@ export const PaymentReceiptsApiFp = function(configuration?: Configuration) {
413
477
  export const PaymentReceiptsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
414
478
  const localVarFp = PaymentReceiptsApiFp(configuration)
415
479
  return {
480
+ /**
481
+ * Cancels a payment receipt recorded by hand: the receipt stays as the trail but no longer counts as paid. Its payment request is recomputed from the receipts left, a closed bank order of that request goes back to processing, and payment.receipt.cancelled is published under the tenant that owns the receipt. A receipt is cancelled once; one recorded by linking a bank transaction is cancelled by undoing that link. **Required Permissions** \"payment-management.payments.delete\"
482
+ * @summary Cancel the payment receipt
483
+ * @param {string} code Unique identifier for the object.
484
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ */
488
+ cancelPaymentReceipt(code: string, authorization?: string, options?: any): AxiosPromise<CancelPaymentReceiptResponseClass> {
489
+ return localVarFp.cancelPaymentReceipt(code, authorization, options).then((request) => request(axios, basePath));
490
+ },
416
491
  /**
417
492
  * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
418
493
  * @summary Create the payment receipt
@@ -425,7 +500,7 @@ export const PaymentReceiptsApiFactory = function (configuration?: Configuration
425
500
  return localVarFp.createPaymentReceipt(createPaymentReceiptRequestDto, authorization, options).then((request) => request(axios, basePath));
426
501
  },
427
502
  /**
428
- * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
503
+ * Refused for every payment receipt: a receipt records money that moved, so it is cancelled with a trail and never deleted. Use POST /paymentservice/v1/payment-receipts/{code}/cancel instead. **Required Permissions** \"payment-management.payments.delete\"
429
504
  * @summary Delete the payment receipt
430
505
  * @param {string} code Unique identifier for the object.
431
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -453,11 +528,11 @@ export const PaymentReceiptsApiFactory = function (configuration?: Configuration
453
528
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
454
529
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
455
530
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
456
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
531
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
457
532
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, amount, paymentRequestCode&lt;/i&gt;
458
533
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount&lt;/i&gt;
459
534
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
460
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
535
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
461
536
  * @param {*} [options] Override http request option.
462
537
  * @throws {RequiredError}
463
538
  */
@@ -478,6 +553,27 @@ export const PaymentReceiptsApiFactory = function (configuration?: Configuration
478
553
  };
479
554
  };
480
555
 
556
+ /**
557
+ * Request parameters for cancelPaymentReceipt operation in PaymentReceiptsApi.
558
+ * @export
559
+ * @interface PaymentReceiptsApiCancelPaymentReceiptRequest
560
+ */
561
+ export interface PaymentReceiptsApiCancelPaymentReceiptRequest {
562
+ /**
563
+ * Unique identifier for the object.
564
+ * @type {string}
565
+ * @memberof PaymentReceiptsApiCancelPaymentReceipt
566
+ */
567
+ readonly code: string
568
+
569
+ /**
570
+ * Bearer Token: provided by the login endpoint under the name accessToken.
571
+ * @type {string}
572
+ * @memberof PaymentReceiptsApiCancelPaymentReceipt
573
+ */
574
+ readonly authorization?: string
575
+ }
576
+
481
577
  /**
482
578
  * Request parameters for createPaymentReceipt operation in PaymentReceiptsApi.
483
579
  * @export
@@ -576,7 +672,7 @@ export interface PaymentReceiptsApiListPaymentReceiptsRequest {
576
672
  readonly pageToken?: string
577
673
 
578
674
  /**
579
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
675
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
580
676
  * @type {string}
581
677
  * @memberof PaymentReceiptsApiListPaymentReceipts
582
678
  */
@@ -604,7 +700,7 @@ export interface PaymentReceiptsApiListPaymentReceiptsRequest {
604
700
  readonly expand?: string
605
701
 
606
702
  /**
607
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount&lt;/i&gt;
703
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, psp, direction, paymentRequestCode, amount, cancelledAt&lt;/i&gt;
608
704
  * @type {string}
609
705
  * @memberof PaymentReceiptsApiListPaymentReceipts
610
706
  */
@@ -639,6 +735,18 @@ export interface PaymentReceiptsApiUpdatePaymentReceiptRequest {
639
735
  * @extends {BaseAPI}
640
736
  */
641
737
  export class PaymentReceiptsApi extends BaseAPI {
738
+ /**
739
+ * Cancels a payment receipt recorded by hand: the receipt stays as the trail but no longer counts as paid. Its payment request is recomputed from the receipts left, a closed bank order of that request goes back to processing, and payment.receipt.cancelled is published under the tenant that owns the receipt. A receipt is cancelled once; one recorded by linking a bank transaction is cancelled by undoing that link. **Required Permissions** \"payment-management.payments.delete\"
740
+ * @summary Cancel the payment receipt
741
+ * @param {PaymentReceiptsApiCancelPaymentReceiptRequest} requestParameters Request parameters.
742
+ * @param {*} [options] Override http request option.
743
+ * @throws {RequiredError}
744
+ * @memberof PaymentReceiptsApi
745
+ */
746
+ public cancelPaymentReceipt(requestParameters: PaymentReceiptsApiCancelPaymentReceiptRequest, options?: AxiosRequestConfig) {
747
+ return PaymentReceiptsApiFp(this.configuration).cancelPaymentReceipt(requestParameters.code, requestParameters.authorization, this.withOwner(options)).then((request) => request(this.axios, this.basePath));
748
+ }
749
+
642
750
  /**
643
751
  * This will create payment receipt. **Required Permissions** \"payment-management.payments.create\"
644
752
  * @summary Create the payment receipt
@@ -652,7 +760,7 @@ export class PaymentReceiptsApi extends BaseAPI {
652
760
  }
653
761
 
654
762
  /**
655
- * This will delete payment receipt. **Required Permissions** \"payment-management.payments.delete\"
763
+ * Refused for every payment receipt: a receipt records money that moved, so it is cancelled with a trail and never deleted. Use POST /paymentservice/v1/payment-receipts/{code}/cancel instead. **Required Permissions** \"payment-management.payments.delete\"
656
764
  * @summary Delete the payment receipt
657
765
  * @param {PaymentReceiptsApiDeletePaymentReceiptRequest} requestParameters Request parameters.
658
766
  * @param {*} [options] Override http request option.
package/api.ts CHANGED
@@ -21,6 +21,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { BankAccountsApi } from './api';
24
+ import { BankOrderTextsApi } from './api';
24
25
  import { BankOrdersApi } from './api';
25
26
  import { BankTransactionApi } from './api';
26
27
  import { BillingAddressesApi } from './api';
@@ -42,6 +43,7 @@ import { WebhooksApi } from './api';
42
43
 
43
44
 
44
45
  export * from './api/bank-accounts-api';
46
+ export * from './api/bank-order-texts-api';
45
47
  export * from './api/bank-orders-api';
46
48
  export * from './api/bank-transaction-api';
47
49
  export * from './api/billing-addresses-api';