whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/{conversion_create_params.rb → event_create_params.rb}

@@ -2,47 +2,53 @@
 
 module WhopSDK
   module Models
-    # @see WhopSDK::Resources::Conversions#create
-    class ConversionCreateParams < WhopSDK::Internal::Type::BaseModel
+    # @see WhopSDK::Resources::Events#create
+    class EventCreateParams < WhopSDK::Internal::Type::BaseModel
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute company_id
-      #   The company to associate with this event.
+      # @!attribute account_id
+      #   The account to associate with this event.
       #
       #   @return [String]
-      required :company_id, String
+      required :account_id, String
 
       # @!attribute event_name
-      #   The type of event.
+      #   The type of conversion or engagement event
       #
-      #   @return [Symbol, WhopSDK::Models::ConversionCreateParams::EventName]
-      required :event_name, enum: -> { WhopSDK::ConversionCreateParams::EventName }
+      #   @return [Symbol, WhopSDK::Models::EventCreateParams::EventName]
+      required :event_name, enum: -> { WhopSDK::EventCreateParams::EventName }
 
       # @!attribute action_source
       #   The channel where an event originated
       #
-      #   @return [Symbol, WhopSDK::Models::ConversionCreateParams::ActionSource, nil]
-      optional :action_source, enum: -> { WhopSDK::ConversionCreateParams::ActionSource }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::EventCreateParams::ActionSource, nil]
+      optional :action_source, enum: -> { WhopSDK::EventCreateParams::ActionSource }, nil?: true
 
       # @!attribute context
       #   Tracking and attribution context.
       #
-      #   @return [WhopSDK::Models::ConversionCreateParams::Context, nil]
-      optional :context, -> { WhopSDK::ConversionCreateParams::Context }, nil?: true
+      #   @return [WhopSDK::Models::EventCreateParams::Context, nil]
+      optional :context, -> { WhopSDK::EventCreateParams::Context }, nil?: true
 
       # @!attribute currency
       #   The available currencies on the platform
       #
-      #   @return [Symbol, WhopSDK::Models::Currency, nil]
-      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::EventCreateParams::Currency, nil]
+      optional :currency, enum: -> { WhopSDK::EventCreateParams::Currency }, nil?: true
 
       # @!attribute custom_name
-      #   Custom event name when event_name is 'custom'.
+      #   Custom event name when event_name is 'custom'. Maximum 35 chars for this value.
       #
       #   @return [String, nil]
       optional :custom_name, String, nil?: true
 
+      # @!attribute duration
+      #   For 'leave' events: milliseconds the visitor spent on the page.
+      #
+      #   @return [Integer, nil]
+      optional :duration, Integer, nil?: true
+
       # @!attribute event_id
       #   Client-provided identifier for deduplication. Generated if omitted.
       #
@@ -73,6 +79,25 @@ module WhopSDK
       #   @return [String, nil]
       optional :referrer_url, String, nil?: true
 
+      # @!attribute resumed
+      #   For 'page' events: true when the page was restored from the back/forward cache.
+      #
+      #   @return [Boolean, nil]
+      optional :resumed, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute source
+      #   For 'identify' events: where the identity was captured (url, form, manual,
+      #   iframe).
+      #
+      #   @return [String, nil]
+      optional :source, String, nil?: true
+
+      # @!attribute title
+      #   For 'page' events: the document title.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
       # @!attribute url
       #   The URL where the event occurred.
       #
@@ -82,8 +107,8 @@ module WhopSDK
       # @!attribute user
       #   User identity and profile data.
       #
-      #   @return [WhopSDK::Models::ConversionCreateParams::User, nil]
-      optional :user, -> { WhopSDK::ConversionCreateParams::User }, nil?: true
+      #   @return [WhopSDK::Models::EventCreateParams::User, nil]
+      optional :user, -> { WhopSDK::EventCreateParams::User }, nil?: true
 
       # @!attribute value
       #   Monetary value associated with the event.
@@ -91,18 +116,23 @@ module WhopSDK
       #   @return [Float, nil]
       optional :value, Float, nil?: true
 
