Class: Coinbase::Client::ServerSignersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServerSignersApi

Returns a new instance of ServerSignersApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_server_signer(opts = {}) ⇒ ServerSigner

Create a new Server-Signer Create a new Server-Signer

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def create_server_signer(opts = {})
  data, _status_code, _headers = create_server_signer_with_http_info(opts)
  data
end

#create_server_signer_with_http_info(opts = {}) ⇒ Array<(ServerSigner, Integer, Hash)>

Create a new Server-Signer Create a new Server-Signer

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ServerSigner 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/server_signers_api.rb', line 37

def create_server_signer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServerSignersApi.create_server_signer ...'
  end
  # resource path
  local_var_path = '/v1/server_signers'

  # 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_server_signer_request'])

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

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

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

#get_server_signer(server_signer_id, opts = {}) ⇒ ServerSigner

Get a server signer by ID Get a server signer by ID

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to fetch

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

    the optional parameters

Returns:



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

def get_server_signer(server_signer_id, opts = {})
  data, _status_code, _headers = get_server_signer_with_http_info(server_signer_id, opts)
  data
end

#get_server_signer_with_http_info(server_signer_id, opts = {}) ⇒ Array<(ServerSigner, Integer, Hash)>

Get a server signer by ID Get a server signer by ID

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to fetch

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

    the optional parameters

Returns:

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

    ServerSigner 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/server_signers_api.rb', line 101

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

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

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

#list_server_signer_events(server_signer_id, opts = {}) ⇒ ServerSignerEventList

List events for a server signer List events for a server signer

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to fetch events 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:



156
157
158
159
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 156

def list_server_signer_events(server_signer_id, opts = {})
  data, _status_code, _headers = list_server_signer_events_with_http_info(server_signer_id, opts)
  data
end

#list_server_signer_events_with_http_info(server_signer_id, opts = {}) ⇒ Array<(ServerSignerEventList, Integer, Hash)>

List events for a server signer List events for a server signer

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to fetch events 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<(ServerSignerEventList, Integer, Hash)>) —

    ServerSignerEventList data, response status code and response headers



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
217
218
219
220
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 168

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

  # resource path
  local_var_path = '/v1/server_signers/{server_signer_id}/events'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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] || 'ServerSignerEventList'

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

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

#list_server_signers(opts = {}) ⇒ ServerSignerList

List server signers for the current project List server signers for the current project

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:



228
229
230
231
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 228

def list_server_signers(opts = {})
  data, _status_code, _headers = list_server_signers_with_http_info(opts)
  data
end

#list_server_signers_with_http_info(opts = {}) ⇒ Array<(ServerSignerList, Integer, Hash)>

List server signers for the current project List server signers for the current project

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

    ServerSignerList data, response status code and response headers



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
280
281
282
283
284
285
286
287
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 239

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

  # resource path
  local_var_path = '/v1/server_signers'

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

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

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

#submit_server_signer_seed_event_result(server_signer_id, opts = {}) ⇒ SeedCreationEventResult

Submit the result of a server signer event Submit the result of a server signer event

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to submit the event result for

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

    the optional parameters

Options Hash (opts):

Returns:



295
296
297
298
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 295

def submit_server_signer_seed_event_result(server_signer_id, opts = {})
  data, _status_code, _headers = submit_server_signer_seed_event_result_with_http_info(server_signer_id, opts)
  data
end

#submit_server_signer_seed_event_result_with_http_info(server_signer_id, opts = {}) ⇒ Array<(SeedCreationEventResult, Integer, Hash)>

Submit the result of a server signer event Submit the result of a server signer event

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to submit the event result for

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SeedCreationEventResult data, response status code and response headers



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
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 306

def submit_server_signer_seed_event_result_with_http_info(server_signer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServerSignersApi.submit_server_signer_seed_event_result ...'
  end
  # verify the required parameter 'server_signer_id' is set
  if @api_client.config.client_side_validation && server_signer_id.nil?
    fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.submit_server_signer_seed_event_result"
  end
  # resource path
  local_var_path = '/v1/server_signers/{server_signer_id}/seed_event_result'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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(opts[:'seed_creation_event_result'])

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

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

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

#submit_server_signer_signature_event_result(server_signer_id, opts = {}) ⇒ SignatureCreationEventResult

Submit the result of a server signer event Submit the result of a server signer event

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to submit the event result for

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

    the optional parameters

Options Hash (opts):

Returns:



365
366
367
368
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 365

def submit_server_signer_signature_event_result(server_signer_id, opts = {})
  data, _status_code, _headers = submit_server_signer_signature_event_result_with_http_info(server_signer_id, opts)
  data
end

#submit_server_signer_signature_event_result_with_http_info(server_signer_id, opts = {}) ⇒ Array<(SignatureCreationEventResult, Integer, Hash)>

Submit the result of a server signer event Submit the result of a server signer event

Parameters:

  • server_signer_id (String) —

    The ID of the server signer to submit the event result for

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

    the optional parameters

Options Hash (opts):

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/coinbase/client/api/server_signers_api.rb', line 376

def submit_server_signer_signature_event_result_with_http_info(server_signer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServerSignersApi.submit_server_signer_signature_event_result ...'
  end
  # verify the required parameter 'server_signer_id' is set
  if @api_client.config.client_side_validation && server_signer_id.nil?
    fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.submit_server_signer_signature_event_result"
  end
  # resource path
  local_var_path = '/v1/server_signers/{server_signer_id}/signature_event_result'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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(opts[:'signature_creation_event_result'])

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

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

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