tapyrus-api-client 0 → 1.1.0beta4

data/docs/TimestampApi.md

@@ -1,20 +1,21 @@
 # TapyrusApiClient::TimestampApi
 
-All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
+All URIs are relative to *https://ap-01.api.tapyrus.chaintope.com/api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**add_timestamp**](TimestampApi.md#add_timestamp) | **POST** /timestamp | Timestampを記録 |
+| [**add_timestamp**](TimestampApi.md#add_timestamp) | **POST** /timestamps | Timestampを記録 |
+| [**get_timestamp**](TimestampApi.md#get_timestamp) | **GET** /timestamps/{id} | Timestamp表示 |
 | [**get_timestamps**](TimestampApi.md#get_timestamps) | **GET** /timestamps | Timestamp一覧表示 |
 
 
 ## add_timestamp
 
-> add_timestamp(opts)
+> <AddTimestampResponse> add_timestamp(opts)
 
 Timestampを記録
 
-ブロックチェーンにハッシュ値をタイムスタンプとして記録します。
+ブロックチェーンにハッシュ値をタイムスタンプとして記録します。 現在、記録方法として2種類の`type`（`simple`（デフォルト）、`trackable`）をサポートしています。  `simple`を指定した場合は、ハッシュ値がトランザクション内のOP_RETURNアウトプットに直接埋め込まれます。 単純に値をブロックチェーンに記録する場合は`simple`の利用を推奨します。  `trackable`を指定した場合は、ハッシュ値を組み合わせたPay to Contractアドレスが生成され、ハッシュ値は間接的に記録されます。 アドレスは、Timestampの戻り値の１つである`payment_base`と指定されたコンテンツハッシュを使って次のように計算されます。 ``` アドレスの公開鍵 = payment_base + SHA256(payment_base || コンテンツハッシュ)G ``` ※Gは楕円曲線の生成元。公開鍵からアドレス（P2PKH）を導出すると、戻り値の１つである`p2c_address`と合致します。 `trackable`を使用するとハッシュ値は間接的に記録されますが、ブロックチェーン上で使用可能なアセットとして管理できます。 そのため、ある記録を持つデータを更新する場合に、このアセットを使用して新しい`trackable`アセットを作成することで、 記録の更新、最新性を表現することが可能になります。未使用な記録のみ`latest`がtrueになります。 
 
 ### Examples
 
@@ -26,12 +27,13 @@ TapyrusApiClient.configure do |config|end
 
 api_instance = TapyrusApiClient::TimestampApi.new
 opts = {
-  add_timestamp_request: TapyrusApiClient::AddTimestampRequest.new({content_hash: '9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d'}) # AddTimestampRequest | `content_hash`, `prefix`を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。
+  add_timestamp_request: TapyrusApiClient::AddTimestampRequest.new({content_hash: '9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d'}) # AddTimestampRequest | `content_hash`, `prefix`, `type` を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。
 }
 
 begin
   # Timestampを記録
-  api_instance.add_timestamp(opts)
+  result = api_instance.add_timestamp(opts)
+  p result
 rescue TapyrusApiClient::ApiError => e
   puts "Error when calling TimestampApi->add_timestamp: #{e}"
 end
@@ -39,9 +41,9 @@ end
 
 #### Using the add_timestamp_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> add_timestamp_with_http_info(opts)
+> <Array(<AddTimestampResponse>, Integer, Hash)> add_timestamp_with_http_info(opts)
 
 ```ruby
 begin
@@ -49,7 +51,7 @@ begin
   data, status_code, headers = api_instance.add_timestamp_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <AddTimestampResponse>
 rescue TapyrusApiClient::ApiError => e
   puts "Error when calling TimestampApi->add_timestamp_with_http_info: #{e}"
 end
@@ -59,11 +61,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **add_timestamp_request** | [**AddTimestampRequest**](AddTimestampRequest.md) | &#x60;content_hash&#x60;, &#x60;prefix&#x60;を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。 | [optional] |
+| **add_timestamp_request** | [**AddTimestampRequest**](AddTimestampRequest.md) | &#x60;content_hash&#x60;, &#x60;prefix&#x60;, &#x60;type&#x60; を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。 | [optional] |
 
 ### Return type
 
-nil (empty response body)
+[**AddTimestampResponse**](AddTimestampResponse.md)
 
 ### Authorization
 
@@ -72,12 +74,78 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
+
+
+## get_timestamp
+
+> <GetTimestampResponse> get_timestamp(id)
+
+Timestamp表示
+
+タイムスタンプ ID に対応する Timestamp を表示します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TimestampApi.new
+id = 56 # Integer | Timestamp id。`Timestamp を記録 API(POST /timestamps)` の返り値の JSON の `id` 要素の値です。
+
+begin
+  # Timestamp表示
+  result = api_instance.get_timestamp(id)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TimestampApi->get_timestamp: #{e}"
+end
+```
+
+#### Using the get_timestamp_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTimestampResponse>, Integer, Hash)> get_timestamp_with_http_info(id)
+
+```ruby
+begin
+  # Timestamp表示
+  data, status_code, headers = api_instance.get_timestamp_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTimestampResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TimestampApi->get_timestamp_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Timestamp id。&#x60;Timestamp を記録 API(POST /timestamps)&#x60; の返り値の JSON の &#x60;id&#x60; 要素の値です。 |  |
+
+### Return type
+
+[**GetTimestampResponse**](GetTimestampResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
 ## get_timestamps
 
-> Array&lt;Array&gt; get_timestamps
+> <Array<GetTimestampResponse>> get_timestamps
 
 Timestamp一覧表示
 
@@ -106,7 +174,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Array&lt;Array&gt;, Integer, Hash)> get_timestamps_with_http_info
+> <Array(<Array<GetTimestampResponse>>, Integer, Hash)> get_timestamps_with_http_info
 
 ```ruby
 begin
@@ -114,7 +182,7 @@ begin
   data, status_code, headers = api_instance.get_timestamps_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Array&lt;Array&gt;
+  p data # => <Array<GetTimestampResponse>>
 rescue TapyrusApiClient::ApiError => e
   puts "Error when calling TimestampApi->get_timestamps_with_http_info: #{e}"
 end
@@ -126,7 +194,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-**Array&lt;Array&gt;**
+[**Array&lt;GetTimestampResponse&gt;**](GetTimestampResponse.md)
 
 ### Authorization
 

data/docs/TimestampType.md

@@ -0,0 +1,15 @@
+# TapyrusApiClient::TimestampType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TimestampType.new()
+```
+

data/docs/TokenApi.md

@@ -1,6 +1,6 @@
 # TapyrusApiClient::TokenApi
 
-All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
+All URIs are relative to *https://ap-01.api.tapyrus.chaintope.com/api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/TokenResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **tokens_id** | **String** |  | [optional] |
-| **txid** | **String** |  | [optional] |
+| **token_id** | **String** |  | [optional] |
+| **txid** | **String** | トランザクションID | [optional] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'tapyrus-api-client'
 
 instance = TapyrusApiClient::TokenResponse.new(
-  tokens_id: c3ec2fd806701a3f55808cbec3922c38dafaa3070c48c803e9043ee3642c660b46,
-  txid: 76077052e323a8445c398b690ed8b4b49c9b6e4d1e8e19ea0e7de7cead6f5fc8
+  token_id: c3ec2fd806701a3f55808cbec3922c38dafaa3070c48c803e9043ee3642c660b46,
+  txid: 6fce02d39279f6d645ecc710ebcf1dbb7b8104106553d8da13f5db79c5a628fc
 )
 ```
 

data/docs/TrackingApi.md

@@ -0,0 +1,344 @@
+# TapyrusApiClient::TrackingApi
+
+All URIs are relative to *https://ap-01.api.tapyrus.chaintope.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**consume_tracking**](TrackingApi.md#consume_tracking) | **POST** /tracking/consume | モノのトラッキングを終了します。 |
+| [**get_tracking_subjects**](TrackingApi.md#get_tracking_subjects) | **GET** /tracking/subjects/{subject_id}/traces | モノの移動の履歴を返します。 |
+| [**get_tracking_traces**](TrackingApi.md#get_tracking_traces) | **GET** /tracking/traces/{trace_id} | モノの移動履歴(trace)に関する情報を返します。 |
+| [**supply_tracking**](TrackingApi.md#supply_tracking) | **POST** /tracking/supply | 新規でトラッキングを開始します。 |
+| [**transport_tracking**](TrackingApi.md#transport_tracking) | **POST** /tracking/transport | トラッキング中のモノの移動を記録します。 |
+
+
+## consume_tracking
+
+> <TrackingResponse> consume_tracking(consume_tracking_request)
+
+モノのトラッキングを終了します。
+
+トラッキング中のモノが消費されたものとみなして、トラッキングを終了します。モノがトラッキング中でない場合は失敗します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TrackingApi.new
+consume_tracking_request = TapyrusApiClient::ConsumeTrackingRequest.new({subjects: ['6948DF80-14BD-4E04-8842-7668D9C001F5']}) # ConsumeTrackingRequest | 
+
+begin
+  # モノのトラッキングを終了します。
+  result = api_instance.consume_tracking(consume_tracking_request)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->consume_tracking: #{e}"
+end
+```
+
+#### Using the consume_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TrackingResponse>, Integer, Hash)> consume_tracking_with_http_info(consume_tracking_request)
+
+```ruby
+begin
+  # モノのトラッキングを終了します。
+  data, status_code, headers = api_instance.consume_tracking_with_http_info(consume_tracking_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TrackingResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->consume_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consume_tracking_request** | [**ConsumeTrackingRequest**](ConsumeTrackingRequest.md) |  |  |
+
+### Return type
+
+[**TrackingResponse**](TrackingResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_tracking_subjects
+
+> <Array<TrackingTrace>> get_tracking_subjects(subject_id)
+
+モノの移動の履歴を返します。
+
+モノの移動の履歴を返します。履歴は発生日時の昇順でソートされています。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TrackingApi.new
+subject_id = 'subject_id_example' # String | モノの識別子。
+
+begin
+  # モノの移動の履歴を返します。
+  result = api_instance.get_tracking_subjects(subject_id)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->get_tracking_subjects: #{e}"
+end
+```
+
+#### Using the get_tracking_subjects_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TrackingTrace>>, Integer, Hash)> get_tracking_subjects_with_http_info(subject_id)
+
+```ruby
+begin
+  # モノの移動の履歴を返します。
+  data, status_code, headers = api_instance.get_tracking_subjects_with_http_info(subject_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TrackingTrace>>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->get_tracking_subjects_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_id** | **String** | モノの識別子。 |  |
+
+### Return type
+
+[**Array&lt;TrackingTrace&gt;**](TrackingTrace.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_tracking_traces
+
+> <TrackingTracesResponse> get_tracking_traces(trace_id)
+
+モノの移動履歴(trace)に関する情報を返します。
+
+モノの移動履歴(trace)に関する情報を返します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TrackingApi.new
+trace_id = 8.14 # Float | モノの移動履歴(trace)に一意に振られたID
+
+begin
+  # モノの移動履歴(trace)に関する情報を返します。
+  result = api_instance.get_tracking_traces(trace_id)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->get_tracking_traces: #{e}"
+end
+```
+
+#### Using the get_tracking_traces_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TrackingTracesResponse>, Integer, Hash)> get_tracking_traces_with_http_info(trace_id)
+
+```ruby
+begin
+  # モノの移動履歴(trace)に関する情報を返します。
+  data, status_code, headers = api_instance.get_tracking_traces_with_http_info(trace_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TrackingTracesResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->get_tracking_traces_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trace_id** | **Float** | モノの移動履歴(trace)に一意に振られたID |  |
+
+### Return type
+
+[**TrackingTracesResponse**](TrackingTracesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## supply_tracking
+
+> <TrackingResponse> supply_tracking(opts)
+
+新規でトラッキングを開始します。
+
+新規でトラッキングを開始します。指定されたモノがすでにトラッキング中の場合はトラッキングの開始に失敗します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TrackingApi.new
+opts = {
+  supply_tracking_request: TapyrusApiClient::SupplyTrackingRequest.new({from_address: '1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a', destinations: [TapyrusApiClient::TrackingDestination.new]}) # SupplyTrackingRequest | 
+}
+
+begin
+  # 新規でトラッキングを開始します。
+  result = api_instance.supply_tracking(opts)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->supply_tracking: #{e}"
+end
+```
+
+#### Using the supply_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TrackingResponse>, Integer, Hash)> supply_tracking_with_http_info(opts)
+
+```ruby
+begin
+  # 新規でトラッキングを開始します。
+  data, status_code, headers = api_instance.supply_tracking_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TrackingResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->supply_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **supply_tracking_request** | [**SupplyTrackingRequest**](SupplyTrackingRequest.md) |  | [optional] |
+
+### Return type
+
+[**TrackingResponse**](TrackingResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## transport_tracking
+
+> <TrackingResponse> transport_tracking(transport_tracking_request)
+
+トラッキング中のモノの移動を記録します。
+
+トラッキング中のモノの移動を記録します。モノがトラッキング中でない場合は記録に失敗します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::TrackingApi.new
+transport_tracking_request = TapyrusApiClient::TransportTrackingRequest.new({destinations: [TapyrusApiClient::TrackingDestination.new]}) # TransportTrackingRequest | 
+
+begin
+  # トラッキング中のモノの移動を記録します。
+  result = api_instance.transport_tracking(transport_tracking_request)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->transport_tracking: #{e}"
+end
+```
+
+#### Using the transport_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TrackingResponse>, Integer, Hash)> transport_tracking_with_http_info(transport_tracking_request)
+
+```ruby
+begin
+  # トラッキング中のモノの移動を記録します。
+  data, status_code, headers = api_instance.transport_tracking_with_http_info(transport_tracking_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TrackingResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling TrackingApi->transport_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transport_tracking_request** | [**TransportTrackingRequest**](TransportTrackingRequest.md) |  |  |
+
+### Return type
+
+[**TrackingResponse**](TrackingResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TrackingDestination.md

@@ -0,0 +1,20 @@
+# TapyrusApiClient::TrackingDestination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** |  | [optional] |
+| **subjects** | [**Array<AnyOfstringTrackingSubject>**](AnyOfstringTrackingSubject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TrackingDestination.new(
+  address: mnzdZUieW2Hqe9GzZzVbcA7nHkDeFhJFzd,
+  subjects: null
+)
+```
+

data/docs/TrackingResponse.md

@@ -0,0 +1,18 @@
+# TapyrusApiClient::TrackingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **txid** | **String** | トランザクションID |  |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TrackingResponse.new(
+  txid: 6fce02d39279f6d645ecc710ebcf1dbb7b8104106553d8da13f5db79c5a628fc
+)
+```
+

data/docs/TrackingSubject.md

@@ -0,0 +1,20 @@
+# TapyrusApiClient::TrackingSubject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_id** | **String** |  |  |
+| **children** | [**Array<AnyOfstringTrackingSubject>**](AnyOfstringTrackingSubject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TrackingSubject.new(
+  subject_id: 6948DF80-14BD-4E04-8842-7668D9C001F5,
+  children: null
+)
+```
+

data/docs/TrackingSubjectMerkleRoot.md

@@ -0,0 +1,22 @@
+# TapyrusApiClient::TrackingSubjectMerkleRoot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_id** | **String** |  | [optional] |
+| **merkle_root** | **String** |  | [optional] |
+| **merkle_path** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TrackingSubjectMerkleRoot.new(
+  subject_id: 6948DF80-14BD-4E04-8842-7668D9C001F5,
+  merkle_root: a6964be0afa2451a7e95806b90ae6e9d2de35b9e6c94a168133e8d354d401267,
+  merkle_path: null
+)
+```
+