Class: WhopSDK::Models::EventCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::EventCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/event_create_params.rb,
sig/whop_sdk/models/event_create_params.rbs

Overview

See Also:

• WhopSDK::Resources::Events#create

Defined Under Namespace

Modules: ActionSource, Currency, EventName Classes: Context, User

Instance Attribute Summary

• #account_id ⇒ String

  The account to associate with this event.

• #action_source ⇒ Symbol, ...

  The channel where an event originated.

• #context ⇒ WhopSDK::Models::EventCreateParams::Context^?

  Tracking and attribution context.

• #currency ⇒ Symbol, ...

  The available currencies on the platform.

• #custom_name ⇒ String^?

  Custom event name when event_name is 'custom'.

• #duration ⇒ Integer^?

  For 'leave' events: milliseconds the visitor spent on the page.

• #event_id ⇒ String^?

  Client-provided identifier for deduplication.

• #event_name ⇒ Symbol, WhopSDK::Models::EventCreateParams::EventName

  The type of conversion or engagement event.

• #event_time ⇒ Time^?

  When the event occurred.

• #plan_id ⇒ String^?

  The plan associated with the event.

• #product_id ⇒ String^?

  The product associated with the event.

• #referrer_url ⇒ String^?

  The referring URL.

• #resumed ⇒ Boolean^?

  For 'page' events: true when the page was restored from the back/forward cache.

• #source ⇒ String^?

  For 'identify' events: where the identity was captured (url, form, manual, iframe).

• #title ⇒ String^?

  For 'page' events: the document title.

• #url ⇒ String^?

  The URL where the event occurred.

• #user ⇒ WhopSDK::Models::EventCreateParams::User^?

  User identity and profile data.

• #value ⇒ Float^?

  Monetary value associated with the event.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(ad_campaign_id: nil, ad_id: nil, ad_set_id: nil, fbc: nil, fbclid: nil, fbp: nil, fingerprint: nil, fingerprint_confidence: nil, ga: nil, gbraid: nil, gclid: nil, ig_sid: nil, ip_address: nil, language: nil, li_fat_id: nil, msclkid: nil, rdt_cid: nil, sccid: nil, screen_resolution: nil, timezone: nil, ttclid: nil, ttp: nil, twclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_id: nil, utm_medium: nil, utm_source: nil, utm_term: nil, wbraid: nil) ⇒ Object constructor

  Tracking and attribution context.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(ad_campaign_id: nil, ad_id: nil, ad_set_id: nil, fbc: nil, fbclid: nil, fbp: nil, fingerprint: nil, fingerprint_confidence: nil, ga: nil, gbraid: nil, gclid: nil, ig_sid: nil, ip_address: nil, language: nil, li_fat_id: nil, msclkid: nil, rdt_cid: nil, sccid: nil, screen_resolution: nil, timezone: nil, ttclid: nil, ttp: nil, twclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_id: nil, utm_medium: nil, utm_source: nil, utm_term: nil, wbraid: nil) ⇒ Object

Tracking and attribution context.

Parameters:

• ad_campaign_id (String, nil) (defaults to: nil) —

  Ad campaign ID.

• ad_id (String, nil) (defaults to: nil) —

  Ad ID.

• ad_set_id (String, nil) (defaults to: nil) —

  Ad set ID.

• fbc (String, nil) (defaults to: nil) —

  Facebook click cookie (_fbc, format fb.1.timestamp.fbclid).

• fbclid (String, nil) (defaults to: nil) —

  Facebook click ID.

• fbp (String, nil) (defaults to: nil) —

  Facebook browser pixel ID.

• fingerprint (String, nil) (defaults to: nil) —

  Client-side device fingerprint.

• fingerprint_confidence (Float, nil) (defaults to: nil) —

  Confidence score (0-1) for the device fingerprint.

• ga (String, nil) (defaults to: nil) —

  Google Analytics client ID.

• gbraid (String, nil) (defaults to: nil) —

  Google Ads gbraid click ID (iOS privacy).

• gclid (String, nil) (defaults to: nil) —

  Google click ID.

• ig_sid (String, nil) (defaults to: nil) —

  Instagram session ID.

• ip_address (String, nil) (defaults to: nil) —

  IP address.

• language (String, nil) (defaults to: nil) —

  Browser language (e.g. en-US).

• li_fat_id (String, nil) (defaults to: nil) —

  LinkedIn click ID.

• msclkid (String, nil) (defaults to: nil) —

  Microsoft Advertising (Bing) click ID.

• rdt_cid (String, nil) (defaults to: nil) —

  Reddit click ID.

• sccid (String, nil) (defaults to: nil) —

  Snapchat click ID.

• screen_resolution (String, nil) (defaults to: nil) —

  Screen resolution (e.g. 1920x1080).

