Class: Coinbase::Client::ValidatorsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ValidatorsApi

Returns a new instance of ValidatorsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_validator(network_id, asset_id, validator_id, opts = {}) ⇒ Validator

Get a validator belonging to the CDP project Get a validator belonging to the user for a given network, asset and id.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The symbol of the asset to get the validator for.

  • validator_id (String) —

    The unique id of the validator to fetch details for.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/coinbase/client/api/validators_api.rb', line 29

def get_validator(network_id, asset_id, validator_id, opts = {})
  data, _status_code, _headers = get_validator_with_http_info(network_id, asset_id, validator_id, opts)
  data
end

#get_validator_with_http_info(network_id, asset_id, validator_id, opts = {}) ⇒ Array<(Validator, Integer, Hash)>

Get a validator belonging to the CDP project Get a validator belonging to the user for a given network, asset and id.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The symbol of the asset to get the validator for.

  • validator_id (String) —

    The unique id of the validator to fetch details for.

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

    the optional parameters

Returns:

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

    Validator data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/coinbase/client/api/validators_api.rb', line 41

def get_validator_with_http_info(network_id, asset_id, validator_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ValidatorsApi.get_validator ...'
  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 ValidatorsApi.get_validator"
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling ValidatorsApi.get_validator"
  end
  # verify the required parameter 'validator_id' is set
  if @api_client.config.client_side_validation && validator_id.nil?
    fail ArgumentError, "Missing the required parameter 'validator_id' when calling ValidatorsApi.get_validator"
  end
  # resource path
  local_var_path = '/v1/networks/{network_id}/assets/{asset_id}/validators/{validator_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'validator_id' + '}', CGI.escape(validator_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']) 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] || 'Validator'

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

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

#list_validators(network_id, asset_id, opts = {}) ⇒ ValidatorList

List validators belonging to the CDP project List validators belonging to the user for a given network and asset.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The symbol of the asset to get the validators for.

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

    the optional parameters

Options Hash (opts):

  • :status (ValidatorStatus) —

    A filter to list validators based on a status.

  • :limit (Integer) —

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

  • :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:



106
107
108
109
 
# File 'lib/coinbase/client/api/validators_api.rb', line 106

def list_validators(network_id, asset_id, opts = {})
  data, _status_code, _headers = list_validators_with_http_info(network_id, asset_id, opts)
  data
end

#list_validators_with_http_info(network_id, asset_id, opts = {}) ⇒ Array<(ValidatorList, Integer, Hash)>

List validators belonging to the CDP project List validators belonging to the user for a given network and asset.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The symbol of the asset to get the validators for.

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

    the optional parameters

Options Hash (opts):

  • :status (ValidatorStatus) —

    A filter to list validators based on a status.

  • :limit (Integer) —

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

  • :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<(ValidatorList, Integer, Hash)>) —

    ValidatorList data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/coinbase/client/api/validators_api.rb', line 120

def list_validators_with_http_info(network_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ValidatorsApi.list_validators ...'
  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 ValidatorsApi.list_validators"
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling ValidatorsApi.list_validators"
  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 ValidatorsApi.list_validators, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/assets/{asset_id}/validators'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'ValidatorList'

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

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