whop_sdk 0.0.37 → 0.0.39

data/lib/whop_sdk/models/conversion_create_params.rb

@@ -0,0 +1,462 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Conversions#create
+    class ConversionCreateParams < 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.
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute event_name
+      #   The type of event.
+      #
+      #   @return [Symbol, WhopSDK::Models::ConversionCreateParams::EventName]
+      required :event_name, enum: -> { WhopSDK::ConversionCreateParams::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
+
+      # @!attribute context
+      #   Tracking and attribution context.
+      #
+      #   @return [WhopSDK::Models::ConversionCreateParams::Context, nil]
+      optional :context, -> { WhopSDK::ConversionCreateParams::Context }, nil?: true
+
+      # @!attribute currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute custom_name
+      #   Custom event name when event_name is 'custom'.
+      #
+      #   @return [String, nil]
+      optional :custom_name, String, nil?: true
+
+      # @!attribute event_id
+      #   Client-provided identifier for deduplication. Generated if omitted.
+      #
+      #   @return [String, nil]
+      optional :event_id, String, nil?: true
+
+      # @!attribute event_time
+      #   When the event occurred. Defaults to now.
+      #
+      #   @return [Time, nil]
+      optional :event_time, Time, nil?: true
+
+      # @!attribute plan_id
+      #   The plan associated with the event.
+      #
+      #   @return [String, nil]
+      optional :plan_id, String, nil?: true
+
+      # @!attribute product_id
+      #   The product associated with the event.
+      #
+      #   @return [String, nil]
+      optional :product_id, String, nil?: true
+
+      # @!attribute referrer_url
+      #   The referring URL.
+      #
+      #   @return [String, nil]
+      optional :referrer_url, String, nil?: true
+
+      # @!attribute url
+      #   The URL where the event occurred.
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!attribute user
+      #   User identity and profile data.
+      #
+      #   @return [WhopSDK::Models::ConversionCreateParams::User, nil]
+      optional :user, -> { WhopSDK::ConversionCreateParams::User }, nil?: true
+
+      # @!attribute value
+      #   Monetary value associated with the event.
+      #
+      #   @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.
+      #
+      #   @param event_name [Symbol, WhopSDK::Models::ConversionCreateParams::EventName] The type of event.
+      #
+      #   @param action_source [Symbol, WhopSDK::Models::ConversionCreateParams::ActionSource, nil] The channel where an event originated
+      #
+      #   @param context [WhopSDK::Models::ConversionCreateParams::Context, nil] Tracking and attribution context.
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      #   @param custom_name [String, nil] Custom event name when event_name is 'custom'.
+      #
+      #   @param event_id [String, nil] Client-provided identifier for deduplication. Generated if omitted.
+      #
+      #   @param event_time [Time, nil] When the event occurred. Defaults to now.
+      #
+      #   @param plan_id [String, nil] The plan associated with the event.
+      #
+      #   @param product_id [String, nil] The product associated with the event.
+      #
+      #   @param referrer_url [String, nil] The referring URL.
+      #
+      #   @param url [String, nil] The URL where the event occurred.
+      #
+      #   @param user [WhopSDK::Models::ConversionCreateParams::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.
+      module EventName
+        extend WhopSDK::Internal::Type::Enum
+
+        LEAD = :lead
+        SUBMIT_APPLICATION = :submit_application
+        CONTACT = :contact
+        COMPLETE_REGISTRATION = :complete_registration
+        SCHEDULE = :schedule
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The channel where an event originated
+      module ActionSource
+        extend WhopSDK::Internal::Type::Enum
+
+        EMAIL = :email
+        WEBSITE = :website
+        APP = :app
+        PHONE_CALL = :phone_call
+        CHAT = :chat
+        PHYSICAL_STORE = :physical_store
+        SYSTEM_GENERATED = :system_generated
+        BUSINESS_MESSAGING = :business_messaging
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Context < WhopSDK::Internal::Type::BaseModel
+        # @!attribute ad_campaign_id
+        #   Ad campaign ID.
+        #
+        #   @return [String, nil]
+        optional :ad_campaign_id, String, nil?: true
+
+        # @!attribute ad_id
+        #   Ad ID.
+        #
+        #   @return [String, nil]
+        optional :ad_id, String, nil?: true
+
+        # @!attribute ad_set_id
+        #   Ad set ID.
+        #
+        #   @return [String, nil]
+        optional :ad_set_id, String, nil?: true
+
+        # @!attribute fbclid
+        #   Facebook click ID.
+        #
+        #   @return [String, nil]
+        optional :fbclid, String, nil?: true
+
+        # @!attribute fbp
+        #   Facebook browser pixel ID.
+        #
+        #   @return [String, nil]
+        optional :fbp, String, nil?: true
+
+        # @!attribute ga
+        #   Google Analytics client ID.
+        #
+        #   @return [String, nil]
+        optional :ga, String, nil?: true
+
+        # @!attribute gclid
+        #   Google click ID.
+        #
+        #   @return [String, nil]
+        optional :gclid, String, nil?: true
+
+        # @!attribute ig_sid
+        #   Instagram session ID.
+        #
+        #   @return [String, nil]
+        optional :ig_sid, String, nil?: true
+
+        # @!attribute ip_address
+        #   IP address.
+        #
+        #   @return [String, nil]
+        optional :ip_address, String, nil?: true
+
+        # @!attribute ttclid
+        #   TikTok click ID.
+        #
+        #   @return [String, nil]
+        optional :ttclid, String, nil?: true
+
+        # @!attribute ttp
+        #   TikTok pixel ID.
+        #
+        #   @return [String, nil]
+        optional :ttp, String, nil?: true
+
+        # @!attribute user_agent
+        #   Browser user agent string.
+        #
+        #   @return [String, nil]
+        optional :user_agent, String, nil?: true
+
+        # @!attribute utm_campaign
+        #   UTM campaign parameter.
+        #
+        #   @return [String, nil]
+        optional :utm_campaign, String, nil?: true
+
+        # @!attribute utm_content
+        #   UTM content parameter.
+        #
+        #   @return [String, nil]
+        optional :utm_content, String, nil?: true
+
+        # @!attribute utm_id
+        #   UTM ID parameter.
+        #
+        #   @return [String, nil]
+        optional :utm_id, String, nil?: true
+
+        # @!attribute utm_medium
+        #   UTM medium parameter.
+        #
+        #   @return [String, nil]
+        optional :utm_medium, String, nil?: true
+
+        # @!attribute utm_source
+        #   UTM source parameter.
+        #
+        #   @return [String, nil]
+        optional :utm_source, String, nil?: true
+
+        # @!attribute utm_term
+        #   UTM term parameter.
+        #
+        #   @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)
+        #   Tracking and attribution context.
+        #
+        #   @param ad_campaign_id [String, nil] Ad campaign ID.
+        #
+        #   @param ad_id [String, nil] Ad ID.
+        #
+        #   @param ad_set_id [String, nil] Ad set ID.
+        #
+        #   @param fbclid [String, nil] Facebook click ID.
+        #
+        #   @param fbp [String, nil] Facebook browser pixel ID.
+        #
+        #   @param ga [String, nil] Google Analytics client ID.
+        #
+        #   @param gclid [String, nil] Google click ID.
+        #
+        #   @param ig_sid [String, nil] Instagram session ID.
+        #
+        #   @param ip_address [String, nil] IP address.
+        #
+        #   @param ttclid [String, nil] TikTok click ID.
+        #
+        #   @param ttp [String, nil] TikTok pixel ID.
+        #
+        #   @param user_agent [String, nil] Browser user agent string.
+        #
+        #   @param utm_campaign [String, nil] UTM campaign parameter.
+        #
+        #   @param utm_content [String, nil] UTM content parameter.
+        #
+        #   @param utm_id [String, nil] UTM ID parameter.
+        #
+        #   @param utm_medium [String, nil] UTM medium parameter.
+        #
+        #   @param utm_source [String, nil] UTM source parameter.
+        #
+        #   @param utm_term [String, nil] UTM term parameter.
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute anonymous_id
+        #   An anonymous identifier for the user.
+        #
+        #   @return [String, nil]
+        optional :anonymous_id, String, nil?: true
+
+        # @!attribute birthdate
+        #   Date of birth (YYYY-MM-DD).
+        #
+        #   @return [String, nil]
+        optional :birthdate, String, nil?: true
+
+        # @!attribute city
+        #   City.
+        #
+        #   @return [String, nil]
+        optional :city, String, nil?: true
+
+        # @!attribute country
+        #   Country.
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute email
+        #   Email address.
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute external_id
+        #   An external identifier for the user.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
+        # @!attribute first_name
+        #   First name.
+        #
+        #   @return [String, nil]
+        optional :first_name, String, nil?: true
+
+        # @!attribute gender
+        #   Gender
+        #
+        #   @return [Symbol, WhopSDK::Models::ConversionCreateParams::User::Gender, nil]
+        optional :gender, enum: -> { WhopSDK::ConversionCreateParams::User::Gender }, nil?: true
+
+        # @!attribute last_name
+        #   Last name.
+        #
+        #   @return [String, nil]
+        optional :last_name, String, nil?: true
+
+        # @!attribute member_id
+        #   The Whop member ID.
+        #
+        #   @return [String, nil]
+        optional :member_id, String, nil?: true
+
+        # @!attribute membership_id
+        #   The Whop membership ID.
+        #
+        #   @return [String, nil]
+        optional :membership_id, String, nil?: true
+
+        # @!attribute name
+        #   Full display name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute phone
+        #   Phone number.
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
+
+        # @!attribute postal_code
+        #   Postal code.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   State or region.
+        #
+        #   @return [String, nil]
+        optional :state, String, nil?: true
+
+        # @!attribute user_id
+        #   The Whop user ID.
+        #
+        #   @return [String, nil]
+        optional :user_id, String, nil?: true
+
+        # @!attribute username
+        #   Username.
+        #
+        #   @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)
+        #   User identity and profile data.
+        #
+        #   @param anonymous_id [String, nil] An anonymous identifier for the user.
+        #
+        #   @param birthdate [String, nil] Date of birth (YYYY-MM-DD).
+        #
+        #   @param city [String, nil] City.
+        #
+        #   @param country [String, nil] Country.
+        #
+        #   @param email [String, nil] Email address.
+        #
+        #   @param external_id [String, nil] An external identifier for the user.
+        #
+        #   @param first_name [String, nil] First name.
+        #
+        #   @param gender [Symbol, WhopSDK::Models::ConversionCreateParams::User::Gender, nil] Gender
+        #
+        #   @param last_name [String, nil] Last name.
+        #
+        #   @param member_id [String, nil] The Whop member ID.
+        #
+        #   @param membership_id [String, nil] The Whop membership ID.
+        #
+        #   @param name [String, nil] Full display name.
+        #
+        #   @param phone [String, nil] Phone number.
+        #
+        #   @param postal_code [String, nil] Postal code.
+        #
+        #   @param state [String, nil] State or region.
+        #
+        #   @param user_id [String, nil] The Whop user ID.
+        #
+        #   @param username [String, nil] Username.
+
+        # Gender
+        #
+        # @see WhopSDK::Models::ConversionCreateParams::User#gender
+        module Gender
+          extend WhopSDK::Internal::Type::Enum
+
+          MALE = :male
+          FEMALE = :female
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/conversion_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Conversions#create
+    class ConversionCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the conversion
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   A tracked conversion event
+      #
+      #   @param id [String] The unique identifier for the conversion
+    end
+  end
+end

data/lib/whop_sdk/models/currency.rb

@@ -92,6 +92,7 @@ module WhopSDK
       BTC = :btc
       CNY = :cny
       USDT = :usdt
+      KZT = :kzt
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/whop_sdk/models/file_create_params.rb

@@ -14,13 +14,34 @@ module WhopSDK
       #   @return [String]
       required :filename, String
 
-      # @!method initialize(filename:, request_options: {})
+      # @!attribute visibility
+      #   Controls whether an uploaded file is publicly accessible or requires
+      #   authentication to access.
+      #
+      #   @return [Symbol, WhopSDK::Models::FileCreateParams::Visibility, nil]
+      optional :visibility, enum: -> { WhopSDK::FileCreateParams::Visibility }, nil?: true
+
+      # @!method initialize(filename:, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::FileCreateParams} for more details.
       #
       #   @param filename [String] The name of the file including its extension (e.g., "photo.png" or "document.pdf
       #
+      #   @param visibility [Symbol, WhopSDK::Models::FileCreateParams::Visibility, nil] Controls whether an uploaded file is publicly accessible or requires authenticat
+      #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Controls whether an uploaded file is publicly accessible or requires
+      # authentication to access.
+      module Visibility
+        extend WhopSDK::Internal::Type::Enum
+
+        PUBLIC = :public
+        PRIVATE = :private
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/whop_sdk/models/file_create_response.rb

@@ -49,12 +49,20 @@ module WhopSDK
       required :upload_url, String, nil?: true
 
       # @!attribute url
-      #   The CDN URL for accessing the file. Null if the file has not finished uploading.
+      #   The URL for accessing the file. For public files, this is a permanent CDN URL.
+      #   For private files, this is a signed URL that expires. Null if the file has not
+      #   finished uploading.
       #
       #   @return [String, nil]
       required :url, String, nil?: true
 
-      # @!method initialize(id:, content_type:, filename:, size:, upload_headers:, upload_status:, upload_url:, url:)
+      # @!attribute visibility
+      #   Whether the file is publicly accessible or requires authentication.
+      #
+      #   @return [Symbol, WhopSDK::Models::FileCreateResponse::Visibility]
+      required :visibility, enum: -> { WhopSDK::Models::FileCreateResponse::Visibility }
+
+      # @!method initialize(id:, content_type:, filename:, size:, upload_headers:, upload_status:, upload_url:, url:, visibility:)
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::FileCreateResponse} for more details.
       #