-      # @!method initialize(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: {})
-      #   @param company_id [String] The company to associate with this event.
+      # @!method initialize(account_id:, event_name:, action_source: nil, context: nil, currency: nil, custom_name: nil, duration: nil, event_id: nil, event_time: nil, plan_id: nil, product_id: nil, referrer_url: nil, resumed: nil, source: nil, title: nil, url: nil, user: nil, value: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::EventCreateParams} for more details.
+      #
+      #   @param account_id [String] The account to associate with this event.
       #
-      #   @param event_name [Symbol, WhopSDK::Models::ConversionCreateParams::EventName] The type of event.
+      #   @param event_name [Symbol, WhopSDK::Models::EventCreateParams::EventName] The type of conversion or engagement event
       #
-      #   @param action_source [Symbol, WhopSDK::Models::ConversionCreateParams::ActionSource, nil] The channel where an event originated
+      #   @param action_source [Symbol, WhopSDK::Models::EventCreateParams::ActionSource, nil] The channel where an event originated
       #
-      #   @param context [WhopSDK::Models::ConversionCreateParams::Context, nil] Tracking and attribution context.
+      #   @param context [WhopSDK::Models::EventCreateParams::Context, nil] Tracking and attribution context.
       #
-      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #   @param currency [Symbol, WhopSDK::Models::EventCreateParams::Currency, nil] The available currencies on the platform
       #
-      #   @param custom_name [String, nil] Custom event name when event_name is 'custom'.
+      #   @param custom_name [String, nil] Custom event name when event_name is 'custom'. Maximum 35 chars for this value.
+      #
+      #   @param duration [Integer, nil] For 'leave' events: milliseconds the visitor spent on the page.
       #
       #   @param event_id [String, nil] Client-provided identifier for deduplication. Generated if omitted.
       #
@@ -114,15 +144,21 @@ module WhopSDK
       #
       #   @param referrer_url [String, nil] The referring URL.
       #
+      #   @param resumed [Boolean, nil] For 'page' events: true when the page was restored from the back/forward cache.
+      #
+      #   @param source [String, nil] For 'identify' events: where the identity was captured (url, form, manual, ifram
+      #
+      #   @param title [String, nil] For 'page' events: the document title.
+      #
       #   @param url [String, nil] The URL where the event occurred.
       #
-      #   @param user [WhopSDK::Models::ConversionCreateParams::User, nil] User identity and profile data.
+      #   @param user [WhopSDK::Models::EventCreateParams::User, nil] User identity and profile data.
       #
       #   @param value [Float, nil] Monetary value associated with the event.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      # The type of event.
+      # The type of conversion or engagement event
       module EventName
         extend WhopSDK::Internal::Type::Enum
 
@@ -131,7 +167,10 @@ module WhopSDK
         CONTACT = :contact
         COMPLETE_REGISTRATION = :complete_registration
         SCHEDULE = :schedule
+        VIEW_CONTENT = :view_content
+        ADD_TO_CART = :add_to_cart
         CUSTOM = :custom
+        PAGE = :page
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -174,6 +213,12 @@ module WhopSDK
         #   @return [String, nil]
         optional :ad_set_id, String, nil?: true
 
+        # @!attribute fbc
+        #   Facebook click cookie (\_fbc, format fb.1.{timestamp}.{fbclid}).
+        #
+        #   @return [String, nil]
+        optional :fbc, String, nil?: true
+
         # @!attribute fbclid
         #   Facebook click ID.
         #
@@ -186,12 +231,30 @@ module WhopSDK
         #   @return [String, nil]
         optional :fbp, String, nil?: true
 
+        # @!attribute fingerprint
+        #   Client-side device fingerprint.
+        #
+        #   @return [String, nil]
+        optional :fingerprint, String, nil?: true
+
+        # @!attribute fingerprint_confidence
+        #   Confidence score (0-1) for the device fingerprint.
+        #
+        #   @return [Float, nil]
+        optional :fingerprint_confidence, Float, nil?: true
+
         # @!attribute ga
         #   Google Analytics client ID.
         #
         #   @return [String, nil]
         optional :ga, String, nil?: true
 
