@orbis-systems/orbis-api-clients 0.7.10 → 0.7.11
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 +114 -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 +500 -491
- 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 +622 -544
- 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/orbis/index.d.ts +1469 -1469
- 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 +319 -319
- 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 +130 -130
- 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
|
@@ -400,6 +400,26 @@ declare class TransfersInstantAccountVerification<HandleError extends boolean =
|
|
|
400
400
|
remoteDevice?: any;
|
|
401
401
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
402
402
|
}
|
|
403
|
+
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
404
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
405
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
406
|
+
/**
|
|
407
|
+
* @tags Transfers Ach
|
|
408
|
+
* @name Deposit
|
|
409
|
+
* @summary Deposit
|
|
410
|
+
* @request POST:/transfer/ach/deposit
|
|
411
|
+
* @secure
|
|
412
|
+
*/
|
|
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
|
+
}
|
|
403
423
|
declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
404
424
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
405
425
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -533,26 +553,6 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
533
553
|
type?: string;
|
|
534
554
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
535
555
|
}
|
|
536
|
-
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
537
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
538
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
539
|
-
/**
|
|
540
|
-
* @tags Transfers Ach
|
|
541
|
-
* @name Deposit
|
|
542
|
-
* @summary Deposit
|
|
543
|
-
* @request POST:/transfer/ach/deposit
|
|
544
|
-
* @secure
|
|
545
|
-
*/
|
|
546
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
547
|
-
/**
|
|
548
|
-
* @tags Transfers Ach
|
|
549
|
-
* @name Withdraw
|
|
550
|
-
* @summary Withdraw
|
|
551
|
-
* @request POST:/transfer/ach/withdraw
|
|
552
|
-
* @secure
|
|
553
|
-
*/
|
|
554
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
555
|
-
}
|
|
556
556
|
declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
557
557
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
558
558
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -628,6 +628,57 @@ declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
|
628
628
|
remoteDevice?: any;
|
|
629
629
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
630
630
|
}
|
|
631
|
+
declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
632
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
633
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
634
|
+
/**
|
|
635
|
+
* @tags Transfers Positions
|
|
636
|
+
* @name TransferRequest
|
|
637
|
+
* @summary Transfer request
|
|
638
|
+
* @request POST:/transfer/position/request
|
|
639
|
+
* @secure
|
|
640
|
+
*/
|
|
641
|
+
transferRequest(data: {
|
|
642
|
+
deliverFrom?: {
|
|
643
|
+
/** @example 124 */
|
|
644
|
+
accountId?: number;
|
|
645
|
+
/** @example "ABC123456" */
|
|
646
|
+
accountNumber?: string;
|
|
647
|
+
};
|
|
648
|
+
deliverTo?: {
|
|
649
|
+
/** @example 456 */
|
|
650
|
+
accountId?: number;
|
|
651
|
+
/** @example "DEF123456" */
|
|
652
|
+
accountNumber?: string;
|
|
653
|
+
};
|
|
654
|
+
/** @example "NoPurpose|Gift" */
|
|
655
|
+
purpose?: any;
|
|
656
|
+
/** @example 1000 */
|
|
657
|
+
quantity?: any;
|
|
658
|
+
quote?: {
|
|
659
|
+
/** @example "IBM" */
|
|
660
|
+
symbol?: string;
|
|
661
|
+
};
|
|
662
|
+
/** @example "" */
|
|
663
|
+
reason?: any;
|
|
664
|
+
/** @example "0.0.0.0" */
|
|
665
|
+
remoteAddr?: any;
|
|
666
|
+
/** @example "Ultra fast proxy" */
|
|
667
|
+
remoteDevice?: any;
|
|
668
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
669
|
+
}
|
|
670
|
+
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
671
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
672
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
673
|
+
/**
|
|
674
|
+
* @tags Transfers Bank
|
|
675
|
+
* @name FundTransfer
|
|
676
|
+
* @summary Fund transfer
|
|
677
|
+
* @request POST:/transfer/bank/{direction}
|
|
678
|
+
* @secure
|
|
679
|
+
*/
|
|
680
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
681
|
+
}
|
|
631
682
|
declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
632
683
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
633
684
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -698,57 +749,6 @@ declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
698
749
|
transferId?: any;
|
|
699
750
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
700
751
|
}
|
|
701
|
-
declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
702
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
703
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
704
|
-
/**
|
|
705
|
-
* @tags Transfers Positions
|
|
706
|
-
* @name TransferRequest
|
|
707
|
-
* @summary Transfer request
|
|
708
|
-
* @request POST:/transfer/position/request
|
|
709
|
-
* @secure
|
|
710
|
-
*/
|
|
711
|
-
transferRequest(data: {
|
|
712
|
-
deliverFrom?: {
|
|
713
|
-
/** @example 124 */
|
|
714
|
-
accountId?: number;
|
|
715
|
-
/** @example "ABC123456" */
|
|
716
|
-
accountNumber?: string;
|
|
717
|
-
};
|
|
718
|
-
deliverTo?: {
|
|
719
|
-
/** @example 456 */
|
|
720
|
-
accountId?: number;
|
|
721
|
-
/** @example "DEF123456" */
|
|
722
|
-
accountNumber?: string;
|
|
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;
|
|
738
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
739
|
-
}
|
|
740
|
-
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
741
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
742
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
743
|
-
/**
|
|
744
|
-
* @tags Transfers Bank
|
|
745
|
-
* @name FundTransfer
|
|
746
|
-
* @summary Fund transfer
|
|
747
|
-
* @request POST:/transfer/bank/{direction}
|
|
748
|
-
* @secure
|
|
749
|
-
*/
|
|
750
|
-
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
751
|
-
}
|
|
752
752
|
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
753
753
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
754
754
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -15181,6 +15181,65 @@ export class MarketData<HandleError extends boolean = boolean> {
|
|
|
15181
15181
|
*/
|
|
15182
15182
|
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15183
15183
|
}
|
|
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
|
+
}
|
|
15184
15243
|
export class Clob<HandleError extends boolean = boolean> {
|
|
15185
15244
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15186
15245
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -15394,65 +15453,6 @@ export class Clob<HandleError extends boolean = boolean> {
|
|
|
15394
15453
|
'X-SCX-TIMESTAMP'?: string;
|
|
15395
15454
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
|
|
15396
15455
|
}
|
|
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>;
|