tapyrus-api-client 0 → 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 +5 -5
- metadata +68 -48
- 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
@@ -0,0 +1,321 @@
|
|
1
|
+
=begin
|
2
|
+
#Tapyrus API
|
3
|
+
|
4
|
+
## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていきます。 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 * Tracking: トレーサビリティを目的としてたモノの移動履歴を記録 Tapyrus ブロックチェーンについては以下の情報を参照してください。 * [Chaintope のブロックチェーンプロトコル](https://www.chaintope.com/chaintope-blockchain-protocol/) * [chaintope/tapyrus-core - github](https://github.com/chaintope/tapyrus-core) ## Tapyrus API の利用法 Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みの トークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。 ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。 ### Tapyrus API のエンドポイント エンドポイントは以下のフォーマットで作成されます。 `https://xxx.api.tapyrus.chaintope.com/api/v1` `xxx`の部分は各ユーザー固有の識別子になります。正式なURLは、ダッシュボードで確認できます。 ### API接続の準備 ダッシュボードに登録すると、chaintopeが登録情報を確認後、お客様のAPIエンドポイントを設定します。 エンドポイントが設定されるまでは、APIの機能はご利用いただけません。 #### クライアント証明書 Tapyrus APIに接続する際には、クライアント証明書が必要になります。ダッシュボードの「クライアント証明書」のメニューより、 クライアント証明書を発行してください。 発行すると秘密鍵と公開鍵の証明書を含む[PKCS#12](https://en.wikipedia.org/wiki/PKCS_12)形式のファイルがダウンロードできます。 #### ユーザーの登録 ダッシュボードからAPIに接続するユーザーを作成します。Tapyrus APIではユーザー単位にウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されています。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 ダッシュボードの、「ユーザー一覧」からアクセスするユーザーを作成することができます。 ユーザーを作成すると、そのユーザー用のアクセストークンが発行されます。このアクセストークンとクライアント証明書の両方が漏洩すると、 不正アクセスが可能になるため、データの取り扱いには十分注意してください。 #### 接続確認 クライアント証明書とユーザーが作成されると、APIにアクセスできるようになります。簡単な接続確認は、curlで以下のように行なえます。 1. ダウンロードしたPKCS#12ファイルからcert.pemを生成。 `$ openssl pkcs12 -in <ダウンロードした.p12ファイルのパス> -out cert.pem -nodes -clcerts` 2. cert.pemとアクセストークンを使ってAPIへアクセス。 `$ curl -X GET -H 'Authorization: Bearer <ユーザーのアクセストークン>' \"https://xxx.api.tapyrus.chaintope.com/api/v1/timestamps\" -E cert.pem` 成功するとAPIへのアクセスが可能になっています。これらの認証情報を使って、以下に記載する各APIがご利用いただけます。
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.0beta4
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.4.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module TapyrusApiClient
|
17
|
+
class TrackingTrace
|
18
|
+
attr_accessor :trace_id
|
19
|
+
|
20
|
+
attr_accessor :subject_id
|
21
|
+
|
22
|
+
attr_accessor :tracking_payload
|
23
|
+
|
24
|
+
# tracking_payload がセットされたアウトプットのインデックス
|
25
|
+
attr_accessor :tracking_payload_output_index
|
26
|
+
|
27
|
+
# subject_id が示す Subject の包含証明。Hex 文字列
|
28
|
+
attr_accessor :inclusion_proof
|
29
|
+
|
30
|
+
# トランザクションID
|
31
|
+
attr_accessor :txid
|
32
|
+
|
33
|
+
attr_accessor :tx_index
|
34
|
+
|
35
|
+
attr_accessor :block_height
|
36
|
+
|
37
|
+
attr_accessor :block_time
|
38
|
+
|
39
|
+
attr_accessor :from_address
|
40
|
+
|
41
|
+
attr_accessor :to_address
|
42
|
+
|
43
|
+
# subject_id が示す Subject が to_address からすでに移動済みの場合 true 、そうでなければ false になります
|
44
|
+
attr_accessor :moved
|
45
|
+
|
46
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
47
|
+
def self.attribute_map
|
48
|
+
{
|
49
|
+
:'trace_id' => :'trace_id',
|
50
|
+
:'subject_id' => :'subject_id',
|
51
|
+
:'tracking_payload' => :'tracking_payload',
|
52
|
+
:'tracking_payload_output_index' => :'tracking_payload_output_index',
|
53
|
+
:'inclusion_proof' => :'inclusion_proof',
|
54
|
+
:'txid' => :'txid',
|
55
|
+
:'tx_index' => :'tx_index',
|
56
|
+
:'block_height' => :'block_height',
|
57
|
+
:'block_time' => :'block_time',
|
58
|
+
:'from_address' => :'from_address',
|
59
|
+
:'to_address' => :'to_address',
|
60
|
+
:'moved' => :'moved'
|
61
|
+
}
|
62
|
+
end
|
63
|
+
|
64
|
+
# Returns all the JSON keys this model knows about
|
65
|
+
def self.acceptable_attributes
|
66
|
+
attribute_map.values
|
67
|
+
end
|
68
|
+
|
69
|
+
# Attribute type mapping.
|
70
|
+
def self.openapi_types
|
71
|
+
{
|
72
|
+
:'trace_id' => :'Float',
|
73
|
+
:'subject_id' => :'String',
|
74
|
+
:'tracking_payload' => :'String',
|
75
|
+
:'tracking_payload_output_index' => :'Integer',
|
76
|
+
:'inclusion_proof' => :'String',
|
77
|
+
:'txid' => :'String',
|
78
|
+
:'tx_index' => :'Integer',
|
79
|
+
:'block_height' => :'Integer',
|
80
|
+
:'block_time' => :'Integer',
|
81
|
+
:'from_address' => :'String',
|
82
|
+
:'to_address' => :'String',
|
83
|
+
:'moved' => :'Boolean'
|
84
|
+
}
|
85
|
+
end
|
86
|
+
|
87
|
+
# List of attributes with nullable: true
|
88
|
+
def self.openapi_nullable
|
89
|
+
Set.new([
|
90
|
+
])
|
91
|
+
end
|
92
|
+
|
93
|
+
# Initializes the object
|
94
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
95
|
+
def initialize(attributes = {})
|
96
|
+
if (!attributes.is_a?(Hash))
|
97
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TapyrusApiClient::TrackingTrace` initialize method"
|
98
|
+
end
|
99
|
+
|
100
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
101
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
102
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
103
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TapyrusApiClient::TrackingTrace`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
104
|
+
end
|
105
|
+
h[k.to_sym] = v
|
106
|
+
}
|
107
|
+
|
108
|
+
if attributes.key?(:'trace_id')
|
109
|
+
self.trace_id = attributes[:'trace_id']
|
110
|
+
end
|
111
|
+
|
112
|
+
if attributes.key?(:'subject_id')
|
113
|
+
self.subject_id = attributes[:'subject_id']
|
114
|
+
end
|
115
|
+
|
116
|
+
if attributes.key?(:'tracking_payload')
|
117
|
+
self.tracking_payload = attributes[:'tracking_payload']
|
118
|
+
end
|
119
|
+
|
120
|
+
if attributes.key?(:'tracking_payload_output_index')
|
121
|
+
self.tracking_payload_output_index = attributes[:'tracking_payload_output_index']
|
122
|
+
end
|
123
|
+
|
124
|
+
if attributes.key?(:'inclusion_proof')
|
125
|
+
self.inclusion_proof = attributes[:'inclusion_proof']
|
126
|
+
end
|
127
|
+
|
128
|
+
if attributes.key?(:'txid')
|
129
|
+
self.txid = attributes[:'txid']
|
130
|
+
end
|
131
|
+
|
132
|
+
if attributes.key?(:'tx_index')
|
133
|
+
self.tx_index = attributes[:'tx_index']
|
134
|
+
end
|
135
|
+
|
136
|
+
if attributes.key?(:'block_height')
|
137
|
+
self.block_height = attributes[:'block_height']
|
138
|
+
end
|
139
|
+
|
140
|
+
if attributes.key?(:'block_time')
|
141
|
+
self.block_time = attributes[:'block_time']
|
142
|
+
end
|
143
|
+
|
144
|
+
if attributes.key?(:'from_address')
|
145
|
+
self.from_address = attributes[:'from_address']
|
146
|
+
end
|
147
|
+
|
148
|
+
if attributes.key?(:'to_address')
|
149
|
+
self.to_address = attributes[:'to_address']
|
150
|
+
end
|
151
|
+
|
152
|
+
if attributes.key?(:'moved')
|
153
|
+
self.moved = attributes[:'moved']
|
154
|
+
end
|
155
|
+
end
|
156
|
+
|
157
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
158
|
+
# @return Array for valid properties with the reasons
|
159
|
+
def list_invalid_properties
|
160
|
+
invalid_properties = Array.new
|
161
|
+
invalid_properties
|
162
|
+
end
|
163
|
+
|
164
|
+
# Check to see if the all the properties in the model are valid
|
165
|
+
# @return true if the model is valid
|
166
|
+
def valid?
|
167
|
+
true
|
168
|
+
end
|
169
|
+
|
170
|
+
# Checks equality by comparing each attribute.
|
171
|
+
# @param [Object] Object to be compared
|
172
|
+
def ==(o)
|
173
|
+
return true if self.equal?(o)
|
174
|
+
self.class == o.class &&
|
175
|
+
trace_id == o.trace_id &&
|
176
|
+
subject_id == o.subject_id &&
|
177
|
+
tracking_payload == o.tracking_payload &&
|
178
|
+
tracking_payload_output_index == o.tracking_payload_output_index &&
|
179
|
+
inclusion_proof == o.inclusion_proof &&
|
180
|
+
txid == o.txid &&
|
181
|
+
tx_index == o.tx_index &&
|
182
|
+
block_height == o.block_height &&
|
183
|
+
block_time == o.block_time &&
|
184
|
+
from_address == o.from_address &&
|
185
|
+
to_address == o.to_address &&
|
186
|
+
moved == o.moved
|
187
|
+
end
|
188
|
+
|
189
|
+
# @see the `==` method
|
190
|
+
# @param [Object] Object to be compared
|
191
|
+
def eql?(o)
|
192
|
+
self == o
|
193
|
+
end
|
194
|
+
|
195
|
+
# Calculates hash code according to all attributes.
|
196
|
+
# @return [Integer] Hash code
|
197
|
+
def hash
|
198
|
+
[trace_id, subject_id, tracking_payload, tracking_payload_output_index, inclusion_proof, txid, tx_index, block_height, block_time, from_address, to_address, moved].hash
|
199
|
+
end
|
200
|
+
|
201
|
+
# Builds the object from hash
|
202
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
203
|
+
# @return [Object] Returns the model itself
|
204
|
+
def self.build_from_hash(attributes)
|
205
|
+
new.build_from_hash(attributes)
|
206
|
+
end
|
207
|
+
|
208
|
+
# Builds the object from hash
|
209
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
210
|
+
# @return [Object] Returns the model itself
|
211
|
+
def build_from_hash(attributes)
|
212
|
+
return nil unless attributes.is_a?(Hash)
|
213
|
+
self.class.openapi_types.each_pair do |key, type|
|
214
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
215
|
+
self.send("#{key}=", nil)
|
216
|
+
elsif type =~ /\AArray<(.*)>/i
|
217
|
+
# check to ensure the input is an array given that the attribute
|
218
|
+
# is documented as an array but the input is not
|
219
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
220
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
221
|
+
end
|
222
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
223
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
self
|
228
|
+
end
|
229
|
+
|
230
|
+
# Deserializes the data based on type
|
231
|
+
# @param string type Data type
|
232
|
+
# @param string value Value to be deserialized
|
233
|
+
# @return [Object] Deserialized data
|
234
|
+
def _deserialize(type, value)
|
235
|
+
case type.to_sym
|
236
|
+
when :Time
|
237
|
+
Time.parse(value)
|
238
|
+
when :Date
|
239
|
+
Date.parse(value)
|
240
|
+
when :String
|
241
|
+
value.to_s
|
242
|
+
when :Integer
|
243
|
+
value.to_i
|
244
|
+
when :Float
|
245
|
+
value.to_f
|
246
|
+
when :Boolean
|
247
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
248
|
+
true
|
249
|
+
else
|
250
|
+
false
|
251
|
+
end
|
252
|
+
when :Object
|
253
|
+
# generic object (usually a Hash), return directly
|
254
|
+
value
|
255
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
256
|
+
inner_type = Regexp.last_match[:inner_type]
|
257
|
+
value.map { |v| _deserialize(inner_type, v) }
|
258
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
259
|
+
k_type = Regexp.last_match[:k_type]
|
260
|
+
v_type = Regexp.last_match[:v_type]
|
261
|
+
{}.tap do |hash|
|
262
|
+
value.each do |k, v|
|
263
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
264
|
+
end
|
265
|
+
end
|
266
|
+
else # model
|
267
|
+
# models (e.g. Pet) or oneOf
|
268
|
+
klass = TapyrusApiClient.const_get(type)
|
269
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
270
|
+
end
|
271
|
+
end
|
272
|
+
|
273
|
+
# Returns the string representation of the object
|
274
|
+
# @return [String] String presentation of the object
|
275
|
+
def to_s
|
276
|
+
to_hash.to_s
|
277
|
+
end
|
278
|
+
|
279
|
+
# to_body is an alias to to_hash (backward compatibility)
|
280
|
+
# @return [Hash] Returns the object in the form of hash
|
281
|
+
def to_body
|
282
|
+
to_hash
|
283
|
+
end
|
284
|
+
|
285
|
+
# Returns the object in the form of hash
|
286
|
+
# @return [Hash] Returns the object in the form of hash
|
287
|
+
def to_hash
|
288
|
+
hash = {}
|
289
|
+
self.class.attribute_map.each_pair do |attr, param|
|
290
|
+
value = self.send(attr)
|
291
|
+
if value.nil?
|
292
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
293
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
294
|
+
end
|
295
|
+
|
296
|
+
hash[param] = _to_hash(value)
|
297
|
+
end
|
298
|
+
hash
|
299
|
+
end
|
300
|
+
|
301
|
+
# Outputs non-array value in the form of hash
|
302
|
+
# For object, use to_hash. Otherwise, just return the value
|
303
|
+
# @param [Object] value Any valid value
|
304
|
+
# @return [Hash] Returns the value in the form of hash
|
305
|
+
def _to_hash(value)
|
306
|
+
if value.is_a?(Array)
|
307
|
+
value.compact.map { |v| _to_hash(v) }
|
308
|
+
elsif value.is_a?(Hash)
|
309
|
+
{}.tap do |hash|
|
310
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
311
|
+
end
|
312
|
+
elsif value.respond_to? :to_hash
|
313
|
+
value.to_hash
|
314
|
+
else
|
315
|
+
value
|
316
|
+
end
|
317
|
+
end
|
318
|
+
|
319
|
+
end
|
320
|
+
|
321
|
+
end
|
@@ -0,0 +1,343 @@
|
|
1
|
+
=begin
|
2
|
+
#Tapyrus API
|
3
|
+
|
4
|
+
## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていきます。 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 * Tracking: トレーサビリティを目的としてたモノの移動履歴を記録 Tapyrus ブロックチェーンについては以下の情報を参照してください。 * [Chaintope のブロックチェーンプロトコル](https://www.chaintope.com/chaintope-blockchain-protocol/) * [chaintope/tapyrus-core - github](https://github.com/chaintope/tapyrus-core) ## Tapyrus API の利用法 Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みの トークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。 ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。 ### Tapyrus API のエンドポイント エンドポイントは以下のフォーマットで作成されます。 `https://xxx.api.tapyrus.chaintope.com/api/v1` `xxx`の部分は各ユーザー固有の識別子になります。正式なURLは、ダッシュボードで確認できます。 ### API接続の準備 ダッシュボードに登録すると、chaintopeが登録情報を確認後、お客様のAPIエンドポイントを設定します。 エンドポイントが設定されるまでは、APIの機能はご利用いただけません。 #### クライアント証明書 Tapyrus APIに接続する際には、クライアント証明書が必要になります。ダッシュボードの「クライアント証明書」のメニューより、 クライアント証明書を発行してください。 発行すると秘密鍵と公開鍵の証明書を含む[PKCS#12](https://en.wikipedia.org/wiki/PKCS_12)形式のファイルがダウンロードできます。 #### ユーザーの登録 ダッシュボードからAPIに接続するユーザーを作成します。Tapyrus APIではユーザー単位にウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されています。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 ダッシュボードの、「ユーザー一覧」からアクセスするユーザーを作成することができます。 ユーザーを作成すると、そのユーザー用のアクセストークンが発行されます。このアクセストークンとクライアント証明書の両方が漏洩すると、 不正アクセスが可能になるため、データの取り扱いには十分注意してください。 #### 接続確認 クライアント証明書とユーザーが作成されると、APIにアクセスできるようになります。簡単な接続確認は、curlで以下のように行なえます。 1. ダウンロードしたPKCS#12ファイルからcert.pemを生成。 `$ openssl pkcs12 -in <ダウンロードした.p12ファイルのパス> -out cert.pem -nodes -clcerts` 2. cert.pemとアクセストークンを使ってAPIへアクセス。 `$ curl -X GET -H 'Authorization: Bearer <ユーザーのアクセストークン>' \"https://xxx.api.tapyrus.chaintope.com/api/v1/timestamps\" -E cert.pem` 成功するとAPIへのアクセスが可能になっています。これらの認証情報を使って、以下に記載する各APIがご利用いただけます。
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.0beta4
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.4.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module TapyrusApiClient
|
17
|
+
class TrackingTracesResponse
|
18
|
+
attr_accessor :trace_id
|
19
|
+
|
20
|
+
attr_accessor :subject_id
|
21
|
+
|
22
|
+
attr_accessor :parents
|
23
|
+
|
24
|
+
attr_accessor :child_subject_ids
|
25
|
+
|
26
|
+
attr_accessor :tracking_payload
|
27
|
+
|
28
|
+
# tracking_payload がセットされたアウトプットのインデックス
|
29
|
+
attr_accessor :tracking_payload_output_index
|
30
|
+
|
31
|
+
# subject_id が示す Subject の包含証明。Hex 文字列
|
32
|
+
attr_accessor :inclusion_proof
|
33
|
+
|
34
|
+
# トランザクションID
|
35
|
+
attr_accessor :txid
|
36
|
+
|
37
|
+
attr_accessor :tx_index
|
38
|
+
|
39
|
+
attr_accessor :block_height
|
40
|
+
|
41
|
+
attr_accessor :block_time
|
42
|
+
|
43
|
+
attr_accessor :from_address
|
44
|
+
|
45
|
+
attr_accessor :to_address
|
46
|
+
|
47
|
+
# subject_id が示す Subject が to_address からすでに移動済みの場合 true 、そうでなければ false になります
|
48
|
+
attr_accessor :moved
|
49
|
+
|
50
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
51
|
+
def self.attribute_map
|
52
|
+
{
|
53
|
+
:'trace_id' => :'trace_id',
|
54
|
+
:'subject_id' => :'subject_id',
|
55
|
+
:'parents' => :'parents',
|
56
|
+
:'child_subject_ids' => :'child_subject_ids',
|
57
|
+
:'tracking_payload' => :'tracking_payload',
|
58
|
+
:'tracking_payload_output_index' => :'tracking_payload_output_index',
|
59
|
+
:'inclusion_proof' => :'inclusion_proof',
|
60
|
+
:'txid' => :'txid',
|
61
|
+
:'tx_index' => :'tx_index',
|
62
|
+
:'block_height' => :'block_height',
|
63
|
+
:'block_time' => :'block_time',
|
64
|
+
:'from_address' => :'from_address',
|
65
|
+
:'to_address' => :'to_address',
|
66
|
+
:'moved' => :'moved'
|
67
|
+
}
|
68
|
+
end
|
69
|
+
|
70
|
+
# Returns all the JSON keys this model knows about
|
71
|
+
def self.acceptable_attributes
|
72
|
+
attribute_map.values
|
73
|
+
end
|
74
|
+
|
75
|
+
# Attribute type mapping.
|
76
|
+
def self.openapi_types
|
77
|
+
{
|
78
|
+
:'trace_id' => :'Float',
|
79
|
+
:'subject_id' => :'String',
|
80
|
+
:'parents' => :'Array<TrackingSubjectMerkleRoot>',
|
81
|
+
:'child_subject_ids' => :'Array<String>',
|
82
|
+
:'tracking_payload' => :'String',
|
83
|
+
:'tracking_payload_output_index' => :'Integer',
|
84
|
+
:'inclusion_proof' => :'String',
|
85
|
+
:'txid' => :'String',
|
86
|
+
:'tx_index' => :'Integer',
|
87
|
+
:'block_height' => :'Integer',
|
88
|
+
:'block_time' => :'Integer',
|
89
|
+
:'from_address' => :'String',
|
90
|
+
:'to_address' => :'String',
|
91
|
+
:'moved' => :'Boolean'
|
92
|
+
}
|
93
|
+
end
|
94
|
+
|
95
|
+
# List of attributes with nullable: true
|
96
|
+
def self.openapi_nullable
|
97
|
+
Set.new([
|
98
|
+
])
|
99
|
+
end
|
100
|
+
|
101
|
+
# Initializes the object
|
102
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
103
|
+
def initialize(attributes = {})
|
104
|
+
if (!attributes.is_a?(Hash))
|
105
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TapyrusApiClient::TrackingTracesResponse` initialize method"
|
106
|
+
end
|
107
|
+
|
108
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
109
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
110
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
111
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TapyrusApiClient::TrackingTracesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
112
|
+
end
|
113
|
+
h[k.to_sym] = v
|
114
|
+
}
|
115
|
+
|
116
|
+
if attributes.key?(:'trace_id')
|
117
|
+
self.trace_id = attributes[:'trace_id']
|
118
|
+
end
|
119
|
+
|
120
|
+
if attributes.key?(:'subject_id')
|
121
|
+
self.subject_id = attributes[:'subject_id']
|
122
|
+
end
|
123
|
+
|
124
|
+
if attributes.key?(:'parents')
|
125
|
+
if (value = attributes[:'parents']).is_a?(Array)
|
126
|
+
self.parents = value
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
if attributes.key?(:'child_subject_ids')
|
131
|
+
if (value = attributes[:'child_subject_ids']).is_a?(Array)
|
132
|
+
self.child_subject_ids = value
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
if attributes.key?(:'tracking_payload')
|
137
|
+
self.tracking_payload = attributes[:'tracking_payload']
|
138
|
+
end
|
139
|
+
|
140
|
+
if attributes.key?(:'tracking_payload_output_index')
|
141
|
+
self.tracking_payload_output_index = attributes[:'tracking_payload_output_index']
|
142
|
+
end
|
143
|
+
|
144
|
+
if attributes.key?(:'inclusion_proof')
|
145
|
+
self.inclusion_proof = attributes[:'inclusion_proof']
|
146
|
+
end
|
147
|
+
|
148
|
+
if attributes.key?(:'txid')
|
149
|
+
self.txid = attributes[:'txid']
|
150
|
+
end
|
151
|
+
|
152
|
+
if attributes.key?(:'tx_index')
|
153
|
+
self.tx_index = attributes[:'tx_index']
|
154
|
+
end
|
155
|
+
|
156
|
+
if attributes.key?(:'block_height')
|
157
|
+
self.block_height = attributes[:'block_height']
|
158
|
+
end
|
159
|
+
|
160
|
+
if attributes.key?(:'block_time')
|
161
|
+
self.block_time = attributes[:'block_time']
|
162
|
+
end
|
163
|
+
|
164
|
+
if attributes.key?(:'from_address')
|
165
|
+
self.from_address = attributes[:'from_address']
|
166
|
+
end
|
167
|
+
|
168
|
+
if attributes.key?(:'to_address')
|
169
|
+
self.to_address = attributes[:'to_address']
|
170
|
+
end
|
171
|
+
|
172
|
+
if attributes.key?(:'moved')
|
173
|
+
self.moved = attributes[:'moved']
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
178
|
+
# @return Array for valid properties with the reasons
|
179
|
+
def list_invalid_properties
|
180
|
+
invalid_properties = Array.new
|
181
|
+
invalid_properties
|
182
|
+
end
|
183
|
+
|
184
|
+
# Check to see if the all the properties in the model are valid
|
185
|
+
# @return true if the model is valid
|
186
|
+
def valid?
|
187
|
+
true
|
188
|
+
end
|
189
|
+
|
190
|
+
# Checks equality by comparing each attribute.
|
191
|
+
# @param [Object] Object to be compared
|
192
|
+
def ==(o)
|
193
|
+
return true if self.equal?(o)
|
194
|
+
self.class == o.class &&
|
195
|
+
trace_id == o.trace_id &&
|
196
|
+
subject_id == o.subject_id &&
|
197
|
+
parents == o.parents &&
|
198
|
+
child_subject_ids == o.child_subject_ids &&
|
199
|
+
tracking_payload == o.tracking_payload &&
|
200
|
+
tracking_payload_output_index == o.tracking_payload_output_index &&
|
201
|
+
inclusion_proof == o.inclusion_proof &&
|
202
|
+
txid == o.txid &&
|
203
|
+
tx_index == o.tx_index &&
|
204
|
+
block_height == o.block_height &&
|
205
|
+
block_time == o.block_time &&
|
206
|
+
from_address == o.from_address &&
|
207
|
+
to_address == o.to_address &&
|
208
|
+
moved == o.moved
|
209
|
+
end
|
210
|
+
|
211
|
+
# @see the `==` method
|
212
|
+
# @param [Object] Object to be compared
|
213
|
+
def eql?(o)
|
214
|
+
self == o
|
215
|
+
end
|
216
|
+
|
217
|
+
# Calculates hash code according to all attributes.
|
218
|
+
# @return [Integer] Hash code
|
219
|
+
def hash
|
220
|
+
[trace_id, subject_id, parents, child_subject_ids, tracking_payload, tracking_payload_output_index, inclusion_proof, txid, tx_index, block_height, block_time, from_address, to_address, moved].hash
|
221
|
+
end
|
222
|
+
|
223
|
+
# Builds the object from hash
|
224
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
225
|
+
# @return [Object] Returns the model itself
|
226
|
+
def self.build_from_hash(attributes)
|
227
|
+
new.build_from_hash(attributes)
|
228
|
+
end
|
229
|
+
|
230
|
+
# Builds the object from hash
|
231
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
232
|
+
# @return [Object] Returns the model itself
|
233
|
+
def build_from_hash(attributes)
|
234
|
+
return nil unless attributes.is_a?(Hash)
|
235
|
+
self.class.openapi_types.each_pair do |key, type|
|
236
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
237
|
+
self.send("#{key}=", nil)
|
238
|
+
elsif type =~ /\AArray<(.*)>/i
|
239
|
+
# check to ensure the input is an array given that the attribute
|
240
|
+
# is documented as an array but the input is not
|
241
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
242
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
243
|
+
end
|
244
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
245
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
self
|
250
|
+
end
|
251
|
+
|
252
|
+
# Deserializes the data based on type
|
253
|
+
# @param string type Data type
|
254
|
+
# @param string value Value to be deserialized
|
255
|
+
# @return [Object] Deserialized data
|
256
|
+
def _deserialize(type, value)
|
257
|
+
case type.to_sym
|
258
|
+
when :Time
|
259
|
+
Time.parse(value)
|
260
|
+
when :Date
|
261
|
+
Date.parse(value)
|
262
|
+
when :String
|
263
|
+
value.to_s
|
264
|
+
when :Integer
|
265
|
+
value.to_i
|
266
|
+
when :Float
|
267
|
+
value.to_f
|
268
|
+
when :Boolean
|
269
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
270
|
+
true
|
271
|
+
else
|
272
|
+
false
|
273
|
+
end
|
274
|
+
when :Object
|
275
|
+
# generic object (usually a Hash), return directly
|
276
|
+
value
|
277
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
278
|
+
inner_type = Regexp.last_match[:inner_type]
|
279
|
+
value.map { |v| _deserialize(inner_type, v) }
|
280
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
281
|
+
k_type = Regexp.last_match[:k_type]
|
282
|
+
v_type = Regexp.last_match[:v_type]
|
283
|
+
{}.tap do |hash|
|
284
|
+
value.each do |k, v|
|
285
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
286
|
+
end
|
287
|
+
end
|
288
|
+
else # model
|
289
|
+
# models (e.g. Pet) or oneOf
|
290
|
+
klass = TapyrusApiClient.const_get(type)
|
291
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
292
|
+
end
|
293
|
+
end
|
294
|
+
|
295
|
+
# Returns the string representation of the object
|
296
|
+
# @return [String] String presentation of the object
|
297
|
+
def to_s
|
298
|
+
to_hash.to_s
|
299
|
+
end
|
300
|
+
|
301
|
+
# to_body is an alias to to_hash (backward compatibility)
|
302
|
+
# @return [Hash] Returns the object in the form of hash
|
303
|
+
def to_body
|
304
|
+
to_hash
|
305
|
+
end
|
306
|
+
|
307
|
+
# Returns the object in the form of hash
|
308
|
+
# @return [Hash] Returns the object in the form of hash
|
309
|
+
def to_hash
|
310
|
+
hash = {}
|
311
|
+
self.class.attribute_map.each_pair do |attr, param|
|
312
|
+
value = self.send(attr)
|
313
|
+
if value.nil?
|
314
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
315
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
316
|
+
end
|
317
|
+
|
318
|
+
hash[param] = _to_hash(value)
|
319
|
+
end
|
320
|
+
hash
|
321
|
+
end
|
322
|
+
|
323
|
+
# Outputs non-array value in the form of hash
|
324
|
+
# For object, use to_hash. Otherwise, just return the value
|
325
|
+
# @param [Object] value Any valid value
|
326
|
+
# @return [Hash] Returns the value in the form of hash
|
327
|
+
def _to_hash(value)
|
328
|
+
if value.is_a?(Array)
|
329
|
+
value.compact.map { |v| _to_hash(v) }
|
330
|
+
elsif value.is_a?(Hash)
|
331
|
+
{}.tap do |hash|
|
332
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
333
|
+
end
|
334
|
+
elsif value.respond_to? :to_hash
|
335
|
+
value.to_hash
|
336
|
+
else
|
337
|
+
value
|
338
|
+
end
|
339
|
+
end
|
340
|
+
|
341
|
+
end
|
342
|
+
|
343
|
+
end
|