@emilgroup/payment-sdk 1.14.1-beta.51 → 1.14.1-beta.53

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.
@@ -72,6 +72,7 @@ models/generate-invoice-match-suggestions-response-class.ts
72
72
  models/get-bank-account-response-class.ts
73
73
  models/get-bank-order-response-class.ts
74
74
  models/get-bank-transactions-response-class.ts
75
+ models/get-credit-allocation-response-class.ts
75
76
  models/get-exceeding-credit-response-class.ts
76
77
  models/get-payment-method-response-class.ts
77
78
  models/get-payment-reminder-response-class.ts
@@ -98,6 +99,7 @@ models/link-bank-transactions-response-class.ts
98
99
  models/list-bank-accounts-response-class.ts
99
100
  models/list-bank-orders-response-class.ts
100
101
  models/list-bank-transactions-response-class.ts
102
+ models/list-credit-allocations-response-class.ts
101
103
  models/list-exceeding-credits-response-class.ts
102
104
  models/list-payment-methods-response-class.ts
103
105
  models/list-payment-reminders-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.14.1-beta.51 --save
20
+ npm install @emilgroup/payment-sdk@1.14.1-beta.53 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.14.1-beta.51
24
+ yarn add @emilgroup/payment-sdk@1.14.1-beta.53
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -24,6 +24,10 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
24
24
  import { CreateCreditAllocationRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateCreditAllocationResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetCreditAllocationResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListCreditAllocationsResponseClass } from '../models';
27
31
  /**
28
32
  * CreditAllocationApi - axios parameter creator
29
33
  * @export
@@ -72,6 +76,127 @@ export const CreditAllocationApiAxiosParamCreator = function (configuration?: Co
72
76
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
73
77
  localVarRequestOptions.data = serializeDataIfNeeded(createCreditAllocationRequestDto, localVarRequestOptions, configuration)
74
78
 
79
+ return {
80
+ url: toPathString(localVarUrlObj),
81
+ options: localVarRequestOptions,
82
+ };
83
+ },
84
+ /**
85
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
86
+ * @summary Retrieve the credit allocation entry
87
+ * @param {string} code Code of the credit allocation to get
88
+ * @param {string} [authorization] Bearer Token
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ getCreditAllocation: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
93
+ // verify required parameter 'code' is not null or undefined
94
+ assertParamExists('getCreditAllocation', 'code', code)
95
+ const localVarPath = `/paymentservice/v1/credit-allocations/{code}`
96
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
97
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
98
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
99
+ let baseOptions;
100
+ let baseAccessToken;
101
+ if (configuration) {
102
+ baseOptions = configuration.baseOptions;
103
+ baseAccessToken = configuration.accessToken;
104
+ }
105
+
106
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
107
+ const localVarHeaderParameter = {} as any;
108
+ const localVarQueryParameter = {} as any;
109
+
110
+ // authentication bearer required
111
+ // http bearer authentication required
112
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
113
+
114
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
115
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
116
+ }
117
+
118
+
119
+
120
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
121
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
122
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
123
+
124
+ return {
125
+ url: toPathString(localVarUrlObj),
126
+ options: localVarRequestOptions,
127
+ };
128
+ },
129
+ /**
130
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
131
+ * @summary List credit allocations
132
+ * @param {string} [authorization] Bearer Token
133
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
134
+ * @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.
135
+ * @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, createdAt, updatedAt&lt;/i&gt;
136
+ * @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&lt;/i&gt;
137
+ * @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;
138
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
139
+ * @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, createdAt, updatedAt&lt;/i&gt;
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ */
143
+ listCreditAllocations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
144
+ const localVarPath = `/paymentservice/v1/credit-allocations`;
145
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
146
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
147
+ let baseOptions;
148
+ let baseAccessToken;
149
+ if (configuration) {
150
+ baseOptions = configuration.baseOptions;
151
+ baseAccessToken = configuration.accessToken;
152
+ }
153
+
154
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
155
+ const localVarHeaderParameter = {} as any;
156
+ const localVarQueryParameter = {} as any;
157
+
158
+ // authentication bearer required
159
+ // http bearer authentication required
160
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
161
+
162
+ if (pageSize !== undefined) {
163
+ localVarQueryParameter['pageSize'] = pageSize;
164
+ }
165
+
166
+ if (pageToken !== undefined) {
167
+ localVarQueryParameter['pageToken'] = pageToken;
168
+ }
169
+
170
+ if (filter !== undefined) {
171
+ localVarQueryParameter['filter'] = filter;
172
+ }
173
+
174
+ if (search !== undefined) {
175
+ localVarQueryParameter['search'] = search;
176
+ }
177
+
178
+ if (order !== undefined) {
179
+ localVarQueryParameter['order'] = order;
180
+ }
181
+
182
+ if (expand !== undefined) {
183
+ localVarQueryParameter['expand'] = expand;
184
+ }
185
+
186
+ if (filters !== undefined) {
187
+ localVarQueryParameter['filters'] = filters;
188
+ }
189
+
190
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
191
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
192
+ }
193
+
194
+
195
+
196
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
197
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
198
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
199
+
75
200
  return {
76
201
  url: toPathString(localVarUrlObj),
77
202
  options: localVarRequestOptions,
@@ -99,6 +224,36 @@ export const CreditAllocationApiFp = function(configuration?: Configuration) {
99
224
  const localVarAxiosArgs = await localVarAxiosParamCreator.createAllocateCredit(createCreditAllocationRequestDto, authorization, options);
100
225
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
101
226
  },
227
+ /**
228
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
229
+ * @summary Retrieve the credit allocation entry
230
+ * @param {string} code Code of the credit allocation to get
231
+ * @param {string} [authorization] Bearer Token
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ async getCreditAllocation(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCreditAllocationResponseClass>> {
236
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCreditAllocation(code, authorization, options);
237
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
238
+ },
239
+ /**
240
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
241
+ * @summary List credit allocations
242
+ * @param {string} [authorization] Bearer Token
243
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
244
+ * @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.
245
+ * @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, createdAt, updatedAt&lt;/i&gt;
246
+ * @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&lt;/i&gt;
247
+ * @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;
248
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
249
+ * @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, createdAt, updatedAt&lt;/i&gt;
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ */
253
+ async listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCreditAllocationsResponseClass>> {
254
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCreditAllocations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
255
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
256
+ },
102
257
  }
