nftstorage / ruby-client

A client library for the https://nft.storage/ service.

nft_storage

This client was generated via the OpenAPI schema and is experimental, unsupported, and may not work at all!

NFTStorage - the Ruby gem for the NFT Storage API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build nft_storage.gemspec

Then either install the gem locally:

gem install ./nft_storage-1.0.0.gem

(for development, run gem install --dev ./nft_storage-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 'nft_storage', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/nftstorage/ruby-client, then add the following in the Gemfile:

gem 'nft_storage', :git => 'https://github.com/nftstorage/ruby-client.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 'nft_storage'

# Setup authorization
NFTStorage.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = NFTStorage::NFTStorageAPI.new
cid = 'cid_example' # String | CID for the NFT

begin
  #Stop storing the content with the passed CID
  result = api_instance.delete(cid)
  p result
rescue NFTStorage::ApiError => e
  puts "Exception when calling NFTStorageAPI->delete: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.nft.storage

Class	Method	HTTP request	Description
NFTStorage::NFTStorageAPI	delete	DELETE /{cid}	Stop storing the content with the passed CID
NFTStorage::NFTStorageAPI	list	GET /	List all stored files
NFTStorage::NFTStorageAPI	status	GET /{cid}	Get information for the stored file CID
NFTStorage::NFTStorageAPI	store	POST /upload	Store a file

Documentation for Models

• NFTStorage::Deal
• NFTStorage::DeleteResponse
• NFTStorage::ErrorResponse
• NFTStorage::ErrorResponseError
• NFTStorage::ForbiddenErrorResponse
• NFTStorage::ForbiddenErrorResponseError
• NFTStorage::GetResponse
• NFTStorage::Links
• NFTStorage::LinksFile
• NFTStorage::ListResponse
• NFTStorage::NFT
• NFTStorage::Pin
• NFTStorage::PinStatus
• NFTStorage::UnauthorizedErrorResponse
• NFTStorage::UnauthorizedErrorResponseError
• NFTStorage::UploadResponse

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)