• timezone (String, nil) (defaults to: nil) —

  IANA timezone (e.g. America/New_York).

• ttclid (String, nil) (defaults to: nil) —

  TikTok click ID.

• ttp (String, nil) (defaults to: nil) —

  TikTok pixel ID.

• twclid (String, nil) (defaults to: nil) —

  X (Twitter) click ID.

• user_agent (String, nil) (defaults to: nil) —

  Browser user agent string.

• utm_campaign (String, nil) (defaults to: nil) —

  UTM campaign parameter.

• utm_content (String, nil) (defaults to: nil) —

  UTM content parameter.

• utm_id (String, nil) (defaults to: nil) —

  UTM ID parameter.

• utm_medium (String, nil) (defaults to: nil) —

  UTM medium parameter.

• utm_source (String, nil) (defaults to: nil) —

  UTM source parameter.

• utm_term (String, nil) (defaults to: nil) —

  UTM term parameter.

• wbraid (String, nil) (defaults to: nil) —

  Google Ads wbraid click ID (iOS privacy).

# File 'lib/whop_sdk/models/event_create_params.rb', line 119

Instance Attribute Details

#account_id ⇒ String

The account to associate with this event.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/event_create_params.rb', line 14

required :account_id, String

#action_source ⇒ Symbol, ...

The channel where an event originated

Parameters:

• value (WhopSDK::Models::EventCreateParams::action_source, nil)

Returns:

• (Symbol, WhopSDK::Models::EventCreateParams::ActionSource, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 26

optional :action_source, enum: -> { WhopSDK::EventCreateParams::ActionSource }, nil?: true

#context ⇒ WhopSDK::Models::EventCreateParams::Context^?

Tracking and attribution context.

Parameters:

• value (WhopSDK::EventCreateParams::Context, nil)

Returns:

• (WhopSDK::Models::EventCreateParams::Context, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 32

optional :context, -> { WhopSDK::EventCreateParams::Context }, nil?: true

#currency ⇒ Symbol, ...

The available currencies on the platform

Parameters:

• value (WhopSDK::Models::EventCreateParams::currency, nil)

Returns:

• (Symbol, WhopSDK::Models::EventCreateParams::Currency, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 38

optional :currency, enum: -> { WhopSDK::EventCreateParams::Currency }, nil?: true

#custom_name ⇒ String^?

Custom event name when event_name is 'custom'. Maximum 35 chars for this value.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 44

optional :custom_name, String, nil?: true

#duration ⇒ Integer^?

For 'leave' events: milliseconds the visitor spent on the page.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 50

optional :duration, Integer, nil?: true

#event_id ⇒ String^?

Client-provided identifier for deduplication. Generated if omitted.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 56

optional :event_id, String, nil?: true

#event_name ⇒ Symbol, WhopSDK::Models::EventCreateParams::EventName

The type of conversion or engagement event

Parameters:

• value (WhopSDK::Models::EventCreateParams::event_name)

Returns:

• (Symbol, WhopSDK::Models::EventCreateParams::EventName)

# File 'lib/whop_sdk/models/event_create_params.rb', line 20

required :event_name, enum: -> { WhopSDK::EventCreateParams::EventName }

#event_time ⇒ Time^?

When the event occurred. Defaults to now.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 62

optional :event_time, Time, nil?: true

#plan_id ⇒ String^?

The plan associated with the event.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 68

optional :plan_id, String, nil?: true

#product_id ⇒ String^?

The product associated with the event.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 74

optional :product_id, String, nil?: true

#referrer_url ⇒ String^?

The referring URL.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 80

optional :referrer_url, String, nil?: true

#resumed ⇒ Boolean^?

For 'page' events: true when the page was restored from the back/forward cache.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 86

optional :resumed, WhopSDK::Internal::Type::Boolean, nil?: true

#source ⇒ String^?

For 'identify' events: where the identity was captured (url, form, manual, iframe).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 93

optional :source, String, nil?: true

#title ⇒ String^?

For 'page' events: the document title.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 99

optional :title, String, nil?: true

#url ⇒ String^?

The URL where the event occurred.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 105

optional :url, String, nil?: true

#user ⇒ WhopSDK::Models::EventCreateParams::User^?

User identity and profile data.

Parameters:

• value (WhopSDK::EventCreateParams::User, nil)

Returns:

• (WhopSDK::Models::EventCreateParams::User, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 111

optional :user, -> { WhopSDK::EventCreateParams::User }, nil?: true

#value ⇒ Float^?

Monetary value associated with the event.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/event_create_params.rb', line 117

optional :value, Float, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/event_create_params.rb', line 175

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/event_create_params.rbs', line 88

def to_hash: -> {