class TapyrusApiClient::TokenApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/tapyrus-api-client/api/token_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

burn_token(token_id, opts = {}) click to toggle source

トークンの焼却 任意の数のトークンを焼却します。 @param token_id [String] トークンの識別子。 @param [Hash] opts the optional parameters @option opts [Integer] :amount `amount`を受け取り、指定した量のトークンを焼却します。 `amount`が未入力の場合全てのトークンを焼却します。 @return [nil]

# 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 = {}) click to toggle source

トークンの焼却 任意の数のトークンを焼却します。 @param token_id [String] トークンの識別子。 @param [Hash] opts the optional parameters @option opts [Integer] :amount &#x60;amount&#x60;を受け取り、指定した量のトークンを焼却します。 &#x60;amount&#x60;が未入力の場合全てのトークンを焼却します。 @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

トークンの総量取得 所有するトークンの総量を取得し、トークン識別子(`token_id`)ごとに総量(`amount`)を一覧で表示します。 @param [Hash] opts the optional parameters @option opts [Boolean] :confirmation_only オプションで&#x60;confirmation_only&#x60;を設定でき、&#x60;true&#x60;の場合ブロックチェーン上で承認済みのトークンのみを取得し、&#x60;false&#x60;の場合未承認のトークンも含めて取得します。デフォルトは&#x60;true&#x60;です。 @return [Array<GetTokensResponse>]

# 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 = {}) click to toggle source

トークンの総量取得 所有するトークンの総量を取得し、トークン識別子(&#x60;token_id&#x60;)ごとに総量(&#x60;amount&#x60;)を一覧で表示します。 @param [Hash] opts the optional parameters @option opts [Boolean] :confirmation_only オプションで&#x60;confirmation_only&#x60;を設定でき、&#x60;true&#x60;の場合ブロックチェーン上で承認済みのトークンのみを取得し、&#x60;false&#x60;の場合未承認のトークンも含めて取得します。デフォルトは&#x60;true&#x60;です。 @return [Array<(Array<GetTokensResponse>, Integer, Hash)>] Array<GetTokensResponse> data, response status code and response headers

# 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 = {}) click to toggle source

トークンの新規発行 任意の数のトークンを新規発行します。 @param [Hash] opts the optional parameters @option opts [IssueTokenRequest] :issue_token_request &#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;を指定することで、指定したトークン識別子のトークンを再発行します。 @return [TokenResponse]

# 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 = {}) click to toggle source

トークンの新規発行 任意の数のトークンを新規発行します。 @param [Hash] opts the optional parameters @option opts [IssueTokenRequest] :issue_token_request &#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;を指定することで、指定したトークン識別子のトークンを再発行します。 @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers

# 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 = {}) click to toggle source

トークンの再発行 指定した識別子を持つ再発行可能なトークンを任意の量再発行します。 @param token_id [String] トークンの識別子。 @param [Hash] opts the optional parameters @option opts [ReissueTokenRequest] :reissue_token_request @return [TokenResponse]

# 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 = {}) click to toggle source

トークンの再発行 指定した識別子を持つ再発行可能なトークンを任意の量再発行します。 @param token_id [String] トークンの識別子。 @param [Hash] opts the optional parameters @option opts [ReissueTokenRequest] :reissue_token_request @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers

# 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 = {}) click to toggle source

トークンの送付 任意の数のトークンを指定したアドレスに対して送付します。 @param token_id [String] トークンの識別子。 @param transfer_token_request [TransferTokenRequest] &#x60;address&#x60;でトークンを送付する相手のアドレスを指定し、&#x60;amount&#x60;で送付するトークンの量を指定します。 @param [Hash] opts the optional parameters @return [TokenResponse]

# 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 = {}) click to toggle source

トークンの送付 任意の数のトークンを指定したアドレスに対して送付します。 @param token_id [String] トークンの識別子。 @param transfer_token_request [TransferTokenRequest] &#x60;address&#x60;でトークンを送付する相手のアドレスを指定し、&#x60;amount&#x60;で送付するトークンの量を指定します。 @param [Hash] opts the optional parameters @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers

# 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