Class: SunshineConversationsClient::DevicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/devices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DevicesApi

Returns a new instance of DevicesApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_device(app_id, user_id_or_external_id, device_id, opts = {}) ⇒ DeviceResponse

Get Device Fetches a specific Device. “‘shell /v2/apps/:appId/users/:userId “`

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user's id or externalId.

  • device_id (String) —

    The device's id.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 26

def get_device(app_id, user_id_or_external_id, device_id, opts = {})
  data, _status_code, _headers = get_device_with_http_info(app_id, user_id_or_external_id, device_id, opts)
  data
end

#get_device_with_http_info(app_id, user_id_or_external_id, device_id, opts = {}) ⇒ Array<(DeviceResponse, Integer, Hash)>

Get Device Fetches a specific Device. &#x60;&#x60;&#x60;shell /v2/apps/:appId/users/:userId &#x60;&#x60;&#x60;

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • device_id (String) —

    The device&#39;s id.

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

    the optional parameters

Returns:

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

    DeviceResponse data, response status code and response headers



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
89
90
91
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 38

def get_device_with_http_info(app_id, user_id_or_external_id, device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.get_device ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DevicesApi.get_device"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling DevicesApi.get_device"
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling DevicesApi.get_device"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/devices/{deviceId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_id.to_s)).sub('{' + 'deviceId' + '}', CGI.escape(device_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'DeviceResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

#list_devices(app_id, user_id_or_external_id, opts = {}) ⇒ DeviceListResponse

List Devices Get all the devices for a particular user. The Devices are sorted based on last seen time. “‘shell /v2/apps/:appId/users/:userId/devices “`

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 99

def list_devices(app_id, user_id_or_external_id, opts = {})
  data, _status_code, _headers = list_devices_with_http_info(app_id, user_id_or_external_id, opts)
  data
end

#list_devices_with_http_info(app_id, user_id_or_external_id, opts = {}) ⇒ Array<(DeviceListResponse, Integer, Hash)>

List Devices Get all the devices for a particular user. The Devices are sorted based on last seen time. &#x60;&#x60;&#x60;shell /v2/apps/:appId/users/:userId/devices &#x60;&#x60;&#x60;

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

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

    DeviceListResponse data, response status code and response headers



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
157
158
159
 
# File 'lib/sunshine-conversations-client/api/devices_api.rb', line 110

def list_devices_with_http_info(app_id, user_id_or_external_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.list_devices ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DevicesApi.list_devices"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling DevicesApi.list_devices"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/devices'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'DeviceListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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