Class: ZoomUs::TSP

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TSP

Returns a new instance of TSP.



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

def api_client
  @api_client
end

Instance Method Details

#tsp(opts = {}) ⇒ InlineResponse20045

Get Account’s TSP Information Get information on Telephony Service Provider on an account level.
Scopes: ‘tsp:read:admin` `tsp:read`
Prerequisites:
* A Pro or a higher plan.

Parameters:

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

    the optional parameters

Returns:

  • (InlineResponse20045) 


26
27
28
29
 
# File 'lib/zoom_us/tsp.rb', line 26

def tsp(opts = {})
  data, _status_code, _headers = tsp_with_http_info(opts)
  data
end

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

Update account’s TSP information Update information of the Telephony Service Provider set up on an account.
Prerequisites:
TSP account option should be enabled.
Scopes: ‘tsp:write:admin` `tsp:write`

Parameters:

  • body —

    TSP Account

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

    the optional parameters

Returns:

  • (nil) 


75
76
77
78
 
# File 'lib/zoom_us/tsp.rb', line 75

def tsp_update(body, opts = {})
  tsp_update_with_http_info(body, opts)
  nil
end

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

Update account&#39;s TSP information Update information of the Telephony Service Provider set up on an account.&lt;br&gt; Prerequisites:&lt;br&gt; TSP account option should be enabled.&lt;br&gt; Scopes: &#x60;tsp:write:admin&#x60; &#x60;tsp:write&#x60;&lt;br&gt;

Parameters:

  • body —

    TSP Account

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



85
86
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
 
# File 'lib/zoom_us/tsp.rb', line 85

def tsp_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.tsp_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 TSPApi.tsp_update"
  end
  # resource path
  local_var_path = '/tsp'

  # 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: TSPApi#tsp_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tsp_url_update(user_id, opts = {}) ⇒ nil

Set Global Dial-in URL for a TSP User A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. <p></p> Scopes:‘tsp:write:admin` `tsp:write`

Parameters:

  • user_id —

    The userId or email address of the user.

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

    the optional parameters

Options Hash (opts):

  • :body (TSPGlobalDialInURLSetting) —

    Global dial-in URL of the user.

Returns:

  • (nil) 


129
130
131
132
 
# File 'lib/zoom_us/tsp.rb', line 129

def tsp_url_update(user_id, opts = {})
  tsp_url_update_with_http_info(user_id, opts)
  nil
end

#tsp_url_update_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set Global Dial-in URL for a TSP User A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. &lt;p&gt;&lt;/p&gt; Scopes:&#x60;tsp:write:admin&#x60; &#x60;tsp:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The userId or email address of the user.

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

    the optional parameters

Options Hash (opts):

  • :body (TSPGlobalDialInURLSetting) —

    Global dial-in URL of the user.

Returns:

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

    nil, response status code and response headers



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
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/zoom_us/tsp.rb', line 140

def tsp_url_update_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.tsp_url_update ...'
  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 TSPApi.tsp_url_update"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp/settings'.sub('{' + 'userId' + '}', user_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TSPApi#tsp_url_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tsp_with_http_info(opts = {}) ⇒ Array<(InlineResponse20045, Fixnum, Hash)>

Get Account&#39;s TSP Information Get information on Telephony Service Provider on an account level.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:read:admin&#x60; &#x60;tsp:read&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * A Pro or a higher plan.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20045 data, response status code and response headers



35
36
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
 
# File 'lib/zoom_us/tsp.rb', line 35

def tsp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.tsp ...'
  end
  # resource path
  local_var_path = '/tsp'

  # 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 => 'InlineResponse20045')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TSPApi#tsp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_ts_ps(user_id, opts = {}) ⇒ InlineResponse20050

List User’s TSP accounts A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.
Scopes: ‘tsp:read:admin` `tsp:read`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

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

    the optional parameters

Returns:

  • (InlineResponse20050) 


183
184
185
186
 
# File 'lib/zoom_us/tsp.rb', line 183

def user_ts_ps(user_id, opts = {})
  data, _status_code, _headers = user_ts_ps_with_http_info(user_id, opts)
  data
end

#user_ts_ps_with_http_info(user_id, opts = {}) ⇒ Array<(InlineResponse20050, Fixnum, Hash)>

List User&#39;s TSP accounts A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:read:admin&#x60; &#x60;tsp:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

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

    the optional parameters

Returns:

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

    InlineResponse20050 data, response status code and response headers



193
194
195
196
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
 
# File 'lib/zoom_us/tsp.rb', line 193

def user_ts_ps_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.user_ts_ps ...'
  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 TSPApi.user_ts_ps"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp'.sub('{' + 'userId' + '}', user_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 => 'InlineResponse20050')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TSPApi#user_ts_ps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tsp(user_id, tsp_id, opts = {}) ⇒ TSPAccount

Get a User’s TSP Account Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.
Scopes: ‘tsp:read:admin` `tsp:read`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

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

    the optional parameters

Returns:

  • (TSPAccount) 


238
239
240
241
 
# File 'lib/zoom_us/tsp.rb', line 238

def user_tsp(user_id, tsp_id, opts = {})
  data, _status_code, _headers = user_tsp_with_http_info(user_id, tsp_id, opts)
  data
end

#user_tsp_create(user_id, body, opts = {}) ⇒ TSPAccountsList2

Add a User’s TSP Account Add a user’s TSP account.
Scopes: ‘tsp:write:admin` `tsp:write`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    TSP account.

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

    the optional parameters

