Class: PureCloud::IntegrationsWorkforceManagementApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsWorkforceManagementApi

Returns a new instance of IntegrationsWorkforceManagementApi.



7
8
9
 
# File 'lib/purecloud/api/integrations_workforce_management_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/integrations_workforce_management_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#post_workforcemanagement_vendorconnection(opts = {}) ⇒ UserActionCategoryEntityListing

Add a vendor connection

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



16
17
18
19
 
# File 'lib/purecloud/api/integrations_workforce_management_api.rb', line 16

def post_workforcemanagement_vendorconnection(opts = {})
  data, status_code, headers = post_workforcemanagement_vendorconnection_with_http_info(opts)
  return data
end

#post_workforcemanagement_vendorconnection_with_http_info(opts = {}) ⇒ Array<(UserActionCategoryEntityListing, Fixnum, Hash)>

Add a vendor connection

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



26
27
28
29
30
31
32
33
34
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
 
# File 'lib/purecloud/api/integrations_workforce_management_api.rb', line 26

def post_workforcemanagement_vendorconnection_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsWorkforceManagementApi#post_workforcemanagement_vendorconnection ..."
  end
  
  # resource path
  path = "/api/v2/integrations/workforcemanagement/vendorconnection".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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserActionCategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsWorkforceManagementApi#post_workforcemanagement_vendorconnection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end