Class: PureCloud::AttributesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/attributes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AttributesApi

Returns a new instance of AttributesApi.



23
24
25
 
# File 'lib/purecloud/api/attributes_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/purecloud/api/attributes_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_attribute_id(attribute_id, opts = {}) ⇒ nil

Delete an existing Attribute. This will remove attribute.

Parameters:

  • attribute_id —

    Attribute ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloud/api/attributes_api.rb', line 32

def delete_attribute_id(attribute_id, opts = {})
  delete_attribute_id_with_http_info(attribute_id, opts)
  return nil
end

#delete_attribute_id_with_http_info(attribute_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an existing Attribute. This will remove attribute.

Parameters:

  • attribute_id —

    Attribute ID

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

    the optional parameters

Returns:

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

    nil, 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
83
84
 
# File 'lib/purecloud/api/attributes_api.rb', line 42

def delete_attribute_id_with_http_info(attribute_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#delete_attribute_id ..."
  end
  
  # verify the required parameter 'attribute_id' is set
  fail "Missing the required parameter 'attribute_id' when calling delete_attribute_id" if attribute_id.nil?
  
  # resource path
  local_var_path = "/api/v2/attributes/{attributeId}".sub('{format}','json').sub('{' + 'attributeId' + '}', attribute_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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(: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: AttributesApi#delete_attribute_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attribute_id(attribute_id, opts = {}) ⇒ Attribute

Get details about an existing attribute.

Parameters:

  • attribute_id —

    Attribute ID

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/purecloud/api/attributes_api.rb', line 91

def get_attribute_id(attribute_id, opts = {})
  data, status_code, headers = get_attribute_id_with_http_info(attribute_id, opts)
  return data
end

#get_attribute_id_with_http_info(attribute_id, opts = {}) ⇒ Array<(Attribute, Fixnum, Hash)>

Get details about an existing attribute.

Parameters:

  • attribute_id —

    Attribute ID

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

    the optional parameters

Returns:

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

    Attribute data, response status code and response headers



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
136
137
138
139
140
141
142
143
144
 
# File 'lib/purecloud/api/attributes_api.rb', line 101

def get_attribute_id_with_http_info(attribute_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#get_attribute_id ..."
  end
  
  # verify the required parameter 'attribute_id' is set
  fail "Missing the required parameter 'attribute_id' when calling get_attribute_id" if attribute_id.nil?
  
  # resource path
  local_var_path = "/api/v2/attributes/{attributeId}".sub('{format}','json').sub('{' + 'attributeId' + '}', attribute_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Attribute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AttributesApi#get_attribute_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attributes(opts = {}) ⇒ AttributeEntityListing

Gets a list of existing attributes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



152
153
154
155
 
# File 'lib/purecloud/api/attributes_api.rb', line 152

def get_attributes(opts = {})
  data, status_code, headers = get_attributes_with_http_info(opts)
  return data
end

#get_attributes_with_http_info(opts = {}) ⇒ Array<(AttributeEntityListing, Fixnum, Hash)>

Gets a list of existing attributes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    AttributeEntityListing data, response status code and response headers



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloud/api/attributes_api.rb', line 163

def get_attributes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#get_attributes ..."
  end
  
  # resource path
  local_var_path = "/api/v2/attributes".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AttributeEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AttributesApi#get_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_attributes(body, opts = {}) ⇒ Attribute

Create an attribute.

Parameters:

  • body —

    Attribute

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

    the optional parameters

Returns:



212
213
214
215
 
# File 'lib/purecloud/api/attributes_api.rb', line 212

def post_attributes(body, opts = {})
  data, status_code, headers = post_attributes_with_http_info(body, opts)
  return data
end

#post_attributes_with_http_info(body, opts = {}) ⇒ Array<(Attribute, Fixnum, Hash)>

Create an attribute.

Parameters:

  • body —

    Attribute

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

    the optional parameters

Returns:

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

    Attribute data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloud/api/attributes_api.rb', line 222

def post_attributes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#post_attributes ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_attributes" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/attributes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_query(body, opts = {}) ⇒ AttributeEntityListing

Query attributes

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/purecloud/api/attributes_api.rb', line 272

def post_query(body, opts = {})
  data, status_code, headers = post_query_with_http_info(body, opts)
  return data
end

#post_query_with_http_info(body, opts = {}) ⇒ Array<(AttributeEntityListing, Fixnum, Hash)>

Query attributes

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    AttributeEntityListing data, response status code and response headers



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/purecloud/api/attributes_api.rb', line 282

def post_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#post_query ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_query" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/attributes/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_attribute_id(attribute_id, body, opts = {}) ⇒ Attribute

Update an existing attribute. Fields that can be updated: name, description. The most recent version is required for updates.

Parameters:

  • attribute_id —

    Attribute ID

  • body —

    Attribute

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

    the optional parameters

Returns:



333
334
335
336
 
# File 'lib/purecloud/api/attributes_api.rb', line 333

def put_attribute_id(attribute_id, body, opts = {})
  data, status_code, headers = put_attribute_id_with_http_info(attribute_id, body, opts)
  return data
end

#put_attribute_id_with_http_info(attribute_id, body, opts = {}) ⇒ Array<(Attribute, Fixnum, Hash)>

Update an existing attribute. Fields that can be updated: name, description. The most recent version is required for updates.

Parameters:

  • attribute_id —

    Attribute ID

  • body —

    Attribute

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

    the optional parameters

Returns:

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

    Attribute data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/purecloud/api/attributes_api.rb', line 344

def put_attribute_id_with_http_info(attribute_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AttributesApi#put_attribute_id ..."
  end
  
  # verify the required parameter 'attribute_id' is set
  fail "Missing the required parameter 'attribute_id' when calling put_attribute_id" if attribute_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_attribute_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/attributes/{attributeId}".sub('{format}','json').sub('{' + 'attributeId' + '}', attribute_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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