@@ -74,7 +82,22 @@ module WhopSDK
       #
       #   @param upload_url [String, nil] The presigned URL to upload the file contents to. Only present in the response f
       #
-      #   @param url [String, nil] The CDN URL for accessing the file. Null if the file has not finished uploading.
+      #   @param url [String, nil] The URL for accessing the file. For public files, this is a permanent CDN URL. F
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::FileCreateResponse::Visibility] Whether the file is publicly accessible or requires authentication.
+
+      # Whether the file is publicly accessible or requires authentication.
+      #
+      # @see WhopSDK::Models::FileCreateResponse#visibility
+      module Visibility
+        extend WhopSDK::Internal::Type::Enum
+
+        PUBLIC = :public
+        PRIVATE = :private
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/whop_sdk/models/file_retrieve_response.rb

@@ -35,12 +35,20 @@ module WhopSDK
       required :upload_status, enum: -> { WhopSDK::UploadStatus }
 
       # @!attribute url
-      #   The CDN URL for accessing the file. Null if the file has not finished uploading.
+      #   The URL for accessing the file. For public files, this is a permanent CDN URL.
+      #   For private files, this is a signed URL that expires. Null if the file has not
+      #   finished uploading.
       #
       #   @return [String, nil]
       required :url, String, nil?: true
 
