Class: Coinbase::Client::OnchainIdentityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/api/onchain_identity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OnchainIdentityApi

Returns a new instance of OnchainIdentityApi.



19
20
21
 
# File 'lib/coinbase/client/api/onchain_identity_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/coinbase/client/api/onchain_identity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#resolve_identity_by_address(network_id, address_id, opts = {}) ⇒ OnchainNameList

Obtains onchain identity for an address on a specific network Obtains onchain identity for an address on a specific network

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the identity for

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

    the optional parameters

Options Hash (opts):

  • :roles (Array<String>) —

    A filter by role of the names related to this address (managed or owned)

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



31
32
33
34
 
# File 'lib/coinbase/client/api/onchain_identity_api.rb', line 31

def resolve_identity_by_address(network_id, address_id, opts = {})
  data, _status_code, _headers = resolve_identity_by_address_with_http_info(network_id, address_id, opts)
  data
end

#resolve_identity_by_address_with_http_info(network_id, address_id, opts = {}) ⇒ Array<(OnchainNameList, Integer, Hash)>

Obtains onchain identity for an address on a specific network Obtains onchain identity for an address on a specific network

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the identity for

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

    the optional parameters

Options Hash (opts):

  • :roles (Array<String>) —

    A filter by role of the names related to this address (managed or owned)

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:

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

    OnchainNameList data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/coinbase/client/api/onchain_identity_api.rb', line 45

def resolve_identity_by_address_with_http_info(network_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnchainIdentityApi.resolve_identity_by_address ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling OnchainIdentityApi.resolve_identity_by_address"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling OnchainIdentityApi.resolve_identity_by_address"
  end
  allowable_values = ["managed", "owned", "unknown_default_open_api"]
  if @api_client.config.client_side_validation && opts[:'roles'] && !opts[:'roles'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"roles\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling OnchainIdentityApi.resolve_identity_by_address, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/identity'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'roles'] = @api_client.build_collection_param(opts[:'roles'], :csv) if !opts[:'roles'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'session']

  new_options = opts.merge(
    :operation => :"OnchainIdentityApi.resolve_identity_by_address",
    :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: OnchainIdentityApi#resolve_identity_by_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end