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.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +11 -9
  3. data/README.md +54 -52
  4. data/docs/AddTimestampRequest.md +3 -1
  5. data/docs/AddTimestampResponse.md +36 -0
  6. data/docs/AddressApi.md +15 -10
  7. data/docs/ConsumeTrackingRequest.md +18 -0
  8. data/docs/GetTimestampResponse.md +36 -0
  9. data/docs/PurposeAddressRequest.md +18 -0
  10. data/docs/SupplyTrackingRequest.md +20 -0
  11. data/docs/TimestampApi.md +84 -16
  12. data/docs/TimestampType.md +15 -0
  13. data/docs/TokenApi.md +1 -1
  14. data/docs/TokenResponse.md +4 -4
  15. data/docs/TrackingApi.md +344 -0
  16. data/docs/TrackingDestination.md +20 -0
  17. data/docs/TrackingResponse.md +18 -0
  18. data/docs/TrackingSubject.md +20 -0
  19. data/docs/TrackingSubjectMerkleRoot.md +22 -0
  20. data/docs/TrackingTrace.md +40 -0
  21. data/docs/TrackingTracesResponse.md +44 -0
  22. data/docs/TransportTrackingRequest.md +18 -0
  23. data/docs/UserApi.md +1 -1
  24. data/git_push.sh +3 -4
  25. data/lib/tapyrus-api-client/api/address_api.rb +25 -11
  26. data/lib/tapyrus-api-client/api/timestamp_api.rb +85 -17
  27. data/lib/tapyrus-api-client/api/token_api.rb +15 -6
  28. data/lib/tapyrus-api-client/api/tracking_api.rb +348 -0
  29. data/lib/tapyrus-api-client/api/user_api.rb +7 -4
  30. data/lib/tapyrus-api-client/api_client.rb +6 -6
  31. data/lib/tapyrus-api-client/api_error.rb +3 -3
  32. data/lib/tapyrus-api-client/configuration.rb +23 -6
  33. data/lib/tapyrus-api-client/models/add_timestamp_request.rb +16 -7
  34. data/lib/tapyrus-api-client/models/add_timestamp_response.rb +299 -0
  35. data/lib/tapyrus-api-client/models/consume_tracking_request.rb +226 -0
  36. data/lib/tapyrus-api-client/models/create_user_request.rb +3 -3
  37. data/lib/tapyrus-api-client/models/get_addresses_response.rb +3 -3
  38. data/lib/tapyrus-api-client/models/get_timestamp_response.rb +337 -0
  39. data/lib/tapyrus-api-client/models/get_tokens_response.rb +3 -3
  40. data/lib/tapyrus-api-client/models/issue_token_request.rb +3 -3
  41. data/lib/tapyrus-api-client/models/purpose_address_request.rb +218 -0
  42. data/lib/tapyrus-api-client/models/reissue_token_request.rb +3 -3
  43. data/lib/tapyrus-api-client/models/supply_tracking_request.rb +241 -0
  44. data/lib/tapyrus-api-client/models/timestamp_type.rb +37 -0
  45. data/lib/tapyrus-api-client/models/token_response.rb +11 -10
  46. data/lib/tapyrus-api-client/models/{payment_request.rb → tracking_destination.rb} +15 -32
  47. data/lib/tapyrus-api-client/models/{payment_response.rb → tracking_response.rb} +12 -6
  48. data/lib/tapyrus-api-client/models/tracking_subject.rb +234 -0
  49. data/lib/tapyrus-api-client/models/tracking_subject_merkle_root.rb +238 -0
  50. data/lib/tapyrus-api-client/models/tracking_trace.rb +321 -0
  51. data/lib/tapyrus-api-client/models/tracking_traces_response.rb +343 -0
  52. data/lib/tapyrus-api-client/models/transfer_token_request.rb +3 -3
  53. data/lib/tapyrus-api-client/models/transport_tracking_request.rb +226 -0
  54. data/lib/tapyrus-api-client/models/userinfo_response.rb +3 -3
  55. data/lib/tapyrus-api-client/models/userinfo_response_balances.rb +3 -3
  56. data/lib/tapyrus-api-client/version.rb +4 -4
  57. data/lib/tapyrus-api-client.rb +17 -6
  58. data/spec/api/address_api_spec.rb +7 -5
  59. data/spec/api/timestamp_api_spec.rb +19 -7
  60. data/spec/api/token_api_spec.rb +3 -3
  61. data/spec/api/tracking_api_spec.rb +95 -0
  62. data/spec/api/user_api_spec.rb +3 -3
  63. data/spec/api_client_spec.rb +5 -5
  64. data/spec/configuration_spec.rb +6 -6
  65. data/spec/models/add_timestamp_request_spec.rb +9 -3
  66. data/spec/models/add_timestamp_response_spec.rb +88 -0
  67. data/spec/models/consume_tracking_request_spec.rb +34 -0
  68. data/spec/models/create_user_request_spec.rb +3 -3
  69. data/spec/models/get_addresses_response_spec.rb +3 -3
  70. data/spec/models/get_timestamp_response_spec.rb +92 -0
  71. data/spec/models/get_tokens_response_spec.rb +3 -3
  72. data/spec/models/issue_token_request_spec.rb +3 -3
  73. data/spec/models/purpose_address_request_spec.rb +34 -0
  74. data/spec/models/reissue_token_request_spec.rb +3 -3
  75. data/spec/models/supply_tracking_request_spec.rb +40 -0
  76. data/spec/models/timestamp_type_spec.rb +28 -0
  77. data/spec/models/token_response_spec.rb +4 -4
  78. data/spec/models/tracking_destination_spec.rb +40 -0
  79. data/spec/models/tracking_response_spec.rb +34 -0
  80. data/spec/models/tracking_subject_merkle_root_spec.rb +46 -0
  81. data/spec/models/tracking_subject_spec.rb +40 -0
  82. data/spec/models/tracking_trace_spec.rb +100 -0
  83. data/spec/models/tracking_traces_response_spec.rb +112 -0
  84. data/spec/models/transfer_token_request_spec.rb +3 -3
  85. data/spec/models/transport_tracking_request_spec.rb +34 -0
  86. data/spec/models/userinfo_response_balances_spec.rb +3 -3
  87. data/spec/models/userinfo_response_spec.rb +3 -3
  88. data/spec/spec_helper.rb +3 -3
  89. data/tapyrus-api-client.gemspec +4 -4
  90. metadata +67 -23
  91. data/docs/PaymentApi.md +0 -76
  92. data/docs/PaymentRequest.md +0 -22
  93. data/docs/PaymentResponse.md +0 -18
  94. data/lib/tapyrus-api-client/api/payment_api.rb +0 -83
  95. data/spec/api/payment_api_spec.rb +0 -47
  96. data/spec/models/payment_request_spec.rb +0 -46
  97. data/spec/models/payment_response_spec.rb +0 -34
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tapyrus-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: 1.1.0beta4
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-20 00:00:00.000000000 Z
11
+ date: 2022-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -62,67 +62,100 @@ files:
62
62
  - README.md
