Class: PureCloud::LicenseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/license_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LicenseApi

Returns a new instance of LicenseApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_license_definition(license_id, opts = {}) ⇒ LicenseDefinition

Get PureCloud license definition.

Parameters:

  • license_id —

    ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 32

def get_license_definition(license_id, opts = {})
  data, _status_code, _headers = get_license_definition_with_http_info(license_id, opts)
  return data
end

#get_license_definition_with_http_info(license_id, opts = {}) ⇒ Array<(LicenseDefinition, Fixnum, Hash)>

Get PureCloud license definition.

Parameters:

  • license_id —

    ID

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

    the optional parameters

Returns:

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

    LicenseDefinition data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 42

def get_license_definition_with_http_info(license_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definition ..."
  end
  # verify the required parameter 'license_id' is set
  fail ArgumentError, "Missing the required parameter 'license_id' when calling LicenseApi.get_license_definition" if license_id.nil?
  # resource path
  local_var_path = "/api/v2/license/definitions/{licenseId}".sub('{format}','json').sub('{' + 'licenseId' + '}', license_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_definitions(opts = {}) ⇒ LicenseDefinitionListing

Get all PureCloud license definitions available for the organization.

Parameters:

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 88

def get_license_definitions(opts = {})
  data, _status_code, _headers = get_license_definitions_with_http_info(opts)
  return data
end

#get_license_definitions_with_http_info(opts = {}) ⇒ Array<(LicenseDefinitionListing, Fixnum, Hash)>

Get all PureCloud license definitions available for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    LicenseDefinitionListing data, response status code and response headers



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
128
129
130
131
132
133
134
135
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 97

def get_license_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definitions ..."
  end
  # resource path
  local_var_path = "/api/v2/license/definitions".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_organization(opts = {}) ⇒ LicenseOrganization

Get license assignments for the organization.

Parameters:

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 141

def get_license_organization(opts = {})
  data, _status_code, _headers = get_license_organization_with_http_info(opts)
  return data
end

#get_license_organization_with_http_info(opts = {}) ⇒ Array<(LicenseOrganization, Fixnum, Hash)>

Get license assignments for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    LicenseOrganization data, response status code and response headers



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
186
187
188
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 150

def get_license_organization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_organization ..."
  end
  # resource path
  local_var_path = "/api/v2/license/organization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_user(user_id, opts = {}) ⇒ LicenseUser

Get licenses for specified user.

Parameters:

  • user_id —

    ID

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

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 195

def get_license_user(user_id, opts = {})
  data, _status_code, _headers = get_license_user_with_http_info(user_id, opts)
  return data
end

#get_license_user_with_http_info(user_id, opts = {}) ⇒ Array<(LicenseUser, Fixnum, Hash)>

Get licenses for specified user.

Parameters:

  • user_id —

    ID

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

    the optional parameters

Returns:

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

    LicenseUser data, response status code and response headers



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
245
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 205

def get_license_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_user ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling LicenseApi.get_license_user" if user_id.nil?
  # resource path
  local_var_path = "/api/v2/license/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_license_organization(opts = {}) ⇒ LicenseUpdateResponse

Update the organization’s license assignments in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



252
253
254
255
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 252

def post_license_organization(opts = {})
  data, _status_code, _headers = post_license_organization_with_http_info(opts)
  return data
end

#post_license_organization_with_http_info(opts = {}) ⇒ Array<(LicenseUpdateResponse, Fixnum, Hash)>

Update the organization&#39;s license assignments in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LicenseUpdateResponse data, response status code and response headers



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
296
297
298
299
300
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 262

def post_license_organization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.post_license_organization ..."
  end
  # resource path
  local_var_path = "/api/v2/license/organization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_license_users(opts = {}) ⇒ Hash<String, Object>

Fetch user licenses in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    The user IDs to fetch.

Returns:

  • (Hash<String, Object>) 


307
308
309
310
 
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 307

def post_license_users(opts = {})
  data, _status_code, _headers = post_license_users_with_http_info(opts)
  return data
end

#post_license_users_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Fetch user licenses in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    The user IDs to fetch.

Returns:

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

    Hash<String, Object> data, response status code and response headers



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/purecloudplatformclientv2/api/license_api.rb', line 317

def post_license_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.post_license_users ..."
  end
  # resource path
  local_var_path = "/api/v2/license/users".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['PureCloud Auth']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LicenseApi#post_license_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end