@orbis-systems/orbis-api-clients 0.7.12 → 0.7.14
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/aesmidas/index.d.ts +242 -142
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +350 -350
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +234 -234
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +64 -64
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +922 -922
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +307 -307
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +405 -405
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/zerohash/index.d.ts
CHANGED
|
@@ -77,6 +77,250 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
77
77
|
setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
|
|
78
78
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
79
|
}
|
|
80
|
+
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
81
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
83
|
+
/**
|
|
84
|
+
* @tags Transfers Relationships
|
|
85
|
+
* @name List
|
|
86
|
+
* @summary List
|
|
87
|
+
* @request GET:/transfer/relationship/list/{account}
|
|
88
|
+
* @secure
|
|
89
|
+
*/
|
|
90
|
+
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
91
|
+
/**
|
|
92
|
+
* @tags Transfers Relationships
|
|
93
|
+
* @name GetInfo
|
|
94
|
+
* @summary Get Info
|
|
95
|
+
* @request GET:/transfer/relationship/get
|
|
96
|
+
* @secure
|
|
97
|
+
*/
|
|
98
|
+
getInfo(query?: {
|
|
99
|
+
/**
|
|
100
|
+
* Account number
|
|
101
|
+
* @example "ABC123"
|
|
102
|
+
*/
|
|
103
|
+
account?: any;
|
|
104
|
+
/**
|
|
105
|
+
* Desired entry ID
|
|
106
|
+
* @example "123"
|
|
107
|
+
*/
|
|
108
|
+
entryId?: any;
|
|
109
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
110
|
+
/**
|
|
111
|
+
* @tags Transfers Relationships
|
|
112
|
+
* @name PaymentMethods
|
|
113
|
+
* @summary Payment methods
|
|
114
|
+
* @request GET:/transfer/bank/paymentMethods
|
|
115
|
+
* @secure
|
|
116
|
+
*/
|
|
117
|
+
paymentMethods(query?: {
|
|
118
|
+
/** @example "IND" */
|
|
119
|
+
country?: any;
|
|
120
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
121
|
+
/**
|
|
122
|
+
* @tags Transfers Relationships
|
|
123
|
+
* @name PaymentMethodsViaAddress
|
|
124
|
+
* @summary Payment methods (via address)
|
|
125
|
+
* @request POST:/transfer/bank/paymentMethods
|
|
126
|
+
* @secure
|
|
127
|
+
*/
|
|
128
|
+
paymentMethodsViaAddress(data: {
|
|
129
|
+
/** @example "Mumbai" */
|
|
130
|
+
city?: any;
|
|
131
|
+
/** @example "IND" */
|
|
132
|
+
country?: any;
|
|
133
|
+
/** @example "400018" */
|
|
134
|
+
postalCode?: any;
|
|
135
|
+
/** @example "Maharashtra" */
|
|
136
|
+
stateProvince?: any;
|
|
137
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
138
|
+
streetAddress?: any;
|
|
139
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
140
|
+
/**
|
|
141
|
+
* @tags Transfers Relationships
|
|
142
|
+
* @name BankCodes
|
|
143
|
+
* @summary Bank Codes
|
|
144
|
+
* @request GET:/transfer/bank/bankCodes
|
|
145
|
+
* @secure
|
|
146
|
+
*/
|
|
147
|
+
bankCodes(query?: {
|
|
148
|
+
/** @example "IND|MEX" */
|
|
149
|
+
country?: any;
|
|
150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
151
|
+
/**
|
|
152
|
+
* @tags Transfers Relationships
|
|
153
|
+
* @name BankCodesViaAddress
|
|
154
|
+
* @summary Bank Codes (via address)
|
|
155
|
+
* @request POST:/transfer/bank/bankCodes
|
|
156
|
+
* @secure
|
|
157
|
+
*/
|
|
158
|
+
bankCodesViaAddress(data: {
|
|
159
|
+
/** @example "Mumbai" */
|
|
160
|
+
city?: any;
|
|
161
|
+
/** @example "IND" */
|
|
162
|
+
country?: any;
|
|
163
|
+
/** @example "400018" */
|
|
164
|
+
postalCode?: any;
|
|
165
|
+
/** @example "Maharashtra" */
|
|
166
|
+
stateProvince?: any;
|
|
167
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
168
|
+
streetAddress?: any;
|
|
169
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
170
|
+
/**
|
|
171
|
+
* @tags Transfers Relationships
|
|
172
|
+
* @name Create
|
|
173
|
+
* @summary Create
|
|
174
|
+
* @request POST:/transfer/relationship/create
|
|
175
|
+
* @secure
|
|
176
|
+
*/
|
|
177
|
+
create(data: {
|
|
178
|
+
/** @example "5VA0XXXX" */
|
|
179
|
+
account?: any;
|
|
180
|
+
/** @example "111111" */
|
|
181
|
+
bankAccount?: any;
|
|
182
|
+
/** @example "John Doe" */
|
|
183
|
+
bankAccountOwnerName?: any;
|
|
184
|
+
/** @example "CHECKING" */
|
|
185
|
+
bankAccountType?: any;
|
|
186
|
+
/** @example "010101010" */
|
|
187
|
+
bankRoutingNumber?: any;
|
|
188
|
+
/** @example "Test" */
|
|
189
|
+
nickname?: any;
|
|
190
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
191
|
+
/**
|
|
192
|
+
* @tags Transfers Relationships
|
|
193
|
+
* @name WireInformation
|
|
194
|
+
* @summary Wire information
|
|
195
|
+
* @request POST:/transfer/relationship/wire/create
|
|
196
|
+
* @secure
|
|
197
|
+
*/
|
|
198
|
+
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
199
|
+
/**
|
|
200
|
+
* @tags Transfers Relationships
|
|
201
|
+
* @name BankingRelationship
|
|
202
|
+
* @summary Banking relationship
|
|
203
|
+
* @request POST:/transfer/relationship/bank/create
|
|
204
|
+
* @secure
|
|
205
|
+
*/
|
|
206
|
+
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
207
|
+
/**
|
|
208
|
+
* @tags Transfers Relationships
|
|
209
|
+
* @name Approve
|
|
210
|
+
* @summary Approve
|
|
211
|
+
* @request POST:/transfer/relationship/approve
|
|
212
|
+
* @secure
|
|
213
|
+
*/
|
|
214
|
+
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
215
|
+
/**
|
|
216
|
+
* @tags Transfers Relationships
|
|
217
|
+
* @name Cancel
|
|
218
|
+
* @summary Cancel
|
|
219
|
+
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
220
|
+
* @secure
|
|
221
|
+
*/
|
|
222
|
+
cancel(entryId: string, data: {
|
|
223
|
+
/** @example "2QC05208" */
|
|
224
|
+
account?: any;
|
|
225
|
+
/** @example "USER CANCELED" */
|
|
226
|
+
reason?: any;
|
|
227
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
228
|
+
/**
|
|
229
|
+
* @tags Transfers Relationships
|
|
230
|
+
* @name Rename
|
|
231
|
+
* @summary Rename
|
|
232
|
+
* @request POST:/transfer/relationship/rename/{entryId}
|
|
233
|
+
* @secure
|
|
234
|
+
*/
|
|
235
|
+
rename(entryId: string, data: {
|
|
236
|
+
/** @example "Citi Checking 2" */
|
|
237
|
+
nickname?: any;
|
|
238
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
239
|
+
/**
|
|
240
|
+
* @tags Transfers Relationships
|
|
241
|
+
* @name AdvisorPolicyUpdate
|
|
242
|
+
* @summary Advisor Policy Update
|
|
243
|
+
* @request POST:/transfer/relationship/policy
|
|
244
|
+
* @secure
|
|
245
|
+
*/
|
|
246
|
+
advisorPolicyUpdate(data: {
|
|
247
|
+
account?: {
|
|
248
|
+
/** @example 0 */
|
|
249
|
+
accountId?: number;
|
|
250
|
+
/** @example "{optional}" */
|
|
251
|
+
accountNumber?: string;
|
|
252
|
+
};
|
|
253
|
+
/** @example 123 */
|
|
254
|
+
entryId?: any;
|
|
255
|
+
/** @example true */
|
|
256
|
+
esigned?: any;
|
|
257
|
+
/** @example "AllowWithdrawal|Disallow" */
|
|
258
|
+
policy?: any;
|
|
259
|
+
/** @example "" */
|
|
260
|
+
remoteAddr?: any;
|
|
261
|
+
/** @example "" */
|
|
262
|
+
remoteDevice?: any;
|
|
263
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
264
|
+
/**
|
|
265
|
+
* @tags Transfers Relationships
|
|
266
|
+
* @name DocumentUpload
|
|
267
|
+
* @summary Document upload
|
|
268
|
+
* @request POST:/transfer/relationship/wire/upload
|
|
269
|
+
* @secure
|
|
270
|
+
*/
|
|
271
|
+
documentUpload(data: {
|
|
272
|
+
/**
|
|
273
|
+
* Wire relationship ID
|
|
274
|
+
* @example ""
|
|
275
|
+
*/
|
|
276
|
+
entryId?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Document file
|
|
279
|
+
* @format binary
|
|
280
|
+
*/
|
|
281
|
+
file?: File;
|
|
282
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
283
|
+
/**
|
|
284
|
+
* @tags Transfers Relationships
|
|
285
|
+
* @name MfaReInitiation
|
|
286
|
+
* @summary 2FA re-initiation
|
|
287
|
+
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
288
|
+
* @secure
|
|
289
|
+
*/
|
|
290
|
+
mfaReInitiation(data: {
|
|
291
|
+
/** @example 123 */
|
|
292
|
+
entryId?: any;
|
|
293
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
294
|
+
/**
|
|
295
|
+
* @tags Transfers Relationships
|
|
296
|
+
* @name SupplementWire
|
|
297
|
+
* @summary Supplement wire
|
|
298
|
+
* @request POST:/transfer/relationship/wire/supplement
|
|
299
|
+
* @secure
|
|
300
|
+
*/
|
|
301
|
+
supplementWire(data: {
|
|
302
|
+
/** @example 123456 */
|
|
303
|
+
entryId?: any;
|
|
304
|
+
recipientBank?: {
|
|
305
|
+
/** @example "Capital City" */
|
|
306
|
+
city?: string;
|
|
307
|
+
identifier?: {
|
|
308
|
+
/** @example "AAA-123-2587964" */
|
|
309
|
+
id?: string;
|
|
310
|
+
/** @example "BIC" */
|
|
311
|
+
type?: string;
|
|
312
|
+
};
|
|
313
|
+
/** @example "ABC 123" */
|
|
314
|
+
postalCode?: string;
|
|
315
|
+
/** @example "NJ" */
|
|
316
|
+
stateProvince?: string;
|
|
317
|
+
};
|
|
318
|
+
userAccount?: {
|
|
319
|
+
/** @example "AB12345" */
|
|
320
|
+
accountNumber?: string;
|
|
321
|
+
};
|
|
322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
323
|
+
}
|
|
80
324
|
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
81
325
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
326
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -610,258 +854,14 @@ declare class TransfersInstantCashTransfers<HandleError extends boolean = boolea
|
|
|
610
854
|
*/
|
|
611
855
|
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
612
856
|
}
|
|
613
|
-
declare class
|
|
857
|
+
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
614
858
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
615
859
|
constructor(apiClient: JwtClient<HandleError>);
|
|
616
860
|
/**
|
|
617
|
-
* @tags Transfers
|
|
618
|
-
* @name
|
|
619
|
-
* @summary
|
|
620
|
-
* @request
|
|
621
|
-
* @secure
|
|
622
|
-
*/
|
|
623
|
-
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
624
|
-
/**
|
|
625
|
-
* @tags Transfers Relationships
|
|
626
|
-
* @name GetInfo
|
|
627
|
-
* @summary Get Info
|
|
628
|
-
* @request GET:/transfer/relationship/get
|
|
629
|
-
* @secure
|
|
630
|
-
*/
|
|
631
|
-
getInfo(query?: {
|
|
632
|
-
/**
|
|
633
|
-
* Account number
|
|
634
|
-
* @example "ABC123"
|
|
635
|
-
*/
|
|
636
|
-
account?: any;
|
|
637
|
-
/**
|
|
638
|
-
* Desired entry ID
|
|
639
|
-
* @example "123"
|
|
640
|
-
*/
|
|
641
|
-
entryId?: any;
|
|
642
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
643
|
-
/**
|
|
644
|
-
* @tags Transfers Relationships
|
|
645
|
-
* @name PaymentMethods
|
|
646
|
-
* @summary Payment methods
|
|
647
|
-
* @request GET:/transfer/bank/paymentMethods
|
|
648
|
-
* @secure
|
|
649
|
-
*/
|
|
650
|
-
paymentMethods(query?: {
|
|
651
|
-
/** @example "IND" */
|
|
652
|
-
country?: any;
|
|
653
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
654
|
-
/**
|
|
655
|
-
* @tags Transfers Relationships
|
|
656
|
-
* @name PaymentMethodsViaAddress
|
|
657
|
-
* @summary Payment methods (via address)
|
|
658
|
-
* @request POST:/transfer/bank/paymentMethods
|
|
659
|
-
* @secure
|
|
660
|
-
*/
|
|
661
|
-
paymentMethodsViaAddress(data: {
|
|
662
|
-
/** @example "Mumbai" */
|
|
663
|
-
city?: any;
|
|
664
|
-
/** @example "IND" */
|
|
665
|
-
country?: any;
|
|
666
|
-
/** @example "400018" */
|
|
667
|
-
postalCode?: any;
|
|
668
|
-
/** @example "Maharashtra" */
|
|
669
|
-
stateProvince?: any;
|
|
670
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
671
|
-
streetAddress?: any;
|
|
672
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
673
|
-
/**
|
|
674
|
-
* @tags Transfers Relationships
|
|
675
|
-
* @name BankCodes
|
|
676
|
-
* @summary Bank Codes
|
|
677
|
-
* @request GET:/transfer/bank/bankCodes
|
|
678
|
-
* @secure
|
|
679
|
-
*/
|
|
680
|
-
bankCodes(query?: {
|
|
681
|
-
/** @example "IND|MEX" */
|
|
682
|
-
country?: any;
|
|
683
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
684
|
-
/**
|
|
685
|
-
* @tags Transfers Relationships
|
|
686
|
-
* @name BankCodesViaAddress
|
|
687
|
-
* @summary Bank Codes (via address)
|
|
688
|
-
* @request POST:/transfer/bank/bankCodes
|
|
689
|
-
* @secure
|
|
690
|
-
*/
|
|
691
|
-
bankCodesViaAddress(data: {
|
|
692
|
-
/** @example "Mumbai" */
|
|
693
|
-
city?: any;
|
|
694
|
-
/** @example "IND" */
|
|
695
|
-
country?: any;
|
|
696
|
-
/** @example "400018" */
|
|
697
|
-
postalCode?: any;
|
|
698
|
-
/** @example "Maharashtra" */
|
|
699
|
-
stateProvince?: any;
|
|
700
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
701
|
-
streetAddress?: any;
|
|
702
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
703
|
-
/**
|
|
704
|
-
* @tags Transfers Relationships
|
|
705
|
-
* @name Create
|
|
706
|
-
* @summary Create
|
|
707
|
-
* @request POST:/transfer/relationship/create
|
|
708
|
-
* @secure
|
|
709
|
-
*/
|
|
710
|
-
create(data: {
|
|
711
|
-
/** @example "5VA0XXXX" */
|
|
712
|
-
account?: any;
|
|
713
|
-
/** @example "111111" */
|
|
714
|
-
bankAccount?: any;
|
|
715
|
-
/** @example "John Doe" */
|
|
716
|
-
bankAccountOwnerName?: any;
|
|
717
|
-
/** @example "CHECKING" */
|
|
718
|
-
bankAccountType?: any;
|
|
719
|
-
/** @example "010101010" */
|
|
720
|
-
bankRoutingNumber?: any;
|
|
721
|
-
/** @example "Test" */
|
|
722
|
-
nickname?: any;
|
|
723
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
724
|
-
/**
|
|
725
|
-
* @tags Transfers Relationships
|
|
726
|
-
* @name WireInformation
|
|
727
|
-
* @summary Wire information
|
|
728
|
-
* @request POST:/transfer/relationship/wire/create
|
|
729
|
-
* @secure
|
|
730
|
-
*/
|
|
731
|
-
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
732
|
-
/**
|
|
733
|
-
* @tags Transfers Relationships
|
|
734
|
-
* @name BankingRelationship
|
|
735
|
-
* @summary Banking relationship
|
|
736
|
-
* @request POST:/transfer/relationship/bank/create
|
|
737
|
-
* @secure
|
|
738
|
-
*/
|
|
739
|
-
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
740
|
-
/**
|
|
741
|
-
* @tags Transfers Relationships
|
|
742
|
-
* @name Approve
|
|
743
|
-
* @summary Approve
|
|
744
|
-
* @request POST:/transfer/relationship/approve
|
|
745
|
-
* @secure
|
|
746
|
-
*/
|
|
747
|
-
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
748
|
-
/**
|
|
749
|
-
* @tags Transfers Relationships
|
|
750
|
-
* @name Cancel
|
|
751
|
-
* @summary Cancel
|
|
752
|
-
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
753
|
-
* @secure
|
|
754
|
-
*/
|
|
755
|
-
cancel(entryId: string, data: {
|
|
756
|
-
/** @example "2QC05208" */
|
|
757
|
-
account?: any;
|
|
758
|
-
/** @example "USER CANCELED" */
|
|
759
|
-
reason?: any;
|
|
760
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
761
|
-
/**
|
|
762
|
-
* @tags Transfers Relationships
|
|
763
|
-
* @name Rename
|
|
764
|
-
* @summary Rename
|
|
765
|
-
* @request POST:/transfer/relationship/rename/{entryId}
|
|
766
|
-
* @secure
|
|
767
|
-
*/
|
|
768
|
-
rename(entryId: string, data: {
|
|
769
|
-
/** @example "Citi Checking 2" */
|
|
770
|
-
nickname?: any;
|
|
771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
772
|
-
/**
|
|
773
|
-
* @tags Transfers Relationships
|
|
774
|
-
* @name AdvisorPolicyUpdate
|
|
775
|
-
* @summary Advisor Policy Update
|
|
776
|
-
* @request POST:/transfer/relationship/policy
|
|
777
|
-
* @secure
|
|
778
|
-
*/
|
|
779
|
-
advisorPolicyUpdate(data: {
|
|
780
|
-
account?: {
|
|
781
|
-
/** @example 0 */
|
|
782
|
-
accountId?: number;
|
|
783
|
-
/** @example "{optional}" */
|
|
784
|
-
accountNumber?: string;
|
|
785
|
-
};
|
|
786
|
-
/** @example 123 */
|
|
787
|
-
entryId?: any;
|
|
788
|
-
/** @example true */
|
|
789
|
-
esigned?: any;
|
|
790
|
-
/** @example "AllowWithdrawal|Disallow" */
|
|
791
|
-
policy?: any;
|
|
792
|
-
/** @example "" */
|
|
793
|
-
remoteAddr?: any;
|
|
794
|
-
/** @example "" */
|
|
795
|
-
remoteDevice?: any;
|
|
796
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
797
|
-
/**
|
|
798
|
-
* @tags Transfers Relationships
|
|
799
|
-
* @name DocumentUpload
|
|
800
|
-
* @summary Document upload
|
|
801
|
-
* @request POST:/transfer/relationship/wire/upload
|
|
802
|
-
* @secure
|
|
803
|
-
*/
|
|
804
|
-
documentUpload(data: {
|
|
805
|
-
/**
|
|
806
|
-
* Wire relationship ID
|
|
807
|
-
* @example ""
|
|
808
|
-
*/
|
|
809
|
-
entryId?: string;
|
|
810
|
-
/**
|
|
811
|
-
* Document file
|
|
812
|
-
* @format binary
|
|
813
|
-
*/
|
|
814
|
-
file?: File;
|
|
815
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
816
|
-
/**
|
|
817
|
-
* @tags Transfers Relationships
|
|
818
|
-
* @name MfaReInitiation
|
|
819
|
-
* @summary 2FA re-initiation
|
|
820
|
-
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
821
|
-
* @secure
|
|
822
|
-
*/
|
|
823
|
-
mfaReInitiation(data: {
|
|
824
|
-
/** @example 123 */
|
|
825
|
-
entryId?: any;
|
|
826
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
827
|
-
/**
|
|
828
|
-
* @tags Transfers Relationships
|
|
829
|
-
* @name SupplementWire
|
|
830
|
-
* @summary Supplement wire
|
|
831
|
-
* @request POST:/transfer/relationship/wire/supplement
|
|
832
|
-
* @secure
|
|
833
|
-
*/
|
|
834
|
-
supplementWire(data: {
|
|
835
|
-
/** @example 123456 */
|
|
836
|
-
entryId?: any;
|
|
837
|
-
recipientBank?: {
|
|
838
|
-
/** @example "Capital City" */
|
|
839
|
-
city?: string;
|
|
840
|
-
identifier?: {
|
|
841
|
-
/** @example "AAA-123-2587964" */
|
|
842
|
-
id?: string;
|
|
843
|
-
/** @example "BIC" */
|
|
844
|
-
type?: string;
|
|
845
|
-
};
|
|
846
|
-
/** @example "ABC 123" */
|
|
847
|
-
postalCode?: string;
|
|
848
|
-
/** @example "NJ" */
|
|
849
|
-
stateProvince?: string;
|
|
850
|
-
};
|
|
851
|
-
userAccount?: {
|
|
852
|
-
/** @example "AB12345" */
|
|
853
|
-
accountNumber?: string;
|
|
854
|
-
};
|
|
855
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
856
|
-
}
|
|
857
|
-
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
858
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
859
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
860
|
-
/**
|
|
861
|
-
* @tags Transfers Cheques
|
|
862
|
-
* @name Withdrawal
|
|
863
|
-
* @summary Withdrawal
|
|
864
|
-
* @request POST:/transfer/check/outgoing
|
|
861
|
+
* @tags Transfers Cheques
|
|
862
|
+
* @name Withdrawal
|
|
863
|
+
* @summary Withdrawal
|
|
864
|
+
* @request POST:/transfer/check/outgoing
|
|
865
865
|
* @secure
|
|
866
866
|
*/
|
|
867
867
|
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -14996,106 +14996,15 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14996
14996
|
'X-SCX-TIMESTAMP'?: string;
|
|
14997
14997
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
14998
14998
|
}
|
|
14999
|
-
export class
|
|
14999
|
+
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
15000
15000
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
15001
|
constructor(apiClient: JwtClient<HandleError>);
|
|
15002
15002
|
/**
|
|
15003
|
-
* @description Retrieves a
|
|
15004
|
-
* @tags
|
|
15005
|
-
* @name
|
|
15006
|
-
* @summary Get
|
|
15007
|
-
* @request GET:/
|
|
15008
|
-
* @secure
|
|
15009
|
-
*/
|
|
15010
|
-
getSymbolData(query?: {
|
|
15011
|
-
/** Filter for underlying asset */
|
|
15012
|
-
underlying?: string;
|
|
15013
|
-
/** Filter for quoted_currency */
|
|
15014
|
-
quoted_currency?: string;
|
|
15015
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
|
|
15016
|
-
/**
|
|
15017
|
-
* @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
|
|
15018
|
-
* @tags Market Data
|
|
15019
|
-
* @name GetOhlcvData
|
|
15020
|
-
* @summary Get OHLCV data
|
|
15021
|
-
* @request GET:/market_data/ohlcv
|
|
15022
|
-
* @secure
|
|
15023
|
-
*/
|
|
15024
|
-
getOhlcvData(query: {
|
|
15025
|
-
/** Filter for underlying asset */
|
|
15026
|
-
underlying: string;
|
|
15027
|
-
/** Filter for quoted asset */
|
|
15028
|
-
quoted_currency: string;
|
|
15029
|
-
/** Filter for maximum number of data points to be returned */
|
|
15030
|
-
limit?: string;
|
|
15031
|
-
/** Filter for objects before given timestamp */
|
|
15032
|
-
data_end_date?: string;
|
|
15033
|
-
/** Filter for all data(daily `time_frame`) */
|
|
15034
|
-
all_data?: boolean;
|
|
15035
|
-
/** Filter for time_frame */
|
|
15036
|
-
time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
|
|
15037
|
-
}, headers?: {
|
|
15038
|
-
/**
|
|
15039
|
-
* Signature for your request.
|
|
15040
|
-
* @default "[WEB] auto-generated on fly"
|
|
15041
|
-
*/
|
|
15042
|
-
'X-SCX-SIGNED'?: string;
|
|
15043
|
-
/**
|
|
15044
|
-
* UNIX timestamp.
|
|
15045
|
-
* @default "[WEB] auto-generated on fly"
|
|
15046
|
-
*/
|
|
15047
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15048
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
|
|
15049
|
-
/**
|
|
15050
|
-
* @description Retrieves a list of market news articles filtered using given parameters.
|
|
15051
|
-
* @tags Market Data
|
|
15052
|
-
* @name GetNewsArticles
|
|
15053
|
-
* @summary Get news articles
|
|
15054
|
-
* @request GET:/market_data/news/latest
|
|
15055
|
-
* @secure
|
|
15056
|
-
*/
|
|
15057
|
-
getNewsArticles(query?: {
|
|
15058
|
-
/** Sources (feeds) of news articles, options can be fetched from /news/feeds */
|
|
15059
|
-
news_source?: string;
|
|
15060
|
-
/** Categories of news articles, options can be fetched from /news/categories */
|
|
15061
|
-
categories?: string;
|
|
15062
|
-
/** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
|
|
15063
|
-
exclude_categories?: string;
|
|
15064
|
-
/** UNIX timestamp, is used to fetch articles before the given time */
|
|
15065
|
-
lookback?: string;
|
|
15066
|
-
/** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
|
|
15067
|
-
language?: string;
|
|
15068
|
-
/** Sorting order of news articles. Can be either `popular` or `latest` */
|
|
15069
|
-
sort_by?: string;
|
|
15070
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
|
|
15071
|
-
/**
|
|
15072
|
-
* @description Retrieves a list of available market data feeds, which can be used to query articles.
|
|
15073
|
-
* @tags Market Data
|
|
15074
|
-
* @name GetNewsFeeds
|
|
15075
|
-
* @summary Get news feeds
|
|
15076
|
-
* @request GET:/market_data/news/feeds
|
|
15077
|
-
* @secure
|
|
15078
|
-
*/
|
|
15079
|
-
getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
|
|
15080
|
-
/**
|
|
15081
|
-
* @description Retrieves a list of available market data categories, which can be used to query articles.
|
|
15082
|
-
* @tags Market Data
|
|
15083
|
-
* @name GetCategories
|
|
15084
|
-
* @summary Get categories
|
|
15085
|
-
* @request GET:/market_data/news/categories
|
|
15086
|
-
* @secure
|
|
15087
|
-
*/
|
|
15088
|
-
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15089
|
-
}
|
|
15090
|
-
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
15091
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15092
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15093
|
-
/**
|
|
15094
|
-
* @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
|
|
15095
|
-
* @tags Convert and Withdraw
|
|
15096
|
-
* @name GetQuote
|
|
15097
|
-
* @summary Get quote
|
|
15098
|
-
* @request GET:/convert_withdraw/rfq
|
|
15003
|
+
* @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
|
|
15004
|
+
* @tags Convert and Withdraw
|
|
15005
|
+
* @name GetQuote
|
|
15006
|
+
* @summary Get quote
|
|
15007
|
+
* @request GET:/convert_withdraw/rfq
|
|
15099
15008
|
* @secure
|
|
15100
15009
|
*/
|
|
15101
15010
|
getQuote(query: {
|
|
@@ -15181,65 +15090,6 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
|
15181
15090
|
'X-SCX-TIMESTAMP'?: string;
|
|
15182
15091
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
|
|
15183
15092
|
}
|
|
15184
|
-
export class Fund<HandleError extends boolean = boolean> {
|
|
15185
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15186
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15187
|
-
/**
|
|
15188
|
-
* @description Retrieves a quote for a fund event for a given participant code and asset. This endpoint response indicates the rate by which a subsequent on-chain deposit will be honored at.
|
|
15189
|
-
* @tags Fund
|
|
15190
|
-
* @name GetQuote
|
|
15191
|
-
* @summary Get quote
|
|
15192
|
-
* @request POST:/fund/rfq
|
|
15193
|
-
* @secure
|
|
15194
|
-
*/
|
|
15195
|
-
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15196
|
-
/**
|
|
15197
|
-
* Signature for your request.
|
|
15198
|
-
* @default "[WEB] auto-generated on fly"
|
|
15199
|
-
*/
|
|
15200
|
-
'X-SCX-SIGNED'?: string;
|
|
15201
|
-
/**
|
|
15202
|
-
* UNIX timestamp.
|
|
15203
|
-
* @default "[WEB] auto-generated on fly"
|
|
15204
|
-
*/
|
|
15205
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15206
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15207
|
-
/**
|
|
15208
|
-
* @description You can use the `fund_id` in the response as the “parent” to query `GET /movements?parent_link_id=[fund_id]` to view a trail of all movements related to this fund event.
|
|
15209
|
-
* @tags Fund
|
|
15210
|
-
* @name GetTransactions
|
|
15211
|
-
* @summary Get transactions
|
|
15212
|
-
* @request GET:/fund/transactions
|
|
15213
|
-
* @secure
|
|
15214
|
-
*/
|
|
15215
|
-
getTransactions(query?: {
|
|
15216
|
-
/** Participant code of the end customer */
|
|
15217
|
-
participant_code?: string;
|
|
15218
|
-
/** The asset sent on-chain by the end customer in order to fund an account */
|
|
15219
|
-
fund_asset?: string;
|
|
15220
|
-
/** The address provided by Zero Hash that the end customer will send to */
|
|
15221
|
-
deposit_address?: string;
|
|
15222
|
-
/** The Zero Hash-generated unique identifier associated with an executed fund event */
|
|
15223
|
-
fund_id?: string;
|
|
15224
|
-
/** Filters for a specific page (pagination) */
|
|
15225
|
-
page?: string;
|
|
15226
|
-
/** The number of results returned per page, with a maximum of 50 transactions per page */
|
|
15227
|
-
page_size?: string;
|
|
15228
|
-
/** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
|
|
15229
|
-
success?: string;
|
|
15230
|
-
}, headers?: {
|
|
15231
|
-
/**
|
|
15232
|
-
* Signature for your request.
|
|
15233
|
-
* @default "[WEB] auto-generated on fly"
|
|
15234
|
-
*/
|
|
15235
|
-
'X-SCX-SIGNED'?: string;
|
|
15236
|
-
/**
|
|
15237
|
-
* UNIX timestamp.
|
|
15238
|
-
* @default "[WEB] auto-generated on fly"
|
|
15239
|
-
*/
|
|
15240
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15241
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15242
|
-
}
|
|
15243
15093
|
export class Clob<HandleError extends boolean = boolean> {
|
|
15244
15094
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15245
15095
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -15453,6 +15303,156 @@ export class Clob<HandleError extends boolean = boolean> {
|
|
|
15453
15303
|
'X-SCX-TIMESTAMP'?: string;
|
|
15454
15304
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
|
|
15455
15305
|
}
|
|
15306
|
+
export class MarketData<HandleError extends boolean = boolean> {
|
|
15307
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
15308
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
15309
|
+
/**
|
|
15310
|
+
* @description Retrieves a list of symbols and their market data.
|
|
15311
|
+
* @tags Market Data
|
|
15312
|
+
* @name GetSymbolData
|
|
15313
|
+
* @summary Get symbol data
|
|
15314
|
+
* @request GET:/market_data/symbol_data
|
|
15315
|
+
* @secure
|
|
15316
|
+
*/
|
|
15317
|
+
getSymbolData(query?: {
|
|
15318
|
+
/** Filter for underlying asset */
|
|
15319
|
+
underlying?: string;
|
|
15320
|
+
/** Filter for quoted_currency */
|
|
15321
|
+
quoted_currency?: string;
|
|
15322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
|
|
15323
|
+
/**
|
|
15324
|
+
* @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
|
|
15325
|
+
* @tags Market Data
|
|
15326
|
+
* @name GetOhlcvData
|
|
15327
|
+
* @summary Get OHLCV data
|
|
15328
|
+
* @request GET:/market_data/ohlcv
|
|
15329
|
+
* @secure
|
|
15330
|
+
*/
|
|
15331
|
+
getOhlcvData(query: {
|
|
15332
|
+
/** Filter for underlying asset */
|
|
15333
|
+
underlying: string;
|
|
15334
|
+
/** Filter for quoted asset */
|
|
15335
|
+
quoted_currency: string;
|
|
15336
|
+
/** Filter for maximum number of data points to be returned */
|
|
15337
|
+
limit?: string;
|
|
15338
|
+
/** Filter for objects before given timestamp */
|
|
15339
|
+
data_end_date?: string;
|
|
15340
|
+
/** Filter for all data(daily `time_frame`) */
|
|
15341
|
+
all_data?: boolean;
|
|
15342
|
+
/** Filter for time_frame */
|
|
15343
|
+
time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
|
|
15344
|
+
}, headers?: {
|
|
15345
|
+
/**
|
|
15346
|
+
* Signature for your request.
|
|
15347
|
+
* @default "[WEB] auto-generated on fly"
|
|
15348
|
+
*/
|
|
15349
|
+
'X-SCX-SIGNED'?: string;
|
|
15350
|
+
/**
|
|
15351
|
+
* UNIX timestamp.
|
|
15352
|
+
* @default "[WEB] auto-generated on fly"
|
|
15353
|
+
*/
|
|
15354
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
15355
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
|
|
15356
|
+
/**
|
|
15357
|
+
* @description Retrieves a list of market news articles filtered using given parameters.
|
|
15358
|
+
* @tags Market Data
|
|
15359
|
+
* @name GetNewsArticles
|
|
15360
|
+
* @summary Get news articles
|
|
15361
|
+
* @request GET:/market_data/news/latest
|
|
15362
|
+
* @secure
|
|
15363
|
+
*/
|
|
15364
|
+
getNewsArticles(query?: {
|
|
15365
|
+
/** Sources (feeds) of news articles, options can be fetched from /news/feeds */
|
|
15366
|
+
news_source?: string;
|
|
15367
|
+
/** Categories of news articles, options can be fetched from /news/categories */
|
|
15368
|
+
categories?: string;
|
|
15369
|
+
/** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
|
|
15370
|
+
exclude_categories?: string;
|
|
15371
|
+
/** UNIX timestamp, is used to fetch articles before the given time */
|
|
15372
|
+
lookback?: string;
|
|
15373
|
+
/** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
|
|
15374
|
+
language?: string;
|
|
15375
|
+
/** Sorting order of news articles. Can be either `popular` or `latest` */
|
|
15376
|
+
sort_by?: string;
|
|
15377
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
|
|
15378
|
+
/**
|
|
15379
|
+
* @description Retrieves a list of available market data feeds, which can be used to query articles.
|
|
15380
|
+
* @tags Market Data
|
|
15381
|
+
* @name GetNewsFeeds
|
|
15382
|
+
* @summary Get news feeds
|
|
15383
|
+
* @request GET:/market_data/news/feeds
|
|
15384
|
+
* @secure
|
|
15385
|
+
*/
|
|
15386
|
+
getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
|
|
15387
|
+
/**
|
|
15388
|
+
* @description Retrieves a list of available market data categories, which can be used to query articles.
|
|
15389
|
+
* @tags Market Data
|
|
15390
|
+
* @name GetCategories
|
|
15391
|
+
* @summary Get categories
|
|
15392
|
+
* @request GET:/market_data/news/categories
|
|
15393
|
+
* @secure
|
|
15394
|
+
*/
|
|
15395
|
+
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15396
|
+
}
|
|
15397
|
+
export class Fund<HandleError extends boolean = boolean> {
|
|
15398
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
15399
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
15400
|
+
/**
|
|
15401
|
+
* @description Retrieves a quote for a fund event for a given participant code and asset. This endpoint response indicates the rate by which a subsequent on-chain deposit will be honored at.
|
|
15402
|
+
* @tags Fund
|
|
15403
|
+
* @name GetQuote
|
|
15404
|
+
* @summary Get quote
|
|
15405
|
+
* @request POST:/fund/rfq
|
|
15406
|
+
* @secure
|
|
15407
|
+
*/
|
|
15408
|
+
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15409
|
+
/**
|
|
15410
|
+
* Signature for your request.
|
|
15411
|
+
* @default "[WEB] auto-generated on fly"
|
|
15412
|
+
*/
|
|
15413
|
+
'X-SCX-SIGNED'?: string;
|
|
15414
|
+
/**
|
|
15415
|
+
* UNIX timestamp.
|
|
15416
|
+
* @default "[WEB] auto-generated on fly"
|
|
15417
|
+
*/
|
|
15418
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
15419
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15420
|
+
/**
|
|
15421
|
+
* @description You can use the `fund_id` in the response as the “parent” to query `GET /movements?parent_link_id=[fund_id]` to view a trail of all movements related to this fund event.
|
|
15422
|
+
* @tags Fund
|
|
15423
|
+
* @name GetTransactions
|
|
15424
|
+
* @summary Get transactions
|
|
15425
|
+
* @request GET:/fund/transactions
|
|
15426
|
+
* @secure
|
|
15427
|
+
*/
|
|
15428
|
+
getTransactions(query?: {
|
|
15429
|
+
/** Participant code of the end customer */
|
|
15430
|
+
participant_code?: string;
|
|
15431
|
+
/** The asset sent on-chain by the end customer in order to fund an account */
|
|
15432
|
+
fund_asset?: string;
|
|
15433
|
+
/** The address provided by Zero Hash that the end customer will send to */
|
|
15434
|
+
deposit_address?: string;
|
|
15435
|
+
/** The Zero Hash-generated unique identifier associated with an executed fund event */
|
|
15436
|
+
fund_id?: string;
|
|
15437
|
+
/** Filters for a specific page (pagination) */
|
|
15438
|
+
page?: string;
|
|
15439
|
+
/** The number of results returned per page, with a maximum of 50 transactions per page */
|
|
15440
|
+
page_size?: string;
|
|
15441
|
+
/** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
|
|
15442
|
+
success?: string;
|
|
15443
|
+
}, headers?: {
|
|
15444
|
+
/**
|
|
15445
|
+
* Signature for your request.
|
|
15446
|
+
* @default "[WEB] auto-generated on fly"
|
|
15447
|
+
*/
|
|
15448
|
+
'X-SCX-SIGNED'?: string;
|
|
15449
|
+
/**
|
|
15450
|
+
* UNIX timestamp.
|
|
15451
|
+
* @default "[WEB] auto-generated on fly"
|
|
15452
|
+
*/
|
|
15453
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
15454
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15455
|
+
}
|
|
15456
15456
|
export class ZeroHashApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
15457
15457
|
readonly config: JwtClientConfig<HandleError>;
|
|
15458
15458
|
accounts: Accounts<HandleError>;
|