63
63
  - Rakefile
64
64
  - docs/AddTimestampRequest.md
65
+ - docs/AddTimestampResponse.md
65
66
  - docs/AddressApi.md
67
+ - docs/ConsumeTrackingRequest.md
66
68
  - docs/CreateUserRequest.md
67
69
  - docs/GetAddressesResponse.md
70
+ - docs/GetTimestampResponse.md
68
71
  - docs/GetTokensResponse.md
69
72
  - docs/IssueTokenRequest.md
70
- - docs/PaymentApi.md
71
- - docs/PaymentRequest.md
72
- - docs/PaymentResponse.md
73
+ - docs/PurposeAddressRequest.md
73
74
  - docs/ReissueTokenRequest.md
75
+ - docs/SupplyTrackingRequest.md
74
76
  - docs/TimestampApi.md
77
+ - docs/TimestampType.md
75
78
  - docs/TokenApi.md
76
79
  - docs/TokenResponse.md
80
+ - docs/TrackingApi.md
81
+ - docs/TrackingDestination.md
82
+ - docs/TrackingResponse.md
83
+ - docs/TrackingSubject.md
84
+ - docs/TrackingSubjectMerkleRoot.md
85
+ - docs/TrackingTrace.md
86
+ - docs/TrackingTracesResponse.md
77
87
  - docs/TransferTokenRequest.md
