Class: WhopSDK::Resources::Conversions

Inherits:

Object

• Object
• WhopSDK::Resources::Conversions

Defined in:

lib/whop_sdk/resources/conversions.rb

Overview

Conversions

Instance Method Summary

• #create(company_id:, event_name:, action_source: nil, context: nil, currency: nil, custom_name: nil, event_id: nil, event_time: nil, plan_id: nil, product_id: nil, referrer_url: nil, url: nil, user: nil, value: nil, request_options: {}) ⇒ WhopSDK::Models::ConversionCreateResponse

  Track a conversion or engagement event for a company.

• #initialize(client:) ⇒ Conversions constructor private

  A new instance of Conversions.

Constructor Details

#initialize(client:) ⇒ Conversions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Conversions.

Parameters:

• client (WhopSDK::Client)

# File 'lib/whop_sdk/resources/conversions.rb', line 62

def initialize(client:)
  @client = client
end

Instance Method Details

#create(company_id:, event_name:, action_source: nil, context: nil, currency: nil, custom_name: nil, event_id: nil, event_time: nil, plan_id: nil, product_id: nil, referrer_url: nil, url: nil, user: nil, value: nil, request_options: {}) ⇒ WhopSDK::Models::ConversionCreateResponse

Track a conversion or engagement event for a company.

Required permissions:

• ‘event:create`

Parameters:

• company_id (String) —

  The company to associate with this event.

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

  The type of event.

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

  The channel where an event originated

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

  Tracking and attribution context.

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

  The available currencies on the platform

• custom_name (String, nil) —

  Custom event name when event_name is ‘custom’.

• event_id (String, nil) —

  Client-provided identifier for deduplication. Generated if omitted.

• event_time (Time, nil) —

  When the event occurred. Defaults to now.

• plan_id (String, nil) —

  The plan associated with the event.

• product_id (String, nil) —

  The product associated with the event.

• referrer_url (String, nil) —

  The referring URL.

• url (String, nil) —

  The URL where the event occurred.

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

  User identity and profile data.

• value (Float, nil) —

  Monetary value associated with the event.

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::ConversionCreateResponse)

See Also:

• Models::ConversionCreateParams

# File 'lib/whop_sdk/resources/conversions.rb', line 48

def create(params)
  parsed, options = WhopSDK::ConversionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "conversions",
    body: parsed,
    model: WhopSDK::Models::ConversionCreateResponse,
    options: options
  )
end