Class: Spatio::RecordsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/api/records_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecordsApi

Returns a new instance of RecordsApi.



19
20
21
 
# File 'lib/spatio-sdk/api/records_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/spatio-sdk/api/records_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_record(create_record_request, opts = {}) ⇒ Record

Create a record.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/spatio-sdk/api/records_api.rb', line 26

def create_record(create_record_request, opts = {})
  data, _status_code, _headers = create_record_with_http_info(create_record_request, opts)
  data
end

#create_record_type(create_record_type_request, opts = {}) ⇒ RecordType

Create a record type (org-scoped).

Parameters:

Returns:



92
93
94
95
 
# File 'lib/spatio-sdk/api/records_api.rb', line 92

def create_record_type(create_record_type_request, opts = {})
  data, _status_code, _headers = create_record_type_with_http_info(create_record_type_request, opts)
  data
end

#create_record_type_with_http_info(create_record_type_request, opts = {}) ⇒ Array<(RecordType, Integer, Hash)>

Create a record type (org-scoped).

Parameters:

Returns:

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

    RecordType 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
148
149
150
151
152
 
# File 'lib/spatio-sdk/api/records_api.rb', line 101

def create_record_type_with_http_info(create_record_type_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.create_record_type ...'
  end
  # verify the required parameter 'create_record_type_request' is set
  if @api_client.config.client_side_validation && create_record_type_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_record_type_request' when calling RecordsApi.create_record_type"
  end
  # resource path
  local_var_path = '/v1/records/types'

  # 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_record_type_request)

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

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

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

#create_record_with_http_info(create_record_request, opts = {}) ⇒ Array<(Record, Integer, Hash)>

Create a record.

Parameters:

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

    the optional parameters

Returns:

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

    Record data, response status code and response headers



35
36
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
85
86
 
# File 'lib/spatio-sdk/api/records_api.rb', line 35

def create_record_with_http_info(create_record_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.create_record ...'
  end
  # verify the required parameter 'create_record_request' is set
  if @api_client.config.client_side_validation && create_record_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_record_request' when calling RecordsApi.create_record"
  end
  # resource path
  local_var_path = '/v1/records'

  # 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_record_request)

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

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

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

#delete_record(id, opts = {}) ⇒ nil

Delete a record.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


158
159
160
161
 
# File 'lib/spatio-sdk/api/records_api.rb', line 158

def delete_record(id, opts = {})
  delete_record_with_http_info(id, opts)
  nil
end

#delete_record_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a record.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/spatio-sdk/api/records_api.rb', line 167

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

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

  new_options = opts.merge(
    :operation => :"RecordsApi.delete_record",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordsApi#delete_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_record(id, opts = {}) ⇒ Record

Fetch a record.

Parameters:

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/spatio-sdk/api/records_api.rb', line 219

def get_record(id, opts = {})
  data, _status_code, _headers = get_record_with_http_info(id, opts)
  data
end

#get_record_with_http_info(id, opts = {}) ⇒ Array<(Record, Integer, Hash)>

Fetch a record.

Parameters:

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

    the optional parameters

Returns:

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

    Record data, response status code and response headers



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
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/spatio-sdk/api/records_api.rb', line 228

def get_record_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.get_record ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RecordsApi.get_record"
  end
  # resource path
  local_var_path = '/v1/records/{id}'.sub('{id}', CGI.escape(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] || 'Record'

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

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

#list_record_types(organization_id, opts = {}) ⇒ RecordTypeListResponse

List record types for an organization.

Parameters:

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

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/spatio-sdk/api/records_api.rb', line 280

def list_record_types(organization_id, opts = {})
  data, _status_code, _headers = list_record_types_with_http_info(organization_id, opts)
  data
end

#list_record_types_with_http_info(organization_id, opts = {}) ⇒ Array<(RecordTypeListResponse, Integer, Hash)>

List record types for an organization.

Parameters:

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

    the optional parameters

Returns:

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

    RecordTypeListResponse data, response status code and response headers



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
 
# File 'lib/spatio-sdk/api/records_api.rb', line 289

def list_record_types_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.list_record_types ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling RecordsApi.list_record_types"
  end
  # resource path
  local_var_path = '/v1/records/types'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization_id'] = organization_id

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

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

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

#list_records(organization_id, opts = {}) ⇒ RecordListResponse

List records for an organization. ‘organization_id` query param is required (handler returns 400 otherwise).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type_id (String)
  • :limit (Integer)

Returns:



344
345
346
347
 
# File 'lib/spatio-sdk/api/records_api.rb', line 344

def list_records(organization_id, opts = {})
  data, _status_code, _headers = list_records_with_http_info(organization_id, opts)
  data
end

#list_records_with_http_info(organization_id, opts = {}) ⇒ Array<(RecordListResponse, Integer, Hash)>

List records for an organization. &#x60;organization_id&#x60; query param is required (handler returns 400 otherwise).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type_id (String)
  • :limit (Integer)

Returns:

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

    RecordListResponse data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
 
# File 'lib/spatio-sdk/api/records_api.rb', line 355

def list_records_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.list_records ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling RecordsApi.list_records"
  end
  # resource path
  local_var_path = '/v1/records'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization_id'] = organization_id
  query_params[:'record_type_id'] = opts[:'record_type_id'] if !opts[:'record_type_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'RecordListResponse'

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

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

#update_record(id, update_record_request, opts = {}) ⇒ Record

Update a record.

Parameters:

  • id (String)
  • update_record_request (UpdateRecordRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



411
412
413
414
 
# File 'lib/spatio-sdk/api/records_api.rb', line 411

def update_record(id, update_record_request, opts = {})
  data, _status_code, _headers = update_record_with_http_info(id, update_record_request, opts)
  data
end

#update_record_type(id, update_record_type_request, opts = {}) ⇒ RecordType

Update a record type.

Parameters:

  • id (String)
  • update_record_type_request (UpdateRecordTypeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



483
484
485
486
 
# File 'lib/spatio-sdk/api/records_api.rb', line 483

def update_record_type(id, update_record_type_request, opts = {})
  data, _status_code, _headers = update_record_type_with_http_info(id, update_record_type_request, opts)
  data
end

#update_record_type_with_http_info(id, update_record_type_request, opts = {}) ⇒ Array<(RecordType, Integer, Hash)>

Update a record type.

Parameters:

  • id (String)
  • update_record_type_request (UpdateRecordTypeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RecordType data, response status code and response headers



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/spatio-sdk/api/records_api.rb', line 493

def update_record_type_with_http_info(id, update_record_type_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.update_record_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RecordsApi.update_record_type"
  end
  # verify the required parameter 'update_record_type_request' is set
  if @api_client.config.client_side_validation && update_record_type_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_record_type_request' when calling RecordsApi.update_record_type"
  end
  # resource path
  local_var_path = '/v1/records/types/{id}'.sub('{id}', CGI.escape(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(update_record_type_request)

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

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

  new_options = opts.merge(
    :operation => :"RecordsApi.update_record_type",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordsApi#update_record_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_record_with_http_info(id, update_record_request, opts = {}) ⇒ Array<(Record, Integer, Hash)>

Update a record.

Parameters:

  • id (String)
  • update_record_request (UpdateRecordRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Record data, response status code and response headers



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/spatio-sdk/api/records_api.rb', line 421

def update_record_with_http_info(id, update_record_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecordsApi.update_record ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RecordsApi.update_record"
  end
  # verify the required parameter 'update_record_request' is set
  if @api_client.config.client_side_validation && update_record_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_record_request' when calling RecordsApi.update_record"
  end
  # resource path
  local_var_path = '/v1/records/{id}'.sub('{id}', CGI.escape(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(update_record_request)

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

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

  new_options = opts.merge(
    :operation => :"RecordsApi.update_record",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordsApi#update_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end