88
+ - docs/TransportTrackingRequest.md
78
89
  - docs/UserApi.md
79
90
  - docs/UserinfoResponse.md
80
91
  - docs/UserinfoResponseBalances.md
81
92
  - git_push.sh
82
93
  - lib/tapyrus-api-client.rb
83
94
  - lib/tapyrus-api-client/api/address_api.rb
84
- - lib/tapyrus-api-client/api/payment_api.rb
85
95
  - lib/tapyrus-api-client/api/timestamp_api.rb
86
96
  - lib/tapyrus-api-client/api/token_api.rb
97
+ - lib/tapyrus-api-client/api/tracking_api.rb
87
98
  - lib/tapyrus-api-client/api/user_api.rb
88
99
  - lib/tapyrus-api-client/api_client.rb
89
100
  - lib/tapyrus-api-client/api_error.rb
90
101
  - lib/tapyrus-api-client/configuration.rb
91
102
  - lib/tapyrus-api-client/models/add_timestamp_request.rb
103
+ - lib/tapyrus-api-client/models/add_timestamp_response.rb
104
+ - lib/tapyrus-api-client/models/consume_tracking_request.rb
92
105
  - lib/tapyrus-api-client/models/create_user_request.rb
93
106
  - lib/tapyrus-api-client/models/get_addresses_response.rb
107
+ - lib/tapyrus-api-client/models/get_timestamp_response.rb
94
108
  - lib/tapyrus-api-client/models/get_tokens_response.rb
95
109
  - lib/tapyrus-api-client/models/issue_token_request.rb
96
- - lib/tapyrus-api-client/models/payment_request.rb
97
- - lib/tapyrus-api-client/models/payment_response.rb
110
+ - lib/tapyrus-api-client/models/purpose_address_request.rb
98
111
  - lib/tapyrus-api-client/models/reissue_token_request.rb
112
+ - lib/tapyrus-api-client/models/supply_tracking_request.rb
113
+ - lib/tapyrus-api-client/models/timestamp_type.rb
99
114
  - lib/tapyrus-api-client/models/token_response.rb
115
+ - lib/tapyrus-api-client/models/tracking_destination.rb
116
+ - lib/tapyrus-api-client/models/tracking_response.rb
117
+ - lib/tapyrus-api-client/models/tracking_subject.rb
118
+ - lib/tapyrus-api-client/models/tracking_subject_merkle_root.rb
119
+ - lib/tapyrus-api-client/models/tracking_trace.rb
120
+ - lib/tapyrus-api-client/models/tracking_traces_response.rb
100
121
  - lib/tapyrus-api-client/models/transfer_token_request.rb
122
+ - lib/tapyrus-api-client/models/transport_tracking_request.rb
101
123
  - lib/tapyrus-api-client/models/userinfo_response.rb
102
124
  - lib/tapyrus-api-client/models/userinfo_response_balances.rb
103
125
  - lib/tapyrus-api-client/version.rb
104
126
  - spec/api/address_api_spec.rb
105
- - spec/api/payment_api_spec.rb
106
127
  - spec/api/timestamp_api_spec.rb
107
128
  - spec/api/token_api_spec.rb
129
+ - spec/api/tracking_api_spec.rb
108
130
  - spec/api/user_api_spec.rb
109
131
  - spec/api_client_spec.rb
110
132
  - spec/configuration_spec.rb
111
133
  - spec/models/add_timestamp_request_spec.rb
134
+ - spec/models/add_timestamp_response_spec.rb
135
+ - spec/models/consume_tracking_request_spec.rb
112
136
  - spec/models/create_user_request_spec.rb
113
137
  - spec/models/get_addresses_response_spec.rb
138
+ - spec/models/get_timestamp_response_spec.rb
114
139
  - spec/models/get_tokens_response_spec.rb
115
140
  - spec/models/issue_token_request_spec.rb
116
- - spec/models/payment_request_spec.rb
117
- - spec/models/payment_response_spec.rb
141
+ - spec/models/purpose_address_request_spec.rb
118
142
  - spec/models/reissue_token_request_spec.rb
143
+ - spec/models/supply_tracking_request_spec.rb
144
+ - spec/models/timestamp_type_spec.rb
119
145
  - spec/models/token_response_spec.rb
