@emilgroup/payment-sdk-node 1.21.1-beta.12 → 1.21.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 +695 -0
  5. package/api/bank-transaction-api.ts +59 -48
  6. package/api/exceeding-credits-api.ts +353 -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 +357 -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 +45 -3
  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 +646 -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 +356 -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 +357 -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 +11 -2
  41. package/dist/base.js +56 -27
  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 +4 -4
  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
  };
@@ -114,14 +105,10 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
114
105
  * @param {*} [options] Override http request option.
115
106
  * @throws {RequiredError}
116
107
  */
117
- createPayment: function (idempotencyKey_1, createPaymentRequestDto_1, authorization_1) {
118
- var args_1 = [];
119
- for (var _i = 3; _i < arguments.length; _i++) {
120
- args_1[_i - 3] = arguments[_i];
121
- }
122
- return __awaiter(_this, __spreadArray([idempotencyKey_1, createPaymentRequestDto_1, authorization_1], args_1, true), void 0, function (idempotencyKey, createPaymentRequestDto, authorization, options) {
108
+ createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
109
+ if (options === void 0) { options = {}; }
110
+ return __awaiter(_this, void 0, void 0, function () {
123
111
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
124
- if (options === void 0) { options = {}; }
125
112
  return __generator(this, function (_a) {
126
113
  switch (_a.label) {
127
114
  case 0:
@@ -164,6 +151,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
164
151
  });
165
152
  });
166
153
  },
154
+ /**
155
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
156
+ * @summary Create the payment
157
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
158
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
159
+ * @param {string} [authorization] Bearer Token
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
164
+ if (options === void 0) { options = {}; }
165
+ return __awaiter(_this, void 0, void 0, function () {
166
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
167
+ return __generator(this, function (_a) {
168
+ switch (_a.label) {
169
+ case 0:
170
+ // verify required parameter 'idempotencyKey' is not null or undefined
171
+ (0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
172
+ // verify required parameter 'createPaymentOrderDto' is not null or undefined
173
+ (0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
174
+ localVarPath = "/paymentservice/v1/payments/order";
175
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
176
+ if (configuration) {
177
+ baseOptions = configuration.baseOptions;
178
+ baseAccessToken = configuration.accessToken;
179
+ }
180
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
181
+ localVarHeaderParameter = {};
182
+ localVarQueryParameter = {};
183
+ // authentication bearer required
184
+ // http bearer authentication required
185
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
186
+ case 1:
187
+ // authentication bearer required
188
+ // http bearer authentication required
189
+ _a.sent();
190
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
191
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
192
+ }
193
+ if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
194
+ localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
195
+ }
196
+ localVarHeaderParameter['Content-Type'] = 'application/json';
197
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
198
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
199
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
200
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
201
+ return [2 /*return*/, {
202
+ url: (0, common_1.toPathString)(localVarUrlObj),
203
+ options: localVarRequestOptions,
204
+ }];
205
+ }
206
+ });
207
+ });
208
+ },
167
209
  /**
168
210
  * 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\"
169
211
  * @summary Retrieve the payment
@@ -173,14 +215,10 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
173
215
  * @param {*} [options] Override http request option.
174
216
  * @throws {RequiredError}
175
217
  */
