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

#get_journey_session_events(session_id, opts = {}) ⇒ EventListing

Retrieve all events for a given session.

Parameters:

  • session_id —

    System-generated UUID that represents the session the event is a part of.

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

    the optional parameters

Options Hash (opts):

  • :before (String) —

    The cursor that points to the start of the set of entities that has been returned.

  • :after (String) —

    The cursor that points to the end of the set of entities that has been returned.

  • :limit (String) —

    Number of entities to return. Maximum of 200.

Returns:



35
36
37
38
 
# File 'lib/purecloudplatformclientv2/api/journey_api.rb', line 35

def get_journey_session_events(session_id, opts = {})
  data, _status_code, _headers = get_journey_session_events_with_http_info(session_id, opts)
  return data
end

#get_journey_session_events_with_http_info(session_id, opts = {}) ⇒ Array<(EventListing, Fixnum, Hash)>

Retrieve all events for a given session.

Parameters:

  • session_id —

    System-generated UUID that represents the session the event is a part of.

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

    the optional parameters

Options Hash (opts):

  • :before (String) —

    The cursor that points to the start of the set of entities that has been returned.

  • :after (String) —

    The cursor that points to the end of the set of entities that has been returned.

  • :limit (String) —

    Number of entities to return. Maximum of 200.

Returns:

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

    EventListing data, response status code and response headers



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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/purecloudplatformclientv2/api/journey_api.rb', line 48

def get_journey_session_events_with_http_info(session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JourneyApi.get_journey_session_events ..."
  end
  
  
  # verify the required parameter 'session_id' is set
  fail ArgumentError, "Missing the required parameter 'session_id' when calling JourneyApi.get_journey_session_events" if session_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/journey/sessions/{sessionId}/events".sub('{format}','json').sub('{' + 'sessionId' + '}', session_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'before'] = opts[:'before'] if opts[:'before']
  query_params[:'after'] = opts[:'after'] if opts[:'after']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']

  # 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 = nil
  
  auth_names = ['PureCloud OAuth']
  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 => 'EventListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JourneyApi#get_journey_session_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end