nft_storage 1.0.0

data/docs/NFTStorageAPI.md

@@ -0,0 +1,289 @@
+# NFTStorage::NFTStorageAPI
+
+All URIs are relative to *https://api.nft.storage*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete**](NFTStorageAPI.md#delete) | **DELETE** /{cid} | Stop storing the content with the passed CID |
+| [**list**](NFTStorageAPI.md#list) | **GET** / | List all stored files |
+| [**status**](NFTStorageAPI.md#status) | **GET** /{cid} | Get information for the stored file CID |
+| [**store**](NFTStorageAPI.md#store) | **POST** /upload | Store a file |
+
+
+## delete
+
+> <DeleteResponse> delete(cid)
+
+Stop storing the content with the passed CID
+
+Stop storing the content with the passed CID on nft.storage. - Unpin the item from the underlying IPFS pinning service. - Cease renewals for expired Filecoin deals involving the CID.    ⚠️ This does not remove the content from the network.  - Does not terminate any established Filecoin deal. - Does not remove the content from other IPFS nodes in the network that already cached or pinned the CID.    Note: the content will remain available if another user has stored the CID with nft.storage. 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling NFTStorageAPI->delete: #{e}"
+end
+```
+
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteResponse>, Integer, Hash)> delete_with_http_info(cid)
+
+```ruby
+begin
+  # Stop storing the content with the passed CID
+  data, status_code, headers = api_instance.delete_with_http_info(cid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteResponse>
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cid** | **String** | CID for the NFT |  |
+
+### Return type
+
+[**DeleteResponse**](DeleteResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> <ListResponse> list(opts)
+
+List all stored files
+
+### Examples
+
+```ruby
+require 'time'
+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
+opts = {
+  before: Time.parse('2020-07-27T17:32:28Z'), # Time | Return results created before provided timestamp
+  limit: 56 # Integer | Max records to return
+}
+
+begin
+  # List all stored files
+  result = api_instance.list(opts)
+  p result
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponse>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List all stored files
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponse>
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **before** | **Time** | Return results created before provided timestamp | [optional] |
+| **limit** | **Integer** | Max records to return | [optional][default to 10] |
+
+### Return type
+
+[**ListResponse**](ListResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## status
+
+> <GetResponse> status(cid)
+
+Get information for the stored file CID
+
+Includes the IPFS pinning state and the Filecoin deal state.
+
+### Examples
+
+```ruby
+require 'time'
+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
+  # Get information for the stored file CID
+  result = api_instance.status(cid)
+  p result
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->status: #{e}"
+end
+```
+
+#### Using the status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetResponse>, Integer, Hash)> status_with_http_info(cid)
+
+```ruby
+begin
+  # Get information for the stored file CID
+  data, status_code, headers = api_instance.status_with_http_info(cid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetResponse>
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cid** | **String** | CID for the NFT |  |
+
+### Return type
+
+[**GetResponse**](GetResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## store
+
+> <UploadResponse> store(body)
+
+Store a file
+
+Store a file with nft.storage.  - Submit a HTTP `POST` request passing the file data in the request body. - To store multiple files in a directory, submit a `multipart/form-data` HTTP `POST` request.  Use the `Content-Disposition` header for each part to specify a filename. 
+
+### Examples
+
+```ruby
+require 'time'
+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
+body = File.new('/path/to/some/file') # File | 
+
+begin
+  # Store a file
+  result = api_instance.store(body)
+  p result
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->store: #{e}"
+end
+```
+
+#### Using the store_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadResponse>, Integer, Hash)> store_with_http_info(body)
+
+```ruby
+begin
+  # Store a file
+  data, status_code, headers = api_instance.store_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadResponse>
+rescue NFTStorage::ApiError => e
+  puts "Error when calling NFTStorageAPI->store_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **File** |  |  |
+
+### Return type
+
+[**UploadResponse**](UploadResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: image/png, application/octet-stream, multipart/form-data
+- **Accept**: application/json
+

data/docs/Pin.md

@@ -0,0 +1,26 @@
+# NFTStorage::Pin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cid** | **String** | Self-describing content-addressed identifiers for distributed systems. Check [spec](https://github.com/multiformats/cid) for more info. | [optional] |
+| **name** | **String** |  | [optional] |
+| **status** | [**PinStatus**](PinStatus.md) |  | [optional] |
+| **created** | **Time** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] |
+| **size** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::Pin.new(
+  cid: bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u,
+  name: pin name,
+  status: null,
+  created: 2021-03-12T17:03:07.787Z,
+  size: 132614
+)
+```
+

data/docs/PinStatus.md

@@ -0,0 +1,15 @@
+# NFTStorage::PinStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::PinStatus.new()
+```
+

data/docs/UnauthorizedErrorResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::UnauthorizedErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to false] |
+| **error** | [**UnauthorizedErrorResponseError**](UnauthorizedErrorResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::UnauthorizedErrorResponse.new(
+  ok: null,
+  error: null
+)
+```
+

data/docs/UnauthorizedErrorResponseError.md

@@ -0,0 +1,20 @@
+# NFTStorage::UnauthorizedErrorResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional][default to 'HTTP Error'] |
+| **message** | **String** |  | [optional][default to 'Unauthorized'] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::UnauthorizedErrorResponseError.new(
+  name: null,
+  message: null
+)
+```
+

data/docs/UploadResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::UploadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to true] |
+| **value** | [**NFT**](NFT.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::UploadResponse.new(
+  ok: null,
+  value: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="nftstorage"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="ruby-client"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+