tapyrus-api-client 0.0.3 → 1.1.0beta4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +11 -9
- data/README.md +54 -52
- data/docs/AddTimestampRequest.md +3 -1
- data/docs/AddTimestampResponse.md +36 -0
- data/docs/AddressApi.md +15 -10
- data/docs/ConsumeTrackingRequest.md +18 -0
- data/docs/GetTimestampResponse.md +36 -0
- data/docs/PurposeAddressRequest.md +18 -0
- data/docs/SupplyTrackingRequest.md +20 -0
- data/docs/TimestampApi.md +84 -16
- data/docs/TimestampType.md +15 -0
- data/docs/TokenApi.md +1 -1
- data/docs/TokenResponse.md +4 -4
- data/docs/TrackingApi.md +344 -0
- data/docs/TrackingDestination.md +20 -0
- data/docs/TrackingResponse.md +18 -0
- data/docs/TrackingSubject.md +20 -0
- data/docs/TrackingSubjectMerkleRoot.md +22 -0
- data/docs/TrackingTrace.md +40 -0
- data/docs/TrackingTracesResponse.md +44 -0
- data/docs/TransportTrackingRequest.md +18 -0
- data/docs/UserApi.md +1 -1
- data/git_push.sh +3 -4
- data/lib/tapyrus-api-client/api/address_api.rb +25 -11
- data/lib/tapyrus-api-client/api/timestamp_api.rb +85 -17
- data/lib/tapyrus-api-client/api/token_api.rb +15 -6
- data/lib/tapyrus-api-client/api/tracking_api.rb +348 -0
- data/lib/tapyrus-api-client/api/user_api.rb +7 -4
- data/lib/tapyrus-api-client/api_client.rb +6 -6
- data/lib/tapyrus-api-client/api_error.rb +3 -3
- data/lib/tapyrus-api-client/configuration.rb +23 -6
- data/lib/tapyrus-api-client/models/add_timestamp_request.rb +16 -7
- data/lib/tapyrus-api-client/models/add_timestamp_response.rb +299 -0
- data/lib/tapyrus-api-client/models/consume_tracking_request.rb +226 -0
- data/lib/tapyrus-api-client/models/create_user_request.rb +3 -3
- data/lib/tapyrus-api-client/models/get_addresses_response.rb +3 -3
- data/lib/tapyrus-api-client/models/get_timestamp_response.rb +337 -0
- data/lib/tapyrus-api-client/models/get_tokens_response.rb +3 -3
- data/lib/tapyrus-api-client/models/issue_token_request.rb +3 -3
- data/lib/tapyrus-api-client/models/purpose_address_request.rb +218 -0
- data/lib/tapyrus-api-client/models/reissue_token_request.rb +3 -3
- data/lib/tapyrus-api-client/models/supply_tracking_request.rb +241 -0
- data/lib/tapyrus-api-client/models/timestamp_type.rb +37 -0
- data/lib/tapyrus-api-client/models/token_response.rb +11 -10
- data/lib/tapyrus-api-client/models/{payment_request.rb → tracking_destination.rb} +15 -32
- data/lib/tapyrus-api-client/models/{payment_response.rb → tracking_response.rb} +12 -6
- data/lib/tapyrus-api-client/models/tracking_subject.rb +234 -0
- data/lib/tapyrus-api-client/models/tracking_subject_merkle_root.rb +238 -0
- data/lib/tapyrus-api-client/models/tracking_trace.rb +321 -0
- data/lib/tapyrus-api-client/models/tracking_traces_response.rb +343 -0
- data/lib/tapyrus-api-client/models/transfer_token_request.rb +3 -3
- data/lib/tapyrus-api-client/models/transport_tracking_request.rb +226 -0
- data/lib/tapyrus-api-client/models/userinfo_response.rb +3 -3
- data/lib/tapyrus-api-client/models/userinfo_response_balances.rb +3 -3
- data/lib/tapyrus-api-client/version.rb +4 -4
- data/lib/tapyrus-api-client.rb +17 -6
- data/spec/api/address_api_spec.rb +7 -5
- data/spec/api/timestamp_api_spec.rb +19 -7
- data/spec/api/token_api_spec.rb +3 -3
- data/spec/api/tracking_api_spec.rb +95 -0
- data/spec/api/user_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +5 -5
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/add_timestamp_request_spec.rb +9 -3
- data/spec/models/add_timestamp_response_spec.rb +88 -0
- data/spec/models/consume_tracking_request_spec.rb +34 -0
- data/spec/models/create_user_request_spec.rb +3 -3
- data/spec/models/get_addresses_response_spec.rb +3 -3
- data/spec/models/get_timestamp_response_spec.rb +92 -0
- data/spec/models/get_tokens_response_spec.rb +3 -3
- data/spec/models/issue_token_request_spec.rb +3 -3
- data/spec/models/purpose_address_request_spec.rb +34 -0
- data/spec/models/reissue_token_request_spec.rb +3 -3
- data/spec/models/supply_tracking_request_spec.rb +40 -0
- data/spec/models/timestamp_type_spec.rb +28 -0
- data/spec/models/token_response_spec.rb +4 -4
- data/spec/models/tracking_destination_spec.rb +40 -0
- data/spec/models/tracking_response_spec.rb +34 -0
- data/spec/models/tracking_subject_merkle_root_spec.rb +46 -0
- data/spec/models/tracking_subject_spec.rb +40 -0
- data/spec/models/tracking_trace_spec.rb +100 -0
- data/spec/models/tracking_traces_response_spec.rb +112 -0
- data/spec/models/transfer_token_request_spec.rb +3 -3
- data/spec/models/transport_tracking_request_spec.rb +34 -0
- data/spec/models/userinfo_response_balances_spec.rb +3 -3
- data/spec/models/userinfo_response_spec.rb +3 -3
- data/spec/spec_helper.rb +3 -3
- data/tapyrus-api-client.gemspec +4 -4
- metadata +67 -23
- data/docs/PaymentApi.md +0 -76
- data/docs/PaymentRequest.md +0 -22
- data/docs/PaymentResponse.md +0 -18
- data/lib/tapyrus-api-client/api/payment_api.rb +0 -83
- data/spec/api/payment_api_spec.rb +0 -47
- data/spec/models/payment_request_spec.rb +0 -46
- data/spec/models/payment_response_spec.rb +0 -34
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c57f1f622b279be6dbf898db514e7747d7959d3cc64f120c45ca2b86f4736aca
|
4
|
+
data.tar.gz: bbb30991f2e1efa87a288a07e2c2bf04e61c91c3d55d10710f728b26a50c425c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 810f0c384de0a6335956c0697b652457ee72ce551ea57789df862bf917dd9e97e7b52e6b0eb5df4e00e0e13abc9c6bbd45023aa868eeffe78cb17174e18c7450
|
7
|
+
data.tar.gz: dafc794c255497caeee3eaacddd2368b140bec574c27c21e43b7ecb4e16f0b96d581809387c1d28b1cc51501617639272fc27d835115be9945a7da73c05dc7c0
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
tapyrus-api-client (
|
4
|
+
tapyrus-api-client (1.1.0beta4)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -10,14 +10,14 @@ GEM
|
|
10
10
|
ast (2.4.2)
|
11
11
|
byebug (11.1.3)
|
12
12
|
coderay (1.1.3)
|
13
|
-
diff-lcs (1.
|
14
|
-
ethon (0.
|
13
|
+
diff-lcs (1.5.0)
|
14
|
+
ethon (0.15.0)
|
15
15
|
ffi (>= 1.15.0)
|
16
|
-
ffi (1.15.
|
16
|
+
ffi (1.15.5)
|
17
17
|
jaro_winkler (1.5.4)
|
18
18
|
method_source (1.0.0)
|
19
|
-
parallel (1.
|
20
|
-
parser (3.0.
|
19
|
+
parallel (1.21.0)
|
20
|
+
parser (3.1.0.0)
|
21
21
|
ast (~> 2.4.1)
|
22
22
|
pry (0.13.1)
|
23
23
|
coderay (~> 1.1)
|
@@ -25,7 +25,8 @@ GEM
|
|
25
25
|
pry-byebug (3.9.0)
|
26
26
|
byebug (~> 11.0)
|
27
27
|
pry (~> 0.13.0)
|
28
|
-
psych (4.0.
|
28
|
+
psych (4.0.3)
|
29
|
+
stringio
|
29
30
|
rainbow (3.0.0)
|
30
31
|
rake (13.0.6)
|
31
32
|
rspec (3.10.0)
|
@@ -40,7 +41,7 @@ GEM
|
|
40
41
|
rspec-mocks (3.10.2)
|
41
42
|
diff-lcs (>= 1.2.0, < 2.0)
|
42
43
|
rspec-support (~> 3.10.0)
|
43
|
-
rspec-support (3.10.
|
44
|
+
rspec-support (3.10.3)
|
44
45
|
rubocop (0.66.0)
|
45
46
|
jaro_winkler (~> 1.5.1)
|
46
47
|
parallel (~> 1.10)
|
@@ -50,6 +51,7 @@ GEM
|
|
50
51
|
ruby-progressbar (~> 1.7)
|
51
52
|
unicode-display_width (>= 1.4.0, < 1.6)
|
52
53
|
ruby-progressbar (1.11.0)
|
54
|
+
stringio (3.0.1)
|
53
55
|
typhoeus (1.4.0)
|
54
56
|
ethon (>= 0.9.0)
|
55
57
|
unicode-display_width (1.5.0)
|
@@ -65,4 +67,4 @@ DEPENDENCIES
|
|
65
67
|
tapyrus-api-client!
|
66
68
|
|
67
69
|
BUNDLED WITH
|
68
|
-
2.
|
70
|
+
2.3.4
|
data/README.md
CHANGED
@@ -5,10 +5,10 @@ TapyrusApiClient - the Ruby gem for the Tapyrus API
|
|
5
5
|
# イントロダクション
|
6
6
|
|
7
7
|
これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。
|
8
|
-
|
9
|
-
* Payment: TPC(Tapyrus Coin) の送金
|
8
|
+
現在以下のユースケースをサポートしています。これは今後も拡張されていきます。
|
10
9
|
* Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録
|
11
10
|
* Token: 新しいトークンの発行、送金、焼却。NFTも利用可能
|
11
|
+
* Tracking: トレーサビリティを目的としてたモノの移動履歴を記録
|
12
12
|
|
13
13
|
Tapyrus ブロックチェーンについては以下の情報を参照してください。
|
14
14
|
|
@@ -23,61 +23,46 @@ Tapyrus API は REST API として提供されています。利用を開始す
|
|
23
23
|
|
24
24
|
### Tapyrus API のエンドポイント
|
25
25
|
|
26
|
-
|
26
|
+
エンドポイントは以下のフォーマットで作成されます。
|
27
27
|
|
28
|
-
`
|
28
|
+
`https://xxx.api.tapyrus.chaintope.com/api/v1`
|
29
29
|
|
30
|
-
|
30
|
+
`xxx`の部分は各ユーザー固有の識別子になります。正式なURLは、ダッシュボードで確認できます。
|
31
31
|
|
32
|
-
|
32
|
+
### API接続の準備
|
33
33
|
|
34
|
-
|
35
|
-
|
34
|
+
ダッシュボードに登録すると、chaintopeが登録情報を確認後、お客様のAPIエンドポイントを設定します。
|
35
|
+
エンドポイントが設定されるまでは、APIの機能はご利用いただけません。
|
36
36
|
|
37
|
-
|
37
|
+
#### クライアント証明書
|
38
|
+
Tapyrus APIに接続する際には、クライアント証明書が必要になります。ダッシュボードの「クライアント証明書」のメニューより、
|
39
|
+
クライアント証明書を発行してください。
|
40
|
+
発行すると秘密鍵と公開鍵の証明書を含む[PKCS#12](https://en.wikipedia.org/wiki/PKCS_12)形式のファイルがダウンロードできます。
|
38
41
|
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
以下のステップを踏みます。
|
43
|
-
|
44
|
-
1. 利用する OpenID Provider(OP) を選択する
|
45
|
-
|
46
|
-
公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API
|
47
|
-
を利用させる場合は後者の自身で OP を構築する方法を選択することになります。
|
48
|
-
|
49
|
-
2. OAuth 2.0 Client Credential を入手する
|
50
|
-
|
51
|
-
多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。
|
52
|
-
|
53
|
-
3. Access Token と ID Token を入手する
|
54
|
-
|
55
|
-
OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。
|
56
|
-
|
57
|
-
4. Tapyrus API ユーザを作成する
|
58
|
-
|
59
|
-
入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。
|
60
|
-
|
61
|
-
コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。
|
62
|
-
|
63
|
-
## Tapyrus API ユーザとウォレットについて
|
64
|
-
|
65
|
-
認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。
|
66
|
-
Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。
|
67
|
-
ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。
|
42
|
+
#### ユーザーの登録
|
43
|
+
ダッシュボードからAPIに接続するユーザーを作成します。Tapyrus APIではユーザー単位にウォレットが作成されます。
|
44
|
+
ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されています。
|
68
45
|
そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。
|
69
46
|
|
70
|
-
|
47
|
+
ダッシュボードの、「ユーザー一覧」からアクセスするユーザーを作成することができます。
|
48
|
+
ユーザーを作成すると、そのユーザー用のアクセストークンが発行されます。このアクセストークンとクライアント証明書の両方が漏洩すると、
|
49
|
+
不正アクセスが可能になるため、データの取り扱いには十分注意してください。
|
50
|
+
|
51
|
+
#### 接続確認
|
52
|
+
クライアント証明書とユーザーが作成されると、APIにアクセスできるようになります。簡単な接続確認は、curlで以下のように行なえます。
|
71
53
|
|
72
|
-
|
54
|
+
1. ダウンロードしたPKCS#12ファイルからcert.pemを生成。
|
55
|
+
`$ openssl pkcs12 -in <ダウンロードした.p12ファイルのパス> -out cert.pem -nodes -clcerts`
|
56
|
+
2. cert.pemとアクセストークンを使ってAPIへアクセス。
|
57
|
+
`$ curl -X GET -H 'Authorization: Bearer <ユーザーのアクセストークン>' \"https://xxx.api.tapyrus.chaintope.com/api/v1/timestamps\" -E cert.pem`
|
73
58
|
|
74
|
-
|
59
|
+
成功するとAPIへのアクセスが可能になっています。これらの認証情報を使って、以下に記載する各APIがご利用いただけます。
|
75
60
|
|
76
61
|
|
77
62
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
78
63
|
|
79
|
-
- API version: 1.
|
80
|
-
- Package version:
|
64
|
+
- API version: 1.1.0beta4
|
65
|
+
- Package version: 1.1.0beta4
|
81
66
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
82
67
|
|
83
68
|
## Installation
|
@@ -93,16 +78,16 @@ gem build tapyrus-api-client.gemspec
|
|
93
78
|
Then either install the gem locally:
|
94
79
|
|
95
80
|
```shell
|
96
|
-
gem install ./tapyrus-api-client-
|
81
|
+
gem install ./tapyrus-api-client-1.1.0beta4.gem
|
97
82
|
```
|
98
83
|
|
99
|
-
(for development, run `gem install --dev ./tapyrus-api-client-
|
84
|
+
(for development, run `gem install --dev ./tapyrus-api-client-1.1.0beta4.gem` to install the development dependencies)
|
100
85
|
|
101
86
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
102
87
|
|
103
88
|
Finally add this to the Gemfile:
|
104
89
|
|
105
|
-
gem 'tapyrus-api-client', '~>
|
90
|
+
gem 'tapyrus-api-client', '~> 1.1.0beta4'
|
106
91
|
|
107
92
|
### Install from Git
|
108
93
|
|
@@ -130,10 +115,11 @@ require 'tapyrus-api-client'
|
|
130
115
|
TapyrusApiClient.configure do |config|end
|
131
116
|
|
132
117
|
api_instance = TapyrusApiClient::AddressApi.new
|
118
|
+
purpose_address_request = TapyrusApiClient::PurposeAddressRequest.new # PurposeAddressRequest |
|
133
119
|
|
134
120
|
begin
|
135
121
|
#アドレスを生成して返します。
|
136
|
-
result = api_instance.create_address
|
122
|
+
result = api_instance.create_address(purpose_address_request)
|
137
123
|
p result
|
138
124
|
rescue TapyrusApiClient::ApiError => e
|
139
125
|
puts "Exception when calling AddressApi->create_address: #{e}"
|
@@ -143,20 +129,25 @@ end
|
|
143
129
|
|
144
130
|
## Documentation for API Endpoints
|
145
131
|
|
146
|
-
All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
|
132
|
+
All URIs are relative to *https://ap-01.api.tapyrus.chaintope.com/api/v1*
|
147
133
|
|
148
134
|
Class | Method | HTTP request | Description
|
149
135
|
------------ | ------------- | ------------- | -------------
|
150
136
|
*TapyrusApiClient::AddressApi* | [**create_address**](docs/AddressApi.md#create_address) | **POST** /addresses | アドレスを生成して返します。
|
151
137
|
*TapyrusApiClient::AddressApi* | [**get_addresses**](docs/AddressApi.md#get_addresses) | **GET** /addresses | これまで生成したアドレスを一覧にして返します。
|
152
|
-
*TapyrusApiClient::
|
153
|
-
*TapyrusApiClient::TimestampApi* | [**
|
138
|
+
*TapyrusApiClient::TimestampApi* | [**add_timestamp**](docs/TimestampApi.md#add_timestamp) | **POST** /timestamps | Timestampを記録
|
139
|
+
*TapyrusApiClient::TimestampApi* | [**get_timestamp**](docs/TimestampApi.md#get_timestamp) | **GET** /timestamps/{id} | Timestamp表示
|
154
140
|
*TapyrusApiClient::TimestampApi* | [**get_timestamps**](docs/TimestampApi.md#get_timestamps) | **GET** /timestamps | Timestamp一覧表示
|
155
141
|
*TapyrusApiClient::TokenApi* | [**burn_token**](docs/TokenApi.md#burn_token) | **DELETE** /tokens/{token_id}/burn | トークンの焼却
|
156
142
|
*TapyrusApiClient::TokenApi* | [**get_tokens**](docs/TokenApi.md#get_tokens) | **GET** /tokens | トークンの総量取得
|
157
143
|
*TapyrusApiClient::TokenApi* | [**issue_token**](docs/TokenApi.md#issue_token) | **POST** /tokens/issue | トークンの新規発行
|
158
144
|
*TapyrusApiClient::TokenApi* | [**reissue_token**](docs/TokenApi.md#reissue_token) | **POST** /tokens/{token_id}/reissue | トークンの再発行
|
159
145
|
*TapyrusApiClient::TokenApi* | [**transfer_token**](docs/TokenApi.md#transfer_token) | **PUT** /tokens/{token_id}/transfer | トークンの送付
|
146
|
+
*TapyrusApiClient::TrackingApi* | [**consume_tracking**](docs/TrackingApi.md#consume_tracking) | **POST** /tracking/consume | モノのトラッキングを終了します。
|
147
|
+
*TapyrusApiClient::TrackingApi* | [**get_tracking_subjects**](docs/TrackingApi.md#get_tracking_subjects) | **GET** /tracking/subjects/{subject_id}/traces | モノの移動の履歴を返します。
|
148
|
+
*TapyrusApiClient::TrackingApi* | [**get_tracking_traces**](docs/TrackingApi.md#get_tracking_traces) | **GET** /tracking/traces/{trace_id} | モノの移動履歴(trace)に関する情報を返します。
|
149
|
+
*TapyrusApiClient::TrackingApi* | [**supply_tracking**](docs/TrackingApi.md#supply_tracking) | **POST** /tracking/supply | 新規でトラッキングを開始します。
|
150
|
+
*TapyrusApiClient::TrackingApi* | [**transport_tracking**](docs/TrackingApi.md#transport_tracking) | **POST** /tracking/transport | トラッキング中のモノの移動を記録します。
|
160
151
|
*TapyrusApiClient::UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /users | ユーザを作成します。
|
161
152
|
*TapyrusApiClient::UserApi* | [**get_user_info**](docs/UserApi.md#get_user_info) | **GET** /userinfo | ユーザの情報を返します。
|
162
153
|
|
@@ -164,15 +155,26 @@ Class | Method | HTTP request | Description
|
|
164
155
|
## Documentation for Models
|
165
156
|
|
166
157
|
- [TapyrusApiClient::AddTimestampRequest](docs/AddTimestampRequest.md)
|
158
|
+
- [TapyrusApiClient::AddTimestampResponse](docs/AddTimestampResponse.md)
|
159
|
+
- [TapyrusApiClient::ConsumeTrackingRequest](docs/ConsumeTrackingRequest.md)
|
167
160
|
- [TapyrusApiClient::CreateUserRequest](docs/CreateUserRequest.md)
|
168
161
|
- [TapyrusApiClient::GetAddressesResponse](docs/GetAddressesResponse.md)
|
162
|
+
- [TapyrusApiClient::GetTimestampResponse](docs/GetTimestampResponse.md)
|
169
163
|
- [TapyrusApiClient::GetTokensResponse](docs/GetTokensResponse.md)
|
170
164
|
- [TapyrusApiClient::IssueTokenRequest](docs/IssueTokenRequest.md)
|
171
|
-
- [TapyrusApiClient::
|
172
|
-
- [TapyrusApiClient::PaymentResponse](docs/PaymentResponse.md)
|
165
|
+
- [TapyrusApiClient::PurposeAddressRequest](docs/PurposeAddressRequest.md)
|
173
166
|
- [TapyrusApiClient::ReissueTokenRequest](docs/ReissueTokenRequest.md)
|
167
|
+
- [TapyrusApiClient::SupplyTrackingRequest](docs/SupplyTrackingRequest.md)
|
168
|
+
- [TapyrusApiClient::TimestampType](docs/TimestampType.md)
|
174
169
|
- [TapyrusApiClient::TokenResponse](docs/TokenResponse.md)
|
170
|
+
- [TapyrusApiClient::TrackingDestination](docs/TrackingDestination.md)
|
171
|
+
- [TapyrusApiClient::TrackingResponse](docs/TrackingResponse.md)
|
172
|
+
- [TapyrusApiClient::TrackingSubject](docs/TrackingSubject.md)
|
173
|
+
- [TapyrusApiClient::TrackingSubjectMerkleRoot](docs/TrackingSubjectMerkleRoot.md)
|
174
|
+
- [TapyrusApiClient::TrackingTrace](docs/TrackingTrace.md)
|
175
|
+
- [TapyrusApiClient::TrackingTracesResponse](docs/TrackingTracesResponse.md)
|
175
176
|
- [TapyrusApiClient::TransferTokenRequest](docs/TransferTokenRequest.md)
|
177
|
+
- [TapyrusApiClient::TransportTrackingRequest](docs/TransportTrackingRequest.md)
|
176
178
|
- [TapyrusApiClient::UserinfoResponse](docs/UserinfoResponse.md)
|
177
179
|
- [TapyrusApiClient::UserinfoResponseBalances](docs/UserinfoResponseBalances.md)
|
178
180
|
|
data/docs/AddTimestampRequest.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **content_hash** | **String** | | |
|
8
8
|
| **prefix** | **String** | | [optional] |
|
9
|
+
| **type** | [**TimestampType**](TimestampType.md) | | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'tapyrus-api-client'
|
|
14
15
|
|
15
16
|
instance = TapyrusApiClient::AddTimestampRequest.new(
|
16
17
|
content_hash: 9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d,
|
17
|
-
prefix: app
|
18
|
+
prefix: app,
|
19
|
+
type: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# TapyrusApiClient::AddTimestampResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | | [optional] |
|
8
|
+
| **txid** | **String** | | [optional] |
|
9
|
+
| **status** | **String** | | [optional] |
|
10
|
+
| **content_hash** | **String** | | [optional] |
|
11
|
+
| **prefix** | **String** | | [optional] |
|
12
|
+
| **wallet_id** | **String** | | [optional] |
|
13
|
+
| **latest** | **Boolean** | | [optional] |
|
14
|
+
| **timestamp_type** | [**TimestampType**](TimestampType.md) | | [optional] |
|
15
|
+
| **p2c_address** | **String** | | [optional] |
|
16
|
+
| **payment_base** | **String** | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'tapyrus-api-client'
|
22
|
+
|
23
|
+
instance = TapyrusApiClient::AddTimestampResponse.new(
|
24
|
+
id: null,
|
25
|
+
txid: null,
|
26
|
+
status: init,
|
27
|
+
content_hash: 9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d,
|
28
|
+
prefix: app,
|
29
|
+
wallet_id: b831e51927edc7b3a21869909d526e51,
|
30
|
+
latest: null,
|
31
|
+
timestamp_type: null,
|
32
|
+
p2c_address: null,
|
33
|
+
payment_base: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/AddressApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# TapyrusApiClient::AddressApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
|
3
|
+
All URIs are relative to *https://ap-01.api.tapyrus.chaintope.com/api/v1*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -10,11 +10,11 @@ All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
|
|
10
10
|
|
11
11
|
## create_address
|
12
12
|
|
13
|
-
> String create_address
|
13
|
+
> String create_address(purpose_address_request)
|
14
14
|
|
15
15
|
アドレスを生成して返します。
|
16
16
|
|
17
|
-
|
17
|
+
受金用のアドレスを生成して返します。 任意で`purpose`を設定し、生成するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスを生成します。 - `purpose` に `general` と入力する、または未指定の場合、汎用的に使うアドレスを生成します。 - `purpose`に`tracking`と入力すると、トラッキングに使用するアドレスを生成します。
|
18
18
|
|
19
19
|
### Examples
|
20
20
|
|
@@ -25,10 +25,11 @@ require 'tapyrus-api-client'
|
|
25
25
|
TapyrusApiClient.configure do |config|end
|
26
26
|
|
27
27
|
api_instance = TapyrusApiClient::AddressApi.new
|
28
|
+
purpose_address_request = TapyrusApiClient::PurposeAddressRequest.new # PurposeAddressRequest |
|
28
29
|
|
29
30
|
begin
|
30
31
|
# アドレスを生成して返します。
|
31
|
-
result = api_instance.create_address
|
32
|
+
result = api_instance.create_address(purpose_address_request)
|
32
33
|
p result
|
33
34
|
rescue TapyrusApiClient::ApiError => e
|
34
35
|
puts "Error when calling AddressApi->create_address: #{e}"
|
@@ -39,12 +40,12 @@ end
|
|
39
40
|
|
40
41
|
This returns an Array which contains the response data, status code and headers.
|
41
42
|
|
42
|
-
> <Array(String, Integer, Hash)> create_address_with_http_info
|
43
|
+
> <Array(String, Integer, Hash)> create_address_with_http_info(purpose_address_request)
|
43
44
|
|
44
45
|
```ruby
|
45
46
|
begin
|
46
47
|
# アドレスを生成して返します。
|
47
|
-
data, status_code, headers = api_instance.create_address_with_http_info
|
48
|
+
data, status_code, headers = api_instance.create_address_with_http_info(purpose_address_request)
|
48
49
|
p status_code # => 2xx
|
49
50
|
p headers # => { ... }
|
50
51
|
p data # => String
|
@@ -55,7 +56,9 @@ end
|
|
55
56
|
|
56
57
|
### Parameters
|
57
58
|
|
58
|
-
|
59
|
+
| Name | Type | Description | Notes |
|
60
|
+
| ---- | ---- | ----------- | ----- |
|
61
|
+
| **purpose_address_request** | [**PurposeAddressRequest**](PurposeAddressRequest.md) | | |
|
59
62
|
|
60
63
|
### Return type
|
61
64
|
|
@@ -67,7 +70,7 @@ No authorization required
|
|
67
70
|
|
68
71
|
### HTTP request headers
|
69
72
|
|
70
|
-
- **Content-Type**:
|
73
|
+
- **Content-Type**: application/json
|
71
74
|
- **Accept**: application/json
|
72
75
|
|
73
76
|
|
@@ -77,7 +80,7 @@ No authorization required
|
|
77
80
|
|
78
81
|
これまで生成したアドレスを一覧にして返します。
|
79
82
|
|
80
|
-
これまで生成したアドレスを一覧にして返します。
|
83
|
+
これまで生成したアドレスを一覧にして返します。 任意で`purpose`を設定し、取得するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスのみ取得します。 - `purpose`に`general`と入力すると、生成したアドレスのうち、汎用的に使うアドレスのみ取得します。 - `purpose`に`all`と入力すると、生成したアドレスすべて取得します。 - `purpose`に`tracking`と入力すると、生成したアドレスのうち、トラッキングに使用されているアドレスを取得します。
|
81
84
|
|
82
85
|
### Examples
|
83
86
|
|
@@ -90,7 +93,8 @@ TapyrusApiClient.configure do |config|end
|
|
90
93
|
api_instance = TapyrusApiClient::AddressApi.new
|
91
94
|
opts = {
|
92
95
|
per: 56, # Integer | 1ページあたりの件数
|
93
|
-
page: 56 # Integer | ページ番号
|
96
|
+
page: 56, # Integer | ページ番号
|
97
|
+
purpose: 'purpose_example' # String | 取得したいアドレス
|
94
98
|
}
|
95
99
|
|
96
100
|
begin
|
@@ -126,6 +130,7 @@ end
|
|
126
130
|
| ---- | ---- | ----------- | ----- |
|
127
131
|
| **per** | **Integer** | 1ページあたりの件数 | [optional] |
|
128
132
|
| **page** | **Integer** | ページ番号 | [optional] |
|
133
|
+
| **purpose** | **String** | 取得したいアドレス | [optional] |
|
129
134
|
|
130
135
|
### Return type
|
131
136
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TapyrusApiClient::ConsumeTrackingRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **subjects** | **Array<String>** | 消費したモノを示します。 | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tapyrus-api-client'
|
13
|
+
|
14
|
+
instance = TapyrusApiClient::ConsumeTrackingRequest.new(
|
15
|
+
subjects: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# TapyrusApiClient::GetTimestampResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | | [optional] |
|
8
|
+
| **txid** | **String** | トランザクションID | [optional] |
|
9
|
+
| **status** | **String** | | [optional] |
|
10
|
+
| **content_hash** | **String** | | [optional] |
|
11
|
+
| **prefix** | **String** | | [optional] |
|
12
|
+
| **wallet_id** | **String** | | [optional] |
|
13
|
+
| **latest** | **Boolean** | timestamp_typeがtrackableの場合のみセットされます。 | [optional] |
|
14
|
+
| **timestamp_type** | [**TimestampType**](TimestampType.md) | | [optional] |
|
15
|
+
| **p2c_address** | **String** | timestamp_typeがtrackableの場合のみセットされます。 | [optional] |
|
16
|
+
| **payment_base** | **String** | timestamp_typeがtrackableの場合のみセットされます。 | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'tapyrus-api-client'
|
22
|
+
|
23
|
+
instance = TapyrusApiClient::GetTimestampResponse.new(
|
24
|
+
id: null,
|
25
|
+
txid: 6fce02d39279f6d645ecc710ebcf1dbb7b8104106553d8da13f5db79c5a628fc,
|
26
|
+
status: null,
|
27
|
+
content_hash: 9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d,
|
28
|
+
prefix: app,
|
29
|
+
wallet_id: b831e51927edc7b3a21869909d526e51,
|
30
|
+
latest: true,
|
31
|
+
timestamp_type: null,
|
32
|
+
p2c_address: 1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a,
|
33
|
+
payment_base: 02124fd6b3c968390be4828058efc941b83f8ce9ccb00cfde86423744dbcb82576
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TapyrusApiClient::PurposeAddressRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **purpose** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tapyrus-api-client'
|
13
|
+
|
14
|
+
instance = TapyrusApiClient::PurposeAddressRequest.new(
|
15
|
+
purpose: general
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TapyrusApiClient::SupplyTrackingRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **from_address** | **String** | 供給元を表すアドレス | |
|
8
|
+
| **destinations** | [**Array<TrackingDestination>**](TrackingDestination.md) | モノの移動先を表します。 | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tapyrus-api-client'
|
14
|
+
|
15
|
+
instance = TapyrusApiClient::SupplyTrackingRequest.new(
|
16
|
+
from_address: 1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a,
|
17
|
+
destinations: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|