103
258
  };
104
259
 
@@ -120,6 +275,34 @@ export const CreditAllocationApiFactory = function (configuration?: Configuratio
120
275
  createAllocateCredit(createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCreditAllocationResponseClass> {
121
276
  return localVarFp.createAllocateCredit(createCreditAllocationRequestDto, authorization, options).then((request) => request(axios, basePath));
122
277
  },
278
+ /**
279
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
280
+ * @summary Retrieve the credit allocation entry
281
+ * @param {string} code Code of the credit allocation to get
282
+ * @param {string} [authorization] Bearer Token
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ getCreditAllocation(code: string, authorization?: string, options?: any): AxiosPromise<GetCreditAllocationResponseClass> {
287
+ return localVarFp.getCreditAllocation(code, authorization, options).then((request) => request(axios, basePath));
288
+ },
289
+ /**
290
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
291
+ * @summary List credit allocations
292
+ * @param {string} [authorization] Bearer Token
293
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
294
+ * @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.
295
+ * @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, createdAt, updatedAt&lt;/i&gt;
296
+ * @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&lt;/i&gt;
297
+ * @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;
298
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
299
+ * @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, createdAt, updatedAt&lt;/i&gt;
300
+ * @param {*} [options] Override http request option.
301
+ * @throws {RequiredError}
302
+ */
303
+ listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCreditAllocationsResponseClass> {
304
+ return localVarFp.listCreditAllocations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
305
+ },
123
306
  };
124
307
  };
125
308
 
@@ -144,6 +327,90 @@ export interface CreditAllocationApiCreateAllocateCreditRequest {
144
327
  readonly authorization?: string
145
328
  }
146
329
 