176
- getPayment: function (code_1, authorization_1, expand_1) {
177
- var args_1 = [];
178
- for (var _i = 3; _i < arguments.length; _i++) {
179
- args_1[_i - 3] = arguments[_i];
180
- }
181
- return __awaiter(_this, __spreadArray([code_1, authorization_1, expand_1], args_1, true), void 0, function (code, authorization, expand, options) {
218
+ getPayment: function (code, authorization, expand, options) {
219
+ if (options === void 0) { options = {}; }
220
+ return __awaiter(_this, void 0, void 0, function () {
182
221
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
183
- if (options === void 0) { options = {}; }
184
222
  return __generator(this, function (_a) {
185
223
  switch (_a.label) {
186
224
  case 0:
@@ -224,21 +262,20 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
224
262
  * 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\"
225
263
  * @summary List payments
226
264
  * @param {string} [authorization] Bearer Token
227
- * @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;
228
- * @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;
265
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
266
+ * @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.
267
+ * @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;
268
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
229
269
  * @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;
230
270
  * @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;
271
+ * @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;
231
272
  * @param {*} [options] Override http request option.
232
273
  * @throws {RequiredError}
233
274
  */
234
- listPayments: function (authorization_1, filter_1, filters_1, order_1, expand_1) {
235
- var args_1 = [];
236
- for (var _i = 5; _i < arguments.length; _i++) {
237
- args_1[_i - 5] = arguments[_i];
238
- }
239
- 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) {
275
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
276
+ if (options === void 0) { options = {}; }
277
+ return __awaiter(_this, void 0, void 0, function () {
240
278
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
241
- if (options === void 0) { options = {}; }
242
279
  return __generator(this, function (_a) {
243
280
  switch (_a.label) {
244
281
  case 0:
@@ -258,11 +295,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
258
295
  // authentication bearer required
259
296
  // http bearer authentication required
260
297
  _a.sent();
298
+ if (pageSize !== undefined) {
299
+ localVarQueryParameter['pageSize'] = pageSize;
300
+ }
301
+ if (pageToken !== undefined) {
302
+ localVarQueryParameter['pageToken'] = pageToken;
303
+ }
261
304
  if (filter !== undefined) {
262
305
  localVarQueryParameter['filter'] = filter;
263
306
  }
264
- if (filters !== undefined) {
265
- localVarQueryParameter['filters'] = filters;
307
+ if (search !== undefined) {
308
+ localVarQueryParameter['search'] = search;
266
309
  }
267
310
  if (order !== undefined) {
268
311
  localVarQueryParameter['order'] = order;
@@ -270,6 +313,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
270
313
  if (expand !== undefined) {
271
314
  localVarQueryParameter['expand'] = expand;
272
315
  }
316
+ if (filters !== undefined) {
317
+ localVarQueryParameter['filters'] = filters;
318
+ }
273
319
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
274
320
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
275
321
  }
@@ -316,6 +362,28 @@ var PaymentsApiFp = function (configuration) {
316
362
  });
317
363
  });
318
364
  },
365
+ /**
366
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
367
+ * @summary Create the payment
368
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
369
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
370
+ * @param {string} [authorization] Bearer Token
371
+ * @param {*} [options] Override http request option.
372
+ * @throws {RequiredError}
373
+ */
374
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
375
+ return __awaiter(this, void 0, void 0, function () {
376
+ var localVarAxiosArgs;
377
+ return __generator(this, function (_a) {
378
+ switch (_a.label) {
379
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
380
+ case 1:
381
+ localVarAxiosArgs = _a.sent();
382
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
383
+ }
384
+ });
385
+ });
386
+ },
319
387
  /**
320
388
  * 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\"
321
389
  * @summary Retrieve the payment
@@ -342,19 +410,22 @@ var PaymentsApiFp = function (configuration) {
342
410
  * 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\"
343
411
  * @summary List payments
344
412
  * @param {string} [authorization] Bearer Token
345
- * @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;
346
- * @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;
413
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
414
+ * @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.
415
+ * @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;
416
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
347
417
  * @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;
348
418
  * @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;
419
+ * @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;
349
420
  * @param {*} [options] Override http request option.
350
421
  * @throws {RequiredError}
351
422
  */
352
- listPayments: function (authorization, filter, filters, order, expand, options) {
423
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
353
424
  return __awaiter(this, void 0, void 0, function () {
354
425
  var localVarAxiosArgs;
355
426
  return __generator(this, function (_a) {
356
427
  switch (_a.label) {
357
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, filter, filters, order, expand, options)];
428
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
358
429
  case 1:
359
430
  localVarAxiosArgs = _a.sent();
360
431
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -384,6 +455,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
384
455
  createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
385
456
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
386
457
  },
458
+ /**
459
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
460
+ * @summary Create the payment
461
+ * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
462
+ * @param {CreatePaymentOrderDto} createPaymentOrderDto
463
+ * @param {string} [authorization] Bearer Token
464
+ * @param {*} [options] Override http request option.
465
+ * @throws {RequiredError}
466
+ */
467
+ createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
468
+ return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
469
+ },
387
470
  /**
388
471
  * 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\"
389
472
  * @summary Retrieve the payment
@@ -400,15 +483,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
400
483
  * 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\"
401
484
  * @summary List payments
402
485
  * @param {string} [authorization] Bearer Token
403
- * @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;
404
- * @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;
486
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
487
+ * @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.
488
+ * @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;
489
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
405
490
  * @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;
406
491
  * @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;
492
+ * @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;
407
493
  * @param {*} [options] Override http request option.
408
494
  * @throws {RequiredError}
409
495
  */
410
- listPayments: function (authorization, filter, filters, order, expand, options) {
411
- return localVarFp.listPayments(authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
496
+ listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
497
+ return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
412
498
  },
413
499
  };
414
500
  };
@@ -436,6 +522,18 @@ var PaymentsApi = /** @class */ (function (_super) {
436
522
  var _this = this;
437
523
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
438
524
  };
525
+ /**
526
+ * This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
527
+ * @summary Create the payment
528
+ * @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
529
+ * @param {*} [options] Override http request option.
530
+ * @throws {RequiredError}
531
+ * @memberof PaymentsApi
532
+ */
533
+ PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
534
+ var _this = this;
535
+ return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
536
+ };
439
537
  /**
440
538
  * 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\"
441
539
  * @summary Retrieve the payment
@@ -459,7 +557,7 @@ var PaymentsApi = /** @class */ (function (_super) {
459
557
  PaymentsApi.prototype.listPayments = function (requestParameters, options) {
460
558
  var _this = this;
461
559
  if (requestParameters === void 0) { requestParameters = {}; }
462
- 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); });
560
+ 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); });
463
561
  };
464
562
  return PaymentsApi;
465
563
  }(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
+ }