Documentation
Table of contents
Classes
- AdminApi
- AutoretrieveApi
- BaseAPI
- CollectionsApi
- ContentApi
- DealsApi
- DefaultApi
- MetricsApi
- MinerApi
- NetApi
- PeeringApi
- PeersApi
- PinningApi
- PublicApi
- RequiredError
- UserApi
Interfaces
- CollectionsCollection
- FetchAPI
- FetchArgs
- MainCreateCollectionBody
- MainDeleteContentFromCollectionBody
- MainEstimateDealBody
- MainGetApiKeysResp
- MainImportDealBody
- MainUserStatsResponse
- UtilContentAddIpfsBody
- UtilContentAddResponse
- UtilContentCreateBody
- UtilHttpError
Variables
Functions
- AdminApiFactory
- AdminApiFetchParamCreator
- AdminApiFp
- AutoretrieveApiFactory
- AutoretrieveApiFetchParamCreator
- AutoretrieveApiFp
- CollectionsApiFactory
- CollectionsApiFetchParamCreator
- CollectionsApiFp
- ContentApiFactory
- ContentApiFetchParamCreator
- ContentApiFp
- DealsApiFactory
- DealsApiFetchParamCreator
- DealsApiFp
- DefaultApiFactory
- DefaultApiFetchParamCreator
- DefaultApiFp
- MetricsApiFactory
- MetricsApiFetchParamCreator
- MetricsApiFp
- MinerApiFactory
- MinerApiFetchParamCreator
- MinerApiFp
- NetApiFactory
- NetApiFetchParamCreator
- NetApiFp
- PeeringApiFactory
- PeeringApiFetchParamCreator
- PeeringApiFp
- PeersApiFactory
- PeersApiFetchParamCreator
- PeersApiFp
- PinningApiFactory
- PinningApiFetchParamCreator
- PinningApiFp
- PublicApiFactory
- PublicApiFetchParamCreator
- PublicApiFp
- UserApiFactory
- UserApiFetchParamCreator
- UserApiFp
Variables
COLLECTION_FORMATS
• Const COLLECTION_FORMATS: Object
Export
Type declaration
| Name | Type |
|---|---|
csv | string |
pipes | string |
ssv | string |
tsv | string |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:26
Functions
AdminApiFactory
▸ AdminApiFactory(configuration?, fetch?, basePath?): Object
AdminApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => Promise<Response> |
adminPeeringStartPost | (options?: any) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => Promise<Response> |
adminPeeringStopPost | (options?: any) => Promise<Response> |
adminSystemConfigGet | (options?: any) => Promise<Response> |
adminUsersGet | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:834
AdminApiFetchParamCreator
▸ AdminApiFetchParamCreator(configuration?): Object
AdminApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => FetchArgs |
adminPeeringPeersGet | (options?: any) => FetchArgs |
adminPeeringPeersPost | (options?: any) => FetchArgs |
adminPeeringStartPost | (options?: any) => FetchArgs |
adminPeeringStatusGet | (options?: any) => FetchArgs |
adminPeeringStopPost | (options?: any) => FetchArgs |
adminSystemConfigGet | (options?: any) => FetchArgs |
adminUsersGet | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:414
AdminApiFp
▸ AdminApiFp(configuration?): Object
AdminApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStartPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStopPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminSystemConfigGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminUsersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:680
AutoretrieveApiFactory
▸ AutoretrieveApiFactory(configuration?, fetch?, basePath?): Object
AutoretrieveApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
adminAutoretrieveInitPost | (addresses: string, pubKey: string, options?: any) => Promise<Response> |
adminAutoretrieveListGet | (options?: any) => Promise<Response> |
autoretrieveHeartbeatPost | (token: string, options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1205
AutoretrieveApiFetchParamCreator
▸ AutoretrieveApiFetchParamCreator(configuration?): Object
AutoretrieveApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminAutoretrieveInitPost | (addresses: string, pubKey: string, options?: any) => FetchArgs |
adminAutoretrieveListGet | (options?: any) => FetchArgs |
autoretrieveHeartbeatPost | (token: string, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1014
AutoretrieveApiFp
▸ AutoretrieveApiFp(configuration?): Object
AutoretrieveApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminAutoretrieveInitPost | (addresses: string, pubKey: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminAutoretrieveListGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
autoretrieveHeartbeatPost | (token: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1139
CollectionsApiFactory
▸ CollectionsApiFactory(configuration?, fetch?, basePath?): Object
CollectionsApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
collectionsColuuidCommitPost | (coluuid: string, options?: any) => Promise<string> |
collectionsColuuidContentsDelete | (coluuid: string, contentid: string, body: MainDeleteContentFromCollectionBody, options?: any) => Promise<string> |
collectionsColuuidDelete | (coluuid: string, options?: any) => Promise<Response> |
collectionsColuuidGet | (coluuid: string, dir?: string, options?: any) => Promise<string> |
collectionsColuuidPost | (coluuid: string, contentIDs: number[], options?: any) => Promise<{ [key: string]: string; }> |
collectionsFsAddPost | (coluuid: string, content: string, path: string, options?: any) => Promise<Response> |
collectionsGet | (options?: any) => Promise<CollectionsCollection[]> |
collectionsPost | (body: MainCreateCollectionBody, options?: any) => Promise<CollectionsCollection> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1807
CollectionsApiFetchParamCreator
▸ CollectionsApiFetchParamCreator(configuration?): Object
CollectionsApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
collectionsColuuidCommitPost | (coluuid: string, options?: any) => FetchArgs |
collectionsColuuidContentsDelete | (coluuid: string, contentid: string, body: MainDeleteContentFromCollectionBody, options?: any) => FetchArgs |
collectionsColuuidDelete | (coluuid: string, options?: any) => FetchArgs |
collectionsColuuidGet | (coluuid: string, dir?: string, options?: any) => FetchArgs |
collectionsColuuidPost | (coluuid: string, contentIDs: number[], options?: any) => FetchArgs |
collectionsFsAddPost | (coluuid: string, content: string, path: string, options?: any) => FetchArgs |
collectionsGet | (options?: any) => FetchArgs |
collectionsPost | (body: MainCreateCollectionBody, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1289
CollectionsApiFp
▸ CollectionsApiFp(configuration?): Object
CollectionsApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
collectionsColuuidCommitPost | (coluuid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
collectionsColuuidContentsDelete | (coluuid: string, contentid: string, body: MainDeleteContentFromCollectionBody, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
collectionsColuuidDelete | (coluuid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
collectionsColuuidGet | (coluuid: string, dir?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
collectionsColuuidPost | (coluuid: string, contentIDs: number[], options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<{ [key: string]: string; }> |
collectionsFsAddPost | (coluuid: string, content: string, path: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
collectionsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<CollectionsCollection[]> |
collectionsPost | (body: MainCreateCollectionBody, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<CollectionsCollection> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:1641
ContentApiFactory
▸ ContentApiFactory(configuration?, fetch?, basePath?): Object
ContentApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
contentAddCarPost | (body: string, ignoreDupes?: string, filename?: string, options?: any) => Promise<Response> |
contentAddIpfsPost | (body: UtilContentAddIpfsBody, ignoreDupes?: string, options?: any) => Promise<Response> |
contentAddPost | (data: any, filename?: string, coluuid?: string, replication?: number, ignoreDupes?: string, lazyProvide?: string, dir?: string, options?: any) => Promise<UtilContentAddResponse> |
contentAggregatedContentGet | (content: string, options?: any) => Promise<string> |
contentAllDealsGet | (begin: string, duration: string, all: string, options?: any) => Promise<Response> |
contentBwUsageContentGet | (content: string, options?: any) => Promise<Response> |
contentCreatePost | (req: UtilContentCreateBody, ignoreDupes?: string, options?: any) => Promise<Response> |
contentDealsGet | (limit?: number, offset?: number, options?: any) => Promise<Response> |
contentEnsureReplicationDatacidGet | (datacid: string, options?: any) => Promise<Response> |
contentFailuresContentGet | (content: string, options?: any) => Promise<string> |
contentIdGet | (id: number, options?: any) => Promise<Response> |
contentImportdealPost | (body: MainImportDealBody, options?: any) => Promise<Response> |
contentListGet | (options?: any) => Promise<string[]> |
contentReadContGet | (cont: string, options?: any) => Promise<Response> |
contentStagingZonesGet | (options?: any) => Promise<Response> |
contentStatsGet | (limit: string, offset: string, options?: any) => Promise<Response> |
contentStatusIdGet | (id: number, options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3087
ContentApiFetchParamCreator
▸ ContentApiFetchParamCreator(configuration?): Object
ContentApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
contentAddCarPost | (body: string, ignoreDupes?: string, filename?: string, options?: any) => FetchArgs |
contentAddIpfsPost | (body: UtilContentAddIpfsBody, ignoreDupes?: string, options?: any) => FetchArgs |
contentAddPost | (data: any, filename?: string, coluuid?: string, replication?: number, ignoreDupes?: string, lazyProvide?: string, dir?: string, options?: any) => FetchArgs |
contentAggregatedContentGet | (content: string, options?: any) => FetchArgs |
contentAllDealsGet | (begin: string, duration: string, all: string, options?: any) => FetchArgs |
contentBwUsageContentGet | (content: string, options?: any) => FetchArgs |
contentCreatePost | (req: UtilContentCreateBody, ignoreDupes?: string, options?: any) => FetchArgs |
contentDealsGet | (limit?: number, offset?: number, options?: any) => FetchArgs |
contentEnsureReplicationDatacidGet | (datacid: string, options?: any) => FetchArgs |
contentFailuresContentGet | (content: string, options?: any) => FetchArgs |
contentIdGet | (id: number, options?: any) => FetchArgs |
contentImportdealPost | (body: MainImportDealBody, options?: any) => FetchArgs |
contentListGet | (options?: any) => FetchArgs |
contentReadContGet | (cont: string, options?: any) => FetchArgs |
contentStagingZonesGet | (options?: any) => FetchArgs |
contentStatsGet | (limit: string, offset: string, options?: any) => FetchArgs |
contentStatusIdGet | (id: number, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:2011
ContentApiFp
▸ ContentApiFp(configuration?): Object
ContentApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
contentAddCarPost | (body: string, ignoreDupes?: string, filename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentAddIpfsPost | (body: UtilContentAddIpfsBody, ignoreDupes?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentAddPost | (data: any, filename?: string, coluuid?: string, replication?: number, ignoreDupes?: string, lazyProvide?: string, dir?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<UtilContentAddResponse> |
contentAggregatedContentGet | (content: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
contentAllDealsGet | (begin: string, duration: string, all: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentBwUsageContentGet | (content: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentCreatePost | (req: UtilContentCreateBody, ignoreDupes?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentDealsGet | (limit?: number, offset?: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentEnsureReplicationDatacidGet | (datacid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentFailuresContentGet | (content: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
contentIdGet | (id: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentImportdealPost | (body: MainImportDealBody, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentListGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
contentReadContGet | (cont: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentStagingZonesGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentStatsGet | (limit: string, offset: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
contentStatusIdGet | (id: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:2743
DealsApiFactory
▸ DealsApiFactory(configuration?, fetch?, basePath?): Object
DealsApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
dealEstimatePost | (body: MainEstimateDealBody, options?: any) => Promise<Response> |
dealInfoDealidGet | (dealid: number, options?: any) => Promise<Response> |
dealProposalPropcidGet | (propcid: string, options?: any) => Promise<Response> |
dealQueryMinerGet | (miner: string, options?: any) => Promise<Response> |
dealStatusByProposalPropcidGet | (propcid: string, options?: any) => Promise<Response> |
dealStatusMinerPropcidGet | (miner: string, propcid: string, options?: any) => Promise<Response> |
dealTransferInProgressGet | (options?: any) => Promise<Response> |
dealsFailuresGet | (options?: any) => Promise<Response> |
dealsMakeMinerPost | (miner: string, dealRequest: string, options?: any) => Promise<Response> |
dealsStatusDealGet | (deal: number, options?: any) => Promise<Response> |
publicDealsFailuresGet | (options?: any) => Promise<Response> |
publicMinersStorageQueryMinerGet | (miner: string, options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4192
DealsApiFetchParamCreator
▸ DealsApiFetchParamCreator(configuration?): Object
DealsApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
dealEstimatePost | (body: MainEstimateDealBody, options?: any) => FetchArgs |
dealInfoDealidGet | (dealid: number, options?: any) => FetchArgs |
dealProposalPropcidGet | (propcid: string, options?: any) => FetchArgs |
dealQueryMinerGet | (miner: string, options?: any) => FetchArgs |
dealStatusByProposalPropcidGet | (propcid: string, options?: any) => FetchArgs |
dealStatusMinerPropcidGet | (miner: string, propcid: string, options?: any) => FetchArgs |
dealTransferInProgressGet | (options?: any) => FetchArgs |
dealsFailuresGet | (options?: any) => FetchArgs |
dealsMakeMinerPost | (miner: string, dealRequest: string, options?: any) => FetchArgs |
dealsStatusDealGet | (deal: number, options?: any) => FetchArgs |
publicDealsFailuresGet | (options?: any) => FetchArgs |
publicMinersStorageQueryMinerGet | (miner: string, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3503
DealsApiFp
▸ DealsApiFp(configuration?): Object
DealsApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
dealEstimatePost | (body: MainEstimateDealBody, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealInfoDealidGet | (dealid: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealProposalPropcidGet | (propcid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealQueryMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealStatusByProposalPropcidGet | (propcid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealStatusMinerPropcidGet | (miner: string, propcid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealTransferInProgressGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealsFailuresGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealsMakeMinerPost | (miner: string, dealRequest: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
dealsStatusDealGet | (deal: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicDealsFailuresGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersStorageQueryMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3956
DefaultApiFactory
▸ DefaultApiFactory(configuration?, fetch?, basePath?): Object
DefaultApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
dealTransferStatusPost | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4537
DefaultApiFetchParamCreator
▸ DefaultApiFetchParamCreator(configuration?): Object
DefaultApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
dealTransferStatusPost | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4472
DefaultApiFp
▸ DefaultApiFp(configuration?): Object
DefaultApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
dealTransferStatusPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4511
MetricsApiFactory
▸ MetricsApiFactory(configuration?, fetch?, basePath?): Object
MetricsApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
publicMetricsDealsOnChainGet | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4640
MetricsApiFetchParamCreator
▸ MetricsApiFetchParamCreator(configuration?): Object
MetricsApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicMetricsDealsOnChainGet | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4573
MetricsApiFp
▸ MetricsApiFp(configuration?): Object
MetricsApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicMetricsDealsOnChainGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4613
MinerApiFactory
▸ MinerApiFactory(configuration?, fetch?, basePath?): Object
MinerApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => Promise<Response> |
publicMinersStatsMinerGet | (miner: string, options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4814
MinerApiFetchParamCreator
▸ MinerApiFetchParamCreator(configuration?): Object
MinerApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => FetchArgs |
publicMinersStatsMinerGet | (miner: string, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4678
MinerApiFp
▸ MinerApiFp(configuration?): Object
MinerApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersStatsMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4766
NetApiFactory
▸ NetApiFactory(configuration?, fetch?, basePath?): Object
NetApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
netAddrsGet | (options?: any) => Promise<string[]> |
publicMinersFailuresMinerGet | (miner: string, options?: any) => Promise<Response> |
publicMinersGet | (options?: any) => Promise<Response> |
publicNetAddrsGet | (options?: any) => Promise<string[]> |
publicNetPeersGet | (options?: any) => Promise<string[]> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5148
NetApiFetchParamCreator
▸ NetApiFetchParamCreator(configuration?): Object
NetApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
netAddrsGet | (options?: any) => FetchArgs |
publicMinersFailuresMinerGet | (miner: string, options?: any) => FetchArgs |
publicMinersGet | (options?: any) => FetchArgs |
publicNetAddrsGet | (options?: any) => FetchArgs |
publicNetPeersGet | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4878
NetApiFp
▸ NetApiFp(configuration?): Object
NetApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
netAddrsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
publicMinersFailuresMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicNetAddrsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
publicNetPeersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5048
PeeringApiFactory
▸ PeeringApiFactory(configuration?, fetch?, basePath?): Object
PeeringApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => Promise<Response> |
adminPeeringStartPost | (options?: any) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => Promise<Response> |
adminPeeringStopPost | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5590
PeeringApiFetchParamCreator
▸ PeeringApiFetchParamCreator(configuration?): Object
PeeringApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => FetchArgs |
adminPeeringPeersGet | (options?: any) => FetchArgs |
adminPeeringPeersPost | (options?: any) => FetchArgs |
adminPeeringStartPost | (options?: any) => FetchArgs |
adminPeeringStatusGet | (options?: any) => FetchArgs |
adminPeeringStopPost | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5268
PeeringApiFp
▸ PeeringApiFp(configuration?): Object
PeeringApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStartPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStopPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5472
PeersApiFactory
▸ PeersApiFactory(configuration?, fetch?, basePath?): Object
PeersApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => Promise<Response> |
adminPeeringStartPost | (options?: any) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => Promise<Response> |
adminPeeringStopPost | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6052
PeersApiFetchParamCreator
▸ PeersApiFetchParamCreator(configuration?): Object
PeersApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => FetchArgs |
adminPeeringPeersGet | (options?: any) => FetchArgs |
adminPeeringPeersPost | (options?: any) => FetchArgs |
adminPeeringStartPost | (options?: any) => FetchArgs |
adminPeeringStatusGet | (options?: any) => FetchArgs |
adminPeeringStopPost | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5730
PeersApiFp
▸ PeersApiFp(configuration?): Object
PeersApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
adminPeeringPeersDelete | (body: string[], options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringPeersPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStartPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStatusGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
adminPeeringStopPost | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5934
PinningApiFactory
▸ PinningApiFactory(configuration?, fetch?, basePath?): Object
PinningApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
pinningPinsGet | (options?: any) => Promise<Response> |
pinningPinsPinidDelete | (pinid: string, options?: any) => Promise<Response> |
pinningPinsPinidGet | (pinid: string, options?: any) => Promise<Response> |
pinningPinsPinidPost | (pinid: string, options?: any) => Promise<Response> |
pinningPinsPost | (cid: string, name: string, options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6490
PinningApiFetchParamCreator
▸ PinningApiFetchParamCreator(configuration?): Object
PinningApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
pinningPinsGet | (options?: any) => FetchArgs |
pinningPinsPinidDelete | (pinid: string, options?: any) => FetchArgs |
pinningPinsPinidGet | (pinid: string, options?: any) => FetchArgs |
pinningPinsPinidPost | (pinid: string, options?: any) => FetchArgs |
pinningPinsPost | (cid: string, name: string, options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6192
PinningApiFp
▸ PinningApiFp(configuration?): Object
PinningApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
pinningPinsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
pinningPinsPinidDelete | (pinid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
pinningPinsPinidGet | (pinid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
pinningPinsPinidPost | (pinid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
pinningPinsPost | (cid: string, name: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6386
PublicApiFactory
▸ PublicApiFactory(configuration?, fetch?, basePath?): Object
PublicApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
publicByCidCidGet | (cid: string, options?: any) => Promise<Response> |
publicInfoGet | (options?: any) => Promise<Response> |
publicMetricsDealsOnChainGet | (options?: any) => Promise<Response> |
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => Promise<Response> |
publicMinersFailuresMinerGet | (miner: string, options?: any) => Promise<Response> |
publicMinersGet | (options?: any) => Promise<Response> |
publicMinersStatsMinerGet | (miner: string, options?: any) => Promise<Response> |
publicNetAddrsGet | (options?: any) => Promise<string[]> |
publicNetPeersGet | (options?: any) => Promise<string[]> |
publicStatsGet | (options?: any) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7160
PublicApiFetchParamCreator
▸ PublicApiFetchParamCreator(configuration?): Object
PublicApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicByCidCidGet | (cid: string, options?: any) => FetchArgs |
publicInfoGet | (options?: any) => FetchArgs |
publicMetricsDealsOnChainGet | (options?: any) => FetchArgs |
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => FetchArgs |
publicMinersFailuresMinerGet | (miner: string, options?: any) => FetchArgs |
publicMinersGet | (options?: any) => FetchArgs |
publicMinersStatsMinerGet | (miner: string, options?: any) => FetchArgs |
publicNetAddrsGet | (options?: any) => FetchArgs |
publicNetPeersGet | (options?: any) => FetchArgs |
publicStatsGet | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6618
PublicApiFp
▸ PublicApiFp(configuration?): Object
PublicApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
publicByCidCidGet | (cid: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicInfoGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMetricsDealsOnChainGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersDealsMinerGet | (miner: string, ignoreFailed?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersFailuresMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicMinersStatsMinerGet | (miner: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
publicNetAddrsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
publicNetPeersGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string[]> |
publicStatsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6966
UserApiFactory
▸ UserApiFactory(configuration?, fetch?, basePath?): Object
UserApi - factory interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
fetch? | FetchAPI |
basePath? | string |
Returns
Object
| Name | Type |
|---|---|
userApiKeysGet | (options?: any) => Promise<MainGetApiKeysResp[]> |
userApiKeysKeyDelete | (key: string, options?: any) => Promise<Response> |
userApiKeysPost | (expiry?: string, perms?: string, options?: any) => Promise<MainGetApiKeysResp> |
userExportGet | (options?: any) => Promise<string> |
userStatsGet | (options?: any) => Promise<MainUserStatsResponse> |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7670
UserApiFetchParamCreator
▸ UserApiFetchParamCreator(configuration?): Object
UserApi - fetch parameter creator
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
userApiKeysGet | (options?: any) => FetchArgs |
userApiKeysKeyDelete | (key: string, options?: any) => FetchArgs |
userApiKeysPost | (expiry?: string, perms?: string, options?: any) => FetchArgs |
userExportGet | (options?: any) => FetchArgs |
userStatsGet | (options?: any) => FetchArgs |
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7388
UserApiFp
▸ UserApiFp(configuration?): Object
UserApi - functional programming interface
Export
Parameters
| Name | Type |
|---|---|
configuration? | Configuration |
Returns
Object
| Name | Type |
|---|---|
userApiKeysGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<MainGetApiKeysResp[]> |
userApiKeysKeyDelete | (key: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response> |
userApiKeysPost | (expiry?: string, perms?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<MainGetApiKeysResp> |
userExportGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string> |
userStatsGet | (options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<MainUserStatsResponse> |