-      # @!method initialize(id:, content_type:, filename:, size:, upload_status:, url:)
+      # @!attribute visibility
+      #   Whether the file is publicly accessible or requires authentication.
+      #
+      #   @return [Symbol, WhopSDK::Models::FileRetrieveResponse::Visibility]
+      required :visibility, enum: -> { WhopSDK::Models::FileRetrieveResponse::Visibility }
+
+      # @!method initialize(id:, content_type:, filename:, size:, upload_status:, url:, visibility:)
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::FileRetrieveResponse} for more details.
       #
@@ -56,7 +64,22 @@ module WhopSDK
       #
       #   @param upload_status [Symbol, WhopSDK::Models::UploadStatus] The current upload status of the file (e.g., pending, ready).
       #
-      #   @param url [String, nil] The CDN URL for accessing the file. Null if the file has not finished uploading.
+      #   @param url [String, nil] The URL for accessing the file. For public files, this is a permanent CDN URL. F
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::FileRetrieveResponse::Visibility] Whether the file is publicly accessible or requires authentication.
+
+      # Whether the file is publicly accessible or requires authentication.
+      #
+      # @see WhopSDK::Models::FileRetrieveResponse#visibility
+      module Visibility
+        extend WhopSDK::Internal::Type::Enum
+
+        PUBLIC = :public
+        PRIVATE = :private
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/whop_sdk/models/forum_post_list_params.rb

