Go API client for estuary_client

This is the API for the Estuary application.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 0.0.0
• Package version: 1.0.6
• Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://docs.estuary.tech/feedback

Installation

Put the package under your project folder and add the following in import:

import "./estuary_client"

Documentation for API Endpoints

All URIs are relative to //api.estuary.tech/

Class	Method	HTTP request	Description
AdminApi	AdminMinersGet	Get /admin/miners/	Get all miners
AdminApi	AdminPeeringPeersDelete	Delete /admin/peering/peers	Remove peers on Peering Service
AdminApi	AdminPeeringPeersGet	Get /admin/peering/peers	List all Peering peers
AdminApi	AdminPeeringPeersPost	Post /admin/peering/peers	Add peers on Peering Service
AdminApi	AdminPeeringStartPost	Post /admin/peering/start	Start Peering
AdminApi	AdminPeeringStatusGet	Get /admin/peering/status	Check Peering Status
AdminApi	AdminPeeringStopPost	Post /admin/peering/stop	Stop Peering
AdminApi	AdminSystemConfigGet	Get /admin/system/config	Get systems(estuary/shuttle) config
AdminApi	AdminUsersGet	Get /admin/users	Get all users
AutoretrieveApi	AdminAutoretrieveInitPost	Post /admin/autoretrieve/init	Register autoretrieve server
AutoretrieveApi	AdminAutoretrieveListGet	Get /admin/autoretrieve/list	List autoretrieve servers
AutoretrieveApi	AutoretrieveHeartbeatPost	Post /autoretrieve/heartbeat	Marks autoretrieve server as up
CollectionsApi	CollectionsColuuidCommitPost	Post /collections/{coluuid}/commit	Produce a CID of the collection contents
CollectionsApi	CollectionsColuuidContentsDelete	Delete /collections/{coluuid}/contents	Deletes a content from a collection
CollectionsApi	CollectionsColuuidDelete	Delete /collections/{coluuid}	Deletes a collection
CollectionsApi	CollectionsColuuidGet	Get /collections/{coluuid}	Get contents in a collection
CollectionsApi	CollectionsColuuidPost	Post /collections/{coluuid}	Add contents to a collection
CollectionsApi	CollectionsFsAddPost	Post /collections/fs/add	Add a file to a collection
CollectionsApi	CollectionsGet	Get /collections/	List all collections
CollectionsApi	CollectionsPost	Post /collections/	Create a new collection
ContentApi	AdminInvitesCodePost	Post /admin/invites/{code}	Create an Estuary invite
ContentApi	AdminInvitesGet	Get /admin/invites	Get Estuary invites
ContentApi	ContentAddCarPost	Post /content/add-car	Add Car object
ContentApi	ContentAddIpfsPost	Post /content/add-ipfs	Add IPFS object
ContentApi	ContentAddPost	Post /content/add	Add new content
ContentApi	ContentAggregatedContentGet	Get /content/aggregated/{content}	Get aggregated content stats
ContentApi	ContentAllDealsGet	Get /content/all-deals	Get all deals for a user
ContentApi	ContentBwUsageContentGet	Get /content/bw-usage/{content}	Get content bandwidth
ContentApi	ContentContentsGet	Get /content/contents	Get user contents
ContentApi	ContentCreatePost	Post /content/create	Add a new content
ContentApi	ContentDealsGet	Get /content/deals	Content with deals
ContentApi	ContentEnsureReplicationDatacidGet	Get /content/ensure-replication/{datacid}	Ensure Replication
ContentApi	ContentFailuresContentGet	Get /content/failures/{content}	List all failures for a content
ContentApi	ContentIdGet	Get /content/{id}	Content
ContentApi	ContentListGet	Get /content/list	List all pinned content
ContentApi	ContentStagingZonesGet	Get /content/staging-zones	Get staging zone for user, excluding its contents
ContentApi	ContentStagingZonesStagingZoneContentsGet	Get /content/staging-zones/{staging_zone}/contents	Get contents for a staging zone
ContentApi	ContentStagingZonesStagingZoneGet	Get /content/staging-zones/{staging_zone}	Get staging zone without its contents field populated
ContentApi	ContentStatsGet	Get /content/stats	Get content statistics
ContentApi	ContentStatusIdGet	Get /content/status/{id}	Content Status
DealsApi	DealEstimatePost	Post /deal/estimate	Estimate the cost of a deal
DealsApi	DealInfoDealidGet	Get /deal/info/{dealid}	Get Deal Info
DealsApi	DealProposalPropcidGet	Get /deal/proposal/{propcid}	Get Proposal
DealsApi	DealQueryMinerGet	Get /deal/query/{miner}	Query Ask
DealsApi	DealStatusByProposalPropcidGet	Get /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
DealsApi	DealStatusMinerPropcidGet	Get /deal/status/{miner}/{propcid}	Deal Status
DealsApi	DealTransferInProgressGet	Get /deal/transfer/in-progress	Transfer In Progress
DealsApi	DealTransferStatusPost	Post /deal/transfer/status	Transfer Status
DealsApi	DealsFailuresGet	Get /deals/failures	Get storage failures for user
DealsApi	DealsMakeMinerPost	Post /deals/make/{miner}	Make Deal
DealsApi	DealsStatusDealGet	Get /deals/status/{deal}	Get Deal Status
DealsApi	PublicDealsFailuresGet	Get /public/deals/failures	Get storage failures
DealsApi	PublicMinersStorageQueryMinerGet	Get /public/miners/storage/query/{miner}	Query Ask
DefaultApi	ViewerGet	Get /viewer	Fetch viewer details
MetricsApi	PublicMetricsDealsOnChainGet	Get /public/metrics/deals-on-chain	Get deal metrics
MinerApi	MinerClaimMinerGet	Get /miner/claim/{miner}	Get Claim Miner Message
MinerApi	MinerClaimPost	Post /miner/claim	Claim Miner
MinerApi	MinerSetInfoMinerPut	Put /miner/set-info/{miner}	Set Miner Info
MinerApi	MinerSuspendMinerPost	Post /miner/suspend/{miner}	Suspend Miner
MinerApi	MinerUnsuspendMinerPut	Put /miner/unsuspend/{miner}	Unuspend Miner
MinerApi	PublicMinersDealsMinerGet	Get /public/miners/deals/{miner}	Get all miners deals
MinerApi	PublicMinersStatsMinerGet	Get /public/miners/stats/{miner}	Get miner stats
NetApi	AdminMinersGet	Get /admin/miners/	Get all miners
NetApi	PublicMinersFailuresMinerGet	Get /public/miners/failures/{miner}	Get all miners
NetApi	PublicNetAddrsGet	Get /public/net/addrs	Net Addrs
NetApi	PublicNetPeersGet	Get /public/net/peers	Net Peers
PinningApi	PinningPinsGet	Get /pinning/pins	List all pin status objects
PinningApi	PinningPinsPinidDelete	Delete /pinning/pins/{pinid}	Delete a pinned object
PinningApi	PinningPinsPinidGet	Get /pinning/pins/{pinid}	Get a pin status object
PinningApi	PinningPinsPinidPost	Post /pinning/pins/{pinid}	Replace a pinned object
PinningApi	PinningPinsPost	Post /pinning/pins	Add and pin object
PublicApi	GetCidGet	Get /get/{cid}	Get Full Content by Cid
PublicApi	PublicByCidCidGet	Get /public/by-cid/{cid}	Get Content by Cid
PublicApi	PublicInfoGet	Get /public/info	Get public node info
PublicApi	PublicMetricsDealsOnChainGet	Get /public/metrics/deals-on-chain	Get deal metrics
PublicApi	PublicMinersDealsMinerGet	Get /public/miners/deals/{miner}	Get all miners deals
PublicApi	PublicMinersFailuresMinerGet	Get /public/miners/failures/{miner}	Get all miners
PublicApi	PublicMinersStatsMinerGet	Get /public/miners/stats/{miner}	Get miner stats
PublicApi	PublicNetAddrsGet	Get /public/net/addrs	Net Addrs
PublicApi	PublicNetPeersGet	Get /public/net/peers	Net Peers
PublicApi	PublicStatsGet	Get /public/stats	Public stats
UserApi	UserApiKeysGet	Get /user/api-keys	Get API keys for a user
UserApi	UserApiKeysKeyOrHashDelete	Delete /user/api-keys/{key_or_hash}	Revoke a User API Key.
UserApi	UserApiKeysPost	Post /user/api-keys	Create API keys for a user
UserApi	UserExportGet	Get /user/export	Export user data
UserApi	UserStatsGet	Get /user/stats	Get stats for the current user

Documentation For Models

• AddressAddress
• ApiChannelIdParam
• ApiClaimMsgResponse
• ApiClaimResponse
• ApiCreateCollectionBody
• ApiDeleteContentFromCollectionBody
• ApiEmptyResp
• ApiEstimateDealBody
• ApiGetApiKeysResp
• ApiMinerResp
• ApiPublicNodeInfo
• AutoretrieveInitBody
• CidCid
• CollectionsCidType
• CollectionsCollection
• CollectionsCollectionListResponse
• ContentAddBody
• MinerClaimMinerBody
• MinerMinerChainInfo
• MinerMinerSetInfoParams
• MinerSuspendMinerBody
• PeeringPeeringPeer
• TypesIpfsListPinStatusResponse
• TypesIpfsPin
• TypesIpfsPinStatusResponse
• TypesPinningStatus
• UtilContentAddResponse
• UtilContentCreateBody
• UtilContentType
• UtilDbCid
• UtilHttpError
• UtilUserSettings
• UtilViewerResponse

Documentation For Authorization

bearerAuth

• Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author