330
+ /**
331
+ * Request parameters for getCreditAllocation operation in CreditAllocationApi.
332
+ * @export
333
+ * @interface CreditAllocationApiGetCreditAllocationRequest
334
+ */
335
+ export interface CreditAllocationApiGetCreditAllocationRequest {
336
+ /**
337
+ * Code of the credit allocation to get
338
+ * @type {string}
339
+ * @memberof CreditAllocationApiGetCreditAllocation
340
+ */
341
+ readonly code: string
342
+
343
+ /**
344
+ * Bearer Token
345
+ * @type {string}
346
+ * @memberof CreditAllocationApiGetCreditAllocation
347
+ */
348
+ readonly authorization?: string
349
+ }
350
+
351
+ /**
352
+ * Request parameters for listCreditAllocations operation in CreditAllocationApi.
353
+ * @export
354
+ * @interface CreditAllocationApiListCreditAllocationsRequest
355
+ */
356
+ export interface CreditAllocationApiListCreditAllocationsRequest {
357
+ /**
358
+ * Bearer Token
359
+ * @type {string}
360
+ * @memberof CreditAllocationApiListCreditAllocations
361
+ */
362
+ readonly authorization?: string
363
+
364
+ /**
365
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
366
+ * @type {number}
367
+ * @memberof CreditAllocationApiListCreditAllocations
368
+ */
369
+ readonly pageSize?: number
370
+
371
+ /**
372
+ * 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.
373
+ * @type {string}
374
+ * @memberof CreditAllocationApiListCreditAllocations
375
+ */
376
+ readonly pageToken?: string
377
+
378
+ /**
379
+ * 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, createdAt, updatedAt&lt;/i&gt;
380
+ * @type {string}
381
+ * @memberof CreditAllocationApiListCreditAllocations
382
+ */
383
+ readonly filter?: string
384
+
385
+ /**
386
+ * 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&lt;/i&gt;
387
+ * @type {string}
388
+ * @memberof CreditAllocationApiListCreditAllocations
389
+ */
390
+ readonly search?: string
391
+
392
+ /**
393
+ * 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;
394
+ * @type {string}
395
+ * @memberof CreditAllocationApiListCreditAllocations
396
+ */
397
+ readonly order?: string
398
+
399
+ /**
400
+ * 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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
401
+ * @type {string}
402
+ * @memberof CreditAllocationApiListCreditAllocations
403
+ */
404
+ readonly expand?: string
405
+
406
+ /**
407
+ * 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, createdAt, updatedAt&lt;/i&gt;
408
+ * @type {string}
409
+ * @memberof CreditAllocationApiListCreditAllocations
410
+ */
411
+ readonly filters?: string
412
+ }
413
+
147
414
  /**
148
415
  * CreditAllocationApi - object-oriented interface
149
416
  * @export
@@ -162,4 +429,28 @@ export class CreditAllocationApi extends BaseAPI {
162
429
  public createAllocateCredit(requestParameters: CreditAllocationApiCreateAllocateCreditRequest, options?: AxiosRequestConfig) {
163
430
  return CreditAllocationApiFp(this.configuration).createAllocateCredit(requestParameters.createCreditAllocationRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
164
431
  }
432
+
433
+ /**
434
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
435
+ * @summary Retrieve the credit allocation entry
436
+ * @param {CreditAllocationApiGetCreditAllocationRequest} requestParameters Request parameters.
437
+ * @param {*} [options] Override http request option.
438
+ * @throws {RequiredError}
439
+ * @memberof CreditAllocationApi
440
+ */
441
+ public getCreditAllocation(requestParameters: CreditAllocationApiGetCreditAllocationRequest, options?: AxiosRequestConfig) {
442
+ return CreditAllocationApiFp(this.configuration).getCreditAllocation(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
443
+ }
444
+
445
+ /**
446
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
447
+ * @summary List credit allocations
448
+ * @param {CreditAllocationApiListCreditAllocationsRequest} requestParameters Request parameters.
449
+ * @param {*} [options] Override http request option.
450
+ * @throws {RequiredError}
451
+ * @memberof CreditAllocationApi
452
+ */
453
+ public listCreditAllocations(requestParameters: CreditAllocationApiListCreditAllocationsRequest = {}, options?: AxiosRequestConfig) {
454
+ return CreditAllocationApiFp(this.configuration).listCreditAllocations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
455
+ }
165
456
  }
@@ -14,6 +14,8 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateCreditAllocationRequestDto } from '../models';
16
16
  import { CreateCreditAllocationResponseClass } from '../models';
17
+ import { GetCreditAllocationResponseClass } from '../models';
18
+ import { ListCreditAllocationsResponseClass } from '../models';
17
19
  /**
18
20
  * CreditAllocationApi - axios parameter creator
19
21
  * @export
@@ -28,6 +30,30 @@ export declare const CreditAllocationApiAxiosParamCreator: (configuration?: Conf
28
30
  * @throws {RequiredError}
29
31
  */
