@finverse/sdk-typescript 0.0.94 → 0.0.96
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 +278 -44
- package/dist/api.js +144 -4
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -858,6 +858,47 @@ export interface CreatePayoutInstructionRequest {
|
|
|
858
858
|
*/
|
|
859
859
|
currency: string;
|
|
860
860
|
}
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @export
|
|
864
|
+
* @interface CreateRecipientAccount
|
|
865
|
+
*/
|
|
866
|
+
export interface CreateRecipientAccount {
|
|
867
|
+
/**
|
|
868
|
+
* Accountholder name of the recipient\'s account
|
|
869
|
+
* @type {string}
|
|
870
|
+
* @memberof CreateRecipientAccount
|
|
871
|
+
*/
|
|
872
|
+
accountholder_name: string;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {RecipientAccountNumber}
|
|
876
|
+
* @memberof CreateRecipientAccount
|
|
877
|
+
*/
|
|
878
|
+
account_number: RecipientAccountNumber;
|
|
879
|
+
/**
|
|
880
|
+
* Type of recipient account.
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof CreateRecipientAccount
|
|
883
|
+
*/
|
|
884
|
+
account_type: CreateRecipientAccountAccountTypeEnum;
|
|
885
|
+
/**
|
|
886
|
+
* List of currencies supported by the recipient account
|
|
887
|
+
* @type {Array<string>}
|
|
888
|
+
* @memberof CreateRecipientAccount
|
|
889
|
+
*/
|
|
890
|
+
currencies: Array<string>;
|
|
891
|
+
/**
|
|
892
|
+
* Finverse Institution ID for the recipient’s institution.
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof CreateRecipientAccount
|
|
895
|
+
*/
|
|
896
|
+
institution_id: string;
|
|
897
|
+
}
|
|
898
|
+
export declare const CreateRecipientAccountAccountTypeEnum: {
|
|
899
|
+
readonly ExternalAccount: "EXTERNAL_ACCOUNT";
|
|
900
|
+
};
|
|
901
|
+
export declare type CreateRecipientAccountAccountTypeEnum = typeof CreateRecipientAccountAccountTypeEnum[keyof typeof CreateRecipientAccountAccountTypeEnum];
|
|
861
902
|
/**
|
|
862
903
|
*
|
|
863
904
|
* @export
|
|
@@ -872,16 +913,16 @@ export interface CreateRecipientRequest {
|
|
|
872
913
|
name: string;
|
|
873
914
|
/**
|
|
874
915
|
*
|
|
875
|
-
* @type {
|
|
916
|
+
* @type {CreateRecipientAccount}
|
|
876
917
|
* @memberof CreateRecipientRequest
|
|
877
918
|
*/
|
|
878
|
-
recipient_account:
|
|
919
|
+
recipient_account: CreateRecipientAccount;
|
|
879
920
|
/**
|
|
880
921
|
* Customer App\'s internal ID for the recipient
|
|
881
922
|
* @type {string}
|
|
882
923
|
* @memberof CreateRecipientRequest
|
|
883
924
|
*/
|
|
884
|
-
user_id
|
|
925
|
+
user_id: string;
|
|
885
926
|
/**
|
|
886
927
|
* 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
928
|
* @type {{ [key: string]: string; }}
|
|
@@ -891,6 +932,56 @@ export interface CreateRecipientRequest {
|
|
|
891
932
|
[key: string]: string;
|
|
892
933
|
};
|
|
893
934
|
}
|
|
935
|
+
/**
|
|
936
|
+
*
|
|
937
|
+
* @export
|
|
938
|
+
* @interface CreateSenderRequest
|
|
939
|
+
*/
|
|
940
|
+
export interface CreateSenderRequest {
|
|
941
|
+
/**
|
|
942
|
+
* Sender’s name/nickname (note: this does not need to match the actual accountholder name of the sender’s account)
|
|
943
|
+
* @type {string}
|
|
944
|
+
* @memberof CreateSenderRequest
|
|
945
|
+
*/
|
|
946
|
+
name: string;
|
|
947
|
+
/**
|
|
948
|
+
* Customer App\'s internal ID for the sender
|
|
949
|
+
* @type {string}
|
|
950
|
+
* @memberof CreateSenderRequest
|
|
951
|
+
*/
|
|
952
|
+
user_id: string;
|
|
953
|
+
/**
|
|
954
|
+
* Sender details which will be used for fraud checking.
|
|
955
|
+
* @type {Array<SenderDetail>}
|
|
956
|
+
* @memberof CreateSenderRequest
|
|
957
|
+
*/
|
|
958
|
+
sender_details?: Array<SenderDetail>;
|
|
959
|
+
/**
|
|
960
|
+
* Customer reference for the sender
|
|
961
|
+
* @type {string}
|
|
962
|
+
* @memberof CreateSenderRequest
|
|
963
|
+
*/
|
|
964
|
+
sender_reference_id?: string;
|
|
965
|
+
/**
|
|
966
|
+
* Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS
|
|
967
|
+
* @type {string}
|
|
968
|
+
* @memberof CreateSenderRequest
|
|
969
|
+
*/
|
|
970
|
+
sender_type: CreateSenderRequestSenderTypeEnum;
|
|
971
|
+
/**
|
|
972
|
+
* Additional attributes of the sender in key:value format (e.g. employer_name: Apple Inc for a payroll case where sender is an employee)
|
|
973
|
+
* @type {{ [key: string]: string; }}
|
|
974
|
+
* @memberof CreateSenderRequest
|
|
975
|
+
*/
|
|
976
|
+
metadata?: {
|
|
977
|
+
[key: string]: string;
|
|
978
|
+
};
|
|
979
|
+
}
|
|
980
|
+
export declare const CreateSenderRequestSenderTypeEnum: {
|
|
981
|
+
readonly Individual: "INDIVIDUAL";
|
|
982
|
+
readonly Business: "BUSINESS";
|
|
983
|
+
};
|
|
984
|
+
export declare type CreateSenderRequestSenderTypeEnum = typeof CreateSenderRequestSenderTypeEnum[keyof typeof CreateSenderRequestSenderTypeEnum];
|
|
894
985
|
/**
|
|
895
986
|
*
|
|
896
987
|
* @export
|
|
@@ -3839,74 +3930,75 @@ export interface ProductStatus {
|
|
|
3839
3930
|
/**
|
|
3840
3931
|
*
|
|
3841
3932
|
* @export
|
|
3842
|
-
* @interface
|
|
3933
|
+
* @interface RecipientAccountNumber
|
|
3843
3934
|
*/
|
|
3844
|
-
export interface
|
|
3935
|
+
export interface RecipientAccountNumber {
|
|
3936
|
+
/**
|
|
3937
|
+
* Type of account number. Possible values: LOCAL, IBAN
|
|
3938
|
+
* @type {string}
|
|
3939
|
+
* @memberof RecipientAccountNumber
|
|
3940
|
+
*/
|
|
3941
|
+
type: RecipientAccountNumberTypeEnum;
|
|
3942
|
+
/**
|
|
3943
|
+
* Account number value
|
|
3944
|
+
* @type {string}
|
|
3945
|
+
* @memberof RecipientAccountNumber
|
|
3946
|
+
*/
|
|
3947
|
+
number: string;
|
|
3948
|
+
}
|
|
3949
|
+
export declare const RecipientAccountNumberTypeEnum: {
|
|
3950
|
+
readonly Local: "LOCAL";
|
|
3951
|
+
readonly Iban: "IBAN";
|
|
3952
|
+
};
|
|
3953
|
+
export declare type RecipientAccountNumberTypeEnum = typeof RecipientAccountNumberTypeEnum[keyof typeof RecipientAccountNumberTypeEnum];
|
|
3954
|
+
/**
|
|
3955
|
+
*
|
|
3956
|
+
* @export
|
|
3957
|
+
* @interface RecipientAccountResponse
|
|
3958
|
+
*/
|
|
3959
|
+
export interface RecipientAccountResponse {
|
|
3845
3960
|
/**
|
|
3846
3961
|
* A unique identifier generated after creating recipient
|
|
3847
3962
|
* @type {string}
|
|
3848
|
-
* @memberof
|
|
3963
|
+
* @memberof RecipientAccountResponse
|
|
3849
3964
|
*/
|
|
3850
3965
|
recipient_account_id?: string;
|
|
3851
3966
|
/**
|
|
3852
3967
|
* Accountholder name of the recipient\'s account
|
|
3853
3968
|
* @type {string}
|
|
3854
|
-
* @memberof
|
|
3969
|
+
* @memberof RecipientAccountResponse
|
|
3855
3970
|
*/
|
|
3856
|
-
accountholder_name
|
|
3971
|
+
accountholder_name?: string;
|
|
3857
3972
|
/**
|
|
3858
3973
|
*
|
|
3859
3974
|
* @type {RecipientAccountNumber}
|
|
3860
|
-
* @memberof
|
|
3975
|
+
* @memberof RecipientAccountResponse
|
|
3861
3976
|
*/
|
|
3862
|
-
account_number
|
|
3977
|
+
account_number?: RecipientAccountNumber;
|
|
3863
3978
|
/**
|
|
3864
3979
|
* Type of recipient account.
|
|
3865
3980
|
* @type {string}
|
|
3866
|
-
* @memberof
|
|
3981
|
+
* @memberof RecipientAccountResponse
|
|
3867
3982
|
*/
|
|
3868
|
-
account_type
|
|
3983
|
+
account_type?: RecipientAccountResponseAccountTypeEnum;
|
|
3869
3984
|
/**
|
|
3870
3985
|
* List of currencies supported by the recipient account
|
|
3871
3986
|
* @type {Array<string>}
|
|
3872
|
-
* @memberof
|
|
3987
|
+
* @memberof RecipientAccountResponse
|
|
3873
3988
|
*/
|
|
3874
|
-
currencies
|
|
3989
|
+
currencies?: Array<string>;
|
|
3875
3990
|
/**
|
|
3876
3991
|
* Finverse Institution ID for the recipient’s institution.
|
|
3877
3992
|
* @type {string}
|
|
3878
|
-
* @memberof
|
|
3993
|
+
* @memberof RecipientAccountResponse
|
|
3879
3994
|
*/
|
|
3880
|
-
institution_id
|
|
3995
|
+
institution_id?: string;
|
|
3881
3996
|
}
|
|
3882
|
-
export declare const
|
|
3997
|
+
export declare const RecipientAccountResponseAccountTypeEnum: {
|
|
3883
3998
|
readonly ExternalAccount: "EXTERNAL_ACCOUNT";
|
|
3999
|
+
readonly SettlementAccount: "SETTLEMENT_ACCOUNT";
|
|
3884
4000
|
};
|
|
3885
|
-
export declare type
|
|
3886
|
-
/**
|
|
3887
|
-
*
|
|
3888
|
-
* @export
|
|
3889
|
-
* @interface RecipientAccountNumber
|
|
3890
|
-
*/
|
|
3891
|
-
export interface RecipientAccountNumber {
|
|
3892
|
-
/**
|
|
3893
|
-
* Type of account number. Possible values: LOCAL, IBAN
|
|
3894
|
-
* @type {string}
|
|
3895
|
-
* @memberof RecipientAccountNumber
|
|
3896
|
-
*/
|
|
3897
|
-
type: RecipientAccountNumberTypeEnum;
|
|
3898
|
-
/**
|
|
3899
|
-
* Account number value
|
|
3900
|
-
* @type {string}
|
|
3901
|
-
* @memberof RecipientAccountNumber
|
|
3902
|
-
*/
|
|
3903
|
-
number: string;
|
|
3904
|
-
}
|
|
3905
|
-
export declare const RecipientAccountNumberTypeEnum: {
|
|
3906
|
-
readonly Local: "LOCAL";
|
|
3907
|
-
readonly Iban: "IBAN";
|
|
3908
|
-
};
|
|
3909
|
-
export declare type RecipientAccountNumberTypeEnum = typeof RecipientAccountNumberTypeEnum[keyof typeof RecipientAccountNumberTypeEnum];
|
|
4001
|
+
export declare type RecipientAccountResponseAccountTypeEnum = typeof RecipientAccountResponseAccountTypeEnum[keyof typeof RecipientAccountResponseAccountTypeEnum];
|
|
3910
4002
|
/**
|
|
3911
4003
|
*
|
|
3912
4004
|
* @export
|
|
@@ -3921,10 +4013,10 @@ export interface RecipientResponse {
|
|
|
3921
4013
|
name: string;
|
|
3922
4014
|
/**
|
|
3923
4015
|
*
|
|
3924
|
-
* @type {
|
|
4016
|
+
* @type {RecipientAccountResponse}
|
|
3925
4017
|
* @memberof RecipientResponse
|
|
3926
4018
|
*/
|
|
3927
|
-
recipient_account:
|
|
4019
|
+
recipient_account: RecipientAccountResponse;
|
|
3928
4020
|
/**
|
|
3929
4021
|
* Customer App\'s internal ID for the recipient
|
|
3930
4022
|
* @type {string}
|
|
@@ -4040,6 +4132,74 @@ export declare const SenderDetailDetailsTypeEnum: {
|
|
|
4040
4132
|
readonly HkCertificateOfIncorporation: "HK_CERTIFICATE_OF_INCORPORATION";
|
|
4041
4133
|
};
|
|
4042
4134
|
export declare type SenderDetailDetailsTypeEnum = typeof SenderDetailDetailsTypeEnum[keyof typeof SenderDetailDetailsTypeEnum];
|
|
4135
|
+
/**
|
|
4136
|
+
*
|
|
4137
|
+
* @export
|
|
4138
|
+
* @interface SenderResponse
|
|
4139
|
+
*/
|
|
4140
|
+
export interface SenderResponse {
|
|
4141
|
+
/**
|
|
4142
|
+
* A unique identifier generated after creating sender
|
|
4143
|
+
* @type {string}
|
|
4144
|
+
* @memberof SenderResponse
|
|
4145
|
+
*/
|
|
4146
|
+
sender_id?: string;
|
|
4147
|
+
/**
|
|
4148
|
+
* Customer App\'s internal ID for the sender
|
|
4149
|
+
* @type {string}
|
|
4150
|
+
* @memberof SenderResponse
|
|
4151
|
+
*/
|
|
4152
|
+
user_id?: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* Sender’s name/nickname (note: this does not need to match the actual accountholder name of the sender’s account)
|
|
4155
|
+
* @type {string}
|
|
4156
|
+
* @memberof SenderResponse
|
|
4157
|
+
*/
|
|
4158
|
+
name?: string;
|
|
4159
|
+
/**
|
|
4160
|
+
* Sender details which will be used for fraud checking.
|
|
4161
|
+
* @type {Array<SenderDetail>}
|
|
4162
|
+
* @memberof SenderResponse
|
|
4163
|
+
*/
|
|
4164
|
+
sender_details?: Array<SenderDetail>;
|
|
4165
|
+
/**
|
|
4166
|
+
* Customer reference for the sender
|
|
4167
|
+
* @type {string}
|
|
4168
|
+
* @memberof SenderResponse
|
|
4169
|
+
*/
|
|
4170
|
+
sender_reference_id?: string;
|
|
4171
|
+
/**
|
|
4172
|
+
* Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS
|
|
4173
|
+
* @type {string}
|
|
4174
|
+
* @memberof SenderResponse
|
|
4175
|
+
*/
|
|
4176
|
+
sender_type?: SenderResponseSenderTypeEnum;
|
|
4177
|
+
/**
|
|
4178
|
+
* Additional attributes of the sender in key:value format (e.g. employer_name: Apple Inc for a payroll case where sender is an employee)
|
|
4179
|
+
* @type {{ [key: string]: string; }}
|
|
4180
|
+
* @memberof SenderResponse
|
|
4181
|
+
*/
|
|
4182
|
+
metadata?: {
|
|
4183
|
+
[key: string]: string;
|
|
4184
|
+
};
|
|
4185
|
+
/**
|
|
4186
|
+
* Timestamp of when the sender was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
4187
|
+
* @type {string}
|
|
4188
|
+
* @memberof SenderResponse
|
|
4189
|
+
*/
|
|
4190
|
+
created_at?: string;
|
|
4191
|
+
/**
|
|
4192
|
+
* Timestamp of when the sender was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
4193
|
+
* @type {string}
|
|
4194
|
+
* @memberof SenderResponse
|
|
4195
|
+
*/
|
|
4196
|
+
updated_at?: string;
|
|
4197
|
+
}
|
|
4198
|
+
export declare const SenderResponseSenderTypeEnum: {
|
|
4199
|
+
readonly Individual: "INDIVIDUAL";
|
|
4200
|
+
readonly Business: "BUSINESS";
|
|
4201
|
+
};
|
|
4202
|
+
export declare type SenderResponseSenderTypeEnum = typeof SenderResponseSenderTypeEnum[keyof typeof SenderResponseSenderTypeEnum];
|
|
4043
4203
|
/**
|
|
4044
4204
|
*
|
|
4045
4205
|
* @export
|
|
@@ -4625,6 +4785,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4625
4785
|
* @throws {RequiredError}
|
|
4626
4786
|
*/
|
|
4627
4787
|
createRecipient: (createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4788
|
+
/**
|
|
4789
|
+
* Create Sender
|
|
4790
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
4791
|
+
* @param {*} [options] Override http request option.
|
|
4792
|
+
* @throws {RequiredError}
|
|
4793
|
+
*/
|
|
4794
|
+
createSender: (createSenderRequest: CreateSenderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4628
4795
|
/**
|
|
4629
4796
|
* Delete Recipient
|
|
4630
4797
|
* @param {string} recipientAccountId The institution id
|
|
@@ -4708,6 +4875,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4708
4875
|
* @throws {RequiredError}
|
|
4709
4876
|
*/
|
|
4710
4877
|
getRecipient: (recipientAccountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4878
|
+
/**
|
|
4879
|
+
* Get Sender
|
|
4880
|
+
* @param {string} senderId The sender id
|
|
4881
|
+
* @param {*} [options] Override http request option.
|
|
4882
|
+
* @throws {RequiredError}
|
|
4883
|
+
*/
|
|
4884
|
+
getSender: (senderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4711
4885
|
/**
|
|
4712
4886
|
* Get a list of institutions
|
|
4713
4887
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -4790,6 +4964,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
4790
4964
|
* @throws {RequiredError}
|
|
4791
4965
|
*/
|
|
4792
4966
|
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecipientResponse>>;
|
|
4967
|
+
/**
|
|
4968
|
+
* Create Sender
|
|
4969
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
4970
|
+
* @param {*} [options] Override http request option.
|
|
4971
|
+
* @throws {RequiredError}
|
|
4972
|
+
*/
|
|
4973
|
+
createSender(createSenderRequest: CreateSenderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SenderResponse>>;
|
|
4793
4974
|
/**
|
|
4794
4975
|
* Delete Recipient
|
|
4795
4976
|
* @param {string} recipientAccountId The institution id
|
|
@@ -4873,6 +5054,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
4873
5054
|
* @throws {RequiredError}
|
|
4874
5055
|
*/
|
|
4875
5056
|
getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecipientResponse>>;
|
|
5057
|
+
/**
|
|
5058
|
+
* Get Sender
|
|
5059
|
+
* @param {string} senderId The sender id
|
|
5060
|
+
* @param {*} [options] Override http request option.
|
|
5061
|
+
* @throws {RequiredError}
|
|
5062
|
+
*/
|
|
5063
|
+
getSender(senderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SenderResponse>>;
|
|
4876
5064
|
/**
|
|
4877
5065
|
* Get a list of institutions
|
|
4878
5066
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -4955,6 +5143,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
|
|
|
4955
5143
|
* @throws {RequiredError}
|
|
4956
5144
|
*/
|
|
4957
5145
|
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: any): AxiosPromise<RecipientResponse>;
|
|
5146
|
+
/**
|
|
5147
|
+
* Create Sender
|
|
5148
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
5149
|
+
* @param {*} [options] Override http request option.
|
|
5150
|
+
* @throws {RequiredError}
|
|
5151
|
+
*/
|
|
5152
|
+
createSender(createSenderRequest: CreateSenderRequest, options?: any): AxiosPromise<SenderResponse>;
|
|
4958
5153
|
/**
|
|
4959
5154
|
* Delete Recipient
|
|
4960
5155
|
* @param {string} recipientAccountId The institution id
|
|
@@ -5038,6 +5233,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
|
|
|
5038
5233
|
* @throws {RequiredError}
|
|
5039
5234
|
*/
|
|
5040
5235
|
getRecipient(recipientAccountId: string, options?: any): AxiosPromise<RecipientResponse>;
|
|
5236
|
+
/**
|
|
5237
|
+
* Get Sender
|
|
5238
|
+
* @param {string} senderId The sender id
|
|
5239
|
+
* @param {*} [options] Override http request option.
|
|
5240
|
+
* @throws {RequiredError}
|
|
5241
|
+
*/
|
|
5242
|
+
getSender(senderId: string, options?: any): AxiosPromise<SenderResponse>;
|
|
5041
5243
|
/**
|
|
5042
5244
|
* Get a list of institutions
|
|
5043
5245
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -5127,6 +5329,14 @@ export interface CustomerApiInterface {
|
|
|
5127
5329
|
* @memberof CustomerApiInterface
|
|
5128
5330
|
*/
|
|
5129
5331
|
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): AxiosPromise<RecipientResponse>;
|
|
5332
|
+
/**
|
|
5333
|
+
* Create Sender
|
|
5334
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
5335
|
+
* @param {*} [options] Override http request option.
|
|
5336
|
+
* @throws {RequiredError}
|
|
5337
|
+
* @memberof CustomerApiInterface
|
|
5338
|
+
*/
|
|
5339
|
+
createSender(createSenderRequest: CreateSenderRequest, options?: AxiosRequestConfig): AxiosPromise<SenderResponse>;
|
|
5130
5340
|
/**
|
|
5131
5341
|
* Delete Recipient
|
|
5132
5342
|
* @param {string} recipientAccountId The institution id
|
|
@@ -5222,6 +5432,14 @@ export interface CustomerApiInterface {
|
|
|
5222
5432
|
* @memberof CustomerApiInterface
|
|
5223
5433
|
*/
|
|
5224
5434
|
getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): AxiosPromise<RecipientResponse>;
|
|
5435
|
+
/**
|
|
5436
|
+
* Get Sender
|
|
5437
|
+
* @param {string} senderId The sender id
|
|
5438
|
+
* @param {*} [options] Override http request option.
|
|
5439
|
+
* @throws {RequiredError}
|
|
5440
|
+
* @memberof CustomerApiInterface
|
|
5441
|
+
*/
|
|
5442
|
+
getSender(senderId: string, options?: AxiosRequestConfig): AxiosPromise<SenderResponse>;
|
|
5225
5443
|
/**
|
|
5226
5444
|
* Get a list of institutions
|
|
5227
5445
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -5316,6 +5534,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
5316
5534
|
* @memberof CustomerApi
|
|
5317
5535
|
*/
|
|
5318
5536
|
createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecipientResponse>>;
|
|
5537
|
+
/**
|
|
5538
|
+
* Create Sender
|
|
5539
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
5540
|
+
* @param {*} [options] Override http request option.
|
|
5541
|
+
* @throws {RequiredError}
|
|
5542
|
+
* @memberof CustomerApi
|
|
5543
|
+
*/
|
|
5544
|
+
createSender(createSenderRequest: CreateSenderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SenderResponse>>;
|
|
5319
5545
|
/**
|
|
5320
5546
|
* Delete Recipient
|
|
5321
5547
|
* @param {string} recipientAccountId The institution id
|
|
@@ -5411,6 +5637,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
5411
5637
|
* @memberof CustomerApi
|
|
5412
5638
|
*/
|
|
5413
5639
|
getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecipientResponse>>;
|
|
5640
|
+
/**
|
|
5641
|
+
* Get Sender
|
|
5642
|
+
* @param {string} senderId The sender id
|
|
5643
|
+
* @param {*} [options] Override http request option.
|
|
5644
|
+
* @throws {RequiredError}
|
|
5645
|
+
* @memberof CustomerApi
|
|
5646
|
+
*/
|
|
5647
|
+
getSender(senderId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SenderResponse>>;
|
|
5414
5648
|
/**
|
|
5415
5649
|
* Get a list of institutions
|
|
5416
5650
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
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.
|
|
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.SenderResponseSenderTypeEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountResponseAccountTypeEnum = exports.RecipientAccountNumberTypeEnum = 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.CreateSenderRequestSenderTypeEnum = exports.CreateRecipientAccountAccountTypeEnum = 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
|
|
@@ -92,6 +92,13 @@ exports.CreatePaymentRequestTypeEnum = {
|
|
|
92
92
|
Mandate: 'MANDATE',
|
|
93
93
|
Single: 'SINGLE',
|
|
94
94
|
};
|
|
95
|
+
exports.CreateRecipientAccountAccountTypeEnum = {
|
|
96
|
+
ExternalAccount: 'EXTERNAL_ACCOUNT',
|
|
97
|
+
};
|
|
98
|
+
exports.CreateSenderRequestSenderTypeEnum = {
|
|
99
|
+
Individual: 'INDIVIDUAL',
|
|
100
|
+
Business: 'BUSINESS',
|
|
101
|
+
};
|
|
95
102
|
exports.CustomerPaymentInstructionTypeEnum = {
|
|
96
103
|
DebitAuthorization: 'DEBIT_AUTHORIZATION',
|
|
97
104
|
};
|
|
@@ -211,19 +218,24 @@ exports.PayoutInstructionResponseStatusEnum = {
|
|
|
211
218
|
Cancelled: 'CANCELLED',
|
|
212
219
|
Failed: 'FAILED',
|
|
213
220
|
};
|
|
214
|
-
exports.RecipientAccountAccountTypeEnum = {
|
|
215
|
-
ExternalAccount: 'EXTERNAL_ACCOUNT',
|
|
216
|
-
};
|
|
217
221
|
exports.RecipientAccountNumberTypeEnum = {
|
|
218
222
|
Local: 'LOCAL',
|
|
219
223
|
Iban: 'IBAN',
|
|
220
224
|
};
|
|
225
|
+
exports.RecipientAccountResponseAccountTypeEnum = {
|
|
226
|
+
ExternalAccount: 'EXTERNAL_ACCOUNT',
|
|
227
|
+
SettlementAccount: 'SETTLEMENT_ACCOUNT',
|
|
228
|
+
};
|
|
221
229
|
exports.SenderDetailDetailsTypeEnum = {
|
|
222
230
|
HkId: 'HK_ID',
|
|
223
231
|
Passport: 'PASSPORT',
|
|
224
232
|
HkBusinessRegistration: 'HK_BUSINESS_REGISTRATION',
|
|
225
233
|
HkCertificateOfIncorporation: 'HK_CERTIFICATE_OF_INCORPORATION',
|
|
226
234
|
};
|
|
235
|
+
exports.SenderResponseSenderTypeEnum = {
|
|
236
|
+
Individual: 'INDIVIDUAL',
|
|
237
|
+
Business: 'BUSINESS',
|
|
238
|
+
};
|
|
227
239
|
exports.SubmitAuthChecklistResponseMandateStatusEnum = {
|
|
228
240
|
Created: 'CREATED',
|
|
229
241
|
Processing: 'PROCESSING',
|
|
@@ -445,6 +457,38 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
|
|
|
445
457
|
options: localVarRequestOptions,
|
|
446
458
|
};
|
|
447
459
|
}),
|
|
460
|
+
/**
|
|
461
|
+
* Create Sender
|
|
462
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
*/
|
|
466
|
+
createSender: (createSenderRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
467
|
+
// verify required parameter 'createSenderRequest' is not null or undefined
|
|
468
|
+
common_1.assertParamExists('createSender', 'createSenderRequest', createSenderRequest);
|
|
469
|
+
const localVarPath = `/senders`;
|
|
470
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
471
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
472
|
+
let baseOptions;
|
|
473
|
+
if (configuration) {
|
|
474
|
+
baseOptions = configuration.baseOptions;
|
|
475
|
+
}
|
|
476
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
477
|
+
const localVarHeaderParameter = {};
|
|
478
|
+
const localVarQueryParameter = {};
|
|
479
|
+
// authentication Oauth2 required
|
|
480
|
+
// oauth required
|
|
481
|
+
yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
|
|
482
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
483
|
+
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
484
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
485
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
486
|
+
localVarRequestOptions.data = common_1.serializeDataIfNeeded(createSenderRequest, localVarRequestOptions, configuration);
|
|
487
|
+
return {
|
|
488
|
+
url: common_1.toPathString(localVarUrlObj),
|
|
489
|
+
options: localVarRequestOptions,
|
|
490
|
+
};
|
|
491
|
+
}),
|
|
448
492
|
/**
|
|
449
493
|
* Delete Recipient
|
|
450
494
|
* @param {string} recipientAccountId The institution id
|
|
@@ -806,6 +850,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
|
|
|
806
850
|
options: localVarRequestOptions,
|
|
807
851
|
};
|
|
808
852
|
}),
|
|
853
|
+
/**
|
|
854
|
+
* Get Sender
|
|
855
|
+
* @param {string} senderId The sender id
|
|
856
|
+
* @param {*} [options] Override http request option.
|
|
857
|
+
* @throws {RequiredError}
|
|
858
|
+
*/
|
|
859
|
+
getSender: (senderId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
860
|
+
// verify required parameter 'senderId' is not null or undefined
|
|
861
|
+
common_1.assertParamExists('getSender', 'senderId', senderId);
|
|
862
|
+
const localVarPath = `/senders/{senderId}`.replace(`{${'senderId'}}`, encodeURIComponent(String(senderId)));
|
|
863
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
864
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
865
|
+
let baseOptions;
|
|
866
|
+
if (configuration) {
|
|
867
|
+
baseOptions = configuration.baseOptions;
|
|
868
|
+
}
|
|
869
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
870
|
+
const localVarHeaderParameter = {};
|
|
871
|
+
const localVarQueryParameter = {};
|
|
872
|
+
// authentication Oauth2 required
|
|
873
|
+
// oauth required
|
|
874
|
+
yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
|
|
875
|
+
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
876
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
877
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
878
|
+
return {
|
|
879
|
+
url: common_1.toPathString(localVarUrlObj),
|
|
880
|
+
options: localVarRequestOptions,
|
|
881
|
+
};
|
|
882
|
+
}),
|
|
809
883
|
/**
|
|
810
884
|
* Get a list of institutions
|
|
811
885
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -1029,6 +1103,18 @@ exports.CustomerApiFp = function (configuration) {
|
|
|
1029
1103
|
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1030
1104
|
});
|
|
1031
1105
|
},
|
|
1106
|
+
/**
|
|
1107
|
+
* Create Sender
|
|
1108
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
1109
|
+
* @param {*} [options] Override http request option.
|
|
1110
|
+
* @throws {RequiredError}
|
|
1111
|
+
*/
|
|
1112
|
+
createSender(createSenderRequest, options) {
|
|
1113
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1114
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createSender(createSenderRequest, options);
|
|
1115
|
+
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1116
|
+
});
|
|
1117
|
+
},
|
|
1032
1118
|
/**
|
|
1033
1119
|
* Delete Recipient
|
|
1034
1120
|
* @param {string} recipientAccountId The institution id
|
|
@@ -1172,6 +1258,18 @@ exports.CustomerApiFp = function (configuration) {
|
|
|
1172
1258
|
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1173
1259
|
});
|
|
1174
1260
|
},
|
|
1261
|
+
/**
|
|
1262
|
+
* Get Sender
|
|
1263
|
+
* @param {string} senderId The sender id
|
|
1264
|
+
* @param {*} [options] Override http request option.
|
|
1265
|
+
* @throws {RequiredError}
|
|
1266
|
+
*/
|
|
1267
|
+
getSender(senderId, options) {
|
|
1268
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1269
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSender(senderId, options);
|
|
1270
|
+
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1271
|
+
});
|
|
1272
|
+
},
|
|
1175
1273
|
/**
|
|
1176
1274
|
* Get a list of institutions
|
|
1177
1275
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -1299,6 +1397,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
|
|
|
1299
1397
|
createRecipient(createRecipientRequest, options) {
|
|
1300
1398
|
return localVarFp.createRecipient(createRecipientRequest, options).then((request) => request(axios, basePath));
|
|
1301
1399
|
},
|
|
1400
|
+
/**
|
|
1401
|
+
* Create Sender
|
|
1402
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
1403
|
+
* @param {*} [options] Override http request option.
|
|
1404
|
+
* @throws {RequiredError}
|
|
1405
|
+
*/
|
|
1406
|
+
createSender(createSenderRequest, options) {
|
|
1407
|
+
return localVarFp.createSender(createSenderRequest, options).then((request) => request(axios, basePath));
|
|
1408
|
+
},
|
|
1302
1409
|
/**
|
|
1303
1410
|
* Delete Recipient
|
|
1304
1411
|
* @param {string} recipientAccountId The institution id
|
|
@@ -1410,6 +1517,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
|
|
|
1410
1517
|
getRecipient(recipientAccountId, options) {
|
|
1411
1518
|
return localVarFp.getRecipient(recipientAccountId, options).then((request) => request(axios, basePath));
|
|
1412
1519
|
},
|
|
1520
|
+
/**
|
|
1521
|
+
* Get Sender
|
|
1522
|
+
* @param {string} senderId The sender id
|
|
1523
|
+
* @param {*} [options] Override http request option.
|
|
1524
|
+
* @throws {RequiredError}
|
|
1525
|
+
*/
|
|
1526
|
+
getSender(senderId, options) {
|
|
1527
|
+
return localVarFp.getSender(senderId, options).then((request) => request(axios, basePath));
|
|
1528
|
+
},
|
|
1413
1529
|
/**
|
|
1414
1530
|
* Get a list of institutions
|
|
1415
1531
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|
|
@@ -1537,6 +1653,18 @@ class CustomerApi extends base_1.BaseAPI {
|
|
|
1537
1653
|
.createRecipient(createRecipientRequest, options)
|
|
1538
1654
|
.then((request) => request(this.axios, this.basePath));
|
|
1539
1655
|
}
|
|
1656
|
+
/**
|
|
1657
|
+
* Create Sender
|
|
1658
|
+
* @param {CreateSenderRequest} createSenderRequest request body for creating sender
|
|
1659
|
+
* @param {*} [options] Override http request option.
|
|
1660
|
+
* @throws {RequiredError}
|
|
1661
|
+
* @memberof CustomerApi
|
|
1662
|
+
*/
|
|
1663
|
+
createSender(createSenderRequest, options) {
|
|
1664
|
+
return exports.CustomerApiFp(this.configuration)
|
|
1665
|
+
.createSender(createSenderRequest, options)
|
|
1666
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1667
|
+
}
|
|
1540
1668
|
/**
|
|
1541
1669
|
* Delete Recipient
|
|
1542
1670
|
* @param {string} recipientAccountId The institution id
|
|
@@ -1680,6 +1808,18 @@ class CustomerApi extends base_1.BaseAPI {
|
|
|
1680
1808
|
.getRecipient(recipientAccountId, options)
|
|
1681
1809
|
.then((request) => request(this.axios, this.basePath));
|
|
1682
1810
|
}
|
|
1811
|
+
/**
|
|
1812
|
+
* Get Sender
|
|
1813
|
+
* @param {string} senderId The sender id
|
|
1814
|
+
* @param {*} [options] Override http request option.
|
|
1815
|
+
* @throws {RequiredError}
|
|
1816
|
+
* @memberof CustomerApi
|
|
1817
|
+
*/
|
|
1818
|
+
getSender(senderId, options) {
|
|
1819
|
+
return exports.CustomerApiFp(this.configuration)
|
|
1820
|
+
.getSender(senderId, options)
|
|
1821
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1822
|
+
}
|
|
1683
1823
|
/**
|
|
1684
1824
|
* Get a list of institutions
|
|
1685
1825
|
* @param {string} [country] (Deprecated) The country the institution belongs to
|