@emilgroup/payment-sdk 1.13.1-beta.12 → 1.13.1-beta.121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/.openapi-generator/FILES +31 -1
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +55 -13
  4. package/api/bank-orders-api.ts +691 -0
  5. package/api/bank-transaction-api.ts +59 -48
  6. package/api/exceeding-credits-api.ts +349 -0
  7. package/api/payment-methods-api.ts +59 -17
  8. package/api/payment-reminders-api.ts +55 -13
  9. package/api/payments-api.ts +180 -17
  10. package/api/policy-payment-methods-api.ts +353 -0
  11. package/api/refunds-api.ts +45 -17
  12. package/api/tenant-bank-account-api.ts +45 -17
  13. package/api.ts +6 -0
  14. package/base.ts +51 -2
  15. package/dist/api/bank-accounts-api.d.ts +35 -8
  16. package/dist/api/bank-accounts-api.js +48 -63
  17. package/dist/api/bank-orders-api.d.ts +393 -0
  18. package/dist/api/bank-orders-api.js +642 -0
  19. package/dist/api/bank-transaction-api.d.ts +39 -31
  20. package/dist/api/bank-transaction-api.js +54 -82
  21. package/dist/api/exceeding-credits-api.d.ts +206 -0
  22. package/dist/api/exceeding-credits-api.js +352 -0
  23. package/dist/api/health-check-api.js +5 -18
  24. package/dist/api/payment-methods-api.d.ts +39 -12
  25. package/dist/api/payment-methods-api.js +42 -45
  26. package/dist/api/payment-reminders-api.d.ts +35 -8
  27. package/dist/api/payment-reminders-api.js +42 -49
  28. package/dist/api/payment-setup-api.js +8 -25
  29. package/dist/api/payments-api.d.ts +104 -12
  30. package/dist/api/payments-api.js +143 -45
  31. package/dist/api/policy-payment-methods-api.d.ts +207 -0
  32. package/dist/api/policy-payment-methods-api.js +353 -0
  33. package/dist/api/refunds-api.d.ts +28 -10
  34. package/dist/api/refunds-api.js +34 -43
  35. package/dist/api/tenant-bank-account-api.d.ts +28 -10
  36. package/dist/api/tenant-bank-account-api.js +40 -57
  37. package/dist/api/webhooks-api.js +5 -18
  38. package/dist/api.d.ts +3 -0
  39. package/dist/api.js +3 -0
  40. package/dist/base.d.ts +10 -1
  41. package/dist/base.js +51 -7
  42. package/dist/common.d.ts +1 -1
  43. package/dist/common.js +2 -2
  44. package/dist/models/bank-order-class.d.ts +122 -0
  45. package/dist/models/bank-order-xml-file-class.d.ts +72 -0
  46. package/dist/models/bank-order-xml-file-class.js +15 -0
  47. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -18
  48. package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
  49. package/dist/models/bank-transaction-class.d.ts +22 -22
  50. package/dist/models/bank-transaction-class.js +5 -0
  51. package/dist/models/bank-transaction-invoice-class.d.ts +60 -0
  52. package/dist/models/bank-transaction-invoice-class.js +15 -0
  53. package/dist/models/bank-transfer-dto.d.ts +25 -0
  54. package/dist/models/bank-transfer-dto.js +15 -0
  55. package/dist/models/billing-address-dto.d.ts +54 -0
  56. package/dist/models/billing-address-dto.js +15 -0
  57. package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
  58. package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
  59. package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
  60. package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
  61. package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
  62. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
  63. package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
  64. package/dist/models/create-bank-order-request-dto.d.ts +74 -0
  65. package/dist/models/create-bank-order-request-dto.js +28 -0
  66. package/dist/models/create-bank-order-response-class.d.ts +25 -0
  67. package/dist/models/create-bank-order-response-class.js +15 -0
  68. package/dist/models/create-payment-order-dto.d.ts +48 -0
  69. package/dist/models/create-payment-order-dto.js +15 -0
  70. package/dist/models/create-payment-order-request-dto.d.ts +48 -0
  71. package/dist/models/create-payment-order-request-dto.js +15 -0
  72. package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
  73. package/dist/models/create-payment-request-dto.d.ts +7 -1
  74. package/dist/models/create-policy-payment-method-request-dto.d.ts +30 -0
  75. package/dist/models/create-policy-payment-method-request-dto.js +15 -0
  76. package/dist/models/create-policy-payment-method-response-class.d.ts +25 -0
  77. package/dist/models/create-policy-payment-method-response-class.js +15 -0
  78. package/dist/models/create-psp-payment-method-request-dto.d.ts +29 -1
  79. package/dist/models/create-psp-payment-method-request-dto.js +3 -1
  80. package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
  81. package/dist/models/eis-sepa-debit-dto.d.ts +55 -0
  82. package/dist/models/eis-sepa-debit-dto.js +15 -0
  83. package/dist/models/exceeding-credit-class.d.ts +116 -0
  84. package/dist/models/exceeding-credit-class.js +29 -0
  85. package/dist/models/financial-account-class.d.ts +111 -0
  86. package/dist/models/financial-account-class.js +24 -0
  87. package/dist/models/get-bank-order-response-class.d.ts +25 -0
  88. package/dist/models/get-bank-order-response-class.js +15 -0
  89. package/dist/models/get-exceeding-credit-response-class.d.ts +25 -0
  90. package/dist/models/get-exceeding-credit-response-class.js +15 -0
  91. package/dist/models/index.d.ts +28 -1
  92. package/dist/models/index.js +28 -1
  93. package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
  94. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
  95. package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
  96. package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
  97. package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
  98. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
  99. package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
  100. package/dist/models/invoice-allocation-dto.js +15 -0
  101. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
  102. package/dist/models/list-bank-orders-response-class.d.ts +31 -0
  103. package/dist/models/list-bank-orders-response-class.js +15 -0
  104. package/dist/models/list-exceeding-credits-response-class.d.ts +31 -0
  105. package/dist/models/list-exceeding-credits-response-class.js +15 -0
  106. package/dist/models/list-policy-payment-methods-response-class.d.ts +31 -0
  107. package/dist/models/list-policy-payment-methods-response-class.js +15 -0
  108. package/dist/models/mandate-dto.d.ts +43 -0
  109. package/dist/models/mandate-dto.js +15 -0
  110. package/dist/models/mandate-hash-data-dto.d.ts +42 -0
  111. package/dist/models/mandate-hash-data-dto.js +15 -0
  112. package/dist/models/mandate-reference-class.d.ts +90 -0
  113. package/dist/models/mandate-reference-class.js +15 -0
  114. package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
  115. package/dist/models/payment-class.d.ts +7 -1
  116. package/dist/models/payment-method-class.d.ts +6 -0
  117. package/dist/models/payment-reminder-class.d.ts +7 -1
  118. package/dist/models/policy-payment-method-class.d.ts +86 -0
  119. package/dist/models/policy-payment-method-class.js +15 -0
  120. package/dist/models/refund-class.d.ts +7 -1
  121. package/dist/models/unlinked-bank-transaction-response-class.d.ts +18 -0
  122. package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
  123. package/dist/models/update-bank-order-request-dto.d.ts +62 -0
  124. package/dist/models/update-bank-order-request-dto.js +23 -0
  125. package/dist/models/update-bank-order-response-class.d.ts +25 -0
  126. package/dist/models/update-bank-order-response-class.js +15 -0
  127. package/models/bank-order-class.ts +128 -0
  128. package/models/bank-order-xml-file-class.ts +78 -0
  129. package/models/bank-transaction-class-without-expand-properties.ts +21 -18
  130. package/models/bank-transaction-class.ts +25 -22
  131. package/models/bank-transaction-invoice-class.ts +66 -0
  132. package/models/bank-transfer-dto.ts +31 -0
  133. package/models/billing-address-dto.ts +60 -0
  134. package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
  135. package/models/complete-eis-payment-setup-request-dto.ts +42 -0
  136. package/models/complete-payment-setup-request-dto.ts +7 -0
  137. package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
  138. package/models/create-bank-order-request-dto.ts +84 -0
  139. package/models/create-bank-order-response-class.ts +31 -0
  140. package/models/create-payment-order-dto.ts +54 -0
  141. package/models/create-payment-order-request-dto.ts +54 -0
  142. package/models/create-payment-reminder-request-dto.ts +7 -1
  143. package/models/create-payment-request-dto.ts +7 -1
  144. package/models/create-policy-payment-method-request-dto.ts +36 -0
  145. package/models/create-policy-payment-method-response-class.ts +31 -0
  146. package/models/create-psp-payment-method-request-dto.ts +30 -2
  147. package/models/deactivated-payment-reminder-class.ts +7 -1
  148. package/models/eis-sepa-debit-dto.ts +61 -0
  149. package/models/exceeding-credit-class.ts +125 -0
  150. package/models/financial-account-class.ts +120 -0
  151. package/models/get-bank-order-response-class.ts +31 -0
  152. package/models/get-exceeding-credit-response-class.ts +31 -0
  153. package/models/index.ts +28 -1
  154. package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
  155. package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
  156. package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
  157. package/models/initiate-payment-setup-request-dto.ts +3 -2
  158. package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
  159. package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
  160. package/models/link-bank-transaction-request-dto-rest.ts +4 -3
  161. package/models/list-bank-orders-response-class.ts +37 -0
  162. package/models/list-exceeding-credits-response-class.ts +37 -0
  163. package/models/list-policy-payment-methods-response-class.ts +37 -0
  164. package/models/mandate-dto.ts +49 -0
  165. package/models/mandate-hash-data-dto.ts +48 -0
  166. package/models/mandate-reference-class.ts +96 -0
  167. package/models/payment-class-without-expand-properties.ts +7 -1
  168. package/models/payment-class.ts +7 -1
  169. package/models/payment-method-class.ts +6 -0
  170. package/models/payment-reminder-class.ts +7 -1
  171. package/models/policy-payment-method-class.ts +92 -0
  172. package/models/refund-class.ts +7 -1
  173. package/models/unlinked-bank-transaction-response-class.ts +21 -0
  174. package/models/update-bank-order-request-dto.ts +71 -0
  175. package/models/update-bank-order-response-class.ts +31 -0
  176. package/package.json +3 -3
  177. /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