30
32
  createAllocateCredit: (createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
+ /**
34
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
35
+ * @summary Retrieve the credit allocation entry
36
+ * @param {string} code Code of the credit allocation to get
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ getCreditAllocation: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
44
+ * @summary List credit allocations
45
+ * @param {string} [authorization] Bearer Token
46
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
47
+ * @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.
48
+ * @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, createdAt, updatedAt&lt;/i&gt;
49
+ * @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&lt;/i&gt;
50
+ * @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;
51
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
52
+ * @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, createdAt, updatedAt&lt;/i&gt;
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ listCreditAllocations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
57
  };
32
58
  /**
33
59
  * CreditAllocationApi - functional programming interface
@@ -43,6 +69,30 @@ export declare const CreditAllocationApiFp: (configuration?: Configuration) => {
43
69
  * @throws {RequiredError}
44
70
  */
45
71
  createAllocateCredit(createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCreditAllocationResponseClass>>;
72
+ /**
73
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
74
+ * @summary Retrieve the credit allocation entry
75
+ * @param {string} code Code of the credit allocation to get
76
+ * @param {string} [authorization] Bearer Token
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ getCreditAllocation(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCreditAllocationResponseClass>>;
81
+ /**
82
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
83
+ * @summary List credit allocations
84
+ * @param {string} [authorization] Bearer Token
85
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
86
+ * @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.
87
+ * @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, createdAt, updatedAt&lt;/i&gt;
88
+ * @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&lt;/i&gt;
89
+ * @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;
90
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
91
+ * @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, createdAt, updatedAt&lt;/i&gt;
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCreditAllocationsResponseClass>>;
46
96
  };
47
97
  /**
48
98
  * CreditAllocationApi - factory interface
@@ -58,6 +108,30 @@ export declare const CreditAllocationApiFactory: (configuration?: Configuration,
58
108
  * @throws {RequiredError}
59
109
  */
60
110
  createAllocateCredit(createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCreditAllocationResponseClass>;
111
+ /**
112
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
113
+ * @summary Retrieve the credit allocation entry
114
+ * @param {string} code Code of the credit allocation to get
115
+ * @param {string} [authorization] Bearer Token
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ getCreditAllocation(code: string, authorization?: string, options?: any): AxiosPromise<GetCreditAllocationResponseClass>;
120
+ /**
121
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
122
+ * @summary List credit allocations
123
+ * @param {string} [authorization] Bearer Token
124
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
125
+ * @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.
126
+ * @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, createdAt, updatedAt&lt;/i&gt;
127
+ * @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&lt;/i&gt;
128
+ * @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;
129
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
130
+ * @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, createdAt, updatedAt&lt;/i&gt;
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCreditAllocationsResponseClass>;
61
135
  };
62
136
  /**
63
137
  * Request parameters for createAllocateCredit operation in CreditAllocationApi.
@@ -78,6 +152,80 @@ export interface CreditAllocationApiCreateAllocateCreditRequest {
78
152
  */
79
153
  readonly authorization?: string;
80
154
  }
155
+ /**
156
+ * Request parameters for getCreditAllocation operation in CreditAllocationApi.
157
+ * @export
158
+ * @interface CreditAllocationApiGetCreditAllocationRequest
159
+ */
160
+ export interface CreditAllocationApiGetCreditAllocationRequest {
161
+ /**
162
+ * Code of the credit allocation to get
163
+ * @type {string}
164
+ * @memberof CreditAllocationApiGetCreditAllocation
165
+ */
166
+ readonly code: string;
167
+ /**
168
+ * Bearer Token
169
+ * @type {string}
170
+ * @memberof CreditAllocationApiGetCreditAllocation
171
+ */
172
+ readonly authorization?: string;
173
+ }
174
+ /**
175
+ * Request parameters for listCreditAllocations operation in CreditAllocationApi.
176
+ * @export
177
+ * @interface CreditAllocationApiListCreditAllocationsRequest
178
+ */
179
+ export interface CreditAllocationApiListCreditAllocationsRequest {
180
+ /**
181
+ * Bearer Token
182
+ * @type {string}
183
+ * @memberof CreditAllocationApiListCreditAllocations
184
+ */
185
+ readonly authorization?: string;
186
+ /**
187
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
188
+ * @type {number}
189
+ * @memberof CreditAllocationApiListCreditAllocations
190
+ */
191
+ readonly pageSize?: number;
192
+ /**
193
+ * 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.
194
+ * @type {string}
195
+ * @memberof CreditAllocationApiListCreditAllocations
196
+ */
197
+ readonly pageToken?: string;
198
+ /**
199
+ * 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, createdAt, updatedAt&lt;/i&gt;
200
+ * @type {string}
201
+ * @memberof CreditAllocationApiListCreditAllocations
202
+ */
203
+ readonly filter?: string;
204
+ /**
205
+ * 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&lt;/i&gt;
206
+ * @type {string}
207
+ * @memberof CreditAllocationApiListCreditAllocations
208
+ */
209
+ readonly search?: string;
210
+ /**
211
+ * 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;
212
+ * @type {string}
213
+ * @memberof CreditAllocationApiListCreditAllocations
214
+ */
215
+ readonly order?: string;
216
+ /**
217
+ * 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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
218
+ * @type {string}
219
+ * @memberof CreditAllocationApiListCreditAllocations
220
+ */
221
+ readonly expand?: string;
222
+ /**
223
+ * 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, createdAt, updatedAt&lt;/i&gt;
224
+ * @type {string}
225
+ * @memberof CreditAllocationApiListCreditAllocations
226
+ */
227
+ readonly filters?: string;
228
+ }
81
229
  /**
82
230
  * CreditAllocationApi - object-oriented interface
83
231
  * @export
@@ -94,4 +242,22 @@ export declare class CreditAllocationApi extends BaseAPI {
94
242
  * @memberof CreditAllocationApi
95
243
  */
96
244
  createAllocateCredit(requestParameters: CreditAllocationApiCreateAllocateCreditRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCreditAllocationResponseClass, any, {}>>;
245
+ /**
246
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
247
+ * @summary Retrieve the credit allocation entry
248
+ * @param {CreditAllocationApiGetCreditAllocationRequest} requestParameters Request parameters.
249
+ * @param {*} [options] Override http request option.
250
+ * @throws {RequiredError}
251
+ * @memberof CreditAllocationApi
252
+ */
253
+ getCreditAllocation(requestParameters: CreditAllocationApiGetCreditAllocationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCreditAllocationResponseClass, any, {}>>;
254
+ /**
255
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
256
+ * @summary List credit allocations
257
+ * @param {CreditAllocationApiListCreditAllocationsRequest} requestParameters Request parameters.
258
+ * @param {*} [options] Override http request option.
259
+ * @throws {RequiredError}
260
+ * @memberof CreditAllocationApi
261
+ */
262
+ listCreditAllocations(requestParameters?: CreditAllocationApiListCreditAllocationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCreditAllocationsResponseClass, any, {}>>;
97
263
  }
@@ -141,6 +141,126 @@ var CreditAllocationApiAxiosParamCreator = function (configuration) {
141
141
  });
142
142
  });
143
143
  },
