@emilgroup/payment-sdk 1.13.1-beta.81 → 1.13.1-beta.83

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.
@@ -6,6 +6,7 @@ api.ts
6
6
  api/bank-accounts-api.ts
7
7
  api/bank-orders-api.ts
8
8
  api/bank-transaction-api.ts
9
+ api/exceeding-credits-api.ts
9
10
  api/health-check-api.ts
10
11
  api/payment-methods-api.ts
11
12
  api/payment-reminders-api.ts
@@ -55,11 +56,13 @@ models/create-tenant-bank-account-response-class.ts
55
56
  models/deactivate-payment-reminder-request-dto.ts
56
57
  models/deactivate-payment-reminder-response-class.ts
57
58
  models/deactivated-payment-reminder-class.ts
59
+ models/exceeding-credit-class.ts
58
60
  models/financial-account-class.ts
59
61
  models/generate-invoice-match-suggestions-response-class.ts
60
62
  models/get-bank-account-response-class.ts
61
63
  models/get-bank-order-response-class.ts
62
64
  models/get-bank-transactions-response-class.ts
65
+ models/get-exceeding-credit-response-class.ts
63
66
  models/get-payment-method-response-class.ts
64
67
  models/get-payment-reminder-response-class.ts
65
68
  models/get-payment-response-class.ts
@@ -85,6 +88,7 @@ models/link-bank-transactions-response-class.ts
85
88
  models/list-bank-accounts-response-class.ts
86
89
  models/list-bank-orders-response-class.ts
87
90
  models/list-bank-transactions-response-class.ts
91
+ models/list-exceeding-credits-response-class.ts
88
92
  models/list-payment-methods-response-class.ts
89
93
  models/list-payment-reminders-response-class.ts
90
94
  models/list-payments-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.13.1-beta.81 --save