+        # @!attribute gbraid
+        #   Google Ads gbraid click ID (iOS privacy).
+        #
+        #   @return [String, nil]
+        optional :gbraid, String, nil?: true
+
         # @!attribute gclid
         #   Google click ID.
         #
@@ -210,6 +273,48 @@ module WhopSDK
         #   @return [String, nil]
         optional :ip_address, String, nil?: true
 
+        # @!attribute language
+        #   Browser language (e.g. en-US).
+        #
+        #   @return [String, nil]
+        optional :language, String, nil?: true
+
+        # @!attribute li_fat_id
+        #   LinkedIn click ID.
+        #
+        #   @return [String, nil]
+        optional :li_fat_id, String, nil?: true
+
+        # @!attribute msclkid
+        #   Microsoft Advertising (Bing) click ID.
+        #
+        #   @return [String, nil]
+        optional :msclkid, String, nil?: true
+
+        # @!attribute rdt_cid
+        #   Reddit click ID.
+        #
+        #   @return [String, nil]
+        optional :rdt_cid, String, nil?: true
+
+        # @!attribute sccid
+        #   Snapchat click ID.
+        #
+        #   @return [String, nil]
+        optional :sccid, String, nil?: true
+
+        # @!attribute screen_resolution
+        #   Screen resolution (e.g. 1920x1080).
+        #
+        #   @return [String, nil]
+        optional :screen_resolution, String, nil?: true
+
+        # @!attribute timezone
+        #   IANA timezone (e.g. America/New_York).
+        #
+        #   @return [String, nil]
+        optional :timezone, String, nil?: true
+
         # @!attribute ttclid
         #   TikTok click ID.
         #
@@ -222,6 +327,12 @@ module WhopSDK
         #   @return [String, nil]
         optional :ttp, String, nil?: true
 
+        # @!attribute twclid
+        #   X (Twitter) click ID.
+        #
+        #   @return [String, nil]
+        optional :twclid, String, nil?: true
+
         # @!attribute user_agent
         #   Browser user agent string.
         #
@@ -264,7 +375,13 @@ module WhopSDK
         #   @return [String, nil]
         optional :utm_term, String, nil?: true
 
-        # @!method 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)
+        # @!attribute wbraid
+        #   Google Ads wbraid click ID (iOS privacy).
+        #
+        #   @return [String, nil]
+        optional :wbraid, String, nil?: true
+
+        # @!method 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)
         #   Tracking and attribution context.
         #
         #   @param ad_campaign_id [String, nil] Ad campaign ID.
@@ -273,22 +390,46 @@ module WhopSDK
         #
         #   @param ad_set_id [String, nil] Ad set ID.
         #
+        #   @param fbc [String, nil] Facebook click cookie (\_fbc, format fb.1.{timestamp}.{fbclid}).
+        #
         #   @param fbclid [String, nil] Facebook click ID.
         #
         #   @param fbp [String, nil] Facebook browser pixel ID.
         #
+        #   @param fingerprint [String, nil] Client-side device fingerprint.
+        #
+        #   @param fingerprint_confidence [Float, nil] Confidence score (0-1) for the device fingerprint.
+        #
         #   @param ga [String, nil] Google Analytics client ID.
         #
+        #   @param gbraid [String, nil] Google Ads gbraid click ID (iOS privacy).
+        #
         #   @param gclid [String, nil] Google click ID.
         #
         #   @param ig_sid [String, nil] Instagram session ID.
         #
         #   @param ip_address [String, nil] IP address.
         #
+        #   @param language [String, nil] Browser language (e.g. en-US).
+        #
+        #   @param li_fat_id [String, nil] LinkedIn click ID.
+        #
+        #   @param msclkid [String, nil] Microsoft Advertising (Bing) click ID.
+        #
+        #   @param rdt_cid [String, nil] Reddit click ID.
+        #
+        #   @param sccid [String, nil] Snapchat click ID.
+        #
+        #   @param screen_resolution [String, nil] Screen resolution (e.g. 1920x1080).
+        #
+        #   @param timezone [String, nil] IANA timezone (e.g. America/New_York).
+        #
         #   @param ttclid [String, nil] TikTok click ID.
         #
         #   @param ttp [String, nil] TikTok pixel ID.
         #