144
+ /**
145
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
146
+ * @summary Retrieve the credit allocation entry
147
+ * @param {string} code Code of the credit allocation to get
148
+ * @param {string} [authorization] Bearer Token
149
+ * @param {*} [options] Override http request option.
150
+ * @throws {RequiredError}
151
+ */
152
+ getCreditAllocation: function (code, authorization, options) {
153
+ if (options === void 0) { options = {}; }
154
+ return __awaiter(_this, void 0, void 0, function () {
155
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
156
+ return __generator(this, function (_a) {
157
+ switch (_a.label) {
158
+ case 0:
159
+ // verify required parameter 'code' is not null or undefined
160
+ (0, common_1.assertParamExists)('getCreditAllocation', 'code', code);
161
+ localVarPath = "/paymentservice/v1/credit-allocations/{code}"
162
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
163
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
164
+ if (configuration) {
165
+ baseOptions = configuration.baseOptions;
166
+ baseAccessToken = configuration.accessToken;
167
+ }
168
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
169
+ localVarHeaderParameter = {};
170
+ localVarQueryParameter = {};
171
+ // authentication bearer required
172
+ // http bearer authentication required
173
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
174
+ case 1:
175
+ // authentication bearer required
176
+ // http bearer authentication required
177
+ _a.sent();
178
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
179
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
180
+ }
181
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
182
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
183
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
184
+ return [2 /*return*/, {
185
+ url: (0, common_1.toPathString)(localVarUrlObj),
186
+ options: localVarRequestOptions,
187
+ }];
188
+ }
189
+ });
190
+ });
191
+ },
192
+ /**
193
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
194
+ * @summary List credit allocations
195
+ * @param {string} [authorization] Bearer Token
196
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
197
+ * @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.
198
+ * @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, createdAt, updatedAt&lt;/i&gt;
199
+ * @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&lt;/i&gt;
200
+ * @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;
201
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
202
+ * @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, createdAt, updatedAt&lt;/i&gt;
203
+ * @param {*} [options] Override http request option.
204
+ * @throws {RequiredError}
205
+ */
206
+ listCreditAllocations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
207
+ if (options === void 0) { options = {}; }
208
+ return __awaiter(_this, void 0, void 0, function () {
209
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
210
+ return __generator(this, function (_a) {
211
+ switch (_a.label) {
212
+ case 0:
213
+ localVarPath = "/paymentservice/v1/credit-allocations";
214
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
215
+ if (configuration) {
216
+ baseOptions = configuration.baseOptions;
217
+ baseAccessToken = configuration.accessToken;
218
+ }
219
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
220
+ localVarHeaderParameter = {};
221
+ localVarQueryParameter = {};
222
+ // authentication bearer required
223
+ // http bearer authentication required
224
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
225
+ case 1:
226
+ // authentication bearer required
227
+ // http bearer authentication required
228
+ _a.sent();
229
+ if (pageSize !== undefined) {
230
+ localVarQueryParameter['pageSize'] = pageSize;
231
+ }
232
+ if (pageToken !== undefined) {
233
+ localVarQueryParameter['pageToken'] = pageToken;
234
+ }
235
+ if (filter !== undefined) {
236
+ localVarQueryParameter['filter'] = filter;
237
+ }
238
+ if (search !== undefined) {
239
+ localVarQueryParameter['search'] = search;
240
+ }
241
+ if (order !== undefined) {
242
+ localVarQueryParameter['order'] = order;
243
+ }
244
+ if (expand !== undefined) {
245
+ localVarQueryParameter['expand'] = expand;
246
+ }
247
+ if (filters !== undefined) {
248
+ localVarQueryParameter['filters'] = filters;
249
+ }
250
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
251
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
252
+ }
253
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
254
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
255
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
256
+ return [2 /*return*/, {
257
+ url: (0, common_1.toPathString)(localVarUrlObj),
258
+ options: localVarRequestOptions,
259
+ }];
260
+ }
261
+ });
262
+ });
263
+ },
144
264
  };
