Class: PureCloud::FlowsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FlowsApi

Returns a new instance of FlowsApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/flows_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/flows_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#post_analytics_flows_aggregates_query(body, opts = {}) ⇒ FlowAggregateQueryResponse

Query for flow aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



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

def post_analytics_flows_aggregates_query(body, opts = {})
  data, _status_code, _headers = post_analytics_flows_aggregates_query_with_http_info(body, opts)
  return data
end

#post_analytics_flows_aggregates_query_with_http_info(body, opts = {}) ⇒ Array<(FlowAggregateQueryResponse, Fixnum, Hash)>

Query for flow aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    FlowAggregateQueryResponse 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
86
87
88
89
90
 
# File 'lib/purecloudplatformclientv2/api/flows_api.rb', line 42

def post_analytics_flows_aggregates_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlowsApi.post_analytics_flows_aggregates_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling FlowsApi.post_analytics_flows_aggregates_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/flows/aggregates/query".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(body)
  
  auth_names = ['PureCloud OAuth']
  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 => 'FlowAggregateQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#post_analytics_flows_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_analytics_flows_observations_query(body, opts = {}) ⇒ FlowObservationQueryResponse

Query for flow observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/flows_api.rb', line 97

def post_analytics_flows_observations_query(body, opts = {})
  data, _status_code, _headers = post_analytics_flows_observations_query_with_http_info(body, opts)
  return data
end

#post_analytics_flows_observations_query_with_http_info(body, opts = {}) ⇒ Array<(FlowObservationQueryResponse, Fixnum, Hash)>

Query for flow observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloudplatformclientv2/api/flows_api.rb', line 107

def post_analytics_flows_observations_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlowsApi.post_analytics_flows_observations_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling FlowsApi.post_analytics_flows_observations_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/flows/observations/query".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(body)
  
  auth_names = ['PureCloud OAuth']
  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 => 'FlowObservationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#post_analytics_flows_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end