Class: ZoomUs::CommonAreaPhones

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommonAreaPhones

Returns a new instance of CommonAreaPhones.



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

def api_client
  @api_client
end

Instance Method Details

#add_common_area_phone(opts = {}) ⇒ InlineResponse20124

Add a Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to [add a common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones#h_2d0da347-c35a-4993-9771-e21aaa568deb).
Prerequisites:
* Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
Scope: ‘phone:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body74)

Returns:

  • (InlineResponse20124) 


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

def add_common_area_phone(opts = {})
  data, _status_code, _headers = add_common_area_phone_with_http_info(opts)
  data
end

#add_common_area_phone_with_http_info(opts = {}) ⇒ Array<(InlineResponse20124, Fixnum, Hash)>

Add a Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don&#39;t belong to a specific employees, you could add a common area phone so that any person can use it.&lt;br&gt; Use this API to [add a common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones#h_2d0da347-c35a-4993-9771-e21aaa568deb).&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)&lt;br&gt; Scope: &#x60;phone:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body74)

Returns:

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

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

def add_common_area_phone_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommonAreaPhonesApi.add_common_area_phone ...'
  end
  # resource path
  local_var_path = '/phone/common_area_phones'

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

  # form parameters
  form_params = {}

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

#delete_common_area_phone(common_area_phone_id, opts = {}) ⇒ Object

Delete a Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to remove the [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) from Zoom Phone System in an account.
Prerequisites:
* Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
Scopes: ‘phone:write:admin`

Parameters:

  • common_area_phone_id —

    Unique Identifier of the common area phone.

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

    the optional parameters

Returns:

  • (Object) 


77
78
79
80
 
# File 'lib/zoom_us/common_area_phones.rb', line 77

def delete_common_area_phone(common_area_phone_id, opts = {})
  data, _status_code, _headers = delete_common_area_phone_with_http_info(common_area_phone_id, opts)
  data
end

#delete_common_area_phone_with_http_info(common_area_phone_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Delete a Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don&#39;t belong to a specific employees, you could add a common area phone so that any person can use it.&lt;br&gt; Use this API to remove the [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) from Zoom Phone System in an account.&lt;br&gt;&lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Parameters:

  • common_area_phone_id —

    Unique Identifier of the common area phone.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



87
88
89
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
 
# File 'lib/zoom_us/common_area_phones.rb', line 87

def delete_common_area_phone_with_http_info(common_area_phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommonAreaPhonesApi.delete_common_area_phone ...'
  end
  # verify the required parameter 'common_area_phone_id' is set
  if @api_client.config.client_side_validation && common_area_phone_id.nil?
    fail ArgumentError, "Missing the required parameter 'common_area_phone_id' when calling CommonAreaPhonesApi.delete_common_area_phone"
  end
  # resource path
  local_var_path = '/phone/common_area_phone/{commonAreaPhoneId}'.sub('{' + 'commonAreaPhoneId' + '}', common_area_phone_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,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommonAreaPhonesApi#delete_common_area_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_common_area_phone(common_area_phone_id, opts = {}) ⇒ InlineResponse20096

Get Common Area Phone Details A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to get details on a specific [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
Prerequisites:
* Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
Scopes: ‘phone:read:admin`

Parameters:

  • common_area_phone_id —

    Unique Identifier of the Common Area Phone. This can be retrieved from List Common Area Phones API.

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

    the optional parameters

Returns:

  • (InlineResponse20096) 


131
132
133
134
 
# File 'lib/zoom_us/common_area_phones.rb', line 131

def get_a_common_area_phone(common_area_phone_id, opts = {})
  data, _status_code, _headers = get_a_common_area_phone_with_http_info(common_area_phone_id, opts)
  data
end

#get_a_common_area_phone_with_http_info(common_area_phone_id, opts = {}) ⇒ Array<(InlineResponse20096, Fixnum, Hash)>