145
265
  };
146
266
  exports.CreditAllocationApiAxiosParamCreator = CreditAllocationApiAxiosParamCreator;
@@ -172,6 +292,54 @@ var CreditAllocationApiFp = function (configuration) {
172
292
  });
173
293
  });
174
294
  },
295
+ /**
296
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
297
+ * @summary Retrieve the credit allocation entry
298
+ * @param {string} code Code of the credit allocation to get
299
+ * @param {string} [authorization] Bearer Token
300
+ * @param {*} [options] Override http request option.
301
+ * @throws {RequiredError}
302
+ */
303
+ getCreditAllocation: function (code, authorization, options) {
304
+ return __awaiter(this, void 0, void 0, function () {
305
+ var localVarAxiosArgs;
306
+ return __generator(this, function (_a) {
307
+ switch (_a.label) {
308
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getCreditAllocation(code, authorization, options)];
309
+ case 1:
310
+ localVarAxiosArgs = _a.sent();
311
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
312
+ }
313
+ });
314
+ });
315
+ },
316
+ /**
317
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
318
+ * @summary List credit allocations
319
+ * @param {string} [authorization] Bearer Token
320
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
321
+ * @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.
322
+ * @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, createdAt, updatedAt&lt;/i&gt;
323
+ * @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&lt;/i&gt;
324
+ * @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;
325
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
326
+ * @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, createdAt, updatedAt&lt;/i&gt;
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ */
330
+ listCreditAllocations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
331
+ return __awaiter(this, void 0, void 0, function () {
332
+ var localVarAxiosArgs;
333
+ return __generator(this, function (_a) {
334
+ switch (_a.label) {
335
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCreditAllocations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
336
+ case 1:
337
+ localVarAxiosArgs = _a.sent();
338
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
339
+ }
340
+ });
341
+ });
342
+ },
175
343
  };
176
344
  };
177
345
  exports.CreditAllocationApiFp = CreditAllocationApiFp;
@@ -193,6 +361,34 @@ var CreditAllocationApiFactory = function (configuration, basePath, axios) {
193
361
  createAllocateCredit: function (createCreditAllocationRequestDto, authorization, options) {
194
362
  return localVarFp.createAllocateCredit(createCreditAllocationRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
195
363
  },
364
+ /**
365
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
366
+ * @summary Retrieve the credit allocation entry
367
+ * @param {string} code Code of the credit allocation to get
368
+ * @param {string} [authorization] Bearer Token
369
+ * @param {*} [options] Override http request option.
370
+ * @throws {RequiredError}
371
+ */
372
+ getCreditAllocation: function (code, authorization, options) {
373
+ return localVarFp.getCreditAllocation(code, authorization, options).then(function (request) { return request(axios, basePath); });
374
+ },
375
+ /**
376
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
377
+ * @summary List credit allocations
378
+ * @param {string} [authorization] Bearer Token
379
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
380
+ * @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.
381
+ * @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, createdAt, updatedAt&lt;/i&gt;
382
+ * @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&lt;/i&gt;
383
+ * @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;
384
+ * @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; &lt;i&gt;Allowed values: exceedingCredits&lt;i&gt;
385
+ * @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, createdAt, updatedAt&lt;/i&gt;
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ */
389
+ listCreditAllocations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
390
+ return localVarFp.listCreditAllocations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
391
+ },
196
392
  };
