Class: WhopSDK::Models::ConversionCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/conversion_create_params.rb

Overview

See Also:

• Resources::Conversions#create

Defined Under Namespace

Modules: ActionSource, EventName Classes: Context, User

Instance Attribute Summary

• #action_source ⇒ Symbol, ...

  The channel where an event originated.

• #company_id ⇒ String

  The company to associate with this event.

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

  Tracking and attribution context.

• #currency ⇒ Symbol, ...

  The available currencies on the platform.

• #custom_name ⇒ String^?

  Custom event name when event_name is ‘custom’.

• #event_id ⇒ String^?

  Client-provided identifier for deduplication.

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

  The type of 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.

• #url ⇒ String^?

  The URL where the event occurred.

• #user ⇒ WhopSDK::Models::ConversionCreateParams::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, fbclid: nil, fbp: nil, ga: nil, gclid: nil, ig_sid: nil, ip_address: nil, ttclid: nil, ttp: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_id: nil, utm_medium: nil, utm_source: nil, utm_term: nil) ⇒ Object constructor

  Tracking and attribution context.

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, fbclid: nil, fbp: nil, ga: nil, gclid: nil, ig_sid: nil, ip_address: nil, ttclid: nil, ttp: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_id: nil, utm_medium: nil, utm_source: nil, utm_term: 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.

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

  Facebook click ID.

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

  Facebook browser pixel ID.

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

  Google Analytics client ID.

• 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.

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

  TikTok click ID.

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

  TikTok pixel 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.

# File 'lib/whop_sdk/models/conversion_create_params.rb', line 94

Instance Attribute Details

#action_source ⇒ Symbol, ...

The channel where an event originated

Returns:

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

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

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

#company_id ⇒ String

The company to associate with this event.

Returns:

• (String)

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

required :company_id, String

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

Tracking and attribution context.

Returns:

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

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

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

#currency ⇒ Symbol, ...

The available currencies on the platform

Returns:

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

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

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

#custom_name ⇒ String^?

Custom event name when event_name is ‘custom’.

Returns:

• (String, nil)

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

optional :custom_name, String, nil?: true

#event_id ⇒ String^?

Client-provided identifier for deduplication. Generated if omitted.

Returns:

• (String, nil)

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

optional :event_id, String, nil?: true

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

The type of event.

Returns:

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

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

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

#event_time ⇒ Time^?

When the event occurred. Defaults to now.

Returns:

• (Time, nil)

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

optional :event_time, Time, nil?: true

#plan_id ⇒ String^?

The plan associated with the event.

Returns:

• (String, nil)

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

optional :plan_id, String, nil?: true

#product_id ⇒ String^?

The product associated with the event.

Returns:

• (String, nil)

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

optional :product_id, String, nil?: true

#referrer_url ⇒ String^?

The referring URL.

Returns:

• (String, nil)

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

optional :referrer_url, String, nil?: true

#url ⇒ String^?

The URL where the event occurred.

Returns:

• (String, nil)

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

optional :url, String, nil?: true

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

User identity and profile data.

Returns:

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

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

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

#value ⇒ Float^?

Monetary value associated with the event.

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/conversion_create_params.rb', line 92

optional :value, Float, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/conversion_create_params.rb', line 136