+        #   @param twclid [String, nil] X (Twitter) click ID.
+        #
         #   @param user_agent [String, nil] Browser user agent string.
         #
         #   @param utm_campaign [String, nil] UTM campaign parameter.
@@ -302,6 +443,107 @@ module WhopSDK
         #   @param utm_source [String, nil] UTM source parameter.
         #
         #   @param utm_term [String, nil] UTM term parameter.
+        #
+        #   @param wbraid [String, nil] Google Ads wbraid click ID (iOS privacy).
+      end
+
+      # The available currencies on the platform
+      module Currency
+        extend WhopSDK::Internal::Type::Enum
+
+        USD = :usd
+        SGD = :sgd
+        INR = :inr
+        AUD = :aud
+        BRL = :brl
+        CAD = :cad
+        DKK = :dkk
+        EUR = :eur
+        NOK = :nok
+        GBP = :gbp
+        SEK = :sek
+        CHF = :chf
+        HKD = :hkd
+        HUF = :huf
+        JPY = :jpy
+        MXN = :mxn
+        MYR = :myr
+        PLN = :pln
+        CZK = :czk
+        NZD = :nzd
+        AED = :aed
+        ETH = :eth
+        APE = :ape
+        COP = :cop
+        RON = :ron
+        THB = :thb
+        BGN = :bgn
+        IDR = :idr
+        DOP = :dop
+        PHP = :php
+        TRY = :try
+        KRW = :krw
+        TWD = :twd
+        VND = :vnd
+        PKR = :pkr
+        CLP = :clp
+        UYU = :uyu
+        ARS = :ars
+        ZAR = :zar
+        DZD = :dzd
+        TND = :tnd
+        MAD = :mad
+        KES = :kes
+        KWD = :kwd
+        JOD = :jod
+        ALL = :all
+        XCD = :xcd
+        AMD = :amd
+        BSD = :bsd
+        BHD = :bhd
+        BOB = :bob
+        BAM = :bam
+        KHR = :khr
+        CRC = :crc
+        XOF = :xof
+        EGP = :egp
+        ETB = :etb
+        GMD = :gmd
+        GHS = :ghs
+        GTQ = :gtq
+        GYD = :gyd
+        ILS = :ils
+        JMD = :jmd
+        MOP = :mop
+        MGA = :mga
+        MUR = :mur
+        MDL = :mdl
+        MNT = :mnt
+        NAD = :nad
+        NGN = :ngn
+        MKD = :mkd
+        OMR = :omr
+        PYG = :pyg
+        PEN = :pen
+        QAR = :qar
+        RWF = :rwf
+        SAR = :sar
+        RSD = :rsd
+        LKR = :lkr
+        TZS = :tzs
+        TTD = :ttd
+        UZS = :uzs
+        RUB = :rub
+        BTC = :btc
+        CNY = :cny
+        USDT = :usdt
+        KZT = :kzt
+        AWG = :awg
+        WHOP_USD = :whop_usd
+        XAU = :xau
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class User < WhopSDK::Internal::Type::BaseModel
@@ -350,8 +592,8 @@ module WhopSDK
         # @!attribute gender
         #   Gender
         #
-        #   @return [Symbol, WhopSDK::Models::ConversionCreateParams::User::Gender, nil]
-        optional :gender, enum: -> { WhopSDK::ConversionCreateParams::User::Gender }, nil?: true
+        #   @return [Symbol, WhopSDK::Models::EventCreateParams::User::Gender, nil]
+        optional :gender, enum: -> { WhopSDK::EventCreateParams::User::Gender }, nil?: true
 
         # @!attribute last_name
         #   Last name.
@@ -359,6 +601,19 @@ module WhopSDK
         #   @return [String, nil]
         optional :last_name, String, nil?: true
 
