@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.4
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/README.md +2 -2
- package/api/bank-accounts-api.ts +24 -24
- package/api/bank-transaction-api.ts +20 -20
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-reminders-api.ts +30 -30
- package/api/payment-setup-api.ts +8 -8
- package/api/payments-api.ts +12 -12
- package/api/refunds-api.ts +12 -12
- package/api/webhooks-api.ts +4 -4
- package/dist/api/bank-accounts-api.d.ts +24 -24
- package/dist/api/bank-accounts-api.js +24 -24
- package/dist/api/bank-transaction-api.d.ts +20 -20
- package/dist/api/bank-transaction-api.js +20 -20
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +12 -12
- package/dist/api/payment-reminders-api.d.ts +26 -26
- package/dist/api/payment-reminders-api.js +25 -25
- package/dist/api/payment-setup-api.d.ts +8 -8
- package/dist/api/payment-setup-api.js +8 -8
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +12 -12
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +12 -12
- package/dist/api/webhooks-api.d.ts +4 -4
- package/dist/api/webhooks-api.js +4 -4
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
- package/dist/models/bank-transaction-class.d.ts +8 -2
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
- package/models/bank-transaction-class-without-expand-properties.ts +8 -2
- package/models/bank-transaction-class.ts +8 -2
- package/models/unlinked-bank-transaction-response-class.ts +8 -2
- package/package.json +1 -1
|
@@ -97,7 +97,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
100
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
101
101
|
* @summary Retrieve the bank transaction
|
|
102
102
|
* @param {string} code
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -149,7 +149,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
149
149
|
});
|
|
150
150
|
},
|
|
151
151
|
/**
|
|
152
|
-
* This will import bank transactions from a swift MT940 file
|
|
152
|
+
* This will import bank transactions from a swift MT940 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
153
153
|
* @summary Create the bank transactions
|
|
154
154
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
155
155
|
* @param {string} [authorization] Bearer Token
|
|
@@ -202,7 +202,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
202
202
|
});
|
|
203
203
|
},
|
|
204
204
|
/**
|
|
205
|
-
* Links a bank transaction with an invoice
|
|
205
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
206
206
|
* @summary Link bank transaction
|
|
207
207
|
* @param {string} code Code of the bank transaction to link
|
|
208
208
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -255,7 +255,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
});
|
|
256
256
|
},
|
|
257
257
|
/**
|
|
258
|
-
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
258
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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-accounts.view\"
|
|
259
259
|
* @summary List bank transactions
|
|
260
260
|
* @param {string} [authorization] Bearer Token
|
|
261
261
|
* @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, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
@@ -319,7 +319,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
319
319
|
});
|
|
320
320
|
},
|
|
321
321
|
/**
|
|
322
|
-
* Unlinks an already linked bank transaction
|
|
322
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
323
323
|
* @summary Unlink bank transaction
|
|
324
324
|
* @param {string} code Code of the bank transaction to unlink
|
|
325
325
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -382,7 +382,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
382
382
|
var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
|
|
383
383
|
return {
|
|
384
384
|
/**
|
|
385
|
-
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
385
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
386
386
|
* @summary Retrieve the bank transaction
|
|
387
387
|
* @param {string} code
|
|
388
388
|
* @param {string} [authorization] Bearer Token
|
|
@@ -404,7 +404,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
404
404
|
});
|
|
405
405
|
},
|
|
406
406
|
/**
|
|
407
|
-
* This will import bank transactions from a swift MT940 file
|
|
407
|
+
* This will import bank transactions from a swift MT940 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
408
408
|
* @summary Create the bank transactions
|
|
409
409
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
410
410
|
* @param {string} [authorization] Bearer Token
|
|
@@ -425,7 +425,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
425
425
|
});
|
|
426
426
|
},
|
|
427
427
|
/**
|
|
428
|
-
* Links a bank transaction with an invoice
|
|
428
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
429
429
|
* @summary Link bank transaction
|
|
430
430
|
* @param {string} code Code of the bank transaction to link
|
|
431
431
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -447,7 +447,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
447
447
|
});
|
|
448
448
|
},
|
|
449
449
|
/**
|
|
450
|
-
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
450
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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-accounts.view\"
|
|
451
451
|
* @summary List bank transactions
|
|
452
452
|
* @param {string} [authorization] Bearer Token
|
|
453
453
|
* @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, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
@@ -472,7 +472,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
472
472
|
});
|
|
473
473
|
},
|
|
474
474
|
/**
|
|
475
|
-
* Unlinks an already linked bank transaction
|
|
475
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
476
476
|
* @summary Unlink bank transaction
|
|
477
477
|
* @param {string} code Code of the bank transaction to unlink
|
|
478
478
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -504,7 +504,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
504
504
|
var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
|
|
505
505
|
return {
|
|
506
506
|
/**
|
|
507
|
-
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
507
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
508
508
|
* @summary Retrieve the bank transaction
|
|
509
509
|
* @param {string} code
|
|
510
510
|
* @param {string} [authorization] Bearer Token
|
|
@@ -516,7 +516,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
516
516
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
519
|
-
* This will import bank transactions from a swift MT940 file
|
|
519
|
+
* This will import bank transactions from a swift MT940 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
520
520
|
* @summary Create the bank transactions
|
|
521
521
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
522
522
|
* @param {string} [authorization] Bearer Token
|
|
@@ -527,7 +527,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
527
527
|
return localVarFp.importBankTransactions(file, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
528
528
|
},
|
|
529
529
|
/**
|
|
530
|
-
* Links a bank transaction with an invoice
|
|
530
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
531
531
|
* @summary Link bank transaction
|
|
532
532
|
* @param {string} code Code of the bank transaction to link
|
|
533
533
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -539,7 +539,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
539
539
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
540
540
|
},
|
|
541
541
|
/**
|
|
542
|
-
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
542
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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-accounts.view\"
|
|
543
543
|
* @summary List bank transactions
|
|
544
544
|
* @param {string} [authorization] Bearer Token
|
|
545
545
|
* @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, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
@@ -554,7 +554,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
554
554
|
return localVarFp.listBankTransactions(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
555
555
|
},
|
|
556
556
|
/**
|
|
557
|
-
* Unlinks an already linked bank transaction
|
|
557
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
558
558
|
* @summary Unlink bank transaction
|
|
559
559
|
* @param {string} code Code of the bank transaction to unlink
|
|
560
560
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -580,7 +580,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
580
580
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
581
581
|
}
|
|
582
582
|
/**
|
|
583
|
-
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
583
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
584
584
|
* @summary Retrieve the bank transaction
|
|
585
585
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
586
586
|
* @param {*} [options] Override http request option.
|
|
@@ -592,7 +592,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
592
592
|
return (0, exports.BankTransactionApiFp)(this.configuration).getBankTransaction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
593
593
|
};
|
|
594
594
|
/**
|
|
595
|
-
* This will import bank transactions from a swift MT940 file
|
|
595
|
+
* This will import bank transactions from a swift MT940 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
596
596
|
* @summary Create the bank transactions
|
|
597
597
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
598
598
|
* @param {*} [options] Override http request option.
|
|
@@ -604,7 +604,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
604
604
|
return (0, exports.BankTransactionApiFp)(this.configuration).importBankTransactions(requestParameters.file, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
605
605
|
};
|
|
606
606
|
/**
|
|
607
|
-
* Links a bank transaction with an invoice
|
|
607
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
608
608
|
* @summary Link bank transaction
|
|
609
609
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
610
610
|
* @param {*} [options] Override http request option.
|
|
@@ -616,7 +616,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
616
616
|
return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
617
617
|
};
|
|
618
618
|
/**
|
|
619
|
-
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
619
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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-accounts.view\"
|
|
620
620
|
* @summary List bank transactions
|
|
621
621
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
622
622
|
* @param {*} [options] Override http request option.
|
|
@@ -629,7 +629,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
629
629
|
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
630
630
|
};
|
|
631
631
|
/**
|
|
632
|
-
* Unlinks an already linked bank transaction
|
|
632
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
633
633
|
* @summary Unlink bank transaction
|
|
634
634
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
635
635
|
* @param {*} [options] Override http request option.
|
|
@@ -22,7 +22,7 @@ import { ListPaymentMethodsResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
25
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
26
26
|
* @summary Create the payment method
|
|
27
27
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
28
28
|
* @param {string} [authorization] Bearer Token
|
|
@@ -31,7 +31,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
31
31
|
*/
|
|
32
32
|
createPaymentMethod: (createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
34
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
35
35
|
* @summary Retrieve the payment method
|
|
36
36
|
* @param {string} code
|
|
37
37
|
* @param {string} [authorization] Bearer Token
|
|
@@ -40,7 +40,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
40
40
|
*/
|
|
41
41
|
getPaymentMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
43
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
44
44
|
* @summary List payment methods
|
|
45
45
|
* @param {string} [authorization] Bearer Token
|
|
46
46
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -58,7 +58,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
58
58
|
*/
|
|
59
59
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
60
60
|
/**
|
|
61
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
61
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
62
62
|
* @summary Create the payment method
|
|
63
63
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
64
64
|
* @param {string} [authorization] Bearer Token
|
|
@@ -67,7 +67,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
67
67
|
*/
|
|
68
68
|
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentMethodResponseClass>>;
|
|
69
69
|
/**
|
|
70
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
70
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
71
71
|
* @summary Retrieve the payment method
|
|
72
72
|
* @param {string} code
|
|
73
73
|
* @param {string} [authorization] Bearer Token
|
|
@@ -76,7 +76,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
76
76
|
*/
|
|
77
77
|
getPaymentMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodResponseClass>>;
|
|
78
78
|
/**
|
|
79
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
79
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
80
80
|
* @summary List payment methods
|
|
81
81
|
* @param {string} [authorization] Bearer Token
|
|
82
82
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -94,7 +94,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
94
94
|
*/
|
|
95
95
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
96
96
|
/**
|
|
97
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
97
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
98
98
|
* @summary Create the payment method
|
|
99
99
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
@@ -103,7 +103,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
103
103
|
*/
|
|
104
104
|
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentMethodResponseClass>;
|
|
105
105
|
/**
|
|
106
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
106
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
107
107
|
* @summary Retrieve the payment method
|
|
108
108
|
* @param {string} code
|
|
109
109
|
* @param {string} [authorization] Bearer Token
|
|
@@ -112,7 +112,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
112
112
|
*/
|
|
113
113
|
getPaymentMethod(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentMethodResponseClass>;
|
|
114
114
|
/**
|
|
115
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
115
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
116
116
|
* @summary List payment methods
|
|
117
117
|
* @param {string} [authorization] Bearer Token
|
|
118
118
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -207,7 +207,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
207
207
|
*/
|
|
208
208
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
209
209
|
/**
|
|
210
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
210
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
211
211
|
* @summary Create the payment method
|
|
212
212
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
213
213
|
* @param {*} [options] Override http request option.
|
|
@@ -216,7 +216,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
216
216
|
*/
|
|
217
217
|
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentMethodResponseClass, any>>;
|
|
218
218
|
/**
|
|
219
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
219
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
220
220
|
* @summary Retrieve the payment method
|
|
221
221
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
222
222
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +225,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
225
225
|
*/
|
|
226
226
|
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentMethodResponseClass, any>>;
|
|
227
227
|
/**
|
|
228
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
228
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
229
229
|
* @summary List payment methods
|
|
230
230
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
231
231
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
100
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
101
101
|
* @summary Create the payment method
|
|
102
102
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -146,7 +146,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
149
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
150
150
|
* @summary Retrieve the payment method
|
|
151
151
|
* @param {string} code
|
|
152
152
|
* @param {string} [authorization] Bearer Token
|
|
@@ -194,7 +194,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
},
|
|
196
196
|
/**
|
|
197
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
197
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
198
198
|
* @summary List payment methods
|
|
199
199
|
* @param {string} [authorization] Bearer Token
|
|
200
200
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -264,7 +264,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
264
264
|
var localVarAxiosParamCreator = (0, exports.PaymentMethodsApiAxiosParamCreator)(configuration);
|
|
265
265
|
return {
|
|
266
266
|
/**
|
|
267
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
267
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
268
268
|
* @summary Create the payment method
|
|
269
269
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
270
270
|
* @param {string} [authorization] Bearer Token
|
|
@@ -285,7 +285,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
285
285
|
});
|
|
286
286
|
},
|
|
287
287
|
/**
|
|
288
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
288
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
289
289
|
* @summary Retrieve the payment method
|
|
290
290
|
* @param {string} code
|
|
291
291
|
* @param {string} [authorization] Bearer Token
|
|
@@ -306,7 +306,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
306
306
|
});
|
|
307
307
|
},
|
|
308
308
|
/**
|
|
309
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
309
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
310
310
|
* @summary List payment methods
|
|
311
311
|
* @param {string} [authorization] Bearer Token
|
|
312
312
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -340,7 +340,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
340
340
|
var localVarFp = (0, exports.PaymentMethodsApiFp)(configuration);
|
|
341
341
|
return {
|
|
342
342
|
/**
|
|
343
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
343
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
344
344
|
* @summary Create the payment method
|
|
345
345
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
346
346
|
* @param {string} [authorization] Bearer Token
|
|
@@ -351,7 +351,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
351
351
|
return localVarFp.createPaymentMethod(createPspPaymentMethodRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
352
352
|
},
|
|
353
353
|
/**
|
|
354
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
354
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
355
355
|
* @summary Retrieve the payment method
|
|
356
356
|
* @param {string} code
|
|
357
357
|
* @param {string} [authorization] Bearer Token
|
|
@@ -362,7 +362,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
362
362
|
return localVarFp.getPaymentMethod(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
363
363
|
},
|
|
364
364
|
/**
|
|
365
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
365
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
366
366
|
* @summary List payment methods
|
|
367
367
|
* @param {string} [authorization] Bearer Token
|
|
368
368
|
* @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: code, id, pspCustomerId, psp, type, productSlug</i>
|
|
@@ -390,7 +390,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
390
390
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
391
391
|
}
|
|
392
392
|
/**
|
|
393
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
393
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
394
394
|
* @summary Create the payment method
|
|
395
395
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
396
396
|
* @param {*} [options] Override http request option.
|
|
@@ -402,7 +402,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
402
402
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).createPaymentMethod(requestParameters.createPspPaymentMethodRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
403
403
|
};
|
|
404
404
|
/**
|
|
405
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
405
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
406
406
|
* @summary Retrieve the payment method
|
|
407
407
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
408
408
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +414,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
414
414
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).getPaymentMethod(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
415
415
|
};
|
|
416
416
|
/**
|
|
417
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
417
|
+
* Returns a list of payment methods you have previously created. The payment methods 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\"
|
|
418
418
|
* @summary List payment methods
|
|
419
419
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
420
420
|
* @param {*} [options] Override http request option.
|
|
@@ -24,7 +24,7 @@ import { ListPaymentRemindersResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create a payment reminder in the database.
|
|
27
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
28
28
|
* @summary Create the payment reminder
|
|
29
29
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -33,7 +33,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
33
33
|
*/
|
|
34
34
|
createPaymentReminder: (createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* This will deactivate the payment reminder
|
|
36
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
37
37
|
* @summary Deactivate payment reminder
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -43,16 +43,16 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
43
43
|
*/
|
|
44
44
|
deactivatePaymentReminder: (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
46
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
47
47
|
* @summary Retrieve the payment reminder
|
|
48
48
|
* @param {string} code
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
getPaymentReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
55
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
56
56
|
* @summary List payment reminders
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @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: code, id, policyCode, nextReminderDate</i>
|
|
@@ -70,7 +70,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
70
70
|
*/
|
|
71
71
|
export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
72
72
|
/**
|
|
73
|
-
* This will create a payment reminder in the database.
|
|
73
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
74
74
|
* @summary Create the payment reminder
|
|
75
75
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
76
76
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -79,7 +79,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
79
79
|
*/
|
|
80
80
|
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentReminderResponseClass>>;
|
|
81
81
|
/**
|
|
82
|
-
* This will deactivate the payment reminder
|
|
82
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
83
83
|
* @summary Deactivate payment reminder
|
|
84
84
|
* @param {string} code Unique identifier for the object.
|
|
85
85
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -89,16 +89,16 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
89
89
|
*/
|
|
90
90
|
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeactivatePaymentReminderResponseClass>>;
|
|
91
91
|
/**
|
|
92
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
92
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
93
93
|
* @summary Retrieve the payment reminder
|
|
94
94
|
* @param {string} code
|
|
95
95
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
98
98
|
*/
|
|
99
|
-
|
|
99
|
+
getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>>;
|
|
100
100
|
/**
|
|
101
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
101
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
102
102
|
* @summary List payment reminders
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
104
|
* @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: code, id, policyCode, nextReminderDate</i>
|
|
@@ -116,7 +116,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
116
116
|
*/
|
|
117
117
|
export declare const PaymentRemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
118
118
|
/**
|
|
119
|
-
* This will create a payment reminder in the database.
|
|
119
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
120
120
|
* @summary Create the payment reminder
|
|
121
121
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
122
122
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -125,7 +125,7 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
125
125
|
*/
|
|
126
126
|
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentReminderResponseClass>;
|
|
127
127
|
/**
|
|
128
|
-
* This will deactivate the payment reminder
|
|
128
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
129
129
|
* @summary Deactivate payment reminder
|
|
130
130
|
* @param {string} code Unique identifier for the object.
|
|
131
131
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -135,16 +135,16 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
135
135
|
*/
|
|
136
136
|
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<DeactivatePaymentReminderResponseClass>;
|
|
137
137
|
/**
|
|
138
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
138
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
139
139
|
* @summary Retrieve the payment reminder
|
|
140
140
|
* @param {string} code
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
142
|
* @param {*} [options] Override http request option.
|
|
143
143
|
* @throws {RequiredError}
|
|
144
144
|
*/
|
|
145
|
-
|
|
145
|
+
getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass>;
|
|
146
146
|
/**
|
|
147
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
147
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
148
148
|
* @summary List payment reminders
|
|
149
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
150
|
* @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: code, id, policyCode, nextReminderDate</i>
|
|
@@ -201,21 +201,21 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
|
|
|
201
201
|
readonly authorization?: string;
|
|
202
202
|
}
|
|
203
203
|
/**
|
|
204
|
-
* Request parameters for
|
|
204
|
+
* Request parameters for getPaymentReminder operation in PaymentRemindersApi.
|
|
205
205
|
* @export
|
|
206
|
-
* @interface
|
|
206
|
+
* @interface PaymentRemindersApiGetPaymentReminderRequest
|
|
207
207
|
*/
|
|
208
|
-
export interface
|
|
208
|
+
export interface PaymentRemindersApiGetPaymentReminderRequest {
|
|
209
209
|
/**
|
|
210
210
|
*
|
|
211
211
|
* @type {string}
|
|
212
|
-
* @memberof
|
|
212
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
213
213
|
*/
|
|
214
214
|
readonly code: string;
|
|
215
215
|
/**
|
|
216
216
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
217
217
|
* @type {string}
|
|
218
|
-
* @memberof
|
|
218
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
219
219
|
*/
|
|
220
220
|
readonly authorization?: string;
|
|
221
221
|
}
|
|
@@ -264,7 +264,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
264
264
|
*/
|
|
265
265
|
export declare class PaymentRemindersApi extends BaseAPI {
|
|
266
266
|
/**
|
|
267
|
-
* This will create a payment reminder in the database.
|
|
267
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
268
268
|
* @summary Create the payment reminder
|
|
269
269
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
270
270
|
* @param {*} [options] Override http request option.
|
|
@@ -273,7 +273,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
|
|
|
273
273
|
*/
|
|
274
274
|
createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentReminderResponseClass, any>>;
|
|
275
275
|
/**
|
|
276
|
-
* This will deactivate the payment reminder
|
|
276
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
277
277
|
* @summary Deactivate payment reminder
|
|
278
278
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
@@ -282,16 +282,16 @@ export declare class PaymentRemindersApi extends BaseAPI {
|
|
|
282
282
|
*/
|
|
283
283
|
deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeactivatePaymentReminderResponseClass, any>>;
|
|
284
284
|
/**
|
|
285
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
285
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
286
286
|
* @summary Retrieve the payment reminder
|
|
287
|
-
* @param {
|
|
287
|
+
* @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
|
|
288
288
|
* @param {*} [options] Override http request option.
|
|
289
289
|
* @throws {RequiredError}
|
|
290
290
|
* @memberof PaymentRemindersApi
|
|
291
291
|
*/
|
|
292
|
-
|
|
292
|
+
getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentReminderResponseClass, any>>;
|
|
293
293
|
/**
|
|
294
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
294
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
295
295
|
* @summary List payment reminders
|
|
296
296
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
297
297
|
* @param {*} [options] Override http request option.
|