Class: DealsApi
DealsApi - object-oriented interface
Export
Hierarchy
↳
DealsApi
Table of contents
Constructors
Properties
Methods
- dealEstimatePost
- dealInfoDealidGet
- dealProposalPropcidGet
- dealQueryMinerGet
- dealStatusByProposalPropcidGet
- dealStatusMinerPropcidGet
- dealTransferInProgressGet
- dealsFailuresGet
- dealsMakeMinerPost
- dealsStatusDealGet
- publicDealsFailuresGet
- publicMinersStorageQueryMinerGet
Constructors
constructor
• new DealsApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
dealEstimatePost
▸ dealEstimatePost(body, options?): Promise<Response>
This endpoint estimates the cost of a deal
Summary
Estimate the cost of a deal
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
body | MainEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4331
dealInfoDealidGet
▸ dealInfoDealidGet(dealid, options?): Promise<Response>
This endpoint returns the deal info for a deal
Summary
Get Deal Info
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
dealid | number | Deal ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4343
dealProposalPropcidGet
▸ dealProposalPropcidGet(propcid, options?): Promise<Response>
This endpoint returns the proposal for a deal
Summary
Get Proposal
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
propcid | string | Proposal CID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4355
dealQueryMinerGet
▸ dealQueryMinerGet(miner, options?): Promise<Response>
This endpoint returns the ask for a given CID
Summary
Query Ask
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | CID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4367
dealStatusByProposalPropcidGet
▸ dealStatusByProposalPropcidGet(propcid, options?): Promise<Response>
Get Deal Status by PropCid
Summary
Get Deal Status by PropCid
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
propcid | string | PropCid |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4379
dealStatusMinerPropcidGet
▸ dealStatusMinerPropcidGet(miner, propcid, options?): Promise<Response>
This endpoint returns the status of a deal
Summary
Deal Status
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Miner |
propcid | string | Proposal CID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4392
dealTransferInProgressGet
▸ dealTransferInProgressGet(options?): Promise<Response>
This endpoint returns the in-progress transfers
Summary
Transfer In Progress
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4403
dealsFailuresGet
▸ dealsFailuresGet(options?): Promise<Response>
This endpoint returns a list of storage failures for user
Summary
Get storage failures for user
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4414
dealsMakeMinerPost
▸ dealsMakeMinerPost(miner, dealRequest, options?): Promise<Response>
This endpoint makes a deal for a given content and miner
Summary
Make Deal
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Miner |
dealRequest | string | Deal Request |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4427
dealsStatusDealGet
▸ dealsStatusDealGet(deal, options?): Promise<Response>
This endpoint returns the status of a deal
Summary
Get Deal Status
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
deal | number | Deal ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4439
publicDealsFailuresGet
▸ publicDealsFailuresGet(options?): Promise<Response>
This endpoint returns a list of storage failures
Summary
Get storage failures
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4450
publicMinersStorageQueryMinerGet
▸ publicMinersStorageQueryMinerGet(miner, options?): Promise<Response>
This endpoint returns the ask for a given CID
Summary
Query Ask
Throws
Memberof
DealsApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | CID |
options? | any | Override http request option. |
Returns
Promise<Response>