@@ -31,6 +31,12 @@ module WhopSDK
       #   @return [Integer, nil]
       optional :first, Integer, nil?: true
 
+      # @!attribute include_bounty_anchors
+      #   Whether to include top-level bounty discussion anchors as rich forum items.
+      #
+      #   @return [Boolean, nil]
+      optional :include_bounty_anchors, WhopSDK::Internal::Type::Boolean, nil?: true
+
       # @!attribute last
       #   Returns the last _n_ elements from the list.
       #
@@ -51,7 +57,7 @@ module WhopSDK
       #   @return [Boolean, nil]
       optional :pinned, WhopSDK::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(experience_id:, after: nil, before: nil, first: nil, last: nil, parent_id: nil, pinned: nil, request_options: {})
+      # @!method initialize(experience_id:, after: nil, before: nil, first: nil, include_bounty_anchors: nil, last: nil, parent_id: nil, pinned: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::ForumPostListParams} for more details.
       #
@@ -63,6 +69,8 @@ module WhopSDK
       #
       #   @param first [Integer, nil] Returns the first _n_ elements from the list.
       #
+      #   @param include_bounty_anchors [Boolean, nil] Whether to include top-level bounty discussion anchors as rich forum items.
+      #
       #   @param last [Integer, nil] Returns the last _n_ elements from the list.
       #
       #   @param parent_id [String, nil] The unique identifier of a parent post to list comments for. When set, returns r