146
+ - spec/models/tracking_destination_spec.rb
147
+ - spec/models/tracking_response_spec.rb
148
+ - spec/models/tracking_subject_merkle_root_spec.rb
149
+ - spec/models/tracking_subject_spec.rb
150
+ - spec/models/tracking_trace_spec.rb
151
+ - spec/models/tracking_traces_response_spec.rb
120
152
  - spec/models/transfer_token_request_spec.rb
153
+ - spec/models/transport_tracking_request_spec.rb
121
154
  - spec/models/userinfo_response_balances_spec.rb
122
155
  - spec/models/userinfo_response_spec.rb
123
156
  - spec/spec_helper.rb
124
157
  - tapyrus-api-client.gemspec
125
- homepage: https://openapi-generator.tech
158
+ homepage: https://github.com/chaintope/tapyrus-api-client-examples
126
159
  licenses:
127
160
  - Unlicense
128
161
  metadata: {}
@@ -137,32 +170,43 @@ required_ruby_version: !ruby/object:Gem::Requirement
137
170
  version: '2.4'
138
171
  required_rubygems_version: !ruby/object:Gem::Requirement
139
172
  requirements:
140
- - - ">="
173
+ - - ">"
141
174
  - !ruby/object:Gem::Version
142
- version: '0'
175
+ version: 1.3.1
143
176
  requirements: []
144
177
  rubygems_version: 3.0.3.1
145
178
  signing_key:
146
179
  specification_version: 4
147
180
  summary: Tapyrus API Ruby Gem
148
181
  test_files:
149
- - spec/api/user_api_spec.rb
150
182
  - spec/api/token_api_spec.rb
151
183
  - spec/api/address_api_spec.rb
152
184
  - spec/api/timestamp_api_spec.rb
153
- - spec/api/payment_api_spec.rb
185
+ - spec/api/user_api_spec.rb
186
+ - spec/api/tracking_api_spec.rb
154
187
  - spec/api_client_spec.rb
155
188
  - spec/configuration_spec.rb
156
- - spec/models/userinfo_response_balances_spec.rb
157
- - spec/models/issue_token_request_spec.rb
189
+ - spec/models/tracking_traces_response_spec.rb
158
190
  - spec/models/transfer_token_request_spec.rb
159
- - spec/models/reissue_token_request_spec.rb
191
+ - spec/models/supply_tracking_request_spec.rb
192
+ - spec/models/transport_tracking_request_spec.rb
160
193
  - spec/models/token_response_spec.rb
161
- - spec/models/create_user_request_spec.rb
194
+ - spec/models/add_timestamp_request_spec.rb
195
+ - spec/models/timestamp_type_spec.rb
162
196
  - spec/models/get_addresses_response_spec.rb
163
- - spec/models/payment_response_spec.rb
164
- - spec/models/payment_request_spec.rb
197
+ - spec/models/consume_tracking_request_spec.rb
198
+ - spec/models/userinfo_response_balances_spec.rb
199
+ - spec/models/issue_token_request_spec.rb
200
+ - spec/models/tracking_destination_spec.rb
201
+ - spec/models/tracking_trace_spec.rb
202
+ - spec/models/add_timestamp_response_spec.rb
203
+ - spec/models/purpose_address_request_spec.rb
204
+ - spec/models/reissue_token_request_spec.rb
165
205
  - spec/models/userinfo_response_spec.rb
206
+ - spec/models/tracking_subject_spec.rb
207
+ - spec/models/tracking_response_spec.rb
208
+ - spec/models/get_timestamp_response_spec.rb
209
+ - spec/models/create_user_request_spec.rb
166
210
  - spec/models/get_tokens_response_spec.rb
167
- - spec/models/add_timestamp_request_spec.rb
211
+ - spec/models/tracking_subject_merkle_root_spec.rb
168
212
  - spec/spec_helper.rb
