Class: PureCloud::JourneyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JourneyApi

Returns a new instance of JourneyApi.



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

def api_client
  @api_client
end

Instance Method Details

#post_analytics_journeys_aggregates_query(body, opts = {}) ⇒ JourneyAggregateQueryResponse

Query for journey aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



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

def post_analytics_journeys_aggregates_query(body, opts = {})
  data, _status_code, _headers = post_analytics_journeys_aggregates_query_with_http_info(body, opts)
  return data
end

#post_analytics_journeys_aggregates_query_with_http_info(body, opts = {}) ⇒ Array<(JourneyAggregateQueryResponse, Fixnum, Hash)>

Query for journey aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



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/journey_api.rb', line 42

def post_analytics_journeys_aggregates_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JourneyApi.post_analytics_journeys_aggregates_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling JourneyApi.post_analytics_journeys_aggregates_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/journeys/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 => 'JourneyAggregateQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JourneyApi#post_analytics_journeys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end