@emilgroup/payment-sdk-node 1.23.0 → 1.23.1-beta.11

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 (103) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +2 -2
  3. package/api/billing-addresses-api.ts +681 -0
  4. package/api/payment-requests-api.ts +697 -0
  5. package/api/payout-methods-api.ts +676 -0
  6. package/api/tenant-bank-account-api.ts +12 -12
  7. package/api.ts +6 -0
  8. package/dist/api/billing-addresses-api.d.ts +384 -0
  9. package/dist/api/billing-addresses-api.js +640 -0
  10. package/dist/api/payment-requests-api.d.ts +393 -0
  11. package/dist/api/payment-requests-api.js +648 -0
  12. package/dist/api/payout-methods-api.d.ts +382 -0
  13. package/dist/api/payout-methods-api.js +639 -0
  14. package/dist/api/tenant-bank-account-api.d.ts +12 -12
  15. package/dist/api/tenant-bank-account-api.js +9 -9
  16. package/dist/api.d.ts +3 -0
  17. package/dist/api.js +3 -0
  18. package/dist/models/bank-order-class.d.ts +3 -3
  19. package/dist/models/bank-order-entity.d.ts +3 -2
  20. package/dist/models/bank-order-entity.js +2 -1
  21. package/dist/models/billing-address-class.d.ts +108 -0
  22. package/dist/models/billing-address-class.js +15 -0
  23. package/dist/models/create-bank-order-request-dto.d.ts +4 -3
  24. package/dist/models/create-bank-order-request-dto.js +2 -1
  25. package/dist/models/create-billing-address-request-dto.d.ts +66 -0
  26. package/dist/models/create-billing-address-request-dto.js +15 -0
  27. package/dist/models/create-billing-address-response-class.d.ts +25 -0
  28. package/dist/models/create-billing-address-response-class.js +15 -0
  29. package/dist/models/create-payment-request-request-dto.d.ts +72 -0
  30. package/dist/models/create-payment-request-request-dto.js +26 -0
  31. package/dist/models/create-payment-request-response-class.d.ts +25 -0
  32. package/dist/models/create-payment-request-response-class.js +15 -0
  33. package/dist/models/create-payout-method-request-dto.d.ts +60 -0
  34. package/dist/models/create-payout-method-request-dto.js +15 -0
  35. package/dist/models/create-payout-method-response-class.d.ts +25 -0
  36. package/dist/models/create-payout-method-response-class.js +15 -0
  37. package/dist/models/create-tenant-bank-account-request-dto.d.ts +17 -0
  38. package/dist/models/create-tenant-bank-account-request-dto.js +11 -1
  39. package/dist/models/get-billing-address-response-class.d.ts +25 -0
  40. package/dist/models/get-billing-address-response-class.js +15 -0
  41. package/dist/models/get-payment-request-response-class.d.ts +25 -0
  42. package/dist/models/get-payment-request-response-class.js +15 -0
  43. package/dist/models/get-payout-method-response-class.d.ts +25 -0
  44. package/dist/models/get-payout-method-response-class.js +15 -0
  45. package/dist/models/index.d.ts +19 -0
  46. package/dist/models/index.js +19 -0
  47. package/dist/models/list-billing-addresses-response-class.d.ts +43 -0
  48. package/dist/models/list-billing-addresses-response-class.js +15 -0
  49. package/dist/models/list-payment-requests-response-class.d.ts +31 -0
  50. package/dist/models/list-payment-requests-response-class.js +15 -0
  51. package/dist/models/list-payout-methods-response-class.d.ts +43 -0
  52. package/dist/models/list-payout-methods-response-class.js +15 -0
  53. package/dist/models/payment-request-class.d.ts +111 -0
  54. package/dist/models/payment-request-class.js +34 -0
  55. package/dist/models/payout-method-class.d.ts +115 -0
  56. package/dist/models/payout-method-class.js +15 -0
  57. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +17 -0
  58. package/dist/models/tenant-bank-account-class-without-expand-properties.js +11 -1
  59. package/dist/models/tenant-bank-account-class.d.ts +17 -0
  60. package/dist/models/tenant-bank-account-class.js +11 -1
  61. package/dist/models/tenant-bank-account-entity.d.ts +17 -0
  62. package/dist/models/tenant-bank-account-entity.js +11 -1
  63. package/dist/models/update-bank-order-request-dto.d.ts +3 -3
  64. package/dist/models/update-billing-address-request-dto.d.ts +66 -0
  65. package/dist/models/update-billing-address-request-dto.js +15 -0
  66. package/dist/models/update-billing-address-response-class.d.ts +25 -0
  67. package/dist/models/update-billing-address-response-class.js +15 -0
  68. package/dist/models/update-payment-request-request-dto.d.ts +39 -0
  69. package/dist/models/update-payment-request-request-dto.js +24 -0
  70. package/dist/models/update-payment-request-response-class.d.ts +25 -0
  71. package/dist/models/update-payment-request-response-class.js +15 -0
  72. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +17 -0
  73. package/dist/models/update-tenant-bank-account-rest-request-dto.js +11 -1
  74. package/models/bank-order-class.ts +3 -3
  75. package/models/bank-order-entity.ts +4 -3
  76. package/models/billing-address-class.ts +114 -0
  77. package/models/create-bank-order-request-dto.ts +5 -4
  78. package/models/create-billing-address-request-dto.ts +72 -0
  79. package/models/create-billing-address-response-class.ts +31 -0
  80. package/models/create-payment-request-request-dto.ts +82 -0
  81. package/models/create-payment-request-response-class.ts +31 -0
  82. package/models/create-payout-method-request-dto.ts +66 -0
  83. package/models/create-payout-method-response-class.ts +31 -0
  84. package/models/create-tenant-bank-account-request-dto.ts +18 -0
  85. package/models/get-billing-address-response-class.ts +31 -0
  86. package/models/get-payment-request-response-class.ts +31 -0
  87. package/models/get-payout-method-response-class.ts +31 -0
  88. package/models/index.ts +19 -0
  89. package/models/list-billing-addresses-response-class.ts +49 -0
  90. package/models/list-payment-requests-response-class.ts +37 -0
  91. package/models/list-payout-methods-response-class.ts +49 -0
  92. package/models/payment-request-class.ts +122 -0
  93. package/models/payout-method-class.ts +121 -0
  94. package/models/tenant-bank-account-class-without-expand-properties.ts +18 -0
  95. package/models/tenant-bank-account-class.ts +18 -0
  96. package/models/tenant-bank-account-entity.ts +18 -0
  97. package/models/update-bank-order-request-dto.ts +3 -3
  98. package/models/update-billing-address-request-dto.ts +72 -0
  99. package/models/update-billing-address-response-class.ts +31 -0
  100. package/models/update-payment-request-request-dto.ts +48 -0
  101. package/models/update-payment-request-response-class.ts +31 -0
  102. package/models/update-tenant-bank-account-rest-request-dto.ts +18 -0
  103. package/package.json +2 -2
