Class: PureCloud::IntegrationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi

Returns a new instance of IntegrationsApi.



7
8
9
 
# File 'lib/purecloud/api/integrations_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_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#get_types(opts = {}) ⇒ IntegrationTypeEntityListing

List integration types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



21
22
23
24
 
# File 'lib/purecloud/api/integrations_api.rb', line 21

def get_types(opts = {})
  data, status_code, headers = get_types_with_http_info(opts)
  return data
end

#get_types_id(id, opts = {}) ⇒ IntegrationType

Get integration type.

Parameters:

  • id —

    Integration Type Id

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/purecloud/api/integrations_api.rb', line 90

def get_types_id(id, opts = {})
  data, status_code, headers = get_types_id_with_http_info(id, opts)
  return data
end

#get_types_id_with_http_info(id, opts = {}) ⇒ Array<(IntegrationType, Fixnum, Hash)>

Get integration type.

Parameters:

  • id —

    Integration Type Id

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

    the optional parameters

Returns:

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

    IntegrationType data, response status code and response headers



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

def get_types_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi#get_types_id ..."
  end
  
  # verify the required parameter 'id' is set
  fail "Missing the required parameter 'id' when calling get_types_id" if id.nil?
  
  # resource path
  path = "/api/v2/integrations/types/{id}".sub('{format}','json').sub('{' + 'id' + '}', 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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_types_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_types_with_http_info(opts = {}) ⇒ Array<(IntegrationTypeEntityListing, Fixnum, Hash)>

List integration types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloud/api/integrations_api.rb', line 36

def get_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi#get_types ..."
  end
  
  # resource path
  path = "/api/v2/integrations/types".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationTypeEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end