50
  var __generator = (this && this.__generator) || function (thisArg, body) {
51
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -74,15 +74,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
74
74
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
75
  }
76
76
  };
77
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
78
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
79
- if (ar || !(i in from)) {
80
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
81
- ar[i] = from[i];
82
- }
83
- }
84
- return to.concat(ar || Array.prototype.slice.call(from));
85
- };
86
77
  var __importDefault = (this && this.__importDefault) || function (mod) {
87
78
  return (mod && mod.__esModule) ? mod : { "default": mod };
88
79
  };
@@ -110,14 +101,10 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
110
101
  * @param {*} [options] Override http request option.
111
102
  * @throws {RequiredError}
112
103
  */
113
- createPayment: function (idempotencyKey_1, createPaymentRequestDto_1, authorization_1) {
114
- var args_1 = [];
115
- for (var _i = 3; _i < arguments.length; _i++) {
116
- args_1[_i - 3] = arguments[_i];
117
- }
118
- return __awaiter(_this, __spreadArray([idempotencyKey_1, createPaymentRequestDto_1, authorization_1], args_1, true), void 0, function (idempotencyKey, createPaymentRequestDto, authorization, options) {
104
+ createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
105
+ if (options === void 0) { options = {}; }
106
+ return __awaiter(_this, void 0, void 0, function () {
119
107
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
120
- if (options === void 0) { options = {}; }
121
108
  return __generator(this, function (_a) {
122
109
  switch (_a.label) {
123
110
  case 0:
@@ -160,6 +147,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
160
147
  });
161
148
  });
162
149
  },
150
+ /**
151
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
152
+ * @summary Create the payment
153
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
154
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
155
+ * @param {string} [authorization] Bearer Token
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
160
+ if (options === void 0) { options = {}; }
161
+ return __awaiter(_this, void 0, void 0, function () {
162
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
163
+ return __generator(this, function (_a) {
164
+ switch (_a.label) {
165
+ case 0:
166
+ // verify required parameter 'idempotencyKey' is not null or undefined
167
+ (0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
168
+ // verify required parameter 'createPaymentOrderDto' is not null or undefined
169
+ (0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
170
+ localVarPath = "/paymentservice/v1/payments/order";
171
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
172
+ if (configuration) {
173
+ baseOptions = configuration.baseOptions;
174
+ baseAccessToken = configuration.accessToken;
175
+ }
176
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
177
+ localVarHeaderParameter = {};
178
+ localVarQueryParameter = {};
179
+ // authentication bearer required
180
+ // http bearer authentication required
181
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
182
+ case 1:
183
+ // authentication bearer required
184
+ // http bearer authentication required
185
+ _a.sent();
186
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
187
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
188
+ }
189
+ if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
190
+ localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
191
+ }
192
+ localVarHeaderParameter['Content-Type'] = 'application/json';
193
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
194
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
195
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
196
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
197
+ return [2 /*return*/, {
198
+ url: (0, common_1.toPathString)(localVarUrlObj),
199
+ options: localVarRequestOptions,
200
+ }];
201
+ }
202
+ });
203
+ });
204
+ },
163
205
  /**
164
206
  * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
165
207
  * @summary Retrieve the payment
@@ -169,14 +211,10 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
169
211
  * @param {*} [options] Override http request option.
170
212
  * @throws {RequiredError}
171
213
  */