@@ -190,11 +190,11 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
190
190
  * @param {string} [authorization] Bearer Token
191
191
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
192
192
  * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
193
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
193
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
194
194
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
195
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
195
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, bankName, accountName</i>
196
196
  * @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.<br/> <br/> <i>Allowed values: bankTransactions<i>
197
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
197
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
198
198
  * @param {*} [options] Override http request option.
199
199
  * @throws {RequiredError}
200
200
  */
@@ -364,11 +364,11 @@ export const TenantBankAccountApiFp = function(configuration?: Configuration) {
364
364
  * @param {string} [authorization] Bearer Token
365
365
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
366
366
  * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
367
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
367
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
368
368
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
369
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
369
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, bankName, accountName</i>
370
370
  * @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.<br/> <br/> <i>Allowed values: bankTransactions<i>
371
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
371
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
372
372
  * @param {*} [options] Override http request option.
373
373
  * @throws {RequiredError}
374
374
  */
@@ -439,11 +439,11 @@ export const TenantBankAccountApiFactory = function (configuration?: Configurati
439
439
  * @param {string} [authorization] Bearer Token
440
440
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
441
441
  * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
442
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
442
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
443
443
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
444
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
444
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, bankName, accountName</i>
445
445
  * @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.<br/> <br/> <i>Allowed values: bankTransactions<i>
446
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
446
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
447
447
  * @param {*} [options] Override http request option.
448
448
  * @throws {RequiredError}
449
449
  */
@@ -563,7 +563,7 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
563
563
  readonly pageToken?: string
564
564
 
565
565
  /**
566
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
566
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
567
567
  * @type {string}
568
568
  * @memberof TenantBankAccountApiListTenantBankAccounts
569
569
  */
@@ -577,7 +577,7 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
577
577
  readonly search?: string
578
578
 
579
579
  /**
580
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
580
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, bankName, accountName</i>
581
581
  * @type {string}
582
582
  * @memberof TenantBankAccountApiListTenantBankAccounts
583
583
  */
@@ -591,7 +591,7 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
591
591
  readonly expand?: string
592
592
 
593
593
  /**
594
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion</i>
594
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
595
595
  * @type {string}
596
596
  * @memberof TenantBankAccountApiListTenantBankAccounts
597
597
  */
package/api.ts CHANGED
@@ -27,13 +27,16 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  import { BankAccountsApi } from './api';
28
28
  import { BankOrdersApi } from './api';
29
29
  import { BankTransactionApi } from './api';
30
+ import { BillingAddressesApi } from './api';
30
31
  import { CreditAllocationApi } from './api';
31
32
  import { ExceedingCreditsApi } from './api';
32
33
  import { HealthCheckApi } from './api';
33
34
  import { PaymentMethodsApi } from './api';
34
35
  import { PaymentRemindersApi } from './api';
36
+ import { PaymentRequestsApi } from './api';
35
37
  import { PaymentSetupApi } from './api';
36
38
  import { PaymentsApi } from './api';
39
+ import { PayoutMethodsApi } from './api';
37
40
  import { PolicyPaymentMethodsApi } from './api';
38
41
  import { RefundsApi } from './api';
39
42
  import { TenantBankAccountApi } from './api';
@@ -43,13 +46,16 @@ import { WebhooksApi } from './api';
43
46
  export * from './api/bank-accounts-api';
44
47
  export * from './api/bank-orders-api';
45
48
  export * from './api/bank-transaction-api';
49
+ export * from './api/billing-addresses-api';
46
50
  export * from './api/credit-allocation-api';
47
51
  export * from './api/exceeding-credits-api';
48
52
  export * from './api/health-check-api';
49
53
  export * from './api/payment-methods-api';
50
54
  export * from './api/payment-reminders-api';
55
+ export * from './api/payment-requests-api';
51
56
  export * from './api/payment-setup-api';
52
57
  export * from './api/payments-api';
58
+ export * from './api/payout-methods-api';
53
59
  export * from './api/policy-payment-methods-api';
54
60
  export * from './api/refunds-api';
55
61
  export * from './api/tenant-bank-account-api';
@@ -0,0 +1,384 @@
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 { CreateBillingAddressRequestDto } from '../models';
16
+ import { CreateBillingAddressResponseClass } from '../models';
17
+ import { GetBillingAddressResponseClass } from '../models';
18
+ import { ListBillingAddressesResponseClass } from '../models';
19
+ import { UpdateBillingAddressRequestDto } from '../models';
20
+ import { UpdateBillingAddressResponseClass } from '../models';
21
+ /**
22
+ * BillingAddressesApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const BillingAddressesApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * This will create a new billing address for a specified account or partner **Required Permissions** \"payment-management.payments.create\"
28
+ * @summary Create the Billing Address
29
+ * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
30
+ * @param {string} [authorization] Bearer Token
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createBillingAddress: (createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Deletes a billing address by code **Required Permissions** \"payment-management.payments.delete\"
37
+ * @summary Delete the Billing Address
38
+ * @param {string} code Unique identifier for the object.
39
+ * @param {string} [authorization] Bearer Token
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ deleteBillingAddress: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code that was returned when you created it and Emil Api will return the corresponding Billing Address information. **Required Permissions** \"payment-management.payments.view\"
46
+ * @summary Retrieve the Billing Address
47
+ * @param {string} code
48
+ * @param {string} [authorization] Bearer Token
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getBillingAddress: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
55
+ * @summary List Billing Addresses
56
+ * @param {string} [authorization] Bearer Token
57
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
58
+ * @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.
59
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
60
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
61
+ * @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, code, createdAt, updatedAt&lt;/i&gt;
62
+ * @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;
63
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
64
+ * @param {*} [options] Override http request option.
65
+ * @throws {RequiredError}
66
+ */
67
+ listBillingAddresses: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ /**
69
+ * Updates a billing address by code **Required Permissions** \"payment-management.payments.update\"
70
+ * @summary Update the Billing Address
71
+ * @param {string} code
72
+ * @param {UpdateBillingAddressRequestDto} updateBillingAddressRequestDto
73
+ * @param {string} [authorization] Bearer Token
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ updateBillingAddress: (code: string, updateBillingAddressRequestDto: UpdateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
+ };
79
+ /**
80
+ * BillingAddressesApi - functional programming interface
81
+ * @export
82
+ */
83
+ export declare const BillingAddressesApiFp: (configuration?: Configuration) => {
84
+ /**
85
+ * This will create a new billing address for a specified account or partner **Required Permissions** \"payment-management.payments.create\"
86
+ * @summary Create the Billing Address
87
+ * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
88
+ * @param {string} [authorization] Bearer Token
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ createBillingAddress(createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBillingAddressResponseClass>>;
93
+ /**
94
+ * Deletes a billing address by code **Required Permissions** \"payment-management.payments.delete\"
95
+ * @summary Delete the Billing Address
96
+ * @param {string} code Unique identifier for the object.
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ deleteBillingAddress(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
102
+ /**
103
+ * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code that was returned when you created it and Emil Api will return the corresponding Billing Address information. **Required Permissions** \"payment-management.payments.view\"
104
+ * @summary Retrieve the Billing Address
105
+ * @param {string} code
106
+ * @param {string} [authorization] Bearer Token
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ getBillingAddress(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillingAddressResponseClass>>;
111
+ /**
112
+ * Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
113
+ * @summary List Billing Addresses
114
+ * @param {string} [authorization] Bearer Token
115
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
+ * @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.
117
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
118
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
119
+ * @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, code, createdAt, updatedAt&lt;/i&gt;
120
+ * @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;
121
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ listBillingAddresses(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBillingAddressesResponseClass>>;
126
+ /**
127
+ * Updates a billing address by code **Required Permissions** \"payment-management.payments.update\"
128
+ * @summary Update the Billing Address
129
+ * @param {string} code
130
+ * @param {UpdateBillingAddressRequestDto} updateBillingAddressRequestDto
131
+ * @param {string} [authorization] Bearer Token
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ updateBillingAddress(code: string, updateBillingAddressRequestDto: UpdateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBillingAddressResponseClass>>;
136
+ };
137
+ /**
138
+ * BillingAddressesApi - factory interface
139
+ * @export
140
+ */
141
+ export declare const BillingAddressesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
142
+ /**
143
+ * This will create a new billing address for a specified account or partner **Required Permissions** \"payment-management.payments.create\"
144
+ * @summary Create the Billing Address
145
+ * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
146
+ * @param {string} [authorization] Bearer Token
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ createBillingAddress(createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBillingAddressResponseClass>;
151
+ /**
152
+ * Deletes a billing address by code **Required Permissions** \"payment-management.payments.delete\"
153
+ * @summary Delete the Billing Address
154
+ * @param {string} code Unique identifier for the object.
155
+ * @param {string} [authorization] Bearer Token
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ deleteBillingAddress(code: string, authorization?: string, options?: any): AxiosPromise<object>;
160
+ /**
161
+ * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code that was returned when you created it and Emil Api will return the corresponding Billing Address information. **Required Permissions** \"payment-management.payments.view\"
162
+ * @summary Retrieve the Billing Address
163
+ * @param {string} code
164
+ * @param {string} [authorization] Bearer Token
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ getBillingAddress(code: string, authorization?: string, options?: any): AxiosPromise<GetBillingAddressResponseClass>;
169
+ /**
170
+ * Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
171
+ * @summary List Billing Addresses
172
+ * @param {string} [authorization] Bearer Token
173
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
174
+ * @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.
175
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
176
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
177
+ * @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, code, createdAt, updatedAt&lt;/i&gt;
178
+ * @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;
179
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ listBillingAddresses(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBillingAddressesResponseClass>;
184
+ /**
185
+ * Updates a billing address by code **Required Permissions** \"payment-management.payments.update\"
186
+ * @summary Update the Billing Address
187
+ * @param {string} code
188
+ * @param {UpdateBillingAddressRequestDto} updateBillingAddressRequestDto
189
+ * @param {string} [authorization] Bearer Token
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ updateBillingAddress(code: string, updateBillingAddressRequestDto: UpdateBillingAddressRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBillingAddressResponseClass>;
194
+ };
195
+ /**
196
+ * Request parameters for createBillingAddress operation in BillingAddressesApi.
197
+ * @export
198
+ * @interface BillingAddressesApiCreateBillingAddressRequest
199
+ */
200
+ export interface BillingAddressesApiCreateBillingAddressRequest {
201
+ /**
202
+ *
203
+ * @type {CreateBillingAddressRequestDto}
204
+ * @memberof BillingAddressesApiCreateBillingAddress
205
+ */
206
+ readonly createBillingAddressRequestDto: CreateBillingAddressRequestDto;
207
+ /**
208
+ * Bearer Token
209
+ * @type {string}
210
+ * @memberof BillingAddressesApiCreateBillingAddress
211
+ */
212
+ readonly authorization?: string;
213
+ }
214
+ /**
215
+ * Request parameters for deleteBillingAddress operation in BillingAddressesApi.
216
+ * @export
217
+ * @interface BillingAddressesApiDeleteBillingAddressRequest
218
+ */
219
+ export interface BillingAddressesApiDeleteBillingAddressRequest {
220
+ /**
221
+ * Unique identifier for the object.
222
+ * @type {string}
223
+ * @memberof BillingAddressesApiDeleteBillingAddress
224
+ */
225
+ readonly code: string;
226
+ /**
227
+ * Bearer Token
228
+ * @type {string}
229
+ * @memberof BillingAddressesApiDeleteBillingAddress
230
+ */
231
+ readonly authorization?: string;
232
+ }
233
+ /**
234
+ * Request parameters for getBillingAddress operation in BillingAddressesApi.
235
+ * @export
236
+ * @interface BillingAddressesApiGetBillingAddressRequest
237
+ */
238
+ export interface BillingAddressesApiGetBillingAddressRequest {
239
+ /**
240
+ *
241
+ * @type {string}
242
+ * @memberof BillingAddressesApiGetBillingAddress
243
+ */
244
+ readonly code: string;
245
+ /**
246
+ * Bearer Token
247
+ * @type {string}
248
+ * @memberof BillingAddressesApiGetBillingAddress
249
+ */
250
+ readonly authorization?: string;
251
+ }
252
+ /**
253
+ * Request parameters for listBillingAddresses operation in BillingAddressesApi.
254
+ * @export
255
+ * @interface BillingAddressesApiListBillingAddressesRequest
256
+ */
257
+ export interface BillingAddressesApiListBillingAddressesRequest {
258
+ /**
259
+ * Bearer Token
260
+ * @type {string}
261
+ * @memberof BillingAddressesApiListBillingAddresses
262
+ */
263
+ readonly authorization?: string;
264
+ /**
265
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
266
+ * @type {number}
267
+ * @memberof BillingAddressesApiListBillingAddresses
268
+ */
269
+ readonly pageSize?: number;
270
+ /**
271
+ * 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.
272
+ * @type {string}
273
+ * @memberof BillingAddressesApiListBillingAddresses
274
+ */
275
+ readonly pageToken?: string;
276
+ /**
277
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
278
+ * @type {string}
279
+ * @memberof BillingAddressesApiListBillingAddresses
280
+ */
281
+ readonly filter?: string;
282
+ /**
283
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
284
+ * @type {string}
285
+ * @memberof BillingAddressesApiListBillingAddresses
286
+ */
287
+ readonly search?: string;
288
+ /**
289
+ * 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, code, createdAt, updatedAt&lt;/i&gt;
290
+ * @type {string}
291
+ * @memberof BillingAddressesApiListBillingAddresses
292
+ */
293
+ readonly order?: string;
294
+ /**
295
+ * 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;
296
+ * @type {string}
297
+ * @memberof BillingAddressesApiListBillingAddresses
298
+ */
299
+ readonly expand?: string;
300
+ /**
301
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode&lt;/i&gt;
302
+ * @type {string}
303
+ * @memberof BillingAddressesApiListBillingAddresses
304
+ */
305
+ readonly filters?: string;
306
+ }
307
+ /**
308
+ * Request parameters for updateBillingAddress operation in BillingAddressesApi.
309
+ * @export
310
+ * @interface BillingAddressesApiUpdateBillingAddressRequest
311
+ */
312
+ export interface BillingAddressesApiUpdateBillingAddressRequest {
313
+ /**
314
+ *
315
+ * @type {string}
316
+ * @memberof BillingAddressesApiUpdateBillingAddress
317
+ */
318
+ readonly code: string;
319
+ /**
320
+ *
321
+ * @type {UpdateBillingAddressRequestDto}
322
+ * @memberof BillingAddressesApiUpdateBillingAddress
323
+ */
324
+ readonly updateBillingAddressRequestDto: UpdateBillingAddressRequestDto;
325
+ /**
326
+ * Bearer Token
327
+ * @type {string}
328
+ * @memberof BillingAddressesApiUpdateBillingAddress
329
+ */
330
+ readonly authorization?: string;
331
+ }
332
+ /**
333
+ * BillingAddressesApi - object-oriented interface
334
+ * @export
335
+ * @class BillingAddressesApi
336
+ * @extends {BaseAPI}
337
+ */
338
+ export declare class BillingAddressesApi extends BaseAPI {
339
+ /**
340
+ * This will create a new billing address for a specified account or partner **Required Permissions** \"payment-management.payments.create\"
341
+ * @summary Create the Billing Address
342
+ * @param {BillingAddressesApiCreateBillingAddressRequest} requestParameters Request parameters.
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ * @memberof BillingAddressesApi
346
+ */
347
+ createBillingAddress(requestParameters: BillingAddressesApiCreateBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBillingAddressResponseClass, any, {}>>;
348
+ /**
349
+ * Deletes a billing address by code **Required Permissions** \"payment-management.payments.delete\"
350
+ * @summary Delete the Billing Address
351
+ * @param {BillingAddressesApiDeleteBillingAddressRequest} requestParameters Request parameters.
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ * @memberof BillingAddressesApi
355
+ */
356
+ deleteBillingAddress(requestParameters: BillingAddressesApiDeleteBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
357
+ /**
358
+ * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code that was returned when you created it and Emil Api will return the corresponding Billing Address information. **Required Permissions** \"payment-management.payments.view\"
359
+ * @summary Retrieve the Billing Address
360
+ * @param {BillingAddressesApiGetBillingAddressRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof BillingAddressesApi
364
+ */
365
+ getBillingAddress(requestParameters: BillingAddressesApiGetBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBillingAddressResponseClass, any, {}>>;
366
+ /**
367
+ * Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
368
+ * @summary List Billing Addresses
369
+ * @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ * @memberof BillingAddressesApi
373
+ */
374
+ listBillingAddresses(requestParameters?: BillingAddressesApiListBillingAddressesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBillingAddressesResponseClass, any, {}>>;
375
+ /**
376
+ * Updates a billing address by code **Required Permissions** \"payment-management.payments.update\"
377
+ * @summary Update the Billing Address
378
+ * @param {BillingAddressesApiUpdateBillingAddressRequest} requestParameters Request parameters.
379
+ * @param {*} [options] Override http request option.
380
+ * @throws {RequiredError}
381
+ * @memberof BillingAddressesApi
382
+ */
383
+ updateBillingAddress(requestParameters: BillingAddressesApiUpdateBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateBillingAddressResponseClass, any, {}>>;
384
+ }