data/lib/whop_sdk/models/forum_update_params.rb

@@ -12,6 +12,13 @@ module WhopSDK
       #   @return [String]
       required :id, String
 
+      # @!attribute banned_words
+      #   A list of words that are automatically blocked from posts in this forum. For
+      #   example, ['spam', 'scam'].
+      #
+      #   @return [Array<String>, nil]
+      optional :banned_words, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute banner_image
       #   The banner image displayed at the top of the forum page. Pass null to remove the
       #   existing banner.
@@ -37,12 +44,14 @@ module WhopSDK
       #   @return [Symbol, WhopSDK::Models::WhoCanPostTypes, nil]
       optional :who_can_post, enum: -> { WhopSDK::WhoCanPostTypes }, nil?: true
 
-      # @!method initialize(id:, banner_image: nil, email_notification_preference: nil, who_can_comment: nil, who_can_post: nil, request_options: {})
+      # @!method initialize(id:, banned_words: nil, banner_image: nil, email_notification_preference: nil, who_can_comment: nil, who_can_post: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::ForumUpdateParams} for more details.
       #
       #   @param id [String]
       #
+      #   @param banned_words [Array<String>, nil] A list of words that are automatically blocked from posts in this forum. For exa
+      #
       #   @param banner_image [WhopSDK::Models::ForumUpdateParams::BannerImage, nil] The banner image displayed at the top of the forum page. Pass null to remove the
       #
       #   @param email_notification_preference [Symbol, WhopSDK::Models::EmailNotificationPreferences, nil] Email notification preference option for a forum feed