197
393
  };
198
394
  exports.CreditAllocationApiFactory = CreditAllocationApiFactory;
@@ -219,6 +415,31 @@ var CreditAllocationApi = /** @class */ (function (_super) {
219
415
  var _this = this;
220
416
  return (0, exports.CreditAllocationApiFp)(this.configuration).createAllocateCredit(requestParameters.createCreditAllocationRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
221
417
  };
418
+ /**
419
+ * Get a credit allocation entry by code. **Required Permissions** \"payment-management.payments.view\"
420
+ * @summary Retrieve the credit allocation entry
421
+ * @param {CreditAllocationApiGetCreditAllocationRequest} requestParameters Request parameters.
422
+ * @param {*} [options] Override http request option.
423
+ * @throws {RequiredError}
424
+ * @memberof CreditAllocationApi
425
+ */
426
+ CreditAllocationApi.prototype.getCreditAllocation = function (requestParameters, options) {
427
+ var _this = this;
428
+ return (0, exports.CreditAllocationApiFp)(this.configuration).getCreditAllocation(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
429
+ };
430
+ /**
431
+ * Returns a list of credit allocations you have previously created. The credit allocations 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\"
432
+ * @summary List credit allocations
433
+ * @param {CreditAllocationApiListCreditAllocationsRequest} requestParameters Request parameters.
434
+ * @param {*} [options] Override http request option.
435
+ * @throws {RequiredError}
436
+ * @memberof CreditAllocationApi
437
+ */
438
+ CreditAllocationApi.prototype.listCreditAllocations = function (requestParameters, options) {
439
+ var _this = this;
440
+ if (requestParameters === void 0) { requestParameters = {}; }
441
+ return (0, exports.CreditAllocationApiFp)(this.configuration).listCreditAllocations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
442
+ };
222
443
  return CreditAllocationApi;
223
444
  }(base_1.BaseAPI));
224
445
  exports.CreditAllocationApi = CreditAllocationApi;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CreditAllocationClass } from './credit-allocation-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetCreditAllocationResponseClass
