Class: ArtikCloud::DevicesStatusApi

Inherits:
Object
  • Object
show all
Defined in:
lib/artikcloud/api/devices_status_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DevicesStatusApi

Returns a new instance of DevicesStatusApi.



18
19
20
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_device_status(device_id, opts = {}) ⇒ DeviceStatus

Get Device Status Get Device Status

Parameters:

  • device_id —

    Device ID.

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

    the optional parameters

Options Hash (opts):

  • :include_snapshot (BOOLEAN) —

    Include device snapshot into the response

  • :include_snapshot_timestamp (BOOLEAN) —

    Include device snapshot timestamp into the response

Returns:



29
30
31
32
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 29

def get_device_status(device_id, opts = {})
  data, _status_code, _headers = get_device_status_with_http_info(device_id, opts)
  return data
end

#get_device_status_with_http_info(device_id, opts = {}) ⇒ Array<(DeviceStatus, Fixnum, Hash)>

Get Device Status Get Device Status

Parameters:

  • device_id —

    Device ID.

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

    the optional parameters

Options Hash (opts):

  • :include_snapshot (BOOLEAN) —

    Include device snapshot into the response

  • :include_snapshot_timestamp (BOOLEAN) —

    Include device snapshot timestamp into the response

Returns:

  • (Array<(DeviceStatus, Fixnum, Hash)>) —

    DeviceStatus data, response status code and response headers



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
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 41

def get_device_status_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DevicesStatusApi.get_device_status ..."
  end
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling DevicesStatusApi.get_device_status" if device_id.nil?
  # resource path
  local_var_path = "/devices/{deviceId}/status".sub('{format}','json').sub('{' + 'deviceId' + '}', device_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeSnapshot'] = opts[:'include_snapshot'] if !opts[:'include_snapshot'].nil?
  query_params[:'includeSnapshotTimestamp'] = opts[:'include_snapshot_timestamp'] if !opts[:'include_snapshot_timestamp'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeviceStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DevicesStatusApi#get_device_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_devices_status(dids, opts = {}) ⇒ DeviceStatusBatch

Get Devices Status Get Devices Status

Parameters:

  • dids —

    List of device ids (comma-separated) for which the statuses are requested.

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

    the optional parameters

Options Hash (opts):

  • :include_snapshot (BOOLEAN) —

    Include device snapshot into the response

  • :include_snapshot_timestamp (BOOLEAN) —

    Include device snapshot timestamp into the response

Returns:



86
87
88
89
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 86

def get_devices_status(dids, opts = {})
  data, _status_code, _headers = get_devices_status_with_http_info(dids, opts)
  return data
end

#get_devices_status_with_http_info(dids, opts = {}) ⇒ Array<(DeviceStatusBatch, Fixnum, Hash)>

Get Devices Status Get Devices Status

Parameters:

  • dids —

    List of device ids (comma-separated) for which the statuses are requested.

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

    the optional parameters

Options Hash (opts):

  • :include_snapshot (BOOLEAN) —

    Include device snapshot into the response

  • :include_snapshot_timestamp (BOOLEAN) —

    Include device snapshot timestamp into the response

Returns:

  • (Array<(DeviceStatusBatch, Fixnum, Hash)>) —

    DeviceStatusBatch data, response status code and response headers



98
99
100
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
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 98

def get_devices_status_with_http_info(dids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DevicesStatusApi.get_devices_status ..."
  end
  # verify the required parameter 'dids' is set
  fail ArgumentError, "Missing the required parameter 'dids' when calling DevicesStatusApi.get_devices_status" if dids.nil?
  # resource path
  local_var_path = "/devices/status".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'dids'] = dids
  query_params[:'includeSnapshot'] = opts[:'include_snapshot'] if !opts[:'include_snapshot'].nil?
  query_params[:'includeSnapshotTimestamp'] = opts[:'include_snapshot_timestamp'] if !opts[:'include_snapshot_timestamp'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeviceStatusBatch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DevicesStatusApi#get_devices_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_device_status(device_id, opts = {}) ⇒ DeviceStatus

Update Device Status Update Device Status

Parameters:

  • device_id —

    Device ID.

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

    the optional parameters

Options Hash (opts):

Returns:



143
144
145
146
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 143

def put_device_status(device_id, opts = {})
  data, _status_code, _headers = put_device_status_with_http_info(device_id, opts)
  return data
end

#put_device_status_with_http_info(device_id, opts = {}) ⇒ Array<(DeviceStatus, Fixnum, Hash)>

Update Device Status Update Device Status

Parameters:

  • device_id —

    Device ID.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DeviceStatus, Fixnum, Hash)>) —

    DeviceStatus data, response status code and response headers



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
187
188
 
# File 'lib/artikcloud/api/devices_status_api.rb', line 154

def put_device_status_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DevicesStatusApi.put_device_status ..."
  end
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling DevicesStatusApi.put_device_status" if device_id.nil?
  # resource path
  local_var_path = "/devices/{deviceId}/status".sub('{format}','json').sub('{' + 'deviceId' + '}', device_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['artikcloud_oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeviceStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DevicesStatusApi#put_device_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end