estuary_api
v0.0.0
Published
This_is_the_API_for_the_Estuary_application_
Downloads
3
Readme
estuary_api
EstuaryApi - JavaScript client for estuary_api This is the API for the Estuary application. This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.0
- Package version: 0.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://docs.estuary.tech/feedback
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install estuary_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your estuary_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('estuary_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var EstuaryApi = require('estuary_api');
var defaultClient = EstuaryApi.ApiClient.instance;
// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"
var api = new EstuaryApi.AdminApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.adminPeeringPeersDelete(callback);
Documentation for API Endpoints
All URIs are relative to https://api.estuary.tech
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EstuaryApi.AdminApi | adminPeeringPeersDelete | DELETE /admin/peering/peers | Remove peers on Peering Service EstuaryApi.AdminApi | adminPeeringPeersGet | GET /admin/peering/peers | List all Peering peers EstuaryApi.AdminApi | adminPeeringPeersPost | POST /admin/peering/peers | Add peers on Peering Service EstuaryApi.AdminApi | adminPeeringStartPost | POST /admin/peering/start | Start Peering EstuaryApi.AdminApi | adminPeeringStatusGet | GET /admin/peering/status | Check Peering Status EstuaryApi.AdminApi | adminPeeringStopPost | POST /admin/peering/stop | Stop Peering EstuaryApi.AdminApi | adminSystemConfigGet | GET /admin/system/config | Get systems(estuary/shuttle) config EstuaryApi.AdminApi | adminUsersGet | GET /admin/users | Get all users EstuaryApi.AutoretrieveApi | adminAutoretrieveInitPost | POST /admin/autoretrieve/init | Register autoretrieve server EstuaryApi.AutoretrieveApi | adminAutoretrieveListGet | GET /admin/autoretrieve/list | List autoretrieve servers EstuaryApi.AutoretrieveApi | autoretrieveHeartbeatPost | POST /autoretrieve/heartbeat | Marks autoretrieve server as up EstuaryApi.CollectionsApi | collectionsColuuidCommitPost | POST /collections/{coluuid}/commit | Produce a CID of the collection contents EstuaryApi.CollectionsApi | collectionsColuuidDelete | DELETE /collections/{coluuid} | Deletes a collection EstuaryApi.CollectionsApi | collectionsColuuidGet | GET /collections/{coluuid} | Get contents in a collection EstuaryApi.CollectionsApi | collectionsColuuidPost | POST /collections/{coluuid} | Add contents to a collection EstuaryApi.CollectionsApi | collectionsFsAddPost | POST /collections/fs/add | Add a file to a collection EstuaryApi.CollectionsApi | collectionsGet | GET /collections/ | List all collections EstuaryApi.CollectionsApi | collectionsPost | POST /collections/ | Create a new collection EstuaryApi.ContentApi | contentAddCarPost | POST /content/add-car | Add Car object EstuaryApi.ContentApi | contentAddIpfsPost | POST /content/add-ipfs | Add IPFS object EstuaryApi.ContentApi | contentAddPost | POST /content/add | Add new content EstuaryApi.ContentApi | contentAggregatedContentGet | GET /content/aggregated/{content} | Get aggregated content stats EstuaryApi.ContentApi | contentAllDealsGet | GET /content/all-deals | Get all deals for a user EstuaryApi.ContentApi | contentBwUsageContentGet | GET /content/bw-usage/{content} | Get content bandwidth EstuaryApi.ContentApi | contentCreatePost | POST /content/create | Add a new content EstuaryApi.ContentApi | contentDealsGet | GET /content/deals | Content with deals EstuaryApi.ContentApi | contentEnsureReplicationDatacidGet | GET /content/ensure-replication/{datacid} | Ensure Replication EstuaryApi.ContentApi | contentFailuresContentGet | GET /content/failures/{content} | List all failures for a content EstuaryApi.ContentApi | contentImportdealPost | POST /content/importdeal | Import a deal EstuaryApi.ContentApi | contentListGet | GET /content/list | List all pinned content EstuaryApi.ContentApi | contentReadContGet | GET /content/read/{cont} | Read content EstuaryApi.ContentApi | contentStagingZonesGet | GET /content/staging-zones | Get staging zone for user EstuaryApi.ContentApi | contentStatsGet | GET /content/stats | Get content statistics EstuaryApi.ContentApi | contentStatusIdGet | GET /content/status/{id} | Content Status EstuaryApi.DealsApi | dealEstimatePost | POST /deal/estimate | Estimate the cost of a deal EstuaryApi.DealsApi | dealInfoDealidGet | GET /deal/info/{dealid} | Get Deal Info EstuaryApi.DealsApi | dealProposalPropcidGet | GET /deal/proposal/{propcid} | Get Proposal EstuaryApi.DealsApi | dealQueryMinerGet | GET /deal/query/{miner} | Query Ask EstuaryApi.DealsApi | dealStatusByProposalPropcidGet | GET /deal/status-by-proposal/{propcid} | Get Deal Status by PropCid EstuaryApi.DealsApi | dealStatusMinerPropcidGet | GET /deal/status/{miner}/{propcid} | Deal Status EstuaryApi.DealsApi | dealTransferInProgressGet | GET /deal/transfer/in-progress | Transfer In Progress EstuaryApi.DealsApi | dealTransferStatusPost | POST /deal/transfer/status | Transfer Status EstuaryApi.DealsApi | dealsFailuresGet | GET /deals/failures | Get storage failures for user EstuaryApi.DealsApi | dealsMakeMinerPost | POST /deals/make/{miner} | Make Deal EstuaryApi.DealsApi | dealsStatusDealGet | GET /deals/status/{deal} | Get Deal Status EstuaryApi.DealsApi | publicDealsFailuresGet | GET /public/deals/failures | Get storage failures EstuaryApi.DealsApi | publicMinersStorageQueryMinerGet | GET /public/miners/storage/query/{miner} | Query Ask EstuaryApi.MetricsApi | publicMetricsDealsOnChainGet | GET /public/metrics/deals-on-chain | Get deal metrics EstuaryApi.MinerApi | publicMinersDealsMinerGet | GET /public/miners/deals/{miner} | Get all miners deals EstuaryApi.MinerApi | publicMinersStatsMinerGet | GET /public/miners/stats/{miner} | Get miner stats EstuaryApi.NetApi | netAddrsGet | GET /net/addrs | Net Addrs EstuaryApi.NetApi | publicMinersFailuresMinerGet | GET /public/miners/failures/{miner} | Get all miners EstuaryApi.NetApi | publicMinersGet | GET /public/miners | Get all miners EstuaryApi.NetApi | publicNetAddrsGet | GET /public/net/addrs | Net Addrs EstuaryApi.NetApi | publicNetPeersGet | GET /public/net/peers | Net Peers EstuaryApi.PeeringApi | adminPeeringPeersDelete | DELETE /admin/peering/peers | Remove peers on Peering Service EstuaryApi.PeeringApi | adminPeeringPeersGet | GET /admin/peering/peers | List all Peering peers EstuaryApi.PeeringApi | adminPeeringPeersPost | POST /admin/peering/peers | Add peers on Peering Service EstuaryApi.PeeringApi | adminPeeringStartPost | POST /admin/peering/start | Start Peering EstuaryApi.PeeringApi | adminPeeringStatusGet | GET /admin/peering/status | Check Peering Status EstuaryApi.PeeringApi | adminPeeringStopPost | POST /admin/peering/stop | Stop Peering EstuaryApi.PeersApi | adminPeeringPeersDelete | DELETE /admin/peering/peers | Remove peers on Peering Service EstuaryApi.PeersApi | adminPeeringPeersGet | GET /admin/peering/peers | List all Peering peers EstuaryApi.PeersApi | adminPeeringPeersPost | POST /admin/peering/peers | Add peers on Peering Service EstuaryApi.PeersApi | adminPeeringStartPost | POST /admin/peering/start | Start Peering EstuaryApi.PeersApi | adminPeeringStatusGet | GET /admin/peering/status | Check Peering Status EstuaryApi.PeersApi | adminPeeringStopPost | POST /admin/peering/stop | Stop Peering EstuaryApi.PinningApi | pinningPinsGet | GET /pinning/pins | List all pin status objects EstuaryApi.PinningApi | pinningPinsPinidDelete | DELETE /pinning/pins/{pinid} | Delete a pinned object EstuaryApi.PinningApi | pinningPinsPinidGet | GET /pinning/pins/{pinid} | Get a pin status object EstuaryApi.PinningApi | pinningPinsPinidPost | POST /pinning/pins/{pinid} | Replace a pinned object EstuaryApi.PinningApi | pinningPinsPost | POST /pinning/pins | Add and pin object EstuaryApi.PublicApi | publicByCidCidGet | GET /public/by-cid/{cid} | Get Content by Cid EstuaryApi.PublicApi | publicInfoGet | GET /public/info | Get public node info EstuaryApi.PublicApi | publicMetricsDealsOnChainGet | GET /public/metrics/deals-on-chain | Get deal metrics EstuaryApi.PublicApi | publicMinersDealsMinerGet | GET /public/miners/deals/{miner} | Get all miners deals EstuaryApi.PublicApi | publicMinersFailuresMinerGet | GET /public/miners/failures/{miner} | Get all miners EstuaryApi.PublicApi | publicMinersGet | GET /public/miners | Get all miners EstuaryApi.PublicApi | publicMinersStatsMinerGet | GET /public/miners/stats/{miner} | Get miner stats EstuaryApi.PublicApi | publicNetAddrsGet | GET /public/net/addrs | Net Addrs EstuaryApi.PublicApi | publicNetPeersGet | GET /public/net/peers | Net Peers EstuaryApi.PublicApi | publicStatsGet | GET /public/stats | Public stats EstuaryApi.UserApi | userApiKeysGet | GET /user/api-keys | Get API keys for a user EstuaryApi.UserApi | userApiKeysKeyDelete | DELETE /user/api-keys/{key} | Revoke a User API Key. EstuaryApi.UserApi | userApiKeysPost | POST /user/api-keys | Create API keys for a user EstuaryApi.UserApi | userExportGet | GET /user/export | Export user data EstuaryApi.UserApi | userStatsGet | GET /user/stats | Create API keys for a user
Documentation for Models
- EstuaryApi.MainCollection
- EstuaryApi.MainCreateCollectionBody
- EstuaryApi.MainEstimateDealBody
- EstuaryApi.MainGetApiKeysResp
- EstuaryApi.MainImportDealBody
- EstuaryApi.MainUserStatsResponse
- EstuaryApi.UtilContentAddIpfsBody
- EstuaryApi.UtilContentAddResponse
- EstuaryApi.UtilHttpError
Documentation for Authorization
bearerAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header