data/docs/PaymentApi.md DELETED
@@ -1,76 +0,0 @@
1
- # TapyrusApiClient::PaymentApi
2
-
3
- All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**transfer**](PaymentApi.md#transfer) | **POST** /payment | 資金の送金 |
8
-
9
-
10
- ## transfer
11
-
12
- > <PaymentResponse> transfer(opts)
13
-
14
- 資金の送金
15
-
16
- 指定したアドレスに任意のtapyrusを送金します。
17
-
18
- ### Examples
19
-
20
- ```ruby
21
- require 'time'
22
- require 'tapyrus-api-client'
23
- # setup authorization
24
- TapyrusApiClient.configure do |config|end
25
-
26
- api_instance = TapyrusApiClient::PaymentApi.new
27
- opts = {
28
- payment_request: TapyrusApiClient::PaymentRequest.new({address: '1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a', amount: 10000000}) # PaymentRequest | `address`, `amount`を受け取り、アドレスに対して指定した額の資金(tapyrus)を送金します。 任意で`fee`を設定し、送金手数料を指定できます。
29
- }
30
-
31
- begin
32
- # 資金の送金
33
- result = api_instance.transfer(opts)
34
- p result
35
- rescue TapyrusApiClient::ApiError => e
36
- puts "Error when calling PaymentApi->transfer: #{e}"
37
- end
38
- ```
39
-
40
- #### Using the transfer_with_http_info variant
41
-
42
- This returns an Array which contains the response data, status code and headers.
43
-
44
- > <Array(<PaymentResponse>, Integer, Hash)> transfer_with_http_info(opts)
45
-
46
- ```ruby
47
- begin
48
- # 資金の送金
49
- data, status_code, headers = api_instance.transfer_with_http_info(opts)
50
- p status_code # => 2xx
51
- p headers # => { ... }
52
- p data # => <PaymentResponse>
53
- rescue TapyrusApiClient::ApiError => e
54
- puts "Error when calling PaymentApi->transfer_with_http_info: #{e}"
55
- end
56
- ```
57
-
58
- ### Parameters
59
-
60
- | Name | Type | Description | Notes |
61
- | ---- | ---- | ----------- | ----- |
62
- | **payment_request** | [**PaymentRequest**](PaymentRequest.md) | &#x60;address&#x60;, &#x60;amount&#x60;を受け取り、アドレスに対して指定した額の資金(tapyrus)を送金します。 任意で&#x60;fee&#x60;を設定し、送金手数料を指定できます。 | [optional] |
63
-
64
- ### Return type
65
-
66
- [**PaymentResponse**](PaymentResponse.md)
67
-
68
- ### Authorization
69
-
70
- No authorization required
71
-
72
- ### HTTP request headers
73
-
74
- - **Content-Type**: application/json
75
- - **Accept**: application/json
76
-
@@ -1,22 +0,0 @@
1
- # TapyrusApiClient::PaymentRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **address** | **String** | | |
8
- | **amount** | **Integer** | | |
9
- | **fee** | **Integer** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'tapyrus-api-client'
15
-
16
- instance = TapyrusApiClient::PaymentRequest.new(
17
- address: 1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a,
18
- amount: 10000000,
19
- fee: 100000
20
- )
21
- ```
22
-
@@ -1,18 +0,0 @@
1
- # TapyrusApiClient::PaymentResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **txid** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'tapyrus-api-client'
13
-
14
- instance = TapyrusApiClient::PaymentResponse.new(
15
- txid: 76077052e323a8445c398b690ed8b4b49c9b6e4d1e8e19ea0e7de7cead6f5fc8
16
- )
17
- ```
18
-
@@ -1,83 +0,0 @@
1
- =begin
2
- #Tapyrus API
3
-
4
- ## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 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 のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
5
-
6
- The version of the OpenAPI document: 1.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.1-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'cgi'
14
-
15
- module TapyrusApiClient
16
- class PaymentApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # 資金の送金
23
- # 指定したアドレスに任意のtapyrusを送金します。
24
- # @param [Hash] opts the optional parameters
25
- # @option opts [PaymentRequest] :payment_request &#x60;address&#x60;, &#x60;amount&#x60;を受け取り、アドレスに対して指定した額の資金(tapyrus)を送金します。 任意で&#x60;fee&#x60;を設定し、送金手数料を指定できます。
26
- # @return [PaymentResponse]
27
- def transfer(opts = {})
28
- data, _status_code, _headers = transfer_with_http_info(opts)
29
- data
30
- end
31
-
32
- # 資金の送金
33
- # 指定したアドレスに任意のtapyrusを送金します。
34
- # @param [Hash] opts the optional parameters
35
- # @option opts [PaymentRequest] :payment_request &#x60;address&#x60;, &#x60;amount&#x60;を受け取り、アドレスに対して指定した額の資金(tapyrus)を送金します。 任意で&#x60;fee&#x60;を設定し、送金手数料を指定できます。
36
- # @return [Array<(PaymentResponse, Integer, Hash)>] PaymentResponse data, response status code and response headers
37
- def transfer_with_http_info(opts = {})
38
- if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: PaymentApi.transfer ...'
40
- end
41
- # resource path
42
- local_var_path = '/payment'
43
-
44
- # query parameters
45
- query_params = opts[:query_params] || {}
46
-
47
- # header parameters
48
- header_params = opts[:header_params] || {}
49
- # HTTP header 'Accept' (if needed)
50
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
51
- # HTTP header 'Content-Type'
52
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
53
-
54
- # form parameters
55
- form_params = opts[:form_params] || {}
56
-
57
- # http body (model)
58
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'payment_request'])
59
-
60
- # return_type
61
- return_type = opts[:debug_return_type] || 'PaymentResponse'
62
-
63
- # auth_names
64
- auth_names = opts[:debug_auth_names] || []
65
-
66
- new_options = opts.merge(
67
- :operation => :"PaymentApi.transfer",
68
- :header_params => header_params,
69
- :query_params => query_params,
70
- :form_params => form_params,
71
- :body => post_body,
72
- :auth_names => auth_names,
73
- :return_type => return_type
74
- )
75
-
76
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
77
- if @api_client.config.debugging
78
- @api_client.config.logger.debug "API called: PaymentApi#transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
- end
80
- return data, status_code, headers
81
- end
82
- end
83
- end
@@ -1,47 +0,0 @@
1
- =begin
2
- #Tapyrus API
3
-
4
- ## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 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 のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
5
-
6
- The version of the OpenAPI document: 1.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.1-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for TapyrusApiClient::PaymentApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'PaymentApi' do
20
- before do
21
- # run before each test
22
- @api_instance = TapyrusApiClient::PaymentApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of PaymentApi' do
30
- it 'should create an instance of PaymentApi' do
31
- expect(@api_instance).to be_instance_of(TapyrusApiClient::PaymentApi)
32
- end
33
- end
34
-
35
- # unit tests for transfer
36
- # 資金の送金
37
- # 指定したアドレスに任意のtapyrusを送金します。
38
- # @param [Hash] opts the optional parameters
39
- # @option opts [PaymentRequest] :payment_request &#x60;address&#x60;, &#x60;amount&#x60;を受け取り、アドレスに対して指定した額の資金(tapyrus)を送金します。 任意で&#x60;fee&#x60;を設定し、送金手数料を指定できます。
40
- # @return [PaymentResponse]
41
- describe 'transfer test' do
42
- it 'should work' do
43
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
- end
45
- end
46
-
47
- end
@@ -1,46 +0,0 @@
1
- =begin
2
- #Tapyrus API
3
-
4
- ## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 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 のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
5
-
6
- The version of the OpenAPI document: 1.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.1-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for TapyrusApiClient::PaymentRequest
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe TapyrusApiClient::PaymentRequest do
21
- let(:instance) { TapyrusApiClient::PaymentRequest.new }
22
-
23
- describe 'test an instance of PaymentRequest' do
24
- it 'should create an instance of PaymentRequest' do
25
- expect(instance).to be_instance_of(TapyrusApiClient::PaymentRequest)
26
- end
27
- end
28
- describe 'test attribute "address"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "amount"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "fee"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- end
@@ -1,34 +0,0 @@
1
- =begin
2
- #Tapyrus API
3
-
4
- ## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 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 のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
5
-
6
- The version of the OpenAPI document: 1.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.1-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for TapyrusApiClient::PaymentResponse
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe TapyrusApiClient::PaymentResponse do
21
- let(:instance) { TapyrusApiClient::PaymentResponse.new }
22
-
23
- describe 'test an instance of PaymentResponse' do
24
- it 'should create an instance of PaymentResponse' do
25
- expect(instance).to be_instance_of(TapyrusApiClient::PaymentResponse)
26
- end
27
- end
28
- describe 'test attribute "txid"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- end