172
- getPayment: function (code_1, authorization_1, expand_1) {
173
- var args_1 = [];
174
- for (var _i = 3; _i < arguments.length; _i++) {
175
- args_1[_i - 3] = arguments[_i];
176
- }
177
- return __awaiter(_this, __spreadArray([code_1, authorization_1, expand_1], args_1, true), void 0, function (code, authorization, expand, options) {
214
+ getPayment: function (code, authorization, expand, options) {
215
+ if (options === void 0) { options = {}; }
216
+ return __awaiter(_this, void 0, void 0, function () {
178
217
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
179
- if (options === void 0) { options = {}; }
180
218
  return __generator(this, function (_a) {
181
219
  switch (_a.label) {
182
220
  case 0:
@@ -220,21 +258,20 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
220
258
  * Returns a list of payments you have previously created. The payments 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\"
221
259
  * @summary List payments
222
260
  * @param {string} [authorization] Bearer Token
223
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
224
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
261
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
262
+ * @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.
263
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
264
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
225
265
  * @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, code, amount&lt;/i&gt;
226
266
  * @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: transactions&lt;i&gt;
267
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
227
268
  * @param {*} [options] Override http request option.
228
269
  * @throws {RequiredError}
229
270
  */
230
- listPayments: function (authorization_1, filter_1, filters_1, order_1, expand_1) {
231
- var args_1 = [];
232
- for (var _i = 5; _i < arguments.length; _i++) {
233
- args_1[_i - 5] = arguments[_i];
234
- }
235
- return __awaiter(_this, __spreadArray([authorization_1, filter_1, filters_1, order_1, expand_1], args_1, true), void 0, function (authorization, filter, filters, order, expand, options) {
271
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
272
+ if (options === void 0) { options = {}; }
273
+ return __awaiter(_this, void 0, void 0, function () {
236
274
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
237
- if (options === void 0) { options = {}; }
238
275
  return __generator(this, function (_a) {
239
276
  switch (_a.label) {
240
277
  case 0:
@@ -254,11 +291,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
254
291
  // authentication bearer required
255
292
  // http bearer authentication required
256
293
  _a.sent();
294
+ if (pageSize !== undefined) {
295
+ localVarQueryParameter['pageSize'] = pageSize;
296
+ }
297
+ if (pageToken !== undefined) {
298
+ localVarQueryParameter['pageToken'] = pageToken;
299
+ }
257
300
  if (filter !== undefined) {
258
301
  localVarQueryParameter['filter'] = filter;
259
302
  }
260
- if (filters !== undefined) {
261
- localVarQueryParameter['filters'] = filters;
303
+ if (search !== undefined) {
304
+ localVarQueryParameter['search'] = search;
262
305
  }
263
306
  if (order !== undefined) {
264
307
  localVarQueryParameter['order'] = order;
@@ -266,6 +309,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
266
309
  if (expand !== undefined) {
267
310
  localVarQueryParameter['expand'] = expand;
268
311
  }
312
+ if (filters !== undefined) {
313
+ localVarQueryParameter['filters'] = filters;
314
+ }
269
315
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
270
316
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
271
317
  }
@@ -312,6 +358,28 @@ var PaymentsApiFp = function (configuration) {
312
358
  });
313
359
  });
314
360
  },
361
+ /**
362
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
363
+ * @summary Create the payment
364
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
365
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
366
+ * @param {string} [authorization] Bearer Token
367
+ * @param {*} [options] Override http request option.
368
+ * @throws {RequiredError}
369
+ */
370
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
371
+ return __awaiter(this, void 0, void 0, function () {
372
+ var localVarAxiosArgs;
373
+ return __generator(this, function (_a) {
374
+ switch (_a.label) {
375
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
376
+ case 1:
377
+ localVarAxiosArgs = _a.sent();
378
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
379
+ }
380
+ });
381
+ });
382
+ },
315
383
  /**
316
384
  * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
317
385
  * @summary Retrieve the payment
@@ -338,19 +406,22 @@ var PaymentsApiFp = function (configuration) {
338
406
  * Returns a list of payments you have previously created. The payments 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\"
339
407
  * @summary List payments
340
408
  * @param {string} [authorization] Bearer Token
341
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
342
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
409
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
410
+ * @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.
411
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
412
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
343
413
  * @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, code, amount&lt;/i&gt;
344
414
  * @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: transactions&lt;i&gt;
415
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
345
416
  * @param {*} [options] Override http request option.
346
417
  * @throws {RequiredError}
347
418
  */
348
- listPayments: function (authorization, filter, filters, order, expand, options) {
419
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
349
420
  return __awaiter(this, void 0, void 0, function () {
350
421
  var localVarAxiosArgs;
351
422
  return __generator(this, function (_a) {
352
423
  switch (_a.label) {
353
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, filter, filters, order, expand, options)];
424
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
354
425
  case 1:
355
426
  localVarAxiosArgs = _a.sent();
356
427
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -380,6 +451,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
380
451
  createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
381
452
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
382
453
  },
454
+ /**
455
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
456
+ * @summary Create the payment
457
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
458
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
459
+ * @param {string} [authorization] Bearer Token
460
+ * @param {*} [options] Override http request option.
461
+ * @throws {RequiredError}
462
+ */
463
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
464
+ return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
465
+ },
383
466
  /**
384
467
  * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
385
468
  * @summary Retrieve the payment
@@ -396,15 +479,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
396
479
  * Returns a list of payments you have previously created. The payments 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\"
397
480
  * @summary List payments
398
481
  * @param {string} [authorization] Bearer Token
399
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
400
- * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
482
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
483
+ * @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.
484
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
485
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
401
486
  * @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, code, amount&lt;/i&gt;
402
487
  * @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: transactions&lt;i&gt;
488
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode&lt;/i&gt;
403
489
  * @param {*} [options] Override http request option.
404
490
  * @throws {RequiredError}
405
491
  */
406
- listPayments: function (authorization, filter, filters, order, expand, options) {
407
- return localVarFp.listPayments(authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
492
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
493
+ return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
408
494
  },
409
495
  };
410
496
  };
@@ -432,6 +518,18 @@ var PaymentsApi = /** @class */ (function (_super) {
432
518
  var _this = this;
433
519
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
434
520
  };
521
+ /**
522
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
523
+ * @summary Create the payment
524
+ * @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ * @memberof PaymentsApi
528
+ */
529
+ PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
530
+ var _this = this;
531
+ return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
532
+ };
435
533
  /**
436
534
  * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
437
535
  * @summary Retrieve the payment
@@ -455,7 +553,7 @@ var PaymentsApi = /** @class */ (function (_super) {
455
553
  PaymentsApi.prototype.listPayments = function (requestParameters, options) {
456
554
  var _this = this;
457
555
  if (requestParameters === void 0) { requestParameters = {}; }
458
- return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
556
+ return (0, exports.PaymentsApiFp)(this.configuration).listPayments(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); });
459
557
  };
460
558
  return PaymentsApi;
461
559
  }(base_1.BaseAPI));
@@ -0,0 +1,207 @@
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 { CreatePolicyPaymentMethodRequestDto } from '../models';
16
+ import { CreatePolicyPaymentMethodResponseClass } from '../models';
17
+ import { ListPolicyPaymentMethodsResponseClass } from '../models';
18
+ /**
19
+ * PolicyPaymentMethodsApi - axios parameter creator
20
+ * @export
21
+ */
22
+ export declare const PolicyPaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
23
+ /**
24
+ * Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
25
+ * @summary Create the policy payment method
26
+ * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
27
+ * @param {string} [authorization] Bearer Token
28
+ * @param {*} [options] Override http request option.
29
+ * @throws {RequiredError}
30
+ */
31
+ createPolicyPaymentMethod: (createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * List policy payment methods **Required Permissions** \"payment-management.payments.view\"
34
+ * @summary Retrieve the policy payment methods
35
+ * @param {string} [authorization] Bearer Token
36
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
37
+ * @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.
38
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
39
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
40
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
41
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
42
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ listPolicyPaymentMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
+ };
48
+ /**
49
+ * PolicyPaymentMethodsApi - functional programming interface
50
+ * @export
51
+ */
52
+ export declare const PolicyPaymentMethodsApiFp: (configuration?: Configuration) => {
53
+ /**
54
+ * Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
55
+ * @summary Create the policy payment method
56
+ * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
57
+ * @param {string} [authorization] Bearer Token
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ */
61
+ createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyPaymentMethodResponseClass>>;
62
+ /**
63
+ * List policy payment methods **Required Permissions** \"payment-management.payments.view\"
64
+ * @summary Retrieve the policy payment methods
65
+ * @param {string} [authorization] Bearer Token
66
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
67
+ * @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.
68
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
69
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
70
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
71
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
72
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyPaymentMethodsResponseClass>>;
77
+ };
78
+ /**
79
+ * PolicyPaymentMethodsApi - factory interface
80
+ * @export
81
+ */
82
+ export declare const PolicyPaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
83
+ /**
84
+ * Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
85
+ * @summary Create the policy payment method
86
+ * @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
87
+ * @param {string} [authorization] Bearer Token
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyPaymentMethodResponseClass>;
92
+ /**
93
+ * List policy payment methods **Required Permissions** \"payment-management.payments.view\"
94
+ * @summary Retrieve the policy payment methods
95
+ * @param {string} [authorization] Bearer Token
96
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
97
+ * @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.
98
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
99
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
100
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
101
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
102
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyPaymentMethodsResponseClass>;
107
+ };
108
+ /**
109
+ * Request parameters for createPolicyPaymentMethod operation in PolicyPaymentMethodsApi.
110
+ * @export
111
+ * @interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest
112
+ */
113
+ export interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest {
114
+ /**
115
+ *
116
+ * @type {CreatePolicyPaymentMethodRequestDto}
117
+ * @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
118
+ */
119
+ readonly createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto;
120
+ /**
121
+ * Bearer Token
122
+ * @type {string}
123
+ * @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
124
+ */
125
+ readonly authorization?: string;
126
+ }
127
+ /**
128
+ * Request parameters for listPolicyPaymentMethods operation in PolicyPaymentMethodsApi.
129
+ * @export
130
+ * @interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest
131
+ */
132
+ export interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest {
133
+ /**
134
+ * Bearer Token
135
+ * @type {string}
136
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
137
+ */
138
+ readonly authorization?: string;
139
+ /**
140
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
141
+ * @type {number}
142
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
143
+ */
144
+ readonly pageSize?: number;
145
+ /**
146
+ * 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.
147
+ * @type {string}
148
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
149
+ */
150
+ readonly pageToken?: string;
151
+ /**
152
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
153
+ * @type {string}
154
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
155
+ */
156
+ readonly filter?: string;
157
+ /**
158
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
159
+ * @type {string}
160
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
161
+ */
162
+ readonly search?: string;
163
+ /**
164
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
165
+ * @type {string}
166
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
167
+ */
168
+ readonly order?: string;
169
+ /**
170
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
171
+ * @type {string}
172
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
173
+ */
174
+ readonly expand?: string;
175
+ /**
176
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
177
+ * @type {string}
178
+ * @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
179
+ */
180
+ readonly filters?: string;
181
+ }
182
+ /**
183
+ * PolicyPaymentMethodsApi - object-oriented interface
184
+ * @export
185
+ * @class PolicyPaymentMethodsApi
186
+ * @extends {BaseAPI}
187
+ */
188
+ export declare class PolicyPaymentMethodsApi extends BaseAPI {
189
+ /**
190
+ * Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
191
+ * @summary Create the policy payment method
192
+ * @param {PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest} requestParameters Request parameters.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ * @memberof PolicyPaymentMethodsApi
196
+ */
197
+ createPolicyPaymentMethod(requestParameters: PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyPaymentMethodResponseClass, any>>;
198
+ /**
199
+ * List policy payment methods **Required Permissions** \"payment-management.payments.view\"
200
+ * @summary Retrieve the policy payment methods
201
+ * @param {PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest} requestParameters Request parameters.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ * @memberof PolicyPaymentMethodsApi
205
+ */
206
+ listPolicyPaymentMethods(requestParameters?: PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyPaymentMethodsResponseClass, any>>;
207
+ }