+        # @!attribute linked_anonymous_id
+        #   A second anonymous identifier to link to this user (e.g. captured across an
+        #   iframe boundary).
+        #
+        #   @return [String, nil]
+        optional :linked_anonymous_id, String, nil?: true
+
+        # @!attribute linked_wuid
+        #   A wuid from a linked frame, captured across an iframe boundary.
+        #
+        #   @return [String, nil]
+        optional :linked_wuid, String, nil?: true
+
         # @!attribute member_id
         #   The Whop member ID.
         #
@@ -407,7 +662,10 @@ module WhopSDK
         #   @return [String, nil]
         optional :username, String, nil?: true
 
-        # @!method initialize(anonymous_id: nil, birthdate: nil, city: nil, country: nil, email: nil, external_id: nil, first_name: nil, gender: nil, last_name: nil, member_id: nil, membership_id: nil, name: nil, phone: nil, postal_code: nil, state: nil, user_id: nil, username: nil)
+        # @!method initialize(anonymous_id: nil, birthdate: nil, city: nil, country: nil, email: nil, external_id: nil, first_name: nil, gender: nil, last_name: nil, linked_anonymous_id: nil, linked_wuid: nil, member_id: nil, membership_id: nil, name: nil, phone: nil, postal_code: nil, state: nil, user_id: nil, username: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::EventCreateParams::User} for more details.
+        #
         #   User identity and profile data.
         #
         #   @param anonymous_id [String, nil] An anonymous identifier for the user.
@@ -424,10 +682,14 @@ module WhopSDK
         #
         #   @param first_name [String, nil] First name.
         #
-        #   @param gender [Symbol, WhopSDK::Models::ConversionCreateParams::User::Gender, nil] Gender
+        #   @param gender [Symbol, WhopSDK::Models::EventCreateParams::User::Gender, nil] Gender
         #
         #   @param last_name [String, nil] Last name.
         #
+        #   @param linked_anonymous_id [String, nil] A second anonymous identifier to link to this user (e.g. captured across an ifra
+        #
+        #   @param linked_wuid [String, nil] A wuid from a linked frame, captured across an iframe boundary.
+        #
         #   @param member_id [String, nil] The Whop member ID.
         #
         #   @param membership_id [String, nil] The Whop membership ID.
@@ -446,7 +708,7 @@ module WhopSDK
 
         # Gender
         #
-        # @see WhopSDK::Models::ConversionCreateParams::User#gender
+        # @see WhopSDK::Models::EventCreateParams::User#gender
         module Gender
           extend WhopSDK::Internal::Type::Enum
 

data/lib/whop_sdk/models/event_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Events#create
+    class EventCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String]
+    end
+  end
+end

data/lib/whop_sdk/models/event_list_params.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Events#list
+    class EventListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute person_id
+      #   The ID of the person.
+      #
+      #   @return [String]
+      required :person_id, String
+
+      # @!attribute account_id
+      #   The ID of the account, which will look like biz\_******\*******. Optional for
+      #   account API keys; required for credentials that can access multiple accounts.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute after
+      #   A cursor for fetching events after a previous page.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   A cursor for fetching events before a later page.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute first
+      #   The number of events to return.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute from
+      #   Start of the time range as a Unix timestamp.
+      #
+      #   @return [Integer, nil]
+      optional :from, Integer
+
+      # @!attribute to
+      #   End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @return [Integer, nil]
+      optional :to, Integer
+
+      # @!method initialize(person_id:, account_id: nil, after: nil, before: nil, first: nil, from: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::EventListParams} for more details.
+      #
+      #   @param person_id [String] The ID of the person.
+      #
+      #   @param account_id [String] The ID of the account, which will look like biz\_******\*******. Optional for
+      #   acco
+      #
+      #   @param after [String] A cursor for fetching events after a previous page.
+      #
+      #   @param before [String] A cursor for fetching events before a later page.
+      #
+      #   @param first [Integer] The number of events to return.
+      #
+      #   @param from [Integer] Start of the time range as a Unix timestamp.
+      #
+      #   @param to [Integer] End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end