@finverse/sdk-typescript 0.0.83 → 0.0.85
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/dist/api.d.ts +296 -0
- package/dist/api.js +154 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -815,6 +815,125 @@ export declare const CreatePaymentRequestTypeEnum: {
|
|
|
815
815
|
readonly Single: "SINGLE";
|
|
816
816
|
};
|
|
817
817
|
export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @export
|
|
821
|
+
* @interface CreatePayoutInstructionRequest
|
|
822
|
+
*/
|
|
823
|
+
export interface CreatePayoutInstructionRequest {
|
|
824
|
+
/**
|
|
825
|
+
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof CreatePayoutInstructionRequest
|
|
828
|
+
*/
|
|
829
|
+
mandate_id: string;
|
|
830
|
+
/**
|
|
831
|
+
* The recipient account to receive the payment
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof CreatePayoutInstructionRequest
|
|
834
|
+
*/
|
|
835
|
+
recipient_account_id: string;
|
|
836
|
+
/**
|
|
837
|
+
* Amount to be paid, in currency\'s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
|
|
838
|
+
* @type {number}
|
|
839
|
+
* @memberof CreatePayoutInstructionRequest
|
|
840
|
+
*/
|
|
841
|
+
amount: number;
|
|
842
|
+
/**
|
|
843
|
+
* YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
|
|
844
|
+
* @type {string}
|
|
845
|
+
* @memberof CreatePayoutInstructionRequest
|
|
846
|
+
*/
|
|
847
|
+
date: string;
|
|
848
|
+
/**
|
|
849
|
+
* A description for the payment (that will appear as the transaction description on bank statements)
|
|
850
|
+
* @type {string}
|
|
851
|
+
* @memberof CreatePayoutInstructionRequest
|
|
852
|
+
*/
|
|
853
|
+
description?: string;
|
|
854
|
+
/**
|
|
855
|
+
* The currency code as defined in ISO 4217.
|
|
856
|
+
* @type {string}
|
|
857
|
+
* @memberof CreatePayoutInstructionRequest
|
|
858
|
+
*/
|
|
859
|
+
currency: string;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @export
|
|
864
|
+
* @interface CreateRecipientRequest
|
|
865
|
+
*/
|
|
866
|
+
export interface CreateRecipientRequest {
|
|
867
|
+
/**
|
|
868
|
+
* Recipient\'s name/nickname (note: this does not need to match the actual accountholder name of the recipient\'s account)
|
|
869
|
+
* @type {string}
|
|
870
|
+
* @memberof CreateRecipientRequest
|
|
871
|
+
*/
|
|
872
|
+
name: string;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {RecipientAccount}
|
|
876
|
+
* @memberof CreateRecipientRequest
|
|
877
|
+
*/
|
|
878
|
+
recipient_account: RecipientAccount;
|
|
879
|
+
/**
|
|
880
|
+
* Customer App\'s internal ID for the recipient
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof CreateRecipientRequest
|
|
883
|
+
*/
|
|
884
|
+
user_id?: string;
|
|
885
|
+
/**
|
|
886
|
+
* Additional attributes of the recipient in key:value format (e.g. employer_name: Apple Inc for a payroll case where recipient is an employee)
|
|
887
|
+
* @type {{ [key: string]: string; }}
|
|
888
|
+
* @memberof CreateRecipientRequest
|
|
889
|
+
*/
|
|
890
|
+
metadata?: {
|
|
891
|
+
[key: string]: string;
|
|
892
|
+
};
|
|
893
|
+
}
|
|
894
|
+
/**
|
|
895
|
+
*
|
|
896
|
+
* @export
|
|
897
|
+
* @interface CreateRecipientResponse
|
|
898
|
+
*/
|
|
899
|
+
export interface CreateRecipientResponse {
|
|
900
|
+
/**
|
|
901
|
+
* A unique identifier generated after creating recipient
|
|
902
|
+
* @type {string}
|
|
903
|
+
* @memberof CreateRecipientResponse
|
|
904
|
+
*/
|
|
905
|
+
recipient_account_id?: string;
|
|
906
|
+
/**
|
|
907
|
+
* Recipient\'s name/nickname (note: this does not need to match the actual accountholder name of the recipient\'s account)
|
|
908
|
+
* @type {string}
|
|
909
|
+
* @memberof CreateRecipientResponse
|
|
910
|
+
*/
|
|
911
|
+
name: string;
|
|
912
|
+
/**
|
|
913
|
+
*
|
|
914
|
+
* @type {RecipientAccount}
|
|
915
|
+
* @memberof CreateRecipientResponse
|
|
916
|
+
*/
|
|
917
|
+
recipient_account: RecipientAccount;
|
|
918
|
+
/**
|
|
919
|
+
* Customer App\'s internal ID for the recipient
|
|
920
|
+
* @type {string}
|
|
921
|
+
* @memberof CreateRecipientResponse
|
|
922
|
+
*/
|
|
923
|
+
user_id?: string;
|
|
924
|
+
/**
|
|
925
|
+
* Additional attributes of the recipient in key:value format (e.g. employer_name: Apple Inc for a payroll case where recipient is an employee)
|
|
926
|
+
* @type {object}
|
|
927
|
+
* @memberof CreateRecipientResponse
|
|
928
|
+
*/
|
|
929
|
+
metadata?: object;
|
|
930
|
+
/**
|
|
931
|
+
* Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
932
|
+
* @type {string}
|
|
933
|
+
* @memberof CreateRecipientResponse
|
|
934
|
+
*/
|
|
935
|
+
last_update?: string;
|
|
936
|
+
}
|
|
818
937
|
/**
|
|
819
938
|
*
|
|
820
939
|
* @export
|
|
@@ -3587,6 +3706,39 @@ export declare const PaymentScheduleFrequencyEnum: {
|
|
|
3587
3706
|
readonly Yearly: "YEARLY";
|
|
3588
3707
|
};
|
|
3589
3708
|
export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequencyEnum[keyof typeof PaymentScheduleFrequencyEnum];
|
|
3709
|
+
/**
|
|
3710
|
+
*
|
|
3711
|
+
* @export
|
|
3712
|
+
* @interface PayoutInstructionResponse
|
|
3713
|
+
*/
|
|
3714
|
+
export interface PayoutInstructionResponse {
|
|
3715
|
+
/**
|
|
3716
|
+
* Finverse Payout Instruction ID
|
|
3717
|
+
* @type {string}
|
|
3718
|
+
* @memberof PayoutInstructionResponse
|
|
3719
|
+
*/
|
|
3720
|
+
payout_instruction_id: string;
|
|
3721
|
+
/**
|
|
3722
|
+
* Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
|
|
3723
|
+
* @type {string}
|
|
3724
|
+
* @memberof PayoutInstructionResponse
|
|
3725
|
+
*/
|
|
3726
|
+
status: PayoutInstructionResponseStatusEnum;
|
|
3727
|
+
/**
|
|
3728
|
+
*
|
|
3729
|
+
* @type {FvErrorModel}
|
|
3730
|
+
* @memberof PayoutInstructionResponse
|
|
3731
|
+
*/
|
|
3732
|
+
error?: FvErrorModel;
|
|
3733
|
+
}
|
|
3734
|
+
export declare const PayoutInstructionResponseStatusEnum: {
|
|
3735
|
+
readonly Created: "CREATED";
|
|
3736
|
+
readonly Processing: "PROCESSING";
|
|
3737
|
+
readonly Executed: "EXECUTED";
|
|
3738
|
+
readonly Cancelled: "CANCELLED";
|
|
3739
|
+
readonly Failed: "FAILED";
|
|
3740
|
+
};
|
|
3741
|
+
export declare type PayoutInstructionResponseStatusEnum = typeof PayoutInstructionResponseStatusEnum[keyof typeof PayoutInstructionResponseStatusEnum];
|
|
3590
3742
|
/**
|
|
3591
3743
|
*
|
|
3592
3744
|
* @export
|
|
@@ -3685,6 +3837,71 @@ export interface ProductStatus {
|
|
|
3685
3837
|
*/
|
|
3686
3838
|
last_successful_update?: string | null;
|
|
3687
3839
|
}
|
|
3840
|
+
/**
|
|
3841
|
+
*
|
|
3842
|
+
* @export
|
|
3843
|
+
* @interface RecipientAccount
|
|
3844
|
+
*/
|
|
3845
|
+
export interface RecipientAccount {
|
|
3846
|
+
/**
|
|
3847
|
+
* Accountholder name of the recipient\'s account
|
|
3848
|
+
* @type {string}
|
|
3849
|
+
* @memberof RecipientAccount
|
|
3850
|
+
*/
|
|
3851
|
+
accountholder_name: string;
|
|
3852
|
+
/**
|
|
3853
|
+
*
|
|
3854
|
+
* @type {RecipientAccountNumber}
|
|
3855
|
+
* @memberof RecipientAccount
|
|
3856
|
+
*/
|
|
3857
|
+
account_number?: RecipientAccountNumber;
|
|
3858
|
+
/**
|
|
3859
|
+
* Type of recipient account.
|
|
3860
|
+
* @type {string}
|
|
3861
|
+
* @memberof RecipientAccount
|
|
3862
|
+
*/
|
|
3863
|
+
account_type: RecipientAccountAccountTypeEnum;
|
|
3864
|
+
/**
|
|
3865
|
+
* List of currencies supported by the recipient account
|
|
3866
|
+
* @type {Array<string>}
|
|
3867
|
+
* @memberof RecipientAccount
|
|
3868
|
+
*/
|
|
3869
|
+
currencies: Array<string>;
|
|
3870
|
+
/**
|
|
3871
|
+
* Finverse Institution ID for the recipient’s institution.
|
|
3872
|
+
* @type {string}
|
|
3873
|
+
* @memberof RecipientAccount
|
|
3874
|
+
*/
|
|
3875
|
+
institution_id: string;
|
|
3876
|
+
}
|
|
3877
|
+
export declare const RecipientAccountAccountTypeEnum: {
|
|
3878
|
+
readonly ExternalAccount: "EXTERNAL_ACCOUNT";
|
|
3879
|
+
};
|
|
3880
|
+
export declare type RecipientAccountAccountTypeEnum = typeof RecipientAccountAccountTypeEnum[keyof typeof RecipientAccountAccountTypeEnum];
|
|
3881
|
+
/**
|
|
3882
|
+
*
|
|
3883
|
+
* @export
|
|
3884
|
+
* @interface RecipientAccountNumber
|
|
3885
|
+
*/
|
|
3886
|
+
export interface RecipientAccountNumber {
|
|
3887
|
+
/**
|
|
3888
|
+
* Type of account number. Possible values: LOCAL, IBAN
|
|
3889
|
+
* @type {string}
|
|
3890
|
+
* @memberof RecipientAccountNumber
|
|
3891
|
+
*/
|
|
3892
|
+
type: RecipientAccountNumberTypeEnum;
|
|
3893
|
+
/**
|
|
3894
|
+
* Account number value
|
|
3895
|
+
* @type {string}
|
|
3896
|
+
* @memberof RecipientAccountNumber
|
|
3897
|
+
*/
|
|
3898
|
+
number: string;
|
|
3899
|
+
}
|
|
3900
|
+
export declare const RecipientAccountNumberTypeEnum: {
|
|
3901
|
+
readonly Local: "LOCAL";
|
|
3902
|
+
readonly Iban: "IBAN";
|
|
3903
|
+
};
|
|
3904
|
+
export declare type RecipientAccountNumberTypeEnum = typeof RecipientAccountNumberTypeEnum[keyof typeof RecipientAccountNumberTypeEnum];
|
|
3688
3905
|
/**
|
|
3689
3906
|
*
|
|
3690
3907
|
* @export
|
|
@@ -4338,6 +4555,21 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4338
4555
|
* @throws {RequiredError}
|
|
4339
4556
|
*/
|
|
4340
4557
|
createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4558
|
+
/**
|
|
4559
|
+
* Create new Payout instruction
|
|
4560
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
4561
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
4562
|
+
* @param {*} [options] Override http request option.
|
|
4563
|
+
* @throws {RequiredError}
|
|
4564
|
+
*/
|
|
4565
|
+
createPayoutInstruction: (createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4566
|
+
/**
|
|
4567
|
+
* Create Recipients
|
|
4568
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
4569
|
+
* @param {*} [options] Override http request option.
|
|
4570
|
+
* @throws {RequiredError}
|
|
4571
|
+
*/
|
|
4572
|
+
createRecipient: (createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4341
4573
|
/**
|
|
4342
4574
|
* generate a link token that can be used to create link
|
|
4343
4575
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -4460,6 +4692,21 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
4460
4692
|
* @throws {RequiredError}
|
|
4461
4693
|
*/
|
|
4462
4694
|
createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
|
|
4695
|
+
/**
|
|
4696
|
+
* Create new Payout instruction
|
|
4697
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
4698
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
4699
|
+
* @param {*} [options] Override http request option.
|
|
4700
|
+
* @throws {RequiredError}
|
|
4701
|
+
*/
|
|
4702
|
+
createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
|
|
4703
|
+
/**
|
|
4704
|
+
* Create Recipients
|
|
4705
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
4706
|
+
* @param {*} [options] Override http request option.
|
|
4707
|
+
* @throws {RequiredError}
|
|
4708
|
+
*/
|
|
4709
|
+
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRecipientResponse>>;
|
|
4463
4710
|
/**
|
|
4464
4711
|
* generate a link token that can be used to create link
|
|
4465
4712
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -4582,6 +4829,21 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
|
|
|
4582
4829
|
* @throws {RequiredError}
|
|
4583
4830
|
*/
|
|
4584
4831
|
createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
|
|
4832
|
+
/**
|
|
4833
|
+
* Create new Payout instruction
|
|
4834
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
4835
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
4836
|
+
* @param {*} [options] Override http request option.
|
|
4837
|
+
* @throws {RequiredError}
|
|
4838
|
+
*/
|
|
4839
|
+
createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
|
|
4840
|
+
/**
|
|
4841
|
+
* Create Recipients
|
|
4842
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
4843
|
+
* @param {*} [options] Override http request option.
|
|
4844
|
+
* @throws {RequiredError}
|
|
4845
|
+
*/
|
|
4846
|
+
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: any): AxiosPromise<CreateRecipientResponse>;
|
|
4585
4847
|
/**
|
|
4586
4848
|
* generate a link token that can be used to create link
|
|
4587
4849
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -4708,6 +4970,23 @@ export interface CustomerApiInterface {
|
|
|
4708
4970
|
* @memberof CustomerApiInterface
|
|
4709
4971
|
*/
|
|
4710
4972
|
createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
|
|
4973
|
+
/**
|
|
4974
|
+
* Create new Payout instruction
|
|
4975
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
4976
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
4977
|
+
* @param {*} [options] Override http request option.
|
|
4978
|
+
* @throws {RequiredError}
|
|
4979
|
+
* @memberof CustomerApiInterface
|
|
4980
|
+
*/
|
|
4981
|
+
createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
|
|
4982
|
+
/**
|
|
4983
|
+
* Create Recipients
|
|
4984
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
4985
|
+
* @param {*} [options] Override http request option.
|
|
4986
|
+
* @throws {RequiredError}
|
|
4987
|
+
* @memberof CustomerApiInterface
|
|
4988
|
+
*/
|
|
4989
|
+
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): AxiosPromise<CreateRecipientResponse>;
|
|
4711
4990
|
/**
|
|
4712
4991
|
* generate a link token that can be used to create link
|
|
4713
4992
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -4848,6 +5127,23 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
4848
5127
|
* @memberof CustomerApi
|
|
4849
5128
|
*/
|
|
4850
5129
|
createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
|
|
5130
|
+
/**
|
|
5131
|
+
* Create new Payout instruction
|
|
5132
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
5133
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
5134
|
+
* @param {*} [options] Override http request option.
|
|
5135
|
+
* @throws {RequiredError}
|
|
5136
|
+
* @memberof CustomerApi
|
|
5137
|
+
*/
|
|
5138
|
+
createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
|
|
5139
|
+
/**
|
|
5140
|
+
* Create Recipients
|
|
5141
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
5142
|
+
* @param {*} [options] Override http request option.
|
|
5143
|
+
* @throws {RequiredError}
|
|
5144
|
+
* @memberof CustomerApi
|
|
5145
|
+
*/
|
|
5146
|
+
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRecipientResponse>>;
|
|
4851
5147
|
/**
|
|
4852
5148
|
* generate a link token that can be used to create link
|
|
4853
5149
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
package/dist/api.js
CHANGED
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderSenderTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreateMandateSenderSenderTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
|
|
25
|
+
exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.RecipientAccountAccountTypeEnum = exports.PayoutInstructionResponseStatusEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderSenderTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreateMandateSenderSenderTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -204,6 +204,20 @@ exports.PaymentScheduleFrequencyEnum = {
|
|
|
204
204
|
Quarterly: 'QUARTERLY',
|
|
205
205
|
Yearly: 'YEARLY',
|
|
206
206
|
};
|
|
207
|
+
exports.PayoutInstructionResponseStatusEnum = {
|
|
208
|
+
Created: 'CREATED',
|
|
209
|
+
Processing: 'PROCESSING',
|
|
210
|
+
Executed: 'EXECUTED',
|
|
211
|
+
Cancelled: 'CANCELLED',
|
|
212
|
+
Failed: 'FAILED',
|
|
213
|
+
};
|
|
214
|
+
exports.RecipientAccountAccountTypeEnum = {
|
|
215
|
+
ExternalAccount: 'EXTERNAL_ACCOUNT',
|
|
216
|
+
};
|
|
217
|
+
exports.RecipientAccountNumberTypeEnum = {
|
|
218
|
+
Local: 'LOCAL',
|
|
219
|
+
Iban: 'IBAN',
|
|
220
|
+
};
|
|
207
221
|
exports.SenderDetailDetailsTypeEnum = {
|
|
208
222
|
HkId: 'HK_ID',
|
|
209
223
|
Passport: 'PASSPORT',
|
|
@@ -333,6 +347,74 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
|
|
|
333
347
|
options: localVarRequestOptions,
|
|
334
348
|
};
|
|
335
349
|
}),
|
|
350
|
+
/**
|
|
351
|
+
* Create new Payout instruction
|
|
352
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
353
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
createPayoutInstruction: (createPayoutInstructionRequest, idempotencyKey, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
358
|
+
// verify required parameter 'createPayoutInstructionRequest' is not null or undefined
|
|
359
|
+
common_1.assertParamExists('createPayoutInstruction', 'createPayoutInstructionRequest', createPayoutInstructionRequest);
|
|
360
|
+
const localVarPath = `/payout_instruction`;
|
|
361
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
362
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
363
|
+
let baseOptions;
|
|
364
|
+
if (configuration) {
|
|
365
|
+
baseOptions = configuration.baseOptions;
|
|
366
|
+
}
|
|
367
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
368
|
+
const localVarHeaderParameter = {};
|
|
369
|
+
const localVarQueryParameter = {};
|
|
370
|
+
// authentication Oauth2 required
|
|
371
|
+
// oauth required
|
|
372
|
+
yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
|
|
373
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null) {
|
|
374
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey);
|
|
375
|
+
}
|
|
376
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
377
|
+
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
379
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
380
|
+
localVarRequestOptions.data = common_1.serializeDataIfNeeded(createPayoutInstructionRequest, localVarRequestOptions, configuration);
|
|
381
|
+
return {
|
|
382
|
+
url: common_1.toPathString(localVarUrlObj),
|
|
383
|
+
options: localVarRequestOptions,
|
|
384
|
+
};
|
|
385
|
+
}),
|
|
386
|
+
/**
|
|
387
|
+
* Create Recipients
|
|
388
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
createRecipient: (createRecipientRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
393
|
+
// verify required parameter 'createRecipientRequest' is not null or undefined
|
|
394
|
+
common_1.assertParamExists('createRecipient', 'createRecipientRequest', createRecipientRequest);
|
|
395
|
+
const localVarPath = `/recipients`;
|
|
396
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
397
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
398
|
+
let baseOptions;
|
|
399
|
+
if (configuration) {
|
|
400
|
+
baseOptions = configuration.baseOptions;
|
|
401
|
+
}
|
|
402
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
403
|
+
const localVarHeaderParameter = {};
|
|
404
|
+
const localVarQueryParameter = {};
|
|
405
|
+
// authentication Oauth2 required
|
|
406
|
+
// oauth required
|
|
407
|
+
yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
|
|
408
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
409
|
+
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
410
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
411
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
412
|
+
localVarRequestOptions.data = common_1.serializeDataIfNeeded(createRecipientRequest, localVarRequestOptions, configuration);
|
|
413
|
+
return {
|
|
414
|
+
url: common_1.toPathString(localVarUrlObj),
|
|
415
|
+
options: localVarRequestOptions,
|
|
416
|
+
};
|
|
417
|
+
}),
|
|
336
418
|
/**
|
|
337
419
|
* generate a link token that can be used to create link
|
|
338
420
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -790,6 +872,31 @@ exports.CustomerApiFp = function (configuration) {
|
|
|
790
872
|
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
791
873
|
});
|
|
792
874
|
},
|
|
875
|
+
/**
|
|
876
|
+
* Create new Payout instruction
|
|
877
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
878
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
879
|
+
* @param {*} [options] Override http request option.
|
|
880
|
+
* @throws {RequiredError}
|
|
881
|
+
*/
|
|
882
|
+
createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
|
|
883
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
884
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options);
|
|
885
|
+
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
886
|
+
});
|
|
887
|
+
},
|
|
888
|
+
/**
|
|
889
|
+
* Create Recipients
|
|
890
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
createRecipient(createRecipientRequest, options) {
|
|
895
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
896
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createRecipient(createRecipientRequest, options);
|
|
897
|
+
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
898
|
+
});
|
|
899
|
+
},
|
|
793
900
|
/**
|
|
794
901
|
* generate a link token that can be used to create link
|
|
795
902
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -992,6 +1099,27 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
|
|
|
992
1099
|
.createPaymentInstruction(paymentInstruction, options)
|
|
993
1100
|
.then((request) => request(axios, basePath));
|
|
994
1101
|
},
|
|
1102
|
+
/**
|
|
1103
|
+
* Create new Payout instruction
|
|
1104
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
1105
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
*/
|
|
1109
|
+
createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
|
|
1110
|
+
return localVarFp
|
|
1111
|
+
.createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options)
|
|
1112
|
+
.then((request) => request(axios, basePath));
|
|
1113
|
+
},
|
|
1114
|
+
/**
|
|
1115
|
+
* Create Recipients
|
|
1116
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
1117
|
+
* @param {*} [options] Override http request option.
|
|
1118
|
+
* @throws {RequiredError}
|
|
1119
|
+
*/
|
|
1120
|
+
createRecipient(createRecipientRequest, options) {
|
|
1121
|
+
return localVarFp.createRecipient(createRecipientRequest, options).then((request) => request(axios, basePath));
|
|
1122
|
+
},
|
|
995
1123
|
/**
|
|
996
1124
|
* generate a link token that can be used to create link
|
|
997
1125
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
|
@@ -1166,6 +1294,31 @@ class CustomerApi extends base_1.BaseAPI {
|
|
|
1166
1294
|
.createPaymentInstruction(paymentInstruction, options)
|
|
1167
1295
|
.then((request) => request(this.axios, this.basePath));
|
|
1168
1296
|
}
|
|
1297
|
+
/**
|
|
1298
|
+
* Create new Payout instruction
|
|
1299
|
+
* @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
|
|
1300
|
+
* @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
|
|
1301
|
+
* @param {*} [options] Override http request option.
|
|
1302
|
+
* @throws {RequiredError}
|
|
1303
|
+
* @memberof CustomerApi
|
|
1304
|
+
*/
|
|
1305
|
+
createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
|
|
1306
|
+
return exports.CustomerApiFp(this.configuration)
|
|
1307
|
+
.createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options)
|
|
1308
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1309
|
+
}
|
|
1310
|
+
/**
|
|
1311
|
+
* Create Recipients
|
|
1312
|
+
* @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
|
|
1313
|
+
* @param {*} [options] Override http request option.
|
|
1314
|
+
* @throws {RequiredError}
|
|
1315
|
+
* @memberof CustomerApi
|
|
1316
|
+
*/
|
|
1317
|
+
createRecipient(createRecipientRequest, options) {
|
|
1318
|
+
return exports.CustomerApiFp(this.configuration)
|
|
1319
|
+
.createRecipient(createRecipientRequest, options)
|
|
1320
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1321
|
+
}
|
|
1169
1322
|
/**
|
|
1170
1323
|
* generate a link token that can be used to create link
|
|
1171
1324
|
* @param {LinkTokenRequest} linkTokenRequest token request
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@finverse/sdk-typescript",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.85",
|
|
4
4
|
"description": "OpenAPI client for @finverse/sdk-typescript",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"keywords": [
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@types/chai": "^4.3.4",
|
|
25
|
-
"@types/mocha": "^10.0.
|
|
25
|
+
"@types/mocha": "^10.0.1",
|
|
26
26
|
"@types/node": "^12.11.5",
|
|
27
27
|
"axios-mock-adapter": "^1.21.2",
|
|
28
28
|
"chai": "^4.3.7",
|