Class: OpenapiClient::UserDevicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/user_devices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserDevicesApi

Returns a new instance of UserDevicesApi.



19
20
21
 
# File 'lib/openapi_client/api/user_devices_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/openapi_client/api/user_devices_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_user_devices(app_id, user_id, device_id, opts = {}) ⇒ nil

Delete a device for a user Delete a device for a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

  • device_id (String) —

    Device ID

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/openapi_client/api/user_devices_api.rb', line 29

def delete_user_devices(app_id, user_id, device_id, opts = {})
  delete_user_devices_with_http_info(app_id, user_id, device_id, opts)
  nil
end

#delete_user_devices_with_http_info(app_id, user_id, device_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a device for a user Delete a device for a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

  • device_id (String) —

    Device ID

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

    the optional parameters

Returns:

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

    nil, 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/openapi_client/api/user_devices_api.rb', line 41

def delete_user_devices_with_http_info(app_id, user_id, device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserDevicesApi.delete_user_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 UserDevicesApi.delete_user_devices"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UserDevicesApi.delete_user_devices"
  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 UserDevicesApi.delete_user_devices"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}/devices/{device_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'device_id' + '}', 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#list_user_devices(app_id, user_id, opts = {}) ⇒ ListDevicesResponse

List User Devices List user devices.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:



103
104
105
106
 
# File 'lib/openapi_client/api/user_devices_api.rb', line 103

def list_user_devices(app_id, user_id, opts = {})
  data, _status_code, _headers = list_user_devices_with_http_info(app_id, user_id, opts)
  data
end

#list_user_devices_with_http_info(app_id, user_id, opts = {}) ⇒ Array<(ListDevicesResponse, Integer, Hash)>

List User Devices List user devices.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

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

    ListDevicesResponse data, response status code and response headers



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
160
161
162
163
164
 
# File 'lib/openapi_client/api/user_devices_api.rb', line 114

def list_user_devices_with_http_info(app_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserDevicesApi.list_user_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 UserDevicesApi.list_user_devices"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UserDevicesApi.list_user_devices"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}/devices'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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[:debug_body]

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

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

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