Class: VoucherifySdk::EventsApi

Inherits:

Object

• Object
• VoucherifySdk::EventsApi

Defined in:

lib/VoucherifySdk/api/events_api.rb

Instance Attribute Summary

• #api_client ⇒ Object

  Returns the value of attribute api_client.

Instance Method Summary

• #initialize(api_client = ApiClient.default) ⇒ EventsApi constructor

  A new instance of EventsApi.

• #track_custom_event(opts = {}) ⇒ EventsCreateResponseBody

  Track Custom Event To track a custom event, you create an event object.

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.

# File 'lib/VoucherifySdk/api/events_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.

# File 'lib/VoucherifySdk/api/events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#track_custom_event(opts = {}) ⇒ EventsCreateResponseBody

Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created.

Parameters:

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

  the optional parameters

Options Hash (opts):

• :events_create_request_body (EventsCreateRequestBody) —

  Specify the details of the custom event.

Returns:

• (EventsCreateResponseBody)

# File 'lib/VoucherifySdk/api/events_api.rb', line 27

def track_custom_event(opts = {})
  data, _status_code, _headers = track_custom_event_with_http_info(opts)
  data
end