Class: Coinbase::Client::TransfersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransfersApi

Returns a new instance of TransfersApi.



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

def api_client
  @api_client
end

Instance Method Details

#broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {}) ⇒ Transfer

Broadcast a transfer Broadcast a transfer

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to broadcast

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 30

def broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {})
  data, _status_code, _headers = broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts)
  data
end

#broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Broadcast a transfer Broadcast a transfer

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to broadcast

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



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
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 43

def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransfersApi.broadcast_transfer ...'
  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 TransfersApi.broadcast_transfer"
  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 TransfersApi.broadcast_transfer"
  end
  # verify the required parameter 'transfer_id' is set
  if @api_client.config.client_side_validation && transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_id' when calling TransfersApi.broadcast_transfer"
  end
  # verify the required parameter 'broadcast_external_transfer_request' is set
  if @api_client.config.client_side_validation && broadcast_external_transfer_request.nil?
    fail ArgumentError, "Missing the required parameter 'broadcast_external_transfer_request' when calling TransfersApi.broadcast_transfer"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/transfers/{transfer_id}/broadcast'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'transfer_id' + '}', CGI.escape(transfer_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']
  # 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(broadcast_external_transfer_request)

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

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

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

#create_transfer(wallet_id, address_id, create_transfer_request, opts = {}) ⇒ Transfer

Create a new transfer for an address Create a new transfer

Parameters:

  • wallet_id (String) —

    The ID of the wallet the source address belongs to

  • address_id (String) —

    The ID of the address to transfer from

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

    the optional parameters

Returns:



115
116
117
118
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 115

def create_transfer(wallet_id, address_id, create_transfer_request, opts = {})
  data, _status_code, _headers = create_transfer_with_http_info(wallet_id, address_id, create_transfer_request, opts)
  data
end

#create_transfer_with_http_info(wallet_id, address_id, create_transfer_request, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Create a new transfer for an address Create a new transfer

Parameters:

  • wallet_id (String) —

    The ID of the wallet the source address belongs to

  • address_id (String) —

    The ID of the address to transfer from

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



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
178
179
180
181
182
183
184
185
186
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 127

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

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

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

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

#get_transfer(wallet_id, address_id, transfer_id, opts = {}) ⇒ Transfer

Get a transfer by ID Get a transfer by ID

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to fetch

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

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 195

def get_transfer(wallet_id, address_id, transfer_id, opts = {})
  data, _status_code, _headers = get_transfer_with_http_info(wallet_id, address_id, transfer_id, opts)
  data
end

#get_transfer_with_http_info(wallet_id, address_id, transfer_id, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Get a transfer by ID Get a transfer by ID

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to fetch

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 207

def get_transfer_with_http_info(wallet_id, address_id, transfer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransfersApi.get_transfer ...'
  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 TransfersApi.get_transfer"
  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 TransfersApi.get_transfer"
  end
  # verify the required parameter 'transfer_id' is set
  if @api_client.config.client_side_validation && transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_id' when calling TransfersApi.get_transfer"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/transfers/{transfer_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'transfer_id' + '}', CGI.escape(transfer_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] || 'Transfer'

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

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

#list_transfers(wallet_id, address_id, opts = {}) ⇒ TransferList

List transfers for an address. List transfers for an address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address to list transfers for

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



271
272
273
274
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 271

def list_transfers(wallet_id, address_id, opts = {})
  data, _status_code, _headers = list_transfers_with_http_info(wallet_id, address_id, opts)
  data
end

#list_transfers_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(TransferList, Integer, Hash)>

List transfers for an address. List transfers for an address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to

  • address_id (String) —

    The ID of the address to list transfers for

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

    TransferList data, response status code and response headers



284
285
286
287
288
289
290
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
 
# File 'lib/coinbase/client/api/transfers_api.rb', line 284

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

  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/transfers'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))

  # 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] || 'TransferList'

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

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