swagger_client

SwaggerClient - the Ruby gem for the 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: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://docs.estuary.tech/feedback

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

# Setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

body = [SwaggerClient::Array<String>.new] # Array<String> | Peer ids


begin
  #Remove peers on Peering Service
  api_instance.admin_peering_peers_delete(body)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AdminApi->admin_peering_peers_delete: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
SwaggerClient::AdminApi	admin_peering_peers_delete	DELETE /admin/peering/peers	Remove peers on Peering Service
SwaggerClient::AdminApi	admin_peering_peers_get	GET /admin/peering/peers	List all Peering peers
SwaggerClient::AdminApi	admin_peering_peers_post	POST /admin/peering/peers	Add peers on Peering Service
SwaggerClient::AdminApi	admin_peering_start_post	POST /admin/peering/start	Start Peering
SwaggerClient::AdminApi	admin_peering_status_get	GET /admin/peering/status	Check Peering Status
SwaggerClient::AdminApi	admin_peering_stop_post	POST /admin/peering/stop	Stop Peering
SwaggerClient::AdminApi	admin_system_config_get	GET /admin/system/config	Get systems(estuary/shuttle) config
SwaggerClient::AdminApi	admin_users_get	GET /admin/users	Get all users
SwaggerClient::AutoretrieveApi	admin_autoretrieve_init_post	POST /admin/autoretrieve/init	Register autoretrieve server
SwaggerClient::AutoretrieveApi	admin_autoretrieve_list_get	GET /admin/autoretrieve/list	List autoretrieve servers
SwaggerClient::AutoretrieveApi	autoretrieve_heartbeat_post	POST /autoretrieve/heartbeat	Marks autoretrieve server as up
SwaggerClient::CollectionsApi	collections_coluuid_commit_post	POST /collections/{coluuid}/commit	Produce a CID of the collection contents
SwaggerClient::CollectionsApi	collections_coluuid_contents_delete	DELETE /collections/{coluuid}/contents	Deletes a content from a collection
SwaggerClient::CollectionsApi	collections_coluuid_delete	DELETE /collections/{coluuid}	Deletes a collection
SwaggerClient::CollectionsApi	collections_coluuid_get	GET /collections/{coluuid}	Get contents in a collection
SwaggerClient::CollectionsApi	collections_coluuid_post	POST /collections/{coluuid}	Add contents to a collection
SwaggerClient::CollectionsApi	collections_fs_add_post	POST /collections/fs/add	Add a file to a collection
SwaggerClient::CollectionsApi	collections_get	GET /collections/	List all collections
SwaggerClient::CollectionsApi	collections_post	POST /collections/	Create a new collection
SwaggerClient::ContentApi	content_add_car_post	POST /content/add-car	Add Car object
SwaggerClient::ContentApi	content_add_ipfs_post	POST /content/add-ipfs	Add IPFS object
SwaggerClient::ContentApi	content_add_post	POST /content/add	Add new content
SwaggerClient::ContentApi	content_aggregated_content_get	GET /content/aggregated/{content}	Get aggregated content stats
SwaggerClient::ContentApi	content_all_deals_get	GET /content/all-deals	Get all deals for a user
SwaggerClient::ContentApi	content_bw_usage_content_get	GET /content/bw-usage/{content}	Get content bandwidth
SwaggerClient::ContentApi	content_create_post	POST /content/create	Add a new content
SwaggerClient::ContentApi	content_deals_get	GET /content/deals	Content with deals
SwaggerClient::ContentApi	content_ensure_replication_datacid_get	GET /content/ensure-replication/{datacid}	Ensure Replication
SwaggerClient::ContentApi	content_failures_content_get	GET /content/failures/{content}	List all failures for a content
SwaggerClient::ContentApi	content_id_get	GET /content/{id}	Content
SwaggerClient::ContentApi	content_importdeal_post	POST /content/importdeal	Import a deal
SwaggerClient::ContentApi	content_list_get	GET /content/list	List all pinned content
SwaggerClient::ContentApi	content_read_cont_get	GET /content/read/{cont}	Read content
SwaggerClient::ContentApi	content_staging_zones_get	GET /content/staging-zones	Get staging zone for user
SwaggerClient::ContentApi	content_stats_get	GET /content/stats	Get content statistics
SwaggerClient::ContentApi	content_status_id_get	GET /content/status/{id}	Content Status
SwaggerClient::DealsApi	deal_estimate_post	POST /deal/estimate	Estimate the cost of a deal
SwaggerClient::DealsApi	deal_info_dealid_get	GET /deal/info/{dealid}	Get Deal Info
SwaggerClient::DealsApi	deal_proposal_propcid_get	GET /deal/proposal/{propcid}	Get Proposal
SwaggerClient::DealsApi	deal_query_miner_get	GET /deal/query/{miner}	Query Ask
SwaggerClient::DealsApi	deal_status_by_proposal_propcid_get	GET /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
SwaggerClient::DealsApi	deal_status_miner_propcid_get	GET /deal/status/{miner}/{propcid}	Deal Status
SwaggerClient::DealsApi	deal_transfer_in_progress_get	GET /deal/transfer/in-progress	Transfer In Progress
SwaggerClient::DealsApi	deals_failures_get	GET /deals/failures	Get storage failures for user
SwaggerClient::DealsApi	deals_make_miner_post	POST /deals/make/{miner}	Make Deal
SwaggerClient::DealsApi	deals_status_deal_get	GET /deals/status/{deal}	Get Deal Status
SwaggerClient::DealsApi	public_deals_failures_get	GET /public/deals/failures	Get storage failures
SwaggerClient::DealsApi	public_miners_storage_query_miner_get	GET /public/miners/storage/query/{miner}	Query Ask
SwaggerClient::DefaultApi	deal_transfer_status_post	POST /deal/transfer/status
SwaggerClient::MetricsApi	public_metrics_deals_on_chain_get	GET /public/metrics/deals-on-chain	Get deal metrics
SwaggerClient::MinerApi	public_miners_deals_miner_get	GET /public/miners/deals/{miner}	Get all miners deals
SwaggerClient::MinerApi	public_miners_stats_miner_get	GET /public/miners/stats/{miner}	Get miner stats
SwaggerClient::NetApi	net_addrs_get	GET /net/addrs	Net Addrs
SwaggerClient::NetApi	public_miners_failures_miner_get	GET /public/miners/failures/{miner}	Get all miners
SwaggerClient::NetApi	public_miners_get	GET /public/miners	Get all miners
SwaggerClient::NetApi	public_net_addrs_get	GET /public/net/addrs	Net Addrs
SwaggerClient::NetApi	public_net_peers_get	GET /public/net/peers	Net Peers
SwaggerClient::PeeringApi	admin_peering_peers_delete	DELETE /admin/peering/peers	Remove peers on Peering Service
SwaggerClient::PeeringApi	admin_peering_peers_get	GET /admin/peering/peers	List all Peering peers
SwaggerClient::PeeringApi	admin_peering_peers_post	POST /admin/peering/peers	Add peers on Peering Service
SwaggerClient::PeeringApi	admin_peering_start_post	POST /admin/peering/start	Start Peering
SwaggerClient::PeeringApi	admin_peering_status_get	GET /admin/peering/status	Check Peering Status
SwaggerClient::PeeringApi	admin_peering_stop_post	POST /admin/peering/stop	Stop Peering
SwaggerClient::PeersApi	admin_peering_peers_delete	DELETE /admin/peering/peers	Remove peers on Peering Service
SwaggerClient::PeersApi	admin_peering_peers_get	GET /admin/peering/peers	List all Peering peers
SwaggerClient::PeersApi	admin_peering_peers_post	POST /admin/peering/peers	Add peers on Peering Service
SwaggerClient::PeersApi	admin_peering_start_post	POST /admin/peering/start	Start Peering
SwaggerClient::PeersApi	admin_peering_status_get	GET /admin/peering/status	Check Peering Status
SwaggerClient::PeersApi	admin_peering_stop_post	POST /admin/peering/stop	Stop Peering
SwaggerClient::PinningApi	pinning_pins_get	GET /pinning/pins	List all pin status objects
SwaggerClient::PinningApi	pinning_pins_pinid_delete	DELETE /pinning/pins/{pinid}	Delete a pinned object
SwaggerClient::PinningApi	pinning_pins_pinid_get	GET /pinning/pins/{pinid}	Get a pin status object
SwaggerClient::PinningApi	pinning_pins_pinid_post	POST /pinning/pins/{pinid}	Replace a pinned object
SwaggerClient::PinningApi	pinning_pins_post	POST /pinning/pins	Add and pin object
SwaggerClient::PublicApi	public_by_cid_cid_get	GET /public/by-cid/{cid}	Get Content by Cid
SwaggerClient::PublicApi	public_info_get	GET /public/info	Get public node info
SwaggerClient::PublicApi	public_metrics_deals_on_chain_get	GET /public/metrics/deals-on-chain	Get deal metrics
SwaggerClient::PublicApi	public_miners_deals_miner_get	GET /public/miners/deals/{miner}	Get all miners deals
SwaggerClient::PublicApi	public_miners_failures_miner_get	GET /public/miners/failures/{miner}	Get all miners
SwaggerClient::PublicApi	public_miners_get	GET /public/miners	Get all miners
SwaggerClient::PublicApi	public_miners_stats_miner_get	GET /public/miners/stats/{miner}	Get miner stats
SwaggerClient::PublicApi	public_net_addrs_get	GET /public/net/addrs	Net Addrs
SwaggerClient::PublicApi	public_net_peers_get	GET /public/net/peers	Net Peers
SwaggerClient::PublicApi	public_stats_get	GET /public/stats	Public stats
SwaggerClient::UserApi	user_api_keys_get	GET /user/api-keys	Get API keys for a user
SwaggerClient::UserApi	user_api_keys_key_delete	DELETE /user/api-keys/{key}	Revoke a User API Key.
SwaggerClient::UserApi	user_api_keys_post	POST /user/api-keys	Create API keys for a user
SwaggerClient::UserApi	user_export_get	GET /user/export	Export user data
SwaggerClient::UserApi	user_stats_get	GET /user/stats	Create API keys for a user

Documentation for Models

• SwaggerClient::CollectionsCollection
• SwaggerClient::MainCreateCollectionBody
• SwaggerClient::MainDeleteContentFromCollectionBody
• SwaggerClient::MainEstimateDealBody
• SwaggerClient::MainGetApiKeysResp
• SwaggerClient::MainImportDealBody
• SwaggerClient::MainUserStatsResponse
• SwaggerClient::UtilContentAddIpfsBody
• SwaggerClient::UtilContentAddResponse
• SwaggerClient::UtilContentCreateBody
• SwaggerClient::UtilHttpError

Documentation for Authorization

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header