@emilgroup/payment-sdk 1.13.1-beta.13 → 1.13.1-beta.131
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.
- package/.openapi-generator/FILES +24 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +130 -57
- package/api/bank-transaction-api.ts +59 -48
- package/api/exceeding-credits-api.ts +349 -0
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +180 -17
- package/api/policy-payment-methods-api.ts +471 -0
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +4 -0
- package/base.ts +10 -32
- package/common.ts +2 -2
- package/configuration.ts +0 -9
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +92 -46
- package/dist/api/bank-orders-api.js +83 -52
- package/dist/api/bank-transaction-api.d.ts +39 -31
- package/dist/api/bank-transaction-api.js +36 -31
- package/dist/api/exceeding-credits-api.d.ts +206 -0
- package/dist/api/exceeding-credits-api.js +352 -0
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +104 -12
- package/dist/api/payments-api.js +133 -14
- package/dist/api/policy-payment-methods-api.d.ts +272 -0
- package/dist/api/policy-payment-methods-api.js +452 -0
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -4
- package/dist/base.js +21 -40
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +0 -6
- package/dist/configuration.js +0 -8
- package/dist/models/activate-policy-payment-method-request-dto.d.ts +24 -0
- package/dist/models/bank-order-class.d.ts +23 -3
- package/dist/models/bank-order-xml-file-class.d.ts +72 -0
- package/dist/models/bank-order-xml-file-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -18
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +22 -22
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +60 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +60 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- package/dist/models/create-bank-order-request-dto.d.ts +9 -9
- package/dist/models/create-payment-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-policy-payment-method-request-dto.d.ts +30 -0
- package/dist/models/create-policy-payment-method-request-dto.js +15 -0
- package/dist/models/create-policy-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-policy-payment-method-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +29 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +30 -0
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/eis-sepa-debit-dto.d.ts +55 -0
- package/dist/models/eis-sepa-debit-dto.js +15 -0
- package/dist/models/exceeding-credit-class.d.ts +116 -0
- package/dist/models/exceeding-credit-class.js +29 -0
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/get-exceeding-credit-response-class.d.ts +25 -0
- package/dist/models/get-exceeding-credit-response-class.js +15 -0
- package/dist/models/index.d.ts +22 -1
- package/dist/models/index.js +22 -1
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -0
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
- package/dist/models/list-exceeding-credits-response-class.d.ts +31 -0
- package/dist/models/list-exceeding-credits-response-class.js +15 -0
- package/dist/models/list-policy-payment-methods-response-class.d.ts +31 -0
- package/dist/models/list-policy-payment-methods-response-class.js +15 -0
- package/dist/models/mandate-dto.d.ts +43 -0
- package/dist/models/mandate-dto.js +15 -0
- package/dist/models/mandate-hash-data-dto.d.ts +42 -0
- package/dist/models/mandate-hash-data-dto.js +15 -0
- package/dist/models/mandate-reference-class.d.ts +90 -0
- package/dist/models/mandate-reference-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/policy-payment-method-class.d.ts +86 -0
- package/dist/models/policy-payment-method-class.js +15 -0
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +30 -0
- package/dist/models/tenant-bank-account-class.d.ts +30 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +18 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +12 -12
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +30 -0
- package/models/activate-policy-payment-method-request-dto.ts +30 -0
- package/models/bank-order-class.ts +23 -3
- package/models/bank-order-xml-file-class.ts +78 -0
- package/models/bank-transaction-class-without-expand-properties.ts +21 -18
- package/models/bank-transaction-class.ts +25 -22
- package/models/bank-transaction-invoice-class.ts +66 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +66 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +9 -9
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-policy-payment-method-request-dto.ts +36 -0
- package/models/create-policy-payment-method-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +30 -2
- package/models/create-tenant-bank-account-request-dto.ts +30 -0
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/eis-sepa-debit-dto.ts +61 -0
- package/models/exceeding-credit-class.ts +125 -0
- package/models/financial-account-class.ts +120 -0
- package/models/get-exceeding-credit-response-class.ts +31 -0
- package/models/index.ts +22 -1
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-exceeding-credits-response-class.ts +37 -0
- package/models/list-policy-payment-methods-response-class.ts +37 -0
- package/models/mandate-dto.ts +49 -0
- package/models/mandate-hash-data-dto.ts +48 -0
- package/models/mandate-reference-class.ts +96 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/policy-payment-method-class.ts +92 -0
- package/models/refund-class.ts +7 -1
- package/models/tenant-bank-account-class-without-expand-properties.ts +30 -0
- package/models/tenant-bank-account-class.ts +30 -0
- package/models/unlinked-bank-transaction-response-class.ts +21 -0
- package/models/update-bank-order-request-dto.ts +12 -12
- package/models/update-tenant-bank-account-rest-request-dto.ts +30 -0
- package/package.json +1 -1
- package/tsconfig.json +0 -1
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → activate-policy-payment-method-request-dto.js} +0 -0
|
@@ -16,6 +16,7 @@ import { CreateBankOrderRequestDto } from '../models';
|
|
|
16
16
|
import { CreateBankOrderResponseClass } from '../models';
|
|
17
17
|
import { GetBankOrderResponseClass } from '../models';
|
|
18
18
|
import { ListBankOrdersResponseClass } from '../models';
|
|
19
|
+
import { UpdateBankOrderRequestDto } from '../models';
|
|
19
20
|
import { UpdateBankOrderResponseClass } from '../models';
|
|
20
21
|
/**
|
|
21
22
|
* BankOrdersApi - axios parameter creator
|
|
@@ -23,7 +24,7 @@ import { UpdateBankOrderResponseClass } from '../models';
|
|
|
23
24
|
*/
|
|
24
25
|
export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
26
|
/**
|
|
26
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-
|
|
27
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financial-accounts.view\", \"billing-management.invoices.view\"
|
|
27
28
|
* @summary Create the bank order
|
|
28
29
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
29
30
|
* @param {string} [authorization] Bearer Token
|
|
@@ -32,7 +33,7 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
32
33
|
*/
|
|
33
34
|
createBankOrder: (createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
35
|
/**
|
|
35
|
-
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-
|
|
36
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
36
37
|
* @summary Delete the bank order
|
|
37
38
|
* @param {string} code Unique identifier for the object.
|
|
38
39
|
* @param {string} [authorization] Bearer Token
|
|
@@ -41,35 +42,40 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
41
42
|
*/
|
|
42
43
|
deleteBankOrder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
44
|
/**
|
|
44
|
-
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-
|
|
45
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
45
46
|
* @summary Retrieve the bank order
|
|
46
47
|
* @param {string} code
|
|
47
48
|
* @param {string} [authorization] Bearer Token
|
|
49
|
+
* @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: financialAccount, xmlFile<i>
|
|
48
50
|
* @param {*} [options] Override http request option.
|
|
49
51
|
* @throws {RequiredError}
|
|
50
52
|
*/
|
|
51
|
-
getBankOrder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
|
+
getBankOrder: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
54
|
/**
|
|
53
|
-
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-
|
|
55
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
54
56
|
* @summary List bank orders
|
|
55
57
|
* @param {string} [authorization] Bearer Token
|
|
56
|
-
* @param {
|
|
57
|
-
* @param {string} [
|
|
58
|
-
* @param {string} [
|
|
59
|
-
* @param {string} [
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
61
|
+
* @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: code, description, orderNumber, financialAccountCode</i>
|
|
62
|
+
* @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, executionDate, dueDate, orderNumber, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
63
|
+
* @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: financialAccount, xmlFile<i>
|
|
64
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
60
65
|
* @param {*} [options] Override http request option.
|
|
61
66
|
* @throws {RequiredError}
|
|
62
67
|
*/
|
|
63
|
-
listBankOrders: (authorization?: string, filter?: string,
|
|
68
|
+
listBankOrders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
69
|
/**
|
|
65
|
-
* Update a bank order by code **Required Permissions** \"payment-management.bank-
|
|
70
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
66
71
|
* @summary Update the bank order
|
|
67
72
|
* @param {string} code Unique identifier for the object.
|
|
73
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
68
74
|
* @param {string} [authorization] Bearer Token
|
|
69
75
|
* @param {*} [options] Override http request option.
|
|
70
76
|
* @throws {RequiredError}
|
|
71
77
|
*/
|
|
72
|
-
updateBankOrder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
updateBankOrder: (code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
79
|
};
|
|
74
80
|
/**
|
|
75
81
|
* BankOrdersApi - functional programming interface
|
|
@@ -77,7 +83,7 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
77
83
|
*/
|
|
78
84
|
export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
79
85
|
/**
|
|
80
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-
|
|
86
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financial-accounts.view\", \"billing-management.invoices.view\"
|
|
81
87
|
* @summary Create the bank order
|
|
82
88
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
83
89
|
* @param {string} [authorization] Bearer Token
|
|
@@ -86,7 +92,7 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
86
92
|
*/
|
|
87
93
|
createBankOrder(createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBankOrderResponseClass>>;
|
|
88
94
|
/**
|
|
89
|
-
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-
|
|
95
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
90
96
|
* @summary Delete the bank order
|
|
91
97
|
* @param {string} code Unique identifier for the object.
|
|
92
98
|
* @param {string} [authorization] Bearer Token
|
|
@@ -95,35 +101,40 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
95
101
|
*/
|
|
96
102
|
deleteBankOrder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
97
103
|
/**
|
|
98
|
-
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-
|
|
104
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
99
105
|
* @summary Retrieve the bank order
|
|
100
106
|
* @param {string} code
|
|
101
107
|
* @param {string} [authorization] Bearer Token
|
|
108
|
+
* @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: financialAccount, xmlFile<i>
|
|
102
109
|
* @param {*} [options] Override http request option.
|
|
103
110
|
* @throws {RequiredError}
|
|
104
111
|
*/
|
|
105
|
-
getBankOrder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderResponseClass>>;
|
|
112
|
+
getBankOrder(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderResponseClass>>;
|
|
106
113
|
/**
|
|
107
|
-
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-
|
|
114
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
108
115
|
* @summary List bank orders
|
|
109
116
|
* @param {string} [authorization] Bearer Token
|
|
110
|
-
* @param {
|
|
111
|
-
* @param {string} [
|
|
112
|
-
* @param {string} [
|
|
113
|
-
* @param {string} [
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @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.
|
|
119
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
120
|
+
* @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: code, description, orderNumber, financialAccountCode</i>
|
|
121
|
+
* @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, executionDate, dueDate, orderNumber, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
122
|
+
* @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: financialAccount, xmlFile<i>
|
|
123
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
114
124
|
* @param {*} [options] Override http request option.
|
|
115
125
|
* @throws {RequiredError}
|
|
116
126
|
*/
|
|
117
|
-
listBankOrders(authorization?: string, filter?: string,
|
|
127
|
+
listBankOrders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankOrdersResponseClass>>;
|
|
118
128
|
/**
|
|
119
|
-
* Update a bank order by code **Required Permissions** \"payment-management.bank-
|
|
129
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
120
130
|
* @summary Update the bank order
|
|
121
131
|
* @param {string} code Unique identifier for the object.
|
|
132
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
122
133
|
* @param {string} [authorization] Bearer Token
|
|
123
134
|
* @param {*} [options] Override http request option.
|
|
124
135
|
* @throws {RequiredError}
|
|
125
136
|
*/
|
|
126
|
-
updateBankOrder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBankOrderResponseClass>>;
|
|
137
|
+
updateBankOrder(code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBankOrderResponseClass>>;
|
|
127
138
|
};
|
|
128
139
|
/**
|
|
129
140
|
* BankOrdersApi - factory interface
|
|
@@ -131,7 +142,7 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
131
142
|
*/
|
|
132
143
|
export declare const BankOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
133
144
|
/**
|
|
134
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-
|
|
145
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financial-accounts.view\", \"billing-management.invoices.view\"
|
|
135
146
|
* @summary Create the bank order
|
|
136
147
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
137
148
|
* @param {string} [authorization] Bearer Token
|
|
@@ -140,7 +151,7 @@ export declare const BankOrdersApiFactory: (configuration?: Configuration, baseP
|
|
|
140
151
|
*/
|
|
141
152
|
createBankOrder(createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBankOrderResponseClass>;
|
|
142
153
|
/**
|
|
143
|
-
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-
|
|
154
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
144
155
|
* @summary Delete the bank order
|
|
145
156
|
* @param {string} code Unique identifier for the object.
|
|
146
157
|
* @param {string} [authorization] Bearer Token
|
|
@@ -149,35 +160,40 @@ export declare const BankOrdersApiFactory: (configuration?: Configuration, baseP
|
|
|
149
160
|
*/
|
|
150
161
|
deleteBankOrder(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
151
162
|
/**
|
|
152
|
-
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-
|
|
163
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
153
164
|
* @summary Retrieve the bank order
|
|
154
165
|
* @param {string} code
|
|
155
166
|
* @param {string} [authorization] Bearer Token
|
|
167
|
+
* @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: financialAccount, xmlFile<i>
|
|
156
168
|
* @param {*} [options] Override http request option.
|
|
157
169
|
* @throws {RequiredError}
|
|
158
170
|
*/
|
|
159
|
-
getBankOrder(code: string, authorization?: string, options?: any): AxiosPromise<GetBankOrderResponseClass>;
|
|
171
|
+
getBankOrder(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankOrderResponseClass>;
|
|
160
172
|
/**
|
|
161
|
-
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-
|
|
173
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
162
174
|
* @summary List bank orders
|
|
163
175
|
* @param {string} [authorization] Bearer Token
|
|
164
|
-
* @param {
|
|
165
|
-
* @param {string} [
|
|
166
|
-
* @param {string} [
|
|
167
|
-
* @param {string} [
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @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.
|
|
178
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
179
|
+
* @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: code, description, orderNumber, financialAccountCode</i>
|
|
180
|
+
* @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, executionDate, dueDate, orderNumber, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
181
|
+
* @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: financialAccount, xmlFile<i>
|
|
182
|
+
* @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, orderNumber, status, type, financialAccountCode</i>
|
|
168
183
|
* @param {*} [options] Override http request option.
|
|
169
184
|
* @throws {RequiredError}
|
|
170
185
|
*/
|
|
171
|
-
listBankOrders(authorization?: string, filter?: string,
|
|
186
|
+
listBankOrders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankOrdersResponseClass>;
|
|
172
187
|
/**
|
|
173
|
-
* Update a bank order by code **Required Permissions** \"payment-management.bank-
|
|
188
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
174
189
|
* @summary Update the bank order
|
|
175
190
|
* @param {string} code Unique identifier for the object.
|
|
191
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
176
192
|
* @param {string} [authorization] Bearer Token
|
|
177
193
|
* @param {*} [options] Override http request option.
|
|
178
194
|
* @throws {RequiredError}
|
|
179
195
|
*/
|
|
180
|
-
updateBankOrder(code: string, authorization?: string, options?: any): AxiosPromise<UpdateBankOrderResponseClass>;
|
|
196
|
+
updateBankOrder(code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBankOrderResponseClass>;
|
|
181
197
|
};
|
|
182
198
|
/**
|
|
183
199
|
* Request parameters for createBankOrder operation in BankOrdersApi.
|
|
@@ -235,6 +251,12 @@ export interface BankOrdersApiGetBankOrderRequest {
|
|
|
235
251
|
* @memberof BankOrdersApiGetBankOrder
|
|
236
252
|
*/
|
|
237
253
|
readonly authorization?: string;
|
|
254
|
+
/**
|
|
255
|
+
* 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: financialAccount, xmlFile<i>
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof BankOrdersApiGetBankOrder
|
|
258
|
+
*/
|
|
259
|
+
readonly expand?: string;
|
|
238
260
|
}
|
|
239
261
|
/**
|
|
240
262
|
* Request parameters for listBankOrders operation in BankOrdersApi.
|
|
@@ -249,29 +271,47 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
249
271
|
*/
|
|
250
272
|
readonly authorization?: string;
|
|
251
273
|
/**
|
|
252
|
-
*
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof BankOrdersApiListBankOrders
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* 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.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof BankOrdersApiListBankOrders
|
|
283
|
+
*/
|
|
284
|
+
readonly pageToken?: string;
|
|
285
|
+
/**
|
|
286
|
+
* 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, orderNumber, status, type, financialAccountCode</i>
|
|
253
287
|
* @type {string}
|
|
254
288
|
* @memberof BankOrdersApiListBankOrders
|
|
255
289
|
*/
|
|
256
290
|
readonly filter?: string;
|
|
257
291
|
/**
|
|
258
|
-
*
|
|
292
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, description, orderNumber, financialAccountCode</i>
|
|
259
293
|
* @type {string}
|
|
260
294
|
* @memberof BankOrdersApiListBankOrders
|
|
261
295
|
*/
|
|
262
|
-
readonly
|
|
296
|
+
readonly search?: string;
|
|
263
297
|
/**
|
|
264
|
-
* 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, executionDate, orderNumber,
|
|
298
|
+
* 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, executionDate, dueDate, orderNumber, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
265
299
|
* @type {string}
|
|
266
300
|
* @memberof BankOrdersApiListBankOrders
|
|
267
301
|
*/
|
|
268
302
|
readonly order?: string;
|
|
269
303
|
/**
|
|
270
|
-
* 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/>
|
|
304
|
+
* 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: financialAccount, xmlFile<i>
|
|
271
305
|
* @type {string}
|
|
272
306
|
* @memberof BankOrdersApiListBankOrders
|
|
273
307
|
*/
|
|
274
308
|
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* 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, orderNumber, status, type, financialAccountCode</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof BankOrdersApiListBankOrders
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
275
315
|
}
|
|
276
316
|
/**
|
|
277
317
|
* Request parameters for updateBankOrder operation in BankOrdersApi.
|
|
@@ -285,6 +325,12 @@ export interface BankOrdersApiUpdateBankOrderRequest {
|
|
|
285
325
|
* @memberof BankOrdersApiUpdateBankOrder
|
|
286
326
|
*/
|
|
287
327
|
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {UpdateBankOrderRequestDto}
|
|
331
|
+
* @memberof BankOrdersApiUpdateBankOrder
|
|
332
|
+
*/
|
|
333
|
+
readonly updateBankOrderRequestDto: UpdateBankOrderRequestDto;
|
|
288
334
|
/**
|
|
289
335
|
* Bearer Token
|
|
290
336
|
* @type {string}
|
|
@@ -300,7 +346,7 @@ export interface BankOrdersApiUpdateBankOrderRequest {
|
|
|
300
346
|
*/
|
|
301
347
|
export declare class BankOrdersApi extends BaseAPI {
|
|
302
348
|
/**
|
|
303
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-
|
|
349
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financial-accounts.view\", \"billing-management.invoices.view\"
|
|
304
350
|
* @summary Create the bank order
|
|
305
351
|
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
306
352
|
* @param {*} [options] Override http request option.
|
|
@@ -309,7 +355,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
309
355
|
*/
|
|
310
356
|
createBankOrder(requestParameters: BankOrdersApiCreateBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBankOrderResponseClass, any>>;
|
|
311
357
|
/**
|
|
312
|
-
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-
|
|
358
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
313
359
|
* @summary Delete the bank order
|
|
314
360
|
* @param {BankOrdersApiDeleteBankOrderRequest} requestParameters Request parameters.
|
|
315
361
|
* @param {*} [options] Override http request option.
|
|
@@ -318,7 +364,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
318
364
|
*/
|
|
319
365
|
deleteBankOrder(requestParameters: BankOrdersApiDeleteBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
320
366
|
/**
|
|
321
|
-
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-
|
|
367
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
322
368
|
* @summary Retrieve the bank order
|
|
323
369
|
* @param {BankOrdersApiGetBankOrderRequest} requestParameters Request parameters.
|
|
324
370
|
* @param {*} [options] Override http request option.
|
|
@@ -327,7 +373,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
327
373
|
*/
|
|
328
374
|
getBankOrder(requestParameters: BankOrdersApiGetBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankOrderResponseClass, any>>;
|
|
329
375
|
/**
|
|
330
|
-
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-
|
|
376
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
331
377
|
* @summary List bank orders
|
|
332
378
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
333
379
|
* @param {*} [options] Override http request option.
|
|
@@ -336,7 +382,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
336
382
|
*/
|
|
337
383
|
listBankOrders(requestParameters?: BankOrdersApiListBankOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankOrdersResponseClass, any>>;
|
|
338
384
|
/**
|
|
339
|
-
* Update a bank order by code **Required Permissions** \"payment-management.bank-
|
|
385
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
340
386
|
* @summary Update the bank order
|
|
341
387
|
* @param {BankOrdersApiUpdateBankOrderRequest} requestParameters Request parameters.
|
|
342
388
|
* @param {*} [options] Override http request option.
|