Class: ZoomUs::Devices

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/devices.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Devices

Returns a new instance of Devices.



19
20
21
 
# File 'lib/zoom_us/devices.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/zoom_us/devices.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#device_create(body, opts = {}) ⇒ nil

Create a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account
Scopes: ‘h323:write:admin`

Parameters:

  • body —

    H.323/SIP device.

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/zoom_us/devices.rb', line 27

def device_create(body, opts = {})
  device_create_with_http_info(body, opts)
  nil
end

#device_create_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account&lt;br&gt;&lt;br&gt; Scopes: &#x60;h323:write:admin&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • body —

    H.323/SIP device.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/zoom_us/devices.rb', line 37

def device_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.device_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DevicesApi.device_create"
  end
  # resource path
  local_var_path = '/h323/devices'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#device_delete(device_id, opts = {}) ⇒ nil

Delete a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.
Scopes: ‘h323:write:admin`

Parameters:

  • device_id —

    The device ID.

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

    the optional parameters

Returns:

  • (nil) 


80
81
82
83
 
# File 'lib/zoom_us/devices.rb', line 80

def device_delete(device_id, opts = {})
  device_delete_with_http_info(device_id, opts)
  nil
end

#device_delete_with_http_info(device_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;h323:write:admin&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • device_id —

    The device ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



90
91
92
93
94
95
96
97
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
 
# File 'lib/zoom_us/devices.rb', line 90

def device_delete_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.device_delete ...'
  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.device_delete"
  end
  # resource path
  local_var_path = '/h323/devices/{deviceId}'.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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#device_list(opts = {}) ⇒ H323SIPDeviceList

List H.323/SIP Devices A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.
Scopes: ‘h323:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (H323SIPDeviceList) 


134
135
136
137
 
# File 'lib/zoom_us/devices.rb', line 134

def device_list(opts = {})
  data, _status_code, _headers = device_list_with_http_info(opts)
  data
end

#device_list_with_http_info(opts = {}) ⇒ Array<(H323SIPDeviceList, Fixnum, Hash)>

List H.323/SIP Devices A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;h323:read:admin&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

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

    H323SIPDeviceList data, response status code and response headers



145
146
147
148
149
150
151
152
153
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
 
# File 'lib/zoom_us/devices.rb', line 145

def device_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.device_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DevicesApi.device_list, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/h323/devices'

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'H323SIPDeviceList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DevicesApi#device_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#device_update(device_id, body, opts = {}) ⇒ nil

Update a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.
Scopes: ‘h323:write:admin`

Parameters:

  • device_id —

    The device ID.

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

    the optional parameters

Returns:

  • (nil) 


192
193
194
195
 
# File 'lib/zoom_us/devices.rb', line 192

def device_update(device_id, body, opts = {})
  device_update_with_http_info(device_id, body, opts)
  nil
end

#device_update_with_http_info(device_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a H.323/SIP Device A H.323 or SIP device can make a video call to a [Room Connector](support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;h323:write:admin&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • device_id —

    The device ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/zoom_us/devices.rb', line 203

def device_update_with_http_info(device_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DevicesApi.device_update ...'
  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.device_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DevicesApi.device_update"
  end
  # resource path
  local_var_path = '/h323/devices/{deviceId}'.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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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