Class: PureCloud::ObjectsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ObjectsApi

Returns a new instance of ObjectsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_objects_object_id(object_id, opts = {}) ⇒ AuthzObject

Returns a permission-protected object, showing the permission contexts it belongs to.

Parameters:

  • object_id —

    Object ID

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

    the optional parameters

Returns:



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

def get_objects_object_id(object_id, opts = {})
  data, status_code, headers = get_objects_object_id_with_http_info(object_id, opts)
  return data
end

#get_objects_object_id_with_http_info(object_id, opts = {}) ⇒ Array<(AuthzObject, Fixnum, Hash)>

Returns a permission-protected object, showing the permission contexts it belongs to.

Parameters:

  • object_id —

    Object ID

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

    the optional parameters

Returns:

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

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

def get_objects_object_id_with_http_info(object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ObjectsApi#get_objects_object_id ..."
  end
  
  # verify the required parameter 'object_id' is set
  fail "Missing the required parameter 'object_id' when calling get_objects_object_id" if object_id.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/objects/{objectId}".sub('{format}','json').sub('{' + 'objectId' + '}', object_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 => 'AuthzObject')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectsApi#get_objects_object_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end