Class: Solifyn::MetersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/solifyn/api/meters_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetersApi

Returns a new instance of MetersApi.



19
20
21
 
# File 'lib/solifyn/api/meters_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/solifyn/api/meters_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#events_ingest(meter_ingest_request_dto, opts = {}) ⇒ MeterIngestResponseDto

Ingest Events Ingest usage events for meters.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/solifyn/api/meters_api.rb', line 27

def events_ingest(meter_ingest_request_dto, opts = {})
  data, _status_code, _headers = events_ingest_with_http_info(meter_ingest_request_dto, opts)
  data
end

#events_ingest_with_http_info(meter_ingest_request_dto, opts = {}) ⇒ Array<(MeterIngestResponseDto, Integer, Hash)>

Ingest Events Ingest usage events for meters.

Parameters:

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

    the optional parameters

Returns:

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

    MeterIngestResponseDto 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
85
86
87
88
 
# File 'lib/solifyn/api/meters_api.rb', line 37

def events_ingest_with_http_info(meter_ingest_request_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetersApi.events_ingest ...'
  end
  # verify the required parameter 'meter_ingest_request_dto' is set
  if @api_client.config.client_side_validation && meter_ingest_request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'meter_ingest_request_dto' when calling MetersApi.events_ingest"
  end
  # resource path
  local_var_path = '/v1/meters/ingest'

  # 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(meter_ingest_request_dto)

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

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

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

#meters_create(create_meter_dto, opts = {}) ⇒ MeterResponseDto

Create Meter Create a new usage meter for event-based billing and usage tracking.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/solifyn/api/meters_api.rb', line 95

def meters_create(create_meter_dto, opts = {})
  data, _status_code, _headers = meters_create_with_http_info(create_meter_dto, opts)
  data
end

#meters_create_with_http_info(create_meter_dto, opts = {}) ⇒ Array<(MeterResponseDto, Integer, Hash)>

Create Meter Create a new usage meter for event-based billing and usage tracking.

Parameters:

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

    the optional parameters

Returns:

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

    MeterResponseDto data, response status code and response headers



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
153
154
155
156
 
# File 'lib/solifyn/api/meters_api.rb', line 105

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

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

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

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

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

#meters_get(id, start_date, end_date, opts = {}) ⇒ MeterDetailResponseDto

Retrieve Meter Retrieve a meter and its most recent usage events.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Returns:



165
166
167
168
 
# File 'lib/solifyn/api/meters_api.rb', line 165

def meters_get(id, start_date, end_date, opts = {})
  data, _status_code, _headers = meters_get_with_http_info(id, start_date, end_date, opts)
  data
end

#meters_get_events(id, opts = {}) ⇒ MeterEventsResponseDto

List Meter Events List recent usage events recorded for a meter.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Maximum number of usage events to return. (default to 100)

Returns:



241
242
243
244
 
# File 'lib/solifyn/api/meters_api.rb', line 241

def meters_get_events(id, opts = {})
  data, _status_code, _headers = meters_get_events_with_http_info(id, opts)
  data
end

#meters_get_events_with_http_info(id, opts = {}) ⇒ Array<(MeterEventsResponseDto, Integer, Hash)>

List Meter Events List recent usage events recorded for a meter.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Maximum number of usage events to return. (default to 100)

Returns:

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

    MeterEventsResponseDto data, response status code and response headers



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
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/solifyn/api/meters_api.rb', line 252

def meters_get_events_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetersApi.meters_get_events ...'
  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 MetersApi.meters_get_events"
  end
  # resource path
  local_var_path = '/v1/meters/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

#meters_get_quantities(id, opts = {}) ⇒ MeterQuantitiesResponseDto

Get Meter Quantities Get aggregated usage quantities for a meter within an optional date range.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Inclusive start date in ISO 8601 format.

  • :end_date (String) —

    Inclusive end date in ISO 8601 format.

Returns:



308
309
310
311
 
# File 'lib/solifyn/api/meters_api.rb', line 308

def meters_get_quantities(id, opts = {})
  data, _status_code, _headers = meters_get_quantities_with_http_info(id, opts)
  data
end

#meters_get_quantities_with_http_info(id, opts = {}) ⇒ Array<(MeterQuantitiesResponseDto, Integer, Hash)>

Get Meter Quantities Get aggregated usage quantities for a meter within an optional date range.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Inclusive start date in ISO 8601 format.

  • :end_date (String) —

    Inclusive end date in ISO 8601 format.

Returns:

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

    MeterQuantitiesResponseDto data, response status code and response headers



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
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/solifyn/api/meters_api.rb', line 320

def meters_get_quantities_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetersApi.meters_get_quantities ...'
  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 MetersApi.meters_get_quantities"
  end
  # resource path
  local_var_path = '/v1/meters/{id}/quantities'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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] || 'MeterQuantitiesResponseDto'

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

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

#meters_get_with_http_info(id, start_date, end_date, opts = {}) ⇒ Array<(MeterDetailResponseDto, Integer, Hash)>

Retrieve Meter Retrieve a meter and its most recent usage events.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Returns:

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

    MeterDetailResponseDto data, response status code and response headers



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
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/solifyn/api/meters_api.rb', line 177

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

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

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

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

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

#meters_list(opts = {}) ⇒ Array<MeterResponseDto>

List Meters List meters belonging to your active business. You can filter by archived status.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by meter status.

Returns:



375
376
377
378
 
# File 'lib/solifyn/api/meters_api.rb', line 375

def meters_list(opts = {})
  data, _status_code, _headers = meters_list_with_http_info(opts)
  data
end

#meters_list_with_http_info(opts = {}) ⇒ Array<(Array<MeterResponseDto>, Integer, Hash)>

List Meters List meters belonging to your active business. You can filter by archived status.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by meter status.

Returns:

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

    Array<MeterResponseDto> data, response status code and response headers



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
428
429
430
431
432
 
# File 'lib/solifyn/api/meters_api.rb', line 385

def meters_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetersApi.meters_list ...'
  end
  allowable_values = ["active", "archived"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/meters'

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

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

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

#meters_update(id, update_meter_dto, opts = {}) ⇒ MeterResponseDto

Update Meter Update an existing meter definition.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Returns:



440
441
442
443
 
# File 'lib/solifyn/api/meters_api.rb', line 440

def meters_update(id, update_meter_dto, opts = {})
  data, _status_code, _headers = meters_update_with_http_info(id, update_meter_dto, opts)
  data
end

#meters_update_with_http_info(id, update_meter_dto, opts = {}) ⇒ Array<(MeterResponseDto, Integer, Hash)>

Update Meter Update an existing meter definition.

Parameters:

  • id (String) —

    The unique meter ID.

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

    the optional parameters

Returns:

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

    MeterResponseDto data, response status code and response headers



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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/solifyn/api/meters_api.rb', line 451

def meters_update_with_http_info(id, update_meter_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetersApi.meters_update ...'
  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 MetersApi.meters_update"
  end
  # verify the required parameter 'update_meter_dto' is set
  if @api_client.config.client_side_validation && update_meter_dto.nil?
    fail ArgumentError, "Missing the required parameter 'update_meter_dto' when calling MetersApi.meters_update"
  end
  # resource path
  local_var_path = '/v1/meters/{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_meter_dto)

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

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

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