Get Common Area Phone Details A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don&#39;t belong to a specific employees, you could add a common area phone so that any person can use it.&lt;br&gt; Use this API to get details on a specific [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.&lt;br&gt;&lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)&lt;br&gt; Scopes: &#x60;phone:read:admin&#x60;&lt;br&gt;

Parameters:

  • common_area_phone_id —

    Unique Identifier of the Common Area Phone. This can be retrieved from List Common Area Phones API.

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

    the optional parameters

Returns:

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

    InlineResponse20096 data, response status code and response headers



141
142
143
144
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
 
# File 'lib/zoom_us/common_area_phones.rb', line 141

def get_a_common_area_phone_with_http_info(common_area_phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommonAreaPhonesApi.get_a_common_area_phone ...'
  end
  # verify the required parameter 'common_area_phone_id' is set
  if @api_client.config.client_side_validation && common_area_phone_id.nil?
    fail ArgumentError, "Missing the required parameter 'common_area_phone_id' when calling CommonAreaPhonesApi.get_a_common_area_phone"
  end
  # resource path
  local_var_path = '/phone/common_area_phone/{commonAreaPhoneId}'.sub('{' + 'commonAreaPhoneId' + '}', common_area_phone_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(: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 => 'InlineResponse20096')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommonAreaPhonesApi#get_a_common_area_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_common_area_phones(opts = {}) ⇒ InlineResponse20095

List Common Area Phones A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to [list all common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
Prerequisites:
* Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
Scope: ‘phone:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

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

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Returns:

  • (InlineResponse20095) 


186
187
188
189
 
# File 'lib/zoom_us/common_area_phones.rb', line 186

def list_common_area_phones(opts = {})
  data, _status_code, _headers = list_common_area_phones_with_http_info(opts)
  data
end

#list_common_area_phones_with_http_info(opts = {}) ⇒ Array<(InlineResponse20095, Fixnum, Hash)>

List Common Area Phones A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don&#39;t belong to a specific employees, you could add a common area phone so that any person can use it.&lt;br&gt; Use this API to [list all common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.&lt;br&gt;&lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)&lt;br&gt;&lt;br&gt; Scope: &#x60;phone:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total number of records returned from a single API call.

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Returns:

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

    InlineResponse20095 data, response status code and response headers



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
234
235
236
237
 
# File 'lib/zoom_us/common_area_phones.rb', line 197

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

  # resource path
  local_var_path = '/phone/common_area_phones'

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].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 => 'InlineResponse20095')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommonAreaPhonesApi#list_common_area_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_common_area_phone(common_area_phone_id, opts = {}) ⇒ Object

Update Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to update details on a specific [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
Prerequisites:
* Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
Scopes: ‘phone:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body75)

Returns:

  • (Object) 


244
245
246
247
 
# File 'lib/zoom_us/common_area_phones.rb', line 244

def update_common_area_phone(common_area_phone_id, opts = {})
  data, _status_code, _headers = update_common_area_phone_with_http_info(common_area_phone_id, opts)
  data
end

#update_common_area_phone_with_http_info(common_area_phone_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Common Area Phone A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don&#39;t belong to a specific employees, you could add a common area phone so that any person can use it.&lt;br&gt; Use this API to update details on a specific [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.&lt;br&gt;&lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body75)

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/zoom_us/common_area_phones.rb', line 255

def update_common_area_phone_with_http_info(common_area_phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommonAreaPhonesApi.update_common_area_phone ...'
  end
  # verify the required parameter 'common_area_phone_id' is set
  if @api_client.config.client_side_validation && common_area_phone_id.nil?
    fail ArgumentError, "Missing the required parameter 'common_area_phone_id' when calling CommonAreaPhonesApi.update_common_area_phone"
  end
  # resource path
  local_var_path = '/phone/common_area_phone/{commonAreaPhoneId}'.sub('{' + 'commonAreaPhoneId' + '}', common_area_phone_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(opts[:'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,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommonAreaPhonesApi#update_common_area_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end