Returns:

  • (TSPAccountsList2) 


302
303
304
305
 
# File 'lib/zoom_us/tsp.rb', line 302

def user_tsp_create(user_id, body, opts = {})
  data, _status_code, _headers = user_tsp_create_with_http_info(user_id, body, opts)
  data
end

#user_tsp_create_with_http_info(user_id, body, opts = {}) ⇒ Array<(TSPAccountsList2, Fixnum, Hash)>

Add a User&#39;s TSP Account Add a user&#39;s TSP account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:write:admin&#x60; &#x60;tsp:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    TSP account.

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

    the optional parameters

Returns:

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

    TSPAccountsList2 data, response status code and response headers



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/zoom_us/tsp.rb', line 313

def user_tsp_create_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.user_tsp_create ...'
  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 TSPApi.user_tsp_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 TSPApi.user_tsp_create"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp'.sub('{' + 'userId' + '}', user_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(: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 => 'TSPAccountsList2')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TSPApi#user_tsp_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tsp_delete(user_id, tsp_id, opts = {}) ⇒ nil

Delete a User’s TSP Account Delete a user’s TSP account.
Scopes: ‘tsp:write:admin` `tsp:write`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

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

    the optional parameters

Returns:

  • (nil) 


362
363
364
365
 
# File 'lib/zoom_us/tsp.rb', line 362

def user_tsp_delete(user_id, tsp_id, opts = {})
  user_tsp_delete_with_http_info(user_id, tsp_id, opts)
  nil
end

#user_tsp_delete_with_http_info(user_id, tsp_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a User&#39;s TSP Account Delete a user&#39;s TSP account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:write:admin&#x60; &#x60;tsp:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/zoom_us/tsp.rb', line 373

def user_tsp_delete_with_http_info(user_id, tsp_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.user_tsp_delete ...'
  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 TSPApi.user_tsp_delete"
  end
  # verify the required parameter 'tsp_id' is set
  if @api_client.config.client_side_validation && tsp_id.nil?
    fail ArgumentError, "Missing the required parameter 'tsp_id' when calling TSPApi.user_tsp_delete"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['1', '2'].include?(tsp_id)
    fail ArgumentError, "invalid value for 'tsp_id', must be one of 1, 2"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp/{tspId}'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'tspId' + '}', tsp_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: TSPApi#user_tsp_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tsp_update(user_id, tsp_id, body, opts = {}) ⇒ nil

Update a TSP Account Update a user’s TSP account.
Scopes: ‘tsp:write:admin` `tsp:write`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

  • body —

    TSP account.

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

    the optional parameters

Returns:

  • (nil) 


426
427
428
429
 
# File 'lib/zoom_us/tsp.rb', line 426

def user_tsp_update(user_id, tsp_id, body, opts = {})
  user_tsp_update_with_http_info(user_id, tsp_id, body, opts)
  nil
end

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

Update a TSP Account Update a user&#39;s TSP account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:write:admin&#x60; &#x60;tsp:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

  • body —

    TSP account.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/zoom_us/tsp.rb', line 438

def user_tsp_update_with_http_info(user_id, tsp_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.user_tsp_update ...'
  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 TSPApi.user_tsp_update"
  end
  # verify the required parameter 'tsp_id' is set
  if @api_client.config.client_side_validation && tsp_id.nil?
    fail ArgumentError, "Missing the required parameter 'tsp_id' when calling TSPApi.user_tsp_update"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['1', '2'].include?(tsp_id)
    fail ArgumentError, "invalid value for 'tsp_id', must be one of 1, 2"
  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 TSPApi.user_tsp_update"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp/{tspId}'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'tspId' + '}', tsp_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: TSPApi#user_tsp_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_tsp_with_http_info(user_id, tsp_id, opts = {}) ⇒ Array<(TSPAccount, Fixnum, Hash)>

Get a User&#39;s TSP Account Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.&lt;br&gt;&lt;br&gt; Scopes: &#x60;tsp:read:admin&#x60; &#x60;tsp:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • tsp_id —

    TSP account ID.

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

    the optional parameters

Returns:

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

    TSPAccount data, response status code and response headers



249
250
251
252
253
254
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
294
295
 
# File 'lib/zoom_us/tsp.rb', line 249

def user_tsp_with_http_info(user_id, tsp_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TSPApi.user_tsp ...'
  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 TSPApi.user_tsp"
  end
  # verify the required parameter 'tsp_id' is set
  if @api_client.config.client_side_validation && tsp_id.nil?
    fail ArgumentError, "Missing the required parameter 'tsp_id' when calling TSPApi.user_tsp"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['1', '2'].include?(tsp_id)
    fail ArgumentError, "invalid value for 'tsp_id', must be one of 1, 2"
  end
  # resource path
  local_var_path = '/users/{userId}/tsp/{tspId}'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'tspId' + '}', tsp_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 => 'TSPAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TSPApi#user_tsp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end