Class: TapyrusApiClient::TokenApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tapyrus-api-client/api/token_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TokenApi

Returns a new instance of TokenApi.



19
20
21
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#burn_token(token_id, opts = {}) ⇒ nil

トークンの焼却任意の数のトークンを焼却します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :amount (Integer) —

    `amount`を受け取り、指定した量のトークンを焼却します。 `amount`が未入力の場合全てのトークンを焼却します。

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 28

def burn_token(token_id, opts = {})
  burn_token_with_http_info(token_id, opts)
  nil
end

#burn_token_with_http_info(token_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

トークンの焼却任意の数のトークンを焼却します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :amount (Integer) —

    &#x60;amount&#x60;を受け取り、指定した量のトークンを焼却します。 &#x60;amount&#x60;が未入力の場合全てのトークンを焼却します。

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 39

def burn_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokenApi.burn_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling TokenApi.burn_token"
  end
  # resource path
  local_var_path = '/tokens/{token_id}/burn'.sub('{' + 'token_id' + '}', CGI.escape(token_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TokenApi.burn_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenApi#burn_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tokens(opts = {}) ⇒ Array<GetTokensResponse>

トークンの総量取得所有するトークンの総量を取得し、トークン識別子(‘token_id`)ごとに総量(`amount`)を一覧で表示します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :confirmation_only (Boolean) —

    オプションで&#x60;confirmation_only&#x60;を設定でき、&#x60;true&#x60;の場合ブロックチェーン上で承認済みのトークンのみを取得し、&#x60;false&#x60;の場合未承認のトークンも含めて取得します。デフォルトは&#x60;true&#x60;です。

Returns:



91
92
93
94
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 91

def get_tokens(opts = {})
  data, _status_code, _headers = get_tokens_with_http_info(opts)
  data
end

#get_tokens_with_http_info(opts = {}) ⇒ Array<(Array<GetTokensResponse>, Integer, Hash)>

トークンの総量取得所有するトークンの総量を取得し、トークン識別子(&#x60;token_id&#x60;)ごとに総量(&#x60;amount&#x60;)を一覧で表示します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :confirmation_only (Boolean) —

    オプションで&#x60;confirmation_only&#x60;を設定でき、&#x60;true&#x60;の場合ブロックチェーン上で承認済みのトークンのみを取得し、&#x60;false&#x60;の場合未承認のトークンも含めて取得します。デフォルトは&#x60;true&#x60;です。

Returns:

  • (Array<(Array<GetTokensResponse>, Integer, Hash)>) —

    Array<GetTokensResponse> data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 101

def get_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokenApi.get_tokens ...'
  end
  # resource path
  local_var_path = '/tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'confirmation_only'] = opts[:'confirmation_only'] if !opts[:'confirmation_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetTokensResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TokenApi.get_tokens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenApi#get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_token(opts = {}) ⇒ TokenResponse

トークンの新規発行任意の数のトークンを新規発行します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :issue_token_request (IssueTokenRequest) —

    &#x60;amount&#x60;を受け取り指定した数のトークンを新規発行します。 任意で&#x60;token_type&#x60;を設定し、トークンの種類を指定できます。 &#x60;token_type&#x60;が未指定な場合、再発行可能なトークンが発行されます。 トークンの種類は以下の通りです。 - 1: 再発行可能なトークン - 2: 再発行不可能なトークン - 3: NFT また、&#x60;token_type&#x60;が未指定または&#x60;1&#x60;の場合、任意でトークン識別子&#x60;id&#x60;を指定することで、指定したトークン識別子のトークンを再発行します。

Returns:



151
152
153
154
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 151

def issue_token(opts = {})
  data, _status_code, _headers = issue_token_with_http_info(opts)
  data
end

#issue_token_with_http_info(opts = {}) ⇒ Array<(TokenResponse, Integer, Hash)>

トークンの新規発行任意の数のトークンを新規発行します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :issue_token_request (IssueTokenRequest) —

    &#x60;amount&#x60;を受け取り指定した数のトークンを新規発行します。 任意で&#x60;token_type&#x60;を設定し、トークンの種類を指定できます。 &#x60;token_type&#x60;が未指定な場合、再発行可能なトークンが発行されます。 トークンの種類は以下の通りです。 - 1: 再発行可能なトークン - 2: 再発行不可能なトークン - 3: NFT また、&#x60;token_type&#x60;が未指定または&#x60;1&#x60;の場合、任意でトークン識別子&#x60;id&#x60;を指定することで、指定したトークン識別子のトークンを再発行します。

Returns:

  • (Array<(TokenResponse, Integer, Hash)>) —

    TokenResponse data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 161

def issue_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokenApi.issue_token ...'
  end
  # resource path
  local_var_path = '/tokens/issue'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'issue_token_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'TokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TokenApi.issue_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenApi#issue_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reissue_token(token_id, opts = {}) ⇒ TokenResponse

トークンの再発行指定した識別子を持つ再発行可能なトークンを任意の量再発行します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



213
214
215
216
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 213

def reissue_token(token_id, opts = {})
  data, _status_code, _headers = reissue_token_with_http_info(token_id, opts)
  data
end

#reissue_token_with_http_info(token_id, opts = {}) ⇒ Array<(TokenResponse, Integer, Hash)>

トークンの再発行指定した識別子を持つ再発行可能なトークンを任意の量再発行します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TokenResponse, Integer, Hash)>) —

    TokenResponse data, response status code and response headers



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 224

def reissue_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokenApi.reissue_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling TokenApi.reissue_token"
  end
  # resource path
  local_var_path = '/tokens/{token_id}/reissue'.sub('{' + 'token_id' + '}', CGI.escape(token_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'reissue_token_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'TokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TokenApi.reissue_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenApi#reissue_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_token(token_id, transfer_token_request, opts = {}) ⇒ TokenResponse

トークンの送付任意の数のトークンを指定したアドレスに対して送付します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • transfer_token_request (TransferTokenRequest) —

    &#x60;address&#x60;でトークンを送付する相手のアドレスを指定し、&#x60;amount&#x60;で送付するトークンの量を指定します。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 280

def transfer_token(token_id, transfer_token_request, opts = {})
  data, _status_code, _headers = transfer_token_with_http_info(token_id, transfer_token_request, opts)
  data
end

#transfer_token_with_http_info(token_id, transfer_token_request, opts = {}) ⇒ Array<(TokenResponse, Integer, Hash)>

トークンの送付任意の数のトークンを指定したアドレスに対して送付します。

Parameters:

  • token_id (String) —

    トークンの識別子。

  • transfer_token_request (TransferTokenRequest) —

    &#x60;address&#x60;でトークンを送付する相手のアドレスを指定し、&#x60;amount&#x60;で送付するトークンの量を指定します。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TokenResponse, Integer, Hash)>) —

    TokenResponse data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/tapyrus-api-client/api/token_api.rb', line 291

def transfer_token_with_http_info(token_id, transfer_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokenApi.transfer_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling TokenApi.transfer_token"
  end
  # verify the required parameter 'transfer_token_request' is set
  if @api_client.config.client_side_validation && transfer_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_token_request' when calling TokenApi.transfer_token"
  end
  # resource path
  local_var_path = '/tokens/{token_id}/transfer'.sub('{' + 'token_id' + '}', CGI.escape(token_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_token_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TokenApi.transfer_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenApi#transfer_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end