@orbis-systems/orbis-api-clients 0.7.13 → 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 +214 -114
- 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 +865 -865
- 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 +1180 -1180
- 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 +46 -46
- 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 +4036 -4036
- 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 +618 -618
- 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 +720 -720
- 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,200 +77,267 @@ 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
|
|
80
|
+
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
81
81
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
82
|
constructor(apiClient: JwtClient<HandleError>);
|
|
83
83
|
/**
|
|
84
|
-
* @tags Transfers
|
|
85
|
-
* @name
|
|
86
|
-
* @summary
|
|
87
|
-
* @request GET:/transfer/
|
|
84
|
+
* @tags Transfers Relationships
|
|
85
|
+
* @name List
|
|
86
|
+
* @summary List
|
|
87
|
+
* @request GET:/transfer/relationship/list/{account}
|
|
88
88
|
* @secure
|
|
89
89
|
*/
|
|
90
|
-
|
|
91
|
-
status?: any;
|
|
92
|
-
account?: any;
|
|
93
|
-
accountId?: any;
|
|
94
|
-
requestId?: any;
|
|
95
|
-
batchId?: any;
|
|
96
|
-
loadAccounts?: any;
|
|
97
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
90
|
+
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
98
91
|
/**
|
|
99
|
-
* @tags Transfers
|
|
100
|
-
* @name
|
|
101
|
-
* @summary
|
|
102
|
-
* @request
|
|
92
|
+
* @tags Transfers Relationships
|
|
93
|
+
* @name GetInfo
|
|
94
|
+
* @summary Get Info
|
|
95
|
+
* @request GET:/transfer/relationship/get
|
|
103
96
|
* @secure
|
|
104
97
|
*/
|
|
105
|
-
|
|
106
|
-
/**
|
|
98
|
+
getInfo(query?: {
|
|
99
|
+
/**
|
|
100
|
+
* Account number
|
|
101
|
+
* @example "ABC123"
|
|
102
|
+
*/
|
|
107
103
|
account?: any;
|
|
108
|
-
/**
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
comment?: any;
|
|
114
|
-
/** @example "{optional}" */
|
|
115
|
-
remoteDevice?: any;
|
|
116
|
-
/** @example "{optional}" */
|
|
117
|
-
remoteIp?: any;
|
|
118
|
-
/** @example "{requestId}" */
|
|
119
|
-
requestId?: any;
|
|
120
|
-
/** @example "{optional}|Cancelled|Disgarded" */
|
|
121
|
-
status?: any;
|
|
104
|
+
/**
|
|
105
|
+
* Desired entry ID
|
|
106
|
+
* @example "123"
|
|
107
|
+
*/
|
|
108
|
+
entryId?: any;
|
|
122
109
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
123
110
|
/**
|
|
124
|
-
* @tags Transfers
|
|
125
|
-
* @name
|
|
126
|
-
* @summary
|
|
127
|
-
* @request
|
|
111
|
+
* @tags Transfers Relationships
|
|
112
|
+
* @name PaymentMethods
|
|
113
|
+
* @summary Payment methods
|
|
114
|
+
* @request GET:/transfer/bank/paymentMethods
|
|
128
115
|
* @secure
|
|
129
116
|
*/
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
accountId?: number;
|
|
134
|
-
/** @example "AC123" */
|
|
135
|
-
accountNumber?: string;
|
|
136
|
-
};
|
|
137
|
-
/** @example [{"isShort":0,"optionFlag":1,"quantity":1000,"quote":{"cusip":"0A1B2C","symbol":""},"symbol":"ZVZZT","type":"Security | Cash"}] */
|
|
138
|
-
assets?: any;
|
|
139
|
-
/** @example "{batchId}" */
|
|
140
|
-
batchId?: any;
|
|
141
|
-
/** @example "something for the record" */
|
|
142
|
-
comment?: any;
|
|
143
|
-
/** @example "" */
|
|
144
|
-
contraAccount?: any;
|
|
145
|
-
/** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
|
|
146
|
-
contraAccountType?: any;
|
|
147
|
-
/** @example "" */
|
|
148
|
-
contraNumber?: any;
|
|
149
|
-
/** @example "" */
|
|
150
|
-
contraTitle?: any;
|
|
151
|
-
/** @example "" */
|
|
152
|
-
participantNumber?: any;
|
|
153
|
-
/** @example "" */
|
|
154
|
-
primaryTaxId?: any;
|
|
155
|
-
/** @example "{optional}" */
|
|
156
|
-
remoteDevice?: any;
|
|
157
|
-
/** @example "{optional}" */
|
|
158
|
-
remoteIp?: any;
|
|
159
|
-
/** @example "" */
|
|
160
|
-
secondaryTaxId?: any;
|
|
161
|
-
/** @example "{optional}|RequestPlaced|Scheduled" */
|
|
162
|
-
status?: any;
|
|
163
|
-
/** @example "Full|Partial" */
|
|
164
|
-
type?: any;
|
|
117
|
+
paymentMethods(query?: {
|
|
118
|
+
/** @example "IND" */
|
|
119
|
+
country?: any;
|
|
165
120
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
166
121
|
/**
|
|
167
|
-
* @tags Transfers
|
|
168
|
-
* @name
|
|
169
|
-
* @summary
|
|
170
|
-
* @request POST:/transfer/
|
|
122
|
+
* @tags Transfers Relationships
|
|
123
|
+
* @name PaymentMethodsViaAddress
|
|
124
|
+
* @summary Payment methods (via address)
|
|
125
|
+
* @request POST:/transfer/bank/paymentMethods
|
|
171
126
|
* @secure
|
|
172
127
|
*/
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
/** @example
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
symbol?: string;
|
|
186
|
-
}[];
|
|
187
|
-
/** @example "{batchId}" */
|
|
188
|
-
batchId?: string;
|
|
189
|
-
/** @example "something for the record" */
|
|
190
|
-
comment?: string;
|
|
191
|
-
/** @example "" */
|
|
192
|
-
contraAccount?: string;
|
|
193
|
-
/** @example "" */
|
|
194
|
-
contraAccountType?: string;
|
|
195
|
-
/** @example "" */
|
|
196
|
-
contraNumber?: string;
|
|
197
|
-
/** @example "" */
|
|
198
|
-
contraTitle?: string;
|
|
199
|
-
/** @example "" */
|
|
200
|
-
participantNumber?: string;
|
|
201
|
-
/** @example "" */
|
|
202
|
-
primaryTaxId?: string;
|
|
203
|
-
/** @example "{optional}" */
|
|
204
|
-
remoteDevice?: string;
|
|
205
|
-
/** @example "{optional}" */
|
|
206
|
-
remoteIp?: string;
|
|
207
|
-
/** @example "" */
|
|
208
|
-
secondaryTaxId?: string;
|
|
209
|
-
/** @example "Full|Partial" */
|
|
210
|
-
type?: string;
|
|
211
|
-
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
212
|
-
}
|
|
213
|
-
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
214
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
215
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
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>>;
|
|
216
140
|
/**
|
|
217
|
-
* @tags Transfers
|
|
218
|
-
* @name
|
|
219
|
-
* @summary
|
|
220
|
-
* @request
|
|
141
|
+
* @tags Transfers Relationships
|
|
142
|
+
* @name BankCodes
|
|
143
|
+
* @summary Bank Codes
|
|
144
|
+
* @request GET:/transfer/bank/bankCodes
|
|
221
145
|
* @secure
|
|
222
146
|
*/
|
|
223
|
-
|
|
147
|
+
bankCodes(query?: {
|
|
148
|
+
/** @example "IND|MEX" */
|
|
149
|
+
country?: any;
|
|
150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
224
151
|
/**
|
|
225
|
-
* @tags Transfers
|
|
226
|
-
* @name
|
|
227
|
-
* @summary
|
|
228
|
-
* @request POST:/transfer/
|
|
152
|
+
* @tags Transfers Relationships
|
|
153
|
+
* @name BankCodesViaAddress
|
|
154
|
+
* @summary Bank Codes (via address)
|
|
155
|
+
* @request POST:/transfer/bank/bankCodes
|
|
229
156
|
* @secure
|
|
230
157
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
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>>;
|
|
236
170
|
/**
|
|
237
|
-
* @tags Transfers
|
|
238
|
-
* @name
|
|
239
|
-
* @summary
|
|
240
|
-
* @request POST:/transfer/
|
|
171
|
+
* @tags Transfers Relationships
|
|
172
|
+
* @name Create
|
|
173
|
+
* @summary Create
|
|
174
|
+
* @request POST:/transfer/relationship/create
|
|
241
175
|
* @secure
|
|
242
176
|
*/
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
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>>;
|
|
248
191
|
/**
|
|
249
|
-
* @tags Transfers
|
|
250
|
-
* @name
|
|
251
|
-
* @summary
|
|
252
|
-
* @request POST:/transfer/
|
|
192
|
+
* @tags Transfers Relationships
|
|
193
|
+
* @name WireInformation
|
|
194
|
+
* @summary Wire information
|
|
195
|
+
* @request POST:/transfer/relationship/wire/create
|
|
253
196
|
* @secure
|
|
254
197
|
*/
|
|
255
|
-
|
|
256
|
-
}
|
|
257
|
-
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
258
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
259
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
198
|
+
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
260
199
|
/**
|
|
261
|
-
* @tags Transfers
|
|
262
|
-
* @name
|
|
263
|
-
* @summary
|
|
264
|
-
* @request
|
|
200
|
+
* @tags Transfers Relationships
|
|
201
|
+
* @name BankingRelationship
|
|
202
|
+
* @summary Banking relationship
|
|
203
|
+
* @request POST:/transfer/relationship/bank/create
|
|
265
204
|
* @secure
|
|
266
205
|
*/
|
|
267
|
-
|
|
206
|
+
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
268
207
|
/**
|
|
269
|
-
* @tags Transfers
|
|
270
|
-
* @name
|
|
271
|
-
* @summary
|
|
272
|
-
* @request POST:/
|
|
273
|
-
* @secure
|
|
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
|
+
}
|
|
324
|
+
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
325
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
326
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
327
|
+
/**
|
|
328
|
+
* @tags Transfers Instant Account Verification
|
|
329
|
+
* @name Initiate
|
|
330
|
+
* @summary Initiate
|
|
331
|
+
* @request GET:/iav/init
|
|
332
|
+
* @secure
|
|
333
|
+
*/
|
|
334
|
+
initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
335
|
+
/**
|
|
336
|
+
* @tags Transfers Instant Account Verification
|
|
337
|
+
* @name InitiatePost
|
|
338
|
+
* @summary Initiate Post
|
|
339
|
+
* @request POST:/iav/init
|
|
340
|
+
* @secure
|
|
274
341
|
*/
|
|
275
342
|
initiatePost(query: object, data: {
|
|
276
343
|
/** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
|
|
@@ -333,110 +400,233 @@ declare class TransfersInstantAccountVerification<HandleError extends boolean =
|
|
|
333
400
|
remoteDevice?: any;
|
|
334
401
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
335
402
|
}
|
|
336
|
-
declare class
|
|
403
|
+
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
337
404
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
338
405
|
constructor(apiClient: JwtClient<HandleError>);
|
|
339
406
|
/**
|
|
340
|
-
* @tags Transfers
|
|
341
|
-
* @name
|
|
342
|
-
* @summary Deposit
|
|
343
|
-
* @request POST:/transfer/
|
|
407
|
+
* @tags Transfers Ach
|
|
408
|
+
* @name Deposit
|
|
409
|
+
* @summary Deposit
|
|
410
|
+
* @request POST:/transfer/ach/deposit
|
|
344
411
|
* @secure
|
|
345
412
|
*/
|
|
346
|
-
|
|
347
|
-
|
|
413
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
414
|
+
/**
|
|
415
|
+
* @tags Transfers Ach
|
|
416
|
+
* @name Withdraw
|
|
417
|
+
* @summary Withdraw
|
|
418
|
+
* @request POST:/transfer/ach/withdraw
|
|
419
|
+
* @secure
|
|
420
|
+
*/
|
|
421
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
422
|
+
}
|
|
423
|
+
declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
424
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
425
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
426
|
+
/**
|
|
427
|
+
* @tags Transfers Acats
|
|
428
|
+
* @name Search
|
|
429
|
+
* @summary Search
|
|
430
|
+
* @request GET:/transfer/acat/search
|
|
431
|
+
* @secure
|
|
432
|
+
*/
|
|
433
|
+
search(query?: {
|
|
434
|
+
status?: any;
|
|
348
435
|
account?: any;
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
436
|
+
accountId?: any;
|
|
437
|
+
requestId?: any;
|
|
438
|
+
batchId?: any;
|
|
439
|
+
loadAccounts?: any;
|
|
440
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
441
|
+
/**
|
|
442
|
+
* @tags Transfers Acats
|
|
443
|
+
* @name Cancel
|
|
444
|
+
* @summary Cancel
|
|
445
|
+
* @request POST:/transfer/acat/cancel
|
|
446
|
+
* @secure
|
|
447
|
+
*/
|
|
448
|
+
cancel(data: {
|
|
449
|
+
/** @example "AC123" */
|
|
450
|
+
account?: any;
|
|
451
|
+
/** @example 0 */
|
|
452
|
+
accountId?: any;
|
|
453
|
+
/** @example "{batchId}" */
|
|
454
|
+
batchId?: any;
|
|
455
|
+
/** @example "something for the record" */
|
|
456
|
+
comment?: any;
|
|
457
|
+
/** @example "{optional}" */
|
|
458
|
+
remoteDevice?: any;
|
|
459
|
+
/** @example "{optional}" */
|
|
460
|
+
remoteIp?: any;
|
|
461
|
+
/** @example "{requestId}" */
|
|
462
|
+
requestId?: any;
|
|
463
|
+
/** @example "{optional}|Cancelled|Disgarded" */
|
|
464
|
+
status?: any;
|
|
465
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
466
|
+
/**
|
|
467
|
+
* @tags Transfers Acats
|
|
468
|
+
* @name InitiateSchedule
|
|
469
|
+
* @summary Initiate/Schedule
|
|
470
|
+
* @request POST:/transfer/acat/initiate
|
|
471
|
+
* @secure
|
|
472
|
+
*/
|
|
473
|
+
initiateSchedule(data: {
|
|
474
|
+
account?: {
|
|
475
|
+
/** @example 0 */
|
|
476
|
+
accountId?: number;
|
|
477
|
+
/** @example "AC123" */
|
|
478
|
+
accountNumber?: string;
|
|
376
479
|
};
|
|
480
|
+
/** @example [{"isShort":0,"optionFlag":1,"quantity":1000,"quote":{"cusip":"0A1B2C","symbol":""},"symbol":"ZVZZT","type":"Security | Cash"}] */
|
|
481
|
+
assets?: any;
|
|
482
|
+
/** @example "{batchId}" */
|
|
483
|
+
batchId?: any;
|
|
484
|
+
/** @example "something for the record" */
|
|
485
|
+
comment?: any;
|
|
486
|
+
/** @example "" */
|
|
487
|
+
contraAccount?: any;
|
|
488
|
+
/** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
|
|
489
|
+
contraAccountType?: any;
|
|
490
|
+
/** @example "" */
|
|
491
|
+
contraNumber?: any;
|
|
492
|
+
/** @example "" */
|
|
493
|
+
contraTitle?: any;
|
|
494
|
+
/** @example "" */
|
|
495
|
+
participantNumber?: any;
|
|
496
|
+
/** @example "" */
|
|
497
|
+
primaryTaxId?: any;
|
|
498
|
+
/** @example "{optional}" */
|
|
499
|
+
remoteDevice?: any;
|
|
500
|
+
/** @example "{optional}" */
|
|
501
|
+
remoteIp?: any;
|
|
502
|
+
/** @example "" */
|
|
503
|
+
secondaryTaxId?: any;
|
|
504
|
+
/** @example "{optional}|RequestPlaced|Scheduled" */
|
|
505
|
+
status?: any;
|
|
506
|
+
/** @example "Full|Partial" */
|
|
507
|
+
type?: any;
|
|
377
508
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
378
509
|
/**
|
|
379
|
-
* @tags Transfers
|
|
380
|
-
* @name
|
|
381
|
-
* @summary
|
|
382
|
-
* @request POST:/transfer/
|
|
510
|
+
* @tags Transfers Acats
|
|
511
|
+
* @name BulkSchedule
|
|
512
|
+
* @summary Bulk schedule
|
|
513
|
+
* @request POST:/transfer/acat/schedule
|
|
383
514
|
* @secure
|
|
384
515
|
*/
|
|
385
|
-
|
|
386
|
-
|
|
516
|
+
bulkSchedule(data: {
|
|
517
|
+
account?: {
|
|
518
|
+
/** @example 0 */
|
|
519
|
+
accountId?: number;
|
|
520
|
+
/** @example "AC123" */
|
|
521
|
+
accountNumber?: string;
|
|
522
|
+
};
|
|
523
|
+
/** @example [{"quantity":1000,"symbol":"ZVZZT"}] */
|
|
524
|
+
assets?: {
|
|
525
|
+
/** @example 1000 */
|
|
526
|
+
quantity?: number;
|
|
527
|
+
/** @example "ZVZZT" */
|
|
528
|
+
symbol?: string;
|
|
529
|
+
}[];
|
|
530
|
+
/** @example "{batchId}" */
|
|
531
|
+
batchId?: string;
|
|
532
|
+
/** @example "something for the record" */
|
|
533
|
+
comment?: string;
|
|
534
|
+
/** @example "" */
|
|
535
|
+
contraAccount?: string;
|
|
536
|
+
/** @example "" */
|
|
537
|
+
contraAccountType?: string;
|
|
538
|
+
/** @example "" */
|
|
539
|
+
contraNumber?: string;
|
|
540
|
+
/** @example "" */
|
|
541
|
+
contraTitle?: string;
|
|
542
|
+
/** @example "" */
|
|
543
|
+
participantNumber?: string;
|
|
544
|
+
/** @example "" */
|
|
545
|
+
primaryTaxId?: string;
|
|
546
|
+
/** @example "{optional}" */
|
|
547
|
+
remoteDevice?: string;
|
|
548
|
+
/** @example "{optional}" */
|
|
549
|
+
remoteIp?: string;
|
|
550
|
+
/** @example "" */
|
|
551
|
+
secondaryTaxId?: string;
|
|
552
|
+
/** @example "Full|Partial" */
|
|
553
|
+
type?: string;
|
|
554
|
+
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
555
|
+
}
|
|
556
|
+
declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
557
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
558
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
559
|
+
/**
|
|
560
|
+
* @tags Transfers Wires
|
|
561
|
+
* @name Outgoing
|
|
562
|
+
* @summary Outgoing
|
|
563
|
+
* @request POST:/transfer/wire/outgoing
|
|
564
|
+
* @secure
|
|
565
|
+
*/
|
|
566
|
+
outgoing(data: {
|
|
567
|
+
/** @example "TRACCOUNT" */
|
|
387
568
|
account?: any;
|
|
388
|
-
/** @example
|
|
569
|
+
/** @example 200 */
|
|
389
570
|
amount?: any;
|
|
390
|
-
|
|
571
|
+
beneficiary?: {
|
|
572
|
+
/** @example "AAA012345" */
|
|
573
|
+
account?: string;
|
|
574
|
+
/** @example "CHECKING|SAVINGS" */
|
|
575
|
+
accountType?: string;
|
|
391
576
|
address?: {
|
|
392
577
|
/** @example "Central City" */
|
|
393
578
|
city?: string;
|
|
394
|
-
/** @example "
|
|
579
|
+
/** @example "USA" */
|
|
580
|
+
country?: string;
|
|
581
|
+
/** @example "11235" */
|
|
395
582
|
postalCode?: string;
|
|
396
|
-
/** @example "
|
|
583
|
+
/** @example "ST" */
|
|
397
584
|
stateProvince?: string;
|
|
398
|
-
/** @example ["
|
|
585
|
+
/** @example ["123 Main St"] */
|
|
399
586
|
streetAddress?: string[];
|
|
400
587
|
};
|
|
401
|
-
/** @example "
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
588
|
+
/** @example "John Smith" */
|
|
589
|
+
name?: string;
|
|
590
|
+
/** @example false */
|
|
591
|
+
thirdParty?: boolean;
|
|
592
|
+
};
|
|
593
|
+
/** @example "Partial|Full" */
|
|
594
|
+
disbursementType?: any;
|
|
595
|
+
/** @example 1234 */
|
|
596
|
+
entryId?: any;
|
|
597
|
+
/** @example false */
|
|
598
|
+
international?: any;
|
|
599
|
+
iraDetails?: {
|
|
600
|
+
/** @example "" */
|
|
601
|
+
contributionType?: string;
|
|
602
|
+
/** @example 2020 */
|
|
603
|
+
contributionYear?: number;
|
|
604
|
+
};
|
|
605
|
+
recipientBank?: {
|
|
606
|
+
/** @example "" */
|
|
607
|
+
additionalInformation?: string;
|
|
608
|
+
/** @example "" */
|
|
609
|
+
city?: string;
|
|
610
|
+
/** @example "" */
|
|
611
|
+
country?: string;
|
|
612
|
+
identifier?: {
|
|
613
|
+
/** @example "021202162" */
|
|
614
|
+
id?: string;
|
|
615
|
+
/** @example "ABA|BIC" */
|
|
616
|
+
type?: string;
|
|
408
617
|
};
|
|
409
|
-
/** @example "
|
|
410
|
-
|
|
618
|
+
/** @example "" */
|
|
619
|
+
name?: string;
|
|
620
|
+
/** @example "" */
|
|
621
|
+
postalCode?: string;
|
|
622
|
+
/** @example "" */
|
|
623
|
+
stateProvince?: string;
|
|
411
624
|
};
|
|
412
|
-
/** @example "
|
|
413
|
-
|
|
414
|
-
/** @example "1.1
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
remoteDevice?: any;
|
|
418
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
419
|
-
/**
|
|
420
|
-
* @tags Transfers Instant Cash Transfers
|
|
421
|
-
* @name ObtainTheReport
|
|
422
|
-
* @summary Obtain the report
|
|
423
|
-
* @request POST:/transfer/reports/obtain
|
|
424
|
-
* @secure
|
|
425
|
-
*/
|
|
426
|
-
obtainTheReport(data: {
|
|
427
|
-
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
428
|
-
date?: any;
|
|
429
|
-
/** @example "RETAIL_BANKING" */
|
|
430
|
-
reportType?: any;
|
|
431
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
432
|
-
/**
|
|
433
|
-
* @tags Transfers Instant Cash Transfers
|
|
434
|
-
* @name ListReports
|
|
435
|
-
* @summary List reports
|
|
436
|
-
* @request GET:/transfer/reports
|
|
437
|
-
* @secure
|
|
438
|
-
*/
|
|
439
|
-
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
625
|
+
/** @example "0.0.0.0" */
|
|
626
|
+
remoteAddr?: any;
|
|
627
|
+
/** @example "ultra fast browser 1.1" */
|
|
628
|
+
remoteDevice?: any;
|
|
629
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
440
630
|
}
|
|
441
631
|
declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
442
632
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -514,357 +704,167 @@ declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
|
514
704
|
/**
|
|
515
705
|
* @tags Transfers Positions
|
|
516
706
|
* @name TransferRequest
|
|
517
|
-
* @summary Transfer request
|
|
518
|
-
* @request POST:/transfer/position/request
|
|
519
|
-
* @secure
|
|
520
|
-
*/
|
|
521
|
-
transferRequest(data: {
|
|
522
|
-
deliverFrom?: {
|
|
523
|
-
/** @example 124 */
|
|
524
|
-
accountId?: number;
|
|
525
|
-
/** @example "ABC123456" */
|
|
526
|
-
accountNumber?: string;
|
|
527
|
-
};
|
|
528
|
-
deliverTo?: {
|
|
529
|
-
/** @example 456 */
|
|
530
|
-
accountId?: number;
|
|
531
|
-
/** @example "DEF123456" */
|
|
532
|
-
accountNumber?: string;
|
|
533
|
-
};
|
|
534
|
-
/** @example "NoPurpose|Gift" */
|
|
535
|
-
purpose?: any;
|
|
536
|
-
/** @example 1000 */
|
|
537
|
-
quantity?: any;
|
|
538
|
-
quote?: {
|
|
539
|
-
/** @example "IBM" */
|
|
540
|
-
symbol?: string;
|
|
541
|
-
};
|
|
542
|
-
/** @example "" */
|
|
543
|
-
reason?: any;
|
|
544
|
-
/** @example "0.0.0.0" */
|
|
545
|
-
remoteAddr?: any;
|
|
546
|
-
/** @example "Ultra fast proxy" */
|
|
547
|
-
remoteDevice?: any;
|
|
548
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
549
|
-
}
|
|
550
|
-
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
551
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
552
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
553
|
-
/**
|
|
554
|
-
* @tags Transfers Relationships
|
|
555
|
-
* @name List
|
|
556
|
-
* @summary List
|
|
557
|
-
* @request GET:/transfer/relationship/list/{account}
|
|
558
|
-
* @secure
|
|
559
|
-
*/
|
|
560
|
-
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
561
|
-
/**
|
|
562
|
-
* @tags Transfers Relationships
|
|
563
|
-
* @name GetInfo
|
|
564
|
-
* @summary Get Info
|
|
565
|
-
* @request GET:/transfer/relationship/get
|
|
566
|
-
* @secure
|
|
567
|
-
*/
|
|
568
|
-
getInfo(query?: {
|
|
569
|
-
/**
|
|
570
|
-
* Account number
|
|
571
|
-
* @example "ABC123"
|
|
572
|
-
*/
|
|
573
|
-
account?: any;
|
|
574
|
-
/**
|
|
575
|
-
* Desired entry ID
|
|
576
|
-
* @example "123"
|
|
577
|
-
*/
|
|
578
|
-
entryId?: any;
|
|
579
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
580
|
-
/**
|
|
581
|
-
* @tags Transfers Relationships
|
|
582
|
-
* @name PaymentMethods
|
|
583
|
-
* @summary Payment methods
|
|
584
|
-
* @request GET:/transfer/bank/paymentMethods
|
|
585
|
-
* @secure
|
|
586
|
-
*/
|
|
587
|
-
paymentMethods(query?: {
|
|
588
|
-
/** @example "IND" */
|
|
589
|
-
country?: any;
|
|
590
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
591
|
-
/**
|
|
592
|
-
* @tags Transfers Relationships
|
|
593
|
-
* @name PaymentMethodsViaAddress
|
|
594
|
-
* @summary Payment methods (via address)
|
|
595
|
-
* @request POST:/transfer/bank/paymentMethods
|
|
596
|
-
* @secure
|
|
597
|
-
*/
|
|
598
|
-
paymentMethodsViaAddress(data: {
|
|
599
|
-
/** @example "Mumbai" */
|
|
600
|
-
city?: any;
|
|
601
|
-
/** @example "IND" */
|
|
602
|
-
country?: any;
|
|
603
|
-
/** @example "400018" */
|
|
604
|
-
postalCode?: any;
|
|
605
|
-
/** @example "Maharashtra" */
|
|
606
|
-
stateProvince?: any;
|
|
607
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
608
|
-
streetAddress?: any;
|
|
609
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
610
|
-
/**
|
|
611
|
-
* @tags Transfers Relationships
|
|
612
|
-
* @name BankCodes
|
|
613
|
-
* @summary Bank Codes
|
|
614
|
-
* @request GET:/transfer/bank/bankCodes
|
|
615
|
-
* @secure
|
|
616
|
-
*/
|
|
617
|
-
bankCodes(query?: {
|
|
618
|
-
/** @example "IND|MEX" */
|
|
619
|
-
country?: any;
|
|
620
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
621
|
-
/**
|
|
622
|
-
* @tags Transfers Relationships
|
|
623
|
-
* @name BankCodesViaAddress
|
|
624
|
-
* @summary Bank Codes (via address)
|
|
625
|
-
* @request POST:/transfer/bank/bankCodes
|
|
626
|
-
* @secure
|
|
627
|
-
*/
|
|
628
|
-
bankCodesViaAddress(data: {
|
|
629
|
-
/** @example "Mumbai" */
|
|
630
|
-
city?: any;
|
|
631
|
-
/** @example "IND" */
|
|
632
|
-
country?: any;
|
|
633
|
-
/** @example "400018" */
|
|
634
|
-
postalCode?: any;
|
|
635
|
-
/** @example "Maharashtra" */
|
|
636
|
-
stateProvince?: any;
|
|
637
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
638
|
-
streetAddress?: any;
|
|
639
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
640
|
-
/**
|
|
641
|
-
* @tags Transfers Relationships
|
|
642
|
-
* @name Create
|
|
643
|
-
* @summary Create
|
|
644
|
-
* @request POST:/transfer/relationship/create
|
|
645
|
-
* @secure
|
|
646
|
-
*/
|
|
647
|
-
create(data: {
|
|
648
|
-
/** @example "5VA0XXXX" */
|
|
649
|
-
account?: any;
|
|
650
|
-
/** @example "111111" */
|
|
651
|
-
bankAccount?: any;
|
|
652
|
-
/** @example "John Doe" */
|
|
653
|
-
bankAccountOwnerName?: any;
|
|
654
|
-
/** @example "CHECKING" */
|
|
655
|
-
bankAccountType?: any;
|
|
656
|
-
/** @example "010101010" */
|
|
657
|
-
bankRoutingNumber?: any;
|
|
658
|
-
/** @example "Test" */
|
|
659
|
-
nickname?: any;
|
|
660
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
661
|
-
/**
|
|
662
|
-
* @tags Transfers Relationships
|
|
663
|
-
* @name WireInformation
|
|
664
|
-
* @summary Wire information
|
|
665
|
-
* @request POST:/transfer/relationship/wire/create
|
|
666
|
-
* @secure
|
|
667
|
-
*/
|
|
668
|
-
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
669
|
-
/**
|
|
670
|
-
* @tags Transfers Relationships
|
|
671
|
-
* @name BankingRelationship
|
|
672
|
-
* @summary Banking relationship
|
|
673
|
-
* @request POST:/transfer/relationship/bank/create
|
|
674
|
-
* @secure
|
|
675
|
-
*/
|
|
676
|
-
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
677
|
-
/**
|
|
678
|
-
* @tags Transfers Relationships
|
|
679
|
-
* @name Approve
|
|
680
|
-
* @summary Approve
|
|
681
|
-
* @request POST:/transfer/relationship/approve
|
|
682
|
-
* @secure
|
|
683
|
-
*/
|
|
684
|
-
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
685
|
-
/**
|
|
686
|
-
* @tags Transfers Relationships
|
|
687
|
-
* @name Cancel
|
|
688
|
-
* @summary Cancel
|
|
689
|
-
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
690
|
-
* @secure
|
|
691
|
-
*/
|
|
692
|
-
cancel(entryId: string, data: {
|
|
693
|
-
/** @example "2QC05208" */
|
|
694
|
-
account?: any;
|
|
695
|
-
/** @example "USER CANCELED" */
|
|
696
|
-
reason?: any;
|
|
697
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
698
|
-
/**
|
|
699
|
-
* @tags Transfers Relationships
|
|
700
|
-
* @name Rename
|
|
701
|
-
* @summary Rename
|
|
702
|
-
* @request POST:/transfer/relationship/rename/{entryId}
|
|
703
|
-
* @secure
|
|
704
|
-
*/
|
|
705
|
-
rename(entryId: string, data: {
|
|
706
|
-
/** @example "Citi Checking 2" */
|
|
707
|
-
nickname?: any;
|
|
708
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
709
|
-
/**
|
|
710
|
-
* @tags Transfers Relationships
|
|
711
|
-
* @name AdvisorPolicyUpdate
|
|
712
|
-
* @summary Advisor Policy Update
|
|
713
|
-
* @request POST:/transfer/relationship/policy
|
|
714
|
-
* @secure
|
|
715
|
-
*/
|
|
716
|
-
advisorPolicyUpdate(data: {
|
|
717
|
-
account?: {
|
|
718
|
-
/** @example 0 */
|
|
719
|
-
accountId?: number;
|
|
720
|
-
/** @example "{optional}" */
|
|
721
|
-
accountNumber?: string;
|
|
722
|
-
};
|
|
723
|
-
/** @example 123 */
|
|
724
|
-
entryId?: any;
|
|
725
|
-
/** @example true */
|
|
726
|
-
esigned?: any;
|
|
727
|
-
/** @example "AllowWithdrawal|Disallow" */
|
|
728
|
-
policy?: any;
|
|
729
|
-
/** @example "" */
|
|
730
|
-
remoteAddr?: any;
|
|
731
|
-
/** @example "" */
|
|
732
|
-
remoteDevice?: any;
|
|
733
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
734
|
-
/**
|
|
735
|
-
* @tags Transfers Relationships
|
|
736
|
-
* @name DocumentUpload
|
|
737
|
-
* @summary Document upload
|
|
738
|
-
* @request POST:/transfer/relationship/wire/upload
|
|
739
|
-
* @secure
|
|
740
|
-
*/
|
|
741
|
-
documentUpload(data: {
|
|
742
|
-
/**
|
|
743
|
-
* Wire relationship ID
|
|
744
|
-
* @example ""
|
|
745
|
-
*/
|
|
746
|
-
entryId?: string;
|
|
747
|
-
/**
|
|
748
|
-
* Document file
|
|
749
|
-
* @format binary
|
|
750
|
-
*/
|
|
751
|
-
file?: File;
|
|
752
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
753
|
-
/**
|
|
754
|
-
* @tags Transfers Relationships
|
|
755
|
-
* @name MfaReInitiation
|
|
756
|
-
* @summary 2FA re-initiation
|
|
757
|
-
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
758
|
-
* @secure
|
|
759
|
-
*/
|
|
760
|
-
mfaReInitiation(data: {
|
|
761
|
-
/** @example 123 */
|
|
762
|
-
entryId?: any;
|
|
763
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
764
|
-
/**
|
|
765
|
-
* @tags Transfers Relationships
|
|
766
|
-
* @name SupplementWire
|
|
767
|
-
* @summary Supplement wire
|
|
768
|
-
* @request POST:/transfer/relationship/wire/supplement
|
|
707
|
+
* @summary Transfer request
|
|
708
|
+
* @request POST:/transfer/position/request
|
|
769
709
|
* @secure
|
|
770
710
|
*/
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
/** @example "
|
|
776
|
-
|
|
777
|
-
identifier?: {
|
|
778
|
-
/** @example "AAA-123-2587964" */
|
|
779
|
-
id?: string;
|
|
780
|
-
/** @example "BIC" */
|
|
781
|
-
type?: string;
|
|
782
|
-
};
|
|
783
|
-
/** @example "ABC 123" */
|
|
784
|
-
postalCode?: string;
|
|
785
|
-
/** @example "NJ" */
|
|
786
|
-
stateProvince?: string;
|
|
711
|
+
transferRequest(data: {
|
|
712
|
+
deliverFrom?: {
|
|
713
|
+
/** @example 124 */
|
|
714
|
+
accountId?: number;
|
|
715
|
+
/** @example "ABC123456" */
|
|
716
|
+
accountNumber?: string;
|
|
787
717
|
};
|
|
788
|
-
|
|
789
|
-
/** @example
|
|
718
|
+
deliverTo?: {
|
|
719
|
+
/** @example 456 */
|
|
720
|
+
accountId?: number;
|
|
721
|
+
/** @example "DEF123456" */
|
|
790
722
|
accountNumber?: string;
|
|
791
723
|
};
|
|
724
|
+
/** @example "NoPurpose|Gift" */
|
|
725
|
+
purpose?: any;
|
|
726
|
+
/** @example 1000 */
|
|
727
|
+
quantity?: any;
|
|
728
|
+
quote?: {
|
|
729
|
+
/** @example "IBM" */
|
|
730
|
+
symbol?: string;
|
|
731
|
+
};
|
|
732
|
+
/** @example "" */
|
|
733
|
+
reason?: any;
|
|
734
|
+
/** @example "0.0.0.0" */
|
|
735
|
+
remoteAddr?: any;
|
|
736
|
+
/** @example "Ultra fast proxy" */
|
|
737
|
+
remoteDevice?: any;
|
|
792
738
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
793
739
|
}
|
|
794
|
-
declare class
|
|
740
|
+
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
795
741
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
796
742
|
constructor(apiClient: JwtClient<HandleError>);
|
|
797
743
|
/**
|
|
798
|
-
* @tags Transfers
|
|
799
|
-
* @name
|
|
800
|
-
* @summary
|
|
801
|
-
* @request POST:/transfer/
|
|
744
|
+
* @tags Transfers Bank
|
|
745
|
+
* @name FundTransfer
|
|
746
|
+
* @summary Fund transfer
|
|
747
|
+
* @request POST:/transfer/bank/{direction}
|
|
802
748
|
* @secure
|
|
803
749
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
750
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
751
|
+
}
|
|
752
|
+
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
753
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
754
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
755
|
+
/**
|
|
756
|
+
* @tags Transfers Instant Cash Transfers
|
|
757
|
+
* @name DepositWithdrawal
|
|
758
|
+
* @summary Deposit/Withdrawal
|
|
759
|
+
* @request POST:/transfer/ict/${direction}
|
|
760
|
+
* @secure
|
|
761
|
+
*/
|
|
762
|
+
depositWithdrawal(direction: string, data: {
|
|
763
|
+
/** @example "ABC123456" */
|
|
806
764
|
account?: any;
|
|
807
|
-
/** @example
|
|
765
|
+
/** @example 100 */
|
|
808
766
|
amount?: any;
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
/** @example "CHECKING|SAVINGS" */
|
|
813
|
-
accountType?: string;
|
|
767
|
+
/** @example "USD" */
|
|
768
|
+
currency?: any;
|
|
769
|
+
originator?: {
|
|
814
770
|
address?: {
|
|
815
771
|
/** @example "Central City" */
|
|
816
772
|
city?: string;
|
|
817
773
|
/** @example "USA" */
|
|
818
774
|
country?: string;
|
|
819
|
-
/** @example "
|
|
775
|
+
/** @example "12345" */
|
|
820
776
|
postalCode?: string;
|
|
821
|
-
/** @example "
|
|
777
|
+
/** @example "NY" */
|
|
822
778
|
stateProvince?: string;
|
|
823
779
|
/** @example ["123 Main St"] */
|
|
824
780
|
streetAddress?: string[];
|
|
825
781
|
};
|
|
826
|
-
/** @example "John
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
international?: any;
|
|
837
|
-
iraDetails?: {
|
|
838
|
-
/** @example "" */
|
|
839
|
-
contributionType?: string;
|
|
840
|
-
/** @example 2020 */
|
|
841
|
-
contributionYear?: number;
|
|
782
|
+
/** @example "John" */
|
|
783
|
+
firstName?: string;
|
|
784
|
+
institution?: {
|
|
785
|
+
/** @example "123456789" */
|
|
786
|
+
accountNumber?: string;
|
|
787
|
+
/** @example "Central City Central Bank" */
|
|
788
|
+
name?: string;
|
|
789
|
+
};
|
|
790
|
+
/** @example "Smith" */
|
|
791
|
+
lastName?: string;
|
|
842
792
|
};
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
793
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
794
|
+
/**
|
|
795
|
+
* @tags Transfers Instant Cash Transfers
|
|
796
|
+
* @name DepositWithdrawalV2
|
|
797
|
+
* @summary Deposit/Withdrawal V2
|
|
798
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
799
|
+
* @secure
|
|
800
|
+
*/
|
|
801
|
+
depositWithdrawalV2(direction: string, data: {
|
|
802
|
+
/** @example "AB123456" */
|
|
803
|
+
account?: any;
|
|
804
|
+
/** @example 100.32 */
|
|
805
|
+
amount?: any;
|
|
806
|
+
counterparty?: {
|
|
807
|
+
address?: {
|
|
808
|
+
/** @example "Central City" */
|
|
809
|
+
city?: string;
|
|
810
|
+
/** @example "12345" */
|
|
811
|
+
postalCode?: string;
|
|
812
|
+
/** @example "CC" */
|
|
813
|
+
stateProvince?: string;
|
|
814
|
+
/** @example ["225 Baker St"] */
|
|
815
|
+
streetAddress?: string[];
|
|
855
816
|
};
|
|
856
|
-
/** @example "" */
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
817
|
+
/** @example "James" */
|
|
818
|
+
firstName?: string;
|
|
819
|
+
institution?: {
|
|
820
|
+
/** @example "123456" */
|
|
821
|
+
accountNumber?: string;
|
|
822
|
+
/** @example "Royal Central Bank" */
|
|
823
|
+
name?: string;
|
|
824
|
+
};
|
|
825
|
+
/** @example "Bond" */
|
|
826
|
+
lastName?: string;
|
|
862
827
|
};
|
|
863
|
-
/** @example "
|
|
828
|
+
/** @example "USD" */
|
|
829
|
+
currency?: any;
|
|
830
|
+
/** @example "1.1.1.1" */
|
|
864
831
|
remoteAddr?: any;
|
|
865
|
-
/** @example "
|
|
832
|
+
/** @example "Droid Phone" */
|
|
866
833
|
remoteDevice?: any;
|
|
867
834
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
835
|
+
/**
|
|
836
|
+
* @tags Transfers Instant Cash Transfers
|
|
837
|
+
* @name ObtainTheReport
|
|
838
|
+
* @summary Obtain the report
|
|
839
|
+
* @request POST:/transfer/reports/obtain
|
|
840
|
+
* @secure
|
|
841
|
+
*/
|
|
842
|
+
obtainTheReport(data: {
|
|
843
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
844
|
+
date?: any;
|
|
845
|
+
/** @example "RETAIL_BANKING" */
|
|
846
|
+
reportType?: any;
|
|
847
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
848
|
+
/**
|
|
849
|
+
* @tags Transfers Instant Cash Transfers
|
|
850
|
+
* @name ListReports
|
|
851
|
+
* @summary List reports
|
|
852
|
+
* @request GET:/transfer/reports
|
|
853
|
+
* @secure
|
|
854
|
+
*/
|
|
855
|
+
listReports(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
|
|
865
|
+
* @secure
|
|
866
|
+
*/
|
|
867
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
868
868
|
}
|
|
869
869
|
declare class _Transfers1<HandleError extends boolean = boolean> {
|
|
870
870
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -14979,62 +14979,11 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14979
14979
|
* @description Executes the quote identified by `quote_id`.
|
|
14980
14980
|
* @tags Payments
|
|
14981
14981
|
* @name ExecuteQuote
|
|
14982
|
-
* @summary Execute quote
|
|
14983
|
-
* @request POST:/payments/execute
|
|
14984
|
-
* @secure
|
|
14985
|
-
*/
|
|
14986
|
-
executeQuote(data: ZeroHashPostPaymentsExecutePaymentRequest, headers?: {
|
|
14987
|
-
/**
|
|
14988
|
-
* Signature for your request.
|
|
14989
|
-
* @default "[WEB] auto-generated on fly"
|
|
14990
|
-
*/
|
|
14991
|
-
'X-SCX-SIGNED'?: string;
|
|
14992
|
-
/**
|
|
14993
|
-
* UNIX timestamp.
|
|
14994
|
-
* @default "[WEB] auto-generated on fly"
|
|
14995
|
-
*/
|
|
14996
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
14997
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
14998
|
-
}
|
|
14999
|
-
export class MarketData<HandleError extends boolean = boolean> {
|
|
15000
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15002
|
-
/**
|
|
15003
|
-
* @description Retrieves a list of symbols and their market data.
|
|
15004
|
-
* @tags Market Data
|
|
15005
|
-
* @name GetSymbolData
|
|
15006
|
-
* @summary Get symbol data
|
|
15007
|
-
* @request GET:/market_data/symbol_data
|
|
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?: {
|
|
14982
|
+
* @summary Execute quote
|
|
14983
|
+
* @request POST:/payments/execute
|
|
14984
|
+
* @secure
|
|
14985
|
+
*/
|
|
14986
|
+
executeQuote(data: ZeroHashPostPaymentsExecutePaymentRequest, headers?: {
|
|
15038
14987
|
/**
|
|
15039
14988
|
* Signature for your request.
|
|
15040
14989
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -15045,47 +14994,7 @@ export class MarketData<HandleError extends boolean = boolean> {
|
|
|
15045
14994
|
* @default "[WEB] auto-generated on fly"
|
|
15046
14995
|
*/
|
|
15047
14996
|
'X-SCX-TIMESTAMP'?: string;
|
|
15048
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
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>>;
|
|
14997
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
15089
14998
|
}
|
|
15090
14999
|
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
15091
15000
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -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>;
|