20
+ npm install @emilgroup/payment-sdk@1.13.1-beta.83 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.13.1-beta.81
24
+ yarn add @emilgroup/payment-sdk@1.13.1-beta.83
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -0,0 +1,349 @@
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 { GetExceedingCreditResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { ListExceedingCreditsResponseClass } from '../models';
27
+ /**
28
+ * ExceedingCreditsApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const ExceedingCreditsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * 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
+ * @summary Retrieve the exceeding credit
36
+ * @param {string} code Code of the exceeding credit to get
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ getExceedingCredit: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
42
+ // verify required parameter 'code' is not null or undefined
43
+ assertParamExists('getExceedingCredit', 'code', code)
44
+ const localVarPath = `/paymentservice/v1/exceeding-credits/{code}`
45
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
46
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
47
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
48
+ let baseOptions;
49
+ let baseAccessToken;
50
+ if (configuration) {
51
+ baseOptions = configuration.baseOptions;
52
+ baseAccessToken = configuration.accessToken;
53
+ }
54
+
55
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
56
+ const localVarHeaderParameter = {} as any;
57
+ const localVarQueryParameter = {} as any;
58
+
59
+ // authentication bearer required
60
+ // http bearer authentication required
61
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
62
+
63
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
64
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
65
+ }
66
+
67
+
68
+
69
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
70
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
71
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
72
+
73
+ return {
74
+ url: toPathString(localVarUrlObj),
75
+ options: localVarRequestOptions,
76
+ };
77
+ },
78
+ /**
79
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
80
+ * @summary List exceeding credits
81
+ * @param {string} [authorization] Bearer Token
82
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
83
+ * @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.
84
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
85
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
86
+ * @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, updatedAt&lt;/i&gt;
87
+ * @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;
88
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ listExceedingCredits: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
93
+ const localVarPath = `/paymentservice/v1/exceeding-credits`;
94
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
95
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
96
+ let baseOptions;
97
+ let baseAccessToken;
98
+ if (configuration) {
99
+ baseOptions = configuration.baseOptions;
100
+ baseAccessToken = configuration.accessToken;
101
+ }
102
+
103
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
104
+ const localVarHeaderParameter = {} as any;
105
+ const localVarQueryParameter = {} as any;
106
+
107
+ // authentication bearer required
108
+ // http bearer authentication required
109
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
110
+
111
+ if (pageSize !== undefined) {
112
+ localVarQueryParameter['pageSize'] = pageSize;
113
+ }
114
+
115
+ if (pageToken !== undefined) {
116
+ localVarQueryParameter['pageToken'] = pageToken;
117
+ }
118
+
119
+ if (filter !== undefined) {
120
+ localVarQueryParameter['filter'] = filter;
121
+ }
122
+
123
+ if (search !== undefined) {
124
+ localVarQueryParameter['search'] = search;
125
+ }
126
+
127
+ if (order !== undefined) {
128
+ localVarQueryParameter['order'] = order;
129
+ }
130
+
131
+ if (expand !== undefined) {
132
+ localVarQueryParameter['expand'] = expand;
133
+ }
134
+
135
+ if (filters !== undefined) {
136
+ localVarQueryParameter['filters'] = filters;
137
+ }
138
+
139
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
140
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
141
+ }
142
+
143
+
144
+
145
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
146
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
147
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
148
+
149
+ return {
150
+ url: toPathString(localVarUrlObj),
151
+ options: localVarRequestOptions,
152
+ };
153
+ },
154
+ }
155
+ };
156
+
157
+ /**
158
+ * ExceedingCreditsApi - functional programming interface
159
+ * @export
160
+ */
161
+ export const ExceedingCreditsApiFp = function(configuration?: Configuration) {
162
+ const localVarAxiosParamCreator = ExceedingCreditsApiAxiosParamCreator(configuration)
163
+ return {
164
+ /**
165
+ * 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\"
166
+ * @summary Retrieve the exceeding credit
167
+ * @param {string} code Code of the exceeding credit to get
168
+ * @param {string} [authorization] Bearer Token
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ async getExceedingCredit(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExceedingCreditResponseClass>> {
173
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getExceedingCredit(code, authorization, options);
174
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
175
+ },
176
+ /**
177
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
178
+ * @summary List exceeding credits
179
+ * @param {string} [authorization] Bearer Token
180
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
181
+ * @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.
182
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
183
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
184
+ * @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, updatedAt&lt;/i&gt;
185
+ * @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;
186
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ async listExceedingCredits(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListExceedingCreditsResponseClass>> {
191
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listExceedingCredits(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
192
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
193
+ },
194
+ }
195
+ };
196
+
197
+ /**
198
+ * ExceedingCreditsApi - factory interface
199
+ * @export
200
+ */
201
+ export const ExceedingCreditsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
202
+ const localVarFp = ExceedingCreditsApiFp(configuration)
203
+ return {
204
+ /**
205
+ * 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\"
206
+ * @summary Retrieve the exceeding credit
207
+ * @param {string} code Code of the exceeding credit to get
208
+ * @param {string} [authorization] Bearer Token
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ getExceedingCredit(code: string, authorization?: string, options?: any): AxiosPromise<GetExceedingCreditResponseClass> {
213
+ return localVarFp.getExceedingCredit(code, authorization, options).then((request) => request(axios, basePath));
214
+ },
215
+ /**
216
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
217
+ * @summary List exceeding credits
218
+ * @param {string} [authorization] Bearer Token
219
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
220
+ * @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.
221
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
222
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
223
+ * @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, updatedAt&lt;/i&gt;
224
+ * @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;
225
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
226
+ * @param {*} [options] Override http request option.
227
+ * @throws {RequiredError}
228
+ */
229
+ listExceedingCredits(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListExceedingCreditsResponseClass> {
230
+ return localVarFp.listExceedingCredits(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
231
+ },
232
+ };
233
+ };
234
+
235
+ /**
236
+ * Request parameters for getExceedingCredit operation in ExceedingCreditsApi.
237
+ * @export
238
+ * @interface ExceedingCreditsApiGetExceedingCreditRequest
239
+ */
240
+ export interface ExceedingCreditsApiGetExceedingCreditRequest {
241
+ /**
242
+ * Code of the exceeding credit to get
243
+ * @type {string}
244
+ * @memberof ExceedingCreditsApiGetExceedingCredit
245
+ */
246
+ readonly code: string
247
+
248
+ /**
249
+ * Bearer Token
250
+ * @type {string}
251
+ * @memberof ExceedingCreditsApiGetExceedingCredit
252
+ */
253
+ readonly authorization?: string
254
+ }
255
+
256
+ /**
257
+ * Request parameters for listExceedingCredits operation in ExceedingCreditsApi.
258
+ * @export
259
+ * @interface ExceedingCreditsApiListExceedingCreditsRequest
260
+ */
261
+ export interface ExceedingCreditsApiListExceedingCreditsRequest {
262
+ /**
263
+ * Bearer Token
264
+ * @type {string}
265
+ * @memberof ExceedingCreditsApiListExceedingCredits
266
+ */
267
+ readonly authorization?: string
268
+
269
+ /**
270
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
271
+ * @type {number}
272
+ * @memberof ExceedingCreditsApiListExceedingCredits
273
+ */
274
+ readonly pageSize?: number
275
+
276
+ /**
277
+ * 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.
278
+ * @type {string}
279
+ * @memberof ExceedingCreditsApiListExceedingCredits
280
+ */
281
+ readonly pageToken?: string
282
+
283
+ /**
284
+ * 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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
285
+ * @type {string}
286
+ * @memberof ExceedingCreditsApiListExceedingCredits
287
+ */
288
+ readonly filter?: string
289
+
290
+ /**
291
+ * 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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
292
+ * @type {string}
293
+ * @memberof ExceedingCreditsApiListExceedingCredits
294
+ */
295
+ readonly search?: string
296
+
297
+ /**
298
+ * 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, updatedAt&lt;/i&gt;
299
+ * @type {string}
300
+ * @memberof ExceedingCreditsApiListExceedingCredits
301
+ */
302
+ readonly order?: string
303
+
304
+ /**
305
+ * 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;
306
+ * @type {string}
307
+ * @memberof ExceedingCreditsApiListExceedingCredits
308
+ */
309
+ readonly expand?: string
310
+
311
+ /**
312
+ * 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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
313
+ * @type {string}
314
+ * @memberof ExceedingCreditsApiListExceedingCredits
315
+ */
316
+ readonly filters?: string
317
+ }
318
+
319
+ /**
320
+ * ExceedingCreditsApi - object-oriented interface
321
+ * @export
322
+ * @class ExceedingCreditsApi
323
+ * @extends {BaseAPI}
324
+ */
325
+ export class ExceedingCreditsApi extends BaseAPI {
326
+ /**
327
+ * 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\"
328
+ * @summary Retrieve the exceeding credit
329
+ * @param {ExceedingCreditsApiGetExceedingCreditRequest} requestParameters Request parameters.
330
+ * @param {*} [options] Override http request option.
331
+ * @throws {RequiredError}
332
+ * @memberof ExceedingCreditsApi
333
+ */
334
+ public getExceedingCredit(requestParameters: ExceedingCreditsApiGetExceedingCreditRequest, options?: AxiosRequestConfig) {
335
+ return ExceedingCreditsApiFp(this.configuration).getExceedingCredit(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
336
+ }
337
+
338
+ /**
339
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
340
+ * @summary List exceeding credits
341
+ * @param {ExceedingCreditsApiListExceedingCreditsRequest} requestParameters Request parameters.
342
+ * @param {*} [options] Override http request option.
343
+ * @throws {RequiredError}
344
+ * @memberof ExceedingCreditsApi
345
+ */
346
+ public listExceedingCredits(requestParameters: ExceedingCreditsApiListExceedingCreditsRequest = {}, options?: AxiosRequestConfig) {
347
+ return ExceedingCreditsApiFp(this.configuration).listExceedingCredits(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
348
+ }
349
+ }
package/api.ts CHANGED
@@ -23,6 +23,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
23
23
  import { BankAccountsApi } from './api';
24
24
  import { BankOrdersApi } from './api';
25
25
  import { BankTransactionApi } from './api';
26
+ import { ExceedingCreditsApi } from './api';
26
27
  import { HealthCheckApi } from './api';
27
28
  import { PaymentMethodsApi } from './api';
28
29
  import { PaymentRemindersApi } from './api';
@@ -36,6 +37,7 @@ import { WebhooksApi } from './api';
36
37
  export * from './api/bank-accounts-api';
37
38
  export * from './api/bank-orders-api';
38
39
  export * from './api/bank-transaction-api';
40
+ export * from './api/exceeding-credits-api';
39
41
  export * from './api/health-check-api';
40
42
  export * from './api/payment-methods-api';
41
43
  export * from './api/payment-reminders-api';
@@ -0,0 +1,206 @@
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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { GetExceedingCreditResponseClass } from '../models';
16
+ import { ListExceedingCreditsResponseClass } from '../models';
17
+ /**
18
+ * ExceedingCreditsApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const ExceedingCreditsApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ * 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\"
24
+ * @summary Retrieve the exceeding credit
25
+ * @param {string} code Code of the exceeding credit to get
26
+ * @param {string} [authorization] Bearer Token
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ getExceedingCredit: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ /**
32
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
33
+ * @summary List exceeding credits
34
+ * @param {string} [authorization] Bearer Token
35
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
36
+ * @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.
37
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
38
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
39
+ * @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, updatedAt&lt;/i&gt;
40
+ * @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;
41
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ listExceedingCredits: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ };
47
+ /**
48
+ * ExceedingCreditsApi - functional programming interface
49
+ * @export
50
+ */
51
+ export declare const ExceedingCreditsApiFp: (configuration?: Configuration) => {
52
+ /**
53
+ * 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\"
54
+ * @summary Retrieve the exceeding credit
55
+ * @param {string} code Code of the exceeding credit to get
56
+ * @param {string} [authorization] Bearer Token
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ getExceedingCredit(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExceedingCreditResponseClass>>;
61
+ /**
62
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
63
+ * @summary List exceeding credits
64
+ * @param {string} [authorization] Bearer Token
65
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
66
+ * @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.
67
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
68
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
69
+ * @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, updatedAt&lt;/i&gt;
70
+ * @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;
71
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
72
+ * @param {*} [options] Override http request option.
73
+ * @throws {RequiredError}
74
+ */
75
+ listExceedingCredits(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListExceedingCreditsResponseClass>>;
76
+ };
77
+ /**
78
+ * ExceedingCreditsApi - factory interface
79
+ * @export
80
+ */
81
+ export declare const ExceedingCreditsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
82
+ /**
83
+ * 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\"
84
+ * @summary Retrieve the exceeding credit
85
+ * @param {string} code Code of the exceeding credit to get
86
+ * @param {string} [authorization] Bearer Token
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ getExceedingCredit(code: string, authorization?: string, options?: any): AxiosPromise<GetExceedingCreditResponseClass>;
91
+ /**
92
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
93
+ * @summary List exceeding credits
94
+ * @param {string} [authorization] Bearer Token
95
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
96
+ * @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.
97
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
98
+ * @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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
99
+ * @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, updatedAt&lt;/i&gt;
100
+ * @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;
101
+ * @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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ listExceedingCredits(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListExceedingCreditsResponseClass>;
106
+ };
107
+ /**
108
+ * Request parameters for getExceedingCredit operation in ExceedingCreditsApi.
109
+ * @export
110
+ * @interface ExceedingCreditsApiGetExceedingCreditRequest
111
+ */
112
+ export interface ExceedingCreditsApiGetExceedingCreditRequest {
113
+ /**
114
+ * Code of the exceeding credit to get
115
+ * @type {string}
116
+ * @memberof ExceedingCreditsApiGetExceedingCredit
117
+ */
118
+ readonly code: string;
119
+ /**
120
+ * Bearer Token
121
+ * @type {string}
122
+ * @memberof ExceedingCreditsApiGetExceedingCredit
123
+ */
124
+ readonly authorization?: string;
125
+ }
126
+ /**
127
+ * Request parameters for listExceedingCredits operation in ExceedingCreditsApi.
128
+ * @export
129
+ * @interface ExceedingCreditsApiListExceedingCreditsRequest
130
+ */
131
+ export interface ExceedingCreditsApiListExceedingCreditsRequest {
132
+ /**
133
+ * Bearer Token
134
+ * @type {string}
135
+ * @memberof ExceedingCreditsApiListExceedingCredits
136
+ */
137
+ readonly authorization?: string;
138
+ /**
139
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
140
+ * @type {number}
141
+ * @memberof ExceedingCreditsApiListExceedingCredits
142
+ */
143
+ readonly pageSize?: number;
144
+ /**
145
+ * 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.
146
+ * @type {string}
147
+ * @memberof ExceedingCreditsApiListExceedingCredits
148
+ */
149
+ readonly pageToken?: string;
150
+ /**
151
+ * 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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
152
+ * @type {string}
153
+ * @memberof ExceedingCreditsApiListExceedingCredits
154
+ */
155
+ readonly filter?: string;
156
+ /**
157
+ * 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, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
158
+ * @type {string}
159
+ * @memberof ExceedingCreditsApiListExceedingCredits
160
+ */
161
+ readonly search?: string;
162
+ /**
163
+ * 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, updatedAt&lt;/i&gt;
164
+ * @type {string}
165
+ * @memberof ExceedingCreditsApiListExceedingCredits
166
+ */
167
+ readonly order?: string;
168
+ /**
169
+ * 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;
170
+ * @type {string}
171
+ * @memberof ExceedingCreditsApiListExceedingCredits
172
+ */
173
+ readonly expand?: string;
174
+ /**
175
+ * 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: code, id, policyCode, bankTransactionCode, invoiceCode&lt;/i&gt;
176
+ * @type {string}
177
+ * @memberof ExceedingCreditsApiListExceedingCredits
178
+ */
179
+ readonly filters?: string;
180
+ }
181
+ /**
182
+ * ExceedingCreditsApi - object-oriented interface
183
+ * @export
184
+ * @class ExceedingCreditsApi
185
+ * @extends {BaseAPI}
186
+ */
187
+ export declare class ExceedingCreditsApi extends BaseAPI {
188
+ /**
189
+ * 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\"
190
+ * @summary Retrieve the exceeding credit
191
+ * @param {ExceedingCreditsApiGetExceedingCreditRequest} requestParameters Request parameters.
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ * @memberof ExceedingCreditsApi
195
+ */
196
+ getExceedingCredit(requestParameters: ExceedingCreditsApiGetExceedingCreditRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExceedingCreditResponseClass, any>>;
197
+ /**
198
+ * Returns a list of exceeding credits you have previously created. The exceeding credits are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
199
+ * @summary List exceeding credits
200
+ * @param {ExceedingCreditsApiListExceedingCreditsRequest} requestParameters Request parameters.
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ * @memberof ExceedingCreditsApi
204
+ */
205
+ listExceedingCredits(requestParameters?: ExceedingCreditsApiListExceedingCreditsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListExceedingCreditsResponseClass, any>>;
206
+ }