Class: Coinbase::Client::WalletsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WalletsApi

Returns a new instance of WalletsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_wallet(opts = {}) ⇒ Wallet

Create a new wallet Create a new wallet scoped to the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 27

def create_wallet(opts = {})
  data, _status_code, _headers = create_wallet_with_http_info(opts)
  data
end

#create_wallet_with_http_info(opts = {}) ⇒ Array<(Wallet, Integer, Hash)>

Create a new wallet Create a new wallet scoped to the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Wallet data, response status code and response headers



37
38
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/coinbase/client/api/wallets_api.rb', line 37

def create_wallet_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletsApi.create_wallet ...'
  end
  # resource path
  local_var_path = '/v1/wallets'

  # 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']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#get_wallet(wallet_id, opts = {}) ⇒ Wallet

Get wallet by ID Get wallet

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 91

def get_wallet(wallet_id, opts = {})
  data, _status_code, _headers = get_wallet_with_http_info(wallet_id, opts)
  data
end

#get_wallet_balance(wallet_id, asset_id, opts = {}) ⇒ Balance

Get the balance of an asset in the wallet Get the aggregated balance of an asset across all of the addresses in the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balance for

  • asset_id (String) —

    The symbol of the asset to fetch the balance for

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 155

def get_wallet_balance(wallet_id, asset_id, opts = {})
  data, _status_code, _headers = get_wallet_balance_with_http_info(wallet_id, asset_id, opts)
  data
end

#get_wallet_balance_with_http_info(wallet_id, asset_id, opts = {}) ⇒ Array<(Balance, Integer, Hash)>

Get the balance of an asset in the wallet Get the aggregated balance of an asset across all of the addresses in the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balance for

  • asset_id (String) —

    The symbol of the asset to fetch the balance for

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

    the optional parameters

Returns:

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

    Balance data, response status code and response headers



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
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 166

def get_wallet_balance_with_http_info(wallet_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletsApi.get_wallet_balance ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling WalletsApi.get_wallet_balance"
  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 WalletsApi.get_wallet_balance"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/balances/{asset_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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] || 'Balance'

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

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

#get_wallet_with_http_info(wallet_id, opts = {}) ⇒ Array<(Wallet, Integer, Hash)>

Get wallet by ID Get wallet

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch

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

    the optional parameters

Returns:

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

    Wallet 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
145
146
147
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 101

def get_wallet_with_http_info(wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletsApi.get_wallet ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling WalletsApi.get_wallet"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_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] || 'Wallet'

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

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

#list_wallet_balances(wallet_id, opts = {}) ⇒ AddressBalanceList

List wallet balances List the balances of all of the addresses in the wallet aggregated by asset.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balances for

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

    the optional parameters

Returns:



223
224
225
226
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 223

def list_wallet_balances(wallet_id, opts = {})
  data, _status_code, _headers = list_wallet_balances_with_http_info(wallet_id, opts)
  data
end

#list_wallet_balances_with_http_info(wallet_id, opts = {}) ⇒ Array<(AddressBalanceList, Integer, Hash)>

List wallet balances List the balances of all of the addresses in the wallet aggregated by asset.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balances for

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

    the optional parameters

Returns:

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

    AddressBalanceList data, response status code and response headers



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
273
274
275
276
277
278
279
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 233

def list_wallet_balances_with_http_info(wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletsApi.list_wallet_balances ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling WalletsApi.list_wallet_balances"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/balances'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_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] || 'AddressBalanceList'

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

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

#list_wallets(opts = {}) ⇒ WalletList

List wallets List wallets belonging to the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

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



287
288
289
290
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 287

def list_wallets(opts = {})
  data, _status_code, _headers = list_wallets_with_http_info(opts)
  data
end

#list_wallets_with_http_info(opts = {}) ⇒ Array<(WalletList, Integer, Hash)>

List wallets List wallets belonging to the user.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    WalletList data, response status code and response headers



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
344
345
346
 
# File 'lib/coinbase/client/api/wallets_api.rb', line 298

def list_wallets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletsApi.list_wallets ...'
  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 WalletsApi.list_wallets, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/wallets'

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'WalletList'

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

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