17
+ */
18
+ export interface GetCreditAllocationResponseClass {
19
+ /**
20
+ * Credit allocation entry.
21
+ * @type {CreditAllocationClass}
22
+ * @memberof GetCreditAllocationResponseClass
23
+ */
24
+ 'creditAllocation': CreditAllocationClass;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -48,6 +48,7 @@ export * from './generate-invoice-match-suggestions-response-class';
48
48
  export * from './get-bank-account-response-class';
49
49
  export * from './get-bank-order-response-class';
50
50
  export * from './get-bank-transactions-response-class';
51
+ export * from './get-credit-allocation-response-class';
51
52
  export * from './get-exceeding-credit-response-class';
52
53
  export * from './get-payment-method-response-class';
53
54
  export * from './get-payment-reminder-response-class';
@@ -73,6 +74,7 @@ export * from './link-bank-transactions-response-class';
73
74
  export * from './list-bank-accounts-response-class';
74
75
  export * from './list-bank-orders-response-class';
75
76
  export * from './list-bank-transactions-response-class';
77
+ export * from './list-credit-allocations-response-class';
76
78
  export * from './list-exceeding-credits-response-class';
77
79
  export * from './list-payment-methods-response-class';
78
80
  export * from './list-payment-reminders-response-class';
@@ -64,6 +64,7 @@ __exportStar(require("./generate-invoice-match-suggestions-response-class"), exp
64
64
  __exportStar(require("./get-bank-account-response-class"), exports);
65
65
  __exportStar(require("./get-bank-order-response-class"), exports);
66
66
  __exportStar(require("./get-bank-transactions-response-class"), exports);
67
+ __exportStar(require("./get-credit-allocation-response-class"), exports);
67
68
  __exportStar(require("./get-exceeding-credit-response-class"), exports);
68
69
  __exportStar(require("./get-payment-method-response-class"), exports);
69
70
  __exportStar(require("./get-payment-reminder-response-class"), exports);
@@ -89,6 +90,7 @@ __exportStar(require("./link-bank-transactions-response-class"), exports);
89
90
  __exportStar(require("./list-bank-accounts-response-class"), exports);
90
91
  __exportStar(require("./list-bank-orders-response-class"), exports);
91
92
  __exportStar(require("./list-bank-transactions-response-class"), exports);
93
+ __exportStar(require("./list-credit-allocations-response-class"), exports);
92
94
  __exportStar(require("./list-exceeding-credits-response-class"), exports);
93
95
  __exportStar(require("./list-payment-methods-response-class"), exports);
94
96
  __exportStar(require("./list-payment-reminders-response-class"), exports);
@@ -0,0 +1,43 @@
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 { CreditAllocationClass } from './credit-allocation-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListCreditAllocationsResponseClass
17
+ */
18
+ export interface ListCreditAllocationsResponseClass {
19
+ /**
20
+ * List of credit allocation entries.
21
+ * @type {Array<CreditAllocationClass>}
22
+ * @memberof ListCreditAllocationsResponseClass
23
+ */
24
+ 'items': Array<CreditAllocationClass>;
25
+ /**
26
+ * Next page token for pagination.
27
+ * @type {string}
28
+ * @memberof ListCreditAllocationsResponseClass
29
+ */
30
+ 'nextPageToken': string;
31
+ /**
32
+ * Number of items per page.
33
+ * @type {number}
34
+ * @memberof ListCreditAllocationsResponseClass
35
+ */
36
+ 'itemsPerPage': number;
37
+ /**
38
+ * Total number of items.
39
+ * @type {number}
40
+ * @memberof ListCreditAllocationsResponseClass
41
+ */
42
+ 'totalItems': number;
43
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,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 { CreditAllocationClass } from './credit-allocation-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface GetCreditAllocationResponseClass
22
+ */
23
+ export interface GetCreditAllocationResponseClass {
24
+ /**
25
+ * Credit allocation entry.
26
+ * @type {CreditAllocationClass}
27
+ * @memberof GetCreditAllocationResponseClass
28
+ */
29
+ 'creditAllocation': CreditAllocationClass;
30
+ }
31
+
package/models/index.ts CHANGED
@@ -48,6 +48,7 @@ export * from './generate-invoice-match-suggestions-response-class';
48
48
  export * from './get-bank-account-response-class';
49
49
  export * from './get-bank-order-response-class';
50
50
  export * from './get-bank-transactions-response-class';
51
+ export * from './get-credit-allocation-response-class';
51
52
  export * from './get-exceeding-credit-response-class';
52
53
  export * from './get-payment-method-response-class';
53
54
  export * from './get-payment-reminder-response-class';
@@ -73,6 +74,7 @@ export * from './link-bank-transactions-response-class';
73
74
  export * from './list-bank-accounts-response-class';
74
75
  export * from './list-bank-orders-response-class';
75
76
  export * from './list-bank-transactions-response-class';
77
+ export * from './list-credit-allocations-response-class';
76
78
  export * from './list-exceeding-credits-response-class';
77
79
  export * from './list-payment-methods-response-class';
78
80
  export * from './list-payment-reminders-response-class';
@@ -0,0 +1,49 @@
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 { CreditAllocationClass } from './credit-allocation-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface ListCreditAllocationsResponseClass
22
+ */
23
+ export interface ListCreditAllocationsResponseClass {
24
+ /**
25
+ * List of credit allocation entries.
26
+ * @type {Array<CreditAllocationClass>}
27
+ * @memberof ListCreditAllocationsResponseClass
28
+ */
29
+ 'items': Array<CreditAllocationClass>;
30
+ /**
31
+ * Next page token for pagination.
32
+ * @type {string}
33
+ * @memberof ListCreditAllocationsResponseClass
34
+ */
35
+ 'nextPageToken': string;
36
+ /**
37
+ * Number of items per page.
38
+ * @type {number}
39
+ * @memberof ListCreditAllocationsResponseClass
40
+ */
41
+ 'itemsPerPage': number;
42
+ /**
43
+ * Total number of items.
44
+ * @type {number}
45
+ * @memberof ListCreditAllocationsResponseClass
46
+ */
47
+ 'totalItems': number;
48
+ }
49
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/payment-sdk",
3
- "version": "1.14.1-beta.51",
3
+ "version": "1.14.1-beta.53",
4
4
  "description": "OpenAPI client for @emilgroup/payment-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [