whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/audience.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Audiences#create
+    class Audience < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Audience ID, prefixed `adaud_`.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the audience was created, as an ISO 8601 timestamp.
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute error_message
+      #   Processing error message. `null` unless processing is partial or failed.
+      #
+      #   @return [String, nil]
+      required :error_message, String, nil?: true
+
+      # @!attribute match_rates
+      #
+      #   @return [Array<WhopSDK::Models::Audience::MatchRate>]
+      required :match_rates, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Audience::MatchRate] }
+
+      # @!attribute matched_rows
+      #   Rows successfully uploaded to connected ad accounts.
+      #
+      #   @return [Float]
+      required :matched_rows, Float
+
+      # @!attribute name
+      #   Audience display name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute platform_audience_ids
+      #
+      #   @return [Array<String>]
+      required :platform_audience_ids, WhopSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute processed_rows
+      #   Rows processed from the uploaded CSV.
+      #
+      #   @return [Float]
+      required :processed_rows, Float
+
+      # @!attribute progress_percent
+      #   Processing progress from 0 to 100.
+      #
+      #   @return [Float]
+      required :progress_percent, Float
+
+      # @!attribute status
+      #   Current state of the audience import. `syncing` means Whop is sending matched
+      #   rows to connected ad accounts. When status is `partial` or `failed`,
+      #   `error_message` explains what went wrong.
+      #
+      #   @return [Symbol, WhopSDK::Models::Audience::Status]
+      required :status, enum: -> { WhopSDK::Audience::Status }
+
+      # @!attribute total_rows
+      #   Total rows detected in the uploaded CSV.
+      #
+      #   @return [Float]
+      required :total_rows, Float
+
+      # @!attribute updated_at
+      #   When the audience was last updated, as an ISO 8601 timestamp.
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!method initialize(id:, created_at:, error_message:, match_rates:, matched_rows:, name:, platform_audience_ids:, processed_rows:, progress_percent:, status:, total_rows:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::Audience} for more details.
+      #
+      #   @param id [String] Audience ID, prefixed `adaud_`.
+      #
+      #   @param created_at [String] When the audience was created, as an ISO 8601 timestamp.
+      #
+      #   @param error_message [String, nil] Processing error message. `null` unless processing is partial or failed.
+      #
+      #   @param match_rates [Array<WhopSDK::Models::Audience::MatchRate>]
+      #
+      #   @param matched_rows [Float] Rows successfully uploaded to connected ad accounts.
+      #
+      #   @param name [String] Audience display name.
+      #
+      #   @param platform_audience_ids [Array<String>]
+      #
+      #   @param processed_rows [Float] Rows processed from the uploaded CSV.
+      #
+      #   @param progress_percent [Float] Processing progress from 0 to 100.
+      #
+      #   @param status [Symbol, WhopSDK::Models::Audience::Status] Current state of the audience import. `syncing` means Whop is sending matched ro
+      #
+      #   @param total_rows [Float] Total rows detected in the uploaded CSV.
+      #
+      #   @param updated_at [String] When the audience was last updated, as an ISO 8601 timestamp.
+
+      class MatchRate < WhopSDK::Internal::Type::BaseModel
+        # @!attribute lower_bound
+        #   Lower bound of the estimated match rate percentage. `null` until available.
+        #
+        #   @return [Float, nil]
+        required :lower_bound, Float, nil?: true
+
+        # @!attribute platform
+        #   The ad platform that provided the match-rate estimate.
+        #
+        #   @return [Symbol, WhopSDK::Models::Audience::MatchRate::Platform]
+        required :platform, enum: -> { WhopSDK::Audience::MatchRate::Platform }
+
+        # @!attribute status
+        #   Availability of the estimated match rate.
+        #
+        #   @return [Symbol, WhopSDK::Models::Audience::MatchRate::Status, nil]
+        required :status, enum: -> { WhopSDK::Audience::MatchRate::Status }, nil?: true
+
+        # @!attribute upper_bound
+        #   Upper bound of the estimated match rate percentage. `null` until available.
+        #
+        #   @return [Float, nil]
+        required :upper_bound, Float, nil?: true
+
+        # @!method initialize(lower_bound:, platform:, status:, upper_bound:)
+        #   Estimated match rates by ad platform. Empty when the audience was not sent to a
+        #   supported platform.
+        #
+        #   @param lower_bound [Float, nil] Lower bound of the estimated match rate percentage. `null` until available.
+        #
+        #   @param platform [Symbol, WhopSDK::Models::Audience::MatchRate::Platform] The ad platform that provided the match-rate estimate.
+        #
+        #   @param status [Symbol, WhopSDK::Models::Audience::MatchRate::Status, nil] Availability of the estimated match rate.
+        #
+        #   @param upper_bound [Float, nil] Upper bound of the estimated match rate percentage. `null` until available.
+
+        # The ad platform that provided the match-rate estimate.
+        #
+        # @see WhopSDK::Models::Audience::MatchRate#platform
+        module Platform
+          extend WhopSDK::Internal::Type::Enum
+
+          META = :meta
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Availability of the estimated match rate.
+        #
+        # @see WhopSDK::Models::Audience::MatchRate#status
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          CALCULATING = :calculating
+          AVAILABLE = :available
+          UNAVAILABLE = :unavailable
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Current state of the audience import. `syncing` means Whop is sending matched
+      # rows to connected ad accounts. When status is `partial` or `failed`,
+      # `error_message` explains what went wrong.
+      #
+      # @see WhopSDK::Models::Audience#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSING = :processing
+        SYNCING = :syncing
+        READY = :ready
+        PARTIAL = :partial
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/audience_create_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Audiences#create
+    class AudienceCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Account ID, prefixed `biz_`.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute column_mapping
+      #   Maps supported identity fields to CSV column headers. Map at least one of
+      #   `email` or `phone`.
+      #
+      #   @return [WhopSDK::Models::AudienceCreateParams::ColumnMapping]
+      required :column_mapping, -> { WhopSDK::AudienceCreateParams::ColumnMapping }
+
+      # @!attribute file_id
+      #   Direct upload ID from the standard media upload endpoint.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!attribute name
+      #   Audience display name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(account_id:, column_mapping:, file_id:, name:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AudienceCreateParams} for more details.
+      #
+      #   @param account_id [String] Account ID, prefixed `biz_`.
+      #
+      #   @param column_mapping [WhopSDK::Models::AudienceCreateParams::ColumnMapping] Maps supported identity fields to CSV column headers. Map at least one of `email
+      #
+      #   @param file_id [String] Direct upload ID from the standard media upload endpoint.
+      #
+      #   @param name [String] Audience display name.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class ColumnMapping < WhopSDK::Internal::Type::BaseModel
+        # @!attribute country
+        #   CSV header for ISO 3166-1 alpha-2 country codes, such as `US`.
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute email
+        #   CSV header for email addresses.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #   CSV header for first names.
+        #
+        #   @return [String, nil]
+        optional :first_name, String
+
+        # @!attribute last_name
+        #   CSV header for last names.
+        #
+        #   @return [String, nil]
+        optional :last_name, String
+
+        # @!attribute phone
+        #   CSV header for phone numbers.
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!method initialize(country: nil, email: nil, first_name: nil, last_name: nil, phone: nil)
+        #   Maps supported identity fields to CSV column headers. Map at least one of
+        #   `email` or `phone`.
+        #
+        #   @param country [String] CSV header for ISO 3166-1 alpha-2 country codes, such as `US`.
+        #
+        #   @param email [String] CSV header for email addresses.
+        #
+        #   @param first_name [String] CSV header for first names.
+        #
+        #   @param last_name [String] CSV header for last names.
+        #
+        #   @param phone [String] CSV header for phone numbers.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/audience_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Audiences#delete
+    class AudienceDeleteParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute audience_id
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!method initialize(audience_id:, request_options: {})
+      #   @param audience_id [String]
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/audience_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Audiences#delete
+    class AudienceDeleteResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/whop_sdk/models/audience_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Audiences#list
+    class AudienceListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Account ID, prefixed `biz_`.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute after
+      #   Cursor for the next page of audiences.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute audience_id
+      #   Audience ID, prefixed `adaud_`, used to filter the response to one audience.
+      #
+      #   @return [String, nil]
+      optional :audience_id, String
+
+      # @!attribute first
+      #   Number of audiences to return. Defaults to 20; maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!method initialize(account_id:, after: nil, audience_id: nil, first: nil, request_options: {})
+      #   @param account_id [String] Account ID, prefixed `biz_`.
+      #
+      #   @param after [String] Cursor for the next page of audiences.
+      #
+      #   @param audience_id [String] Audience ID, prefixed `adaud_`, used to filter the response to one audience.
+      #
+      #   @param first [Integer] Number of audiences to return. Defaults to 20; maximum 100.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/authorized_user_create_params.rb

@@ -26,13 +26,19 @@ module WhopSDK
       #   @return [String]
       required :user_id, String
 
+      # @!attribute elevation
+      #   Re-authentication proof required to perform this sensitive action.
+      #
+      #   @return [WhopSDK::Models::AuthorizedUserCreateParams::Elevation, nil]
+      optional :elevation, -> { WhopSDK::AuthorizedUserCreateParams::Elevation }, nil?: true
+
       # @!attribute send_emails
       #   Whether to send notification emails to the user on creation.
       #
       #   @return [Boolean, nil]
       optional :send_emails, WhopSDK::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(company_id:, role:, user_id:, send_emails: nil, request_options: {})
+      # @!method initialize(company_id:, role:, user_id:, elevation: nil, send_emails: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::AuthorizedUserCreateParams} for more details.
       #
@@ -42,9 +48,72 @@ module WhopSDK
       #
       #   @param user_id [String] The ID of the user to add as an authorized user.
       #
+      #   @param elevation [WhopSDK::Models::AuthorizedUserCreateParams::Elevation, nil] Re-authentication proof required to perform this sensitive action.
+      #
       #   @param send_emails [Boolean, nil] Whether to send notification emails to the user on creation.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class Elevation < WhopSDK::Internal::Type::BaseModel
+        # @!attribute authenticator_data
+        #   The WebAuthn authenticator data (base64).
+        #
+        #   @return [String, nil]
+        optional :authenticator_data, String, nil?: true
+
+        # @!attribute client_data_json
+        #   The WebAuthn client data JSON (base64).
+        #
+        #   @return [String, nil]
+        optional :client_data_json, String, nil?: true
+
+        # @!attribute credential_id
+        #   The WebAuthn credential ID (base64).
+        #
+        #   @return [String, nil]
+        optional :credential_id, String, nil?: true
+
+        # @!attribute email_code
+        #   The 6-digit code emailed to the user.
+        #
+        #   @return [String, nil]
+        optional :email_code, String, nil?: true
+
+        # @!attribute signature
+        #   The WebAuthn signature (base64).
+        #
+        #   @return [String, nil]
+        optional :signature, String, nil?: true
+
+        # @!attribute totp_code
+        #   The 6-digit code from the authenticator app or SMS.
+        #
+        #   @return [String, nil]
+        optional :totp_code, String, nil?: true
+
+        # @!attribute use_finance_session
+        #   Reuse an existing elevated session (for SMS/email 2FA users).
+        #
+        #   @return [Boolean, nil]
+        optional :use_finance_session, WhopSDK::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(authenticator_data: nil, client_data_json: nil, credential_id: nil, email_code: nil, signature: nil, totp_code: nil, use_finance_session: nil)
+        #   Re-authentication proof required to perform this sensitive action.
+        #
+        #   @param authenticator_data [String, nil] The WebAuthn authenticator data (base64).
+        #
+        #   @param client_data_json [String, nil] The WebAuthn client data JSON (base64).
+        #
+        #   @param credential_id [String, nil] The WebAuthn credential ID (base64).
+        #
+        #   @param email_code [String, nil] The 6-digit code emailed to the user.
+        #
+        #   @param signature [String, nil] The WebAuthn signature (base64).
+        #
+        #   @param totp_code [String, nil] The 6-digit code from the authenticator app or SMS.
+        #
+        #   @param use_finance_session [Boolean, nil] Reuse an existing elevated session (for SMS/email 2FA users).
+      end
     end
   end
 end

data/lib/whop_sdk/models/bounty_create_params.rb

@@ -9,7 +9,8 @@ module WhopSDK
 
       # @!attribute base_unit_amount
       #   The amount paid to each approved submission. The total bounty pool funded is
-      #   this amount times accepted_submissions_limit.
+      #   this amount times accepted_submissions_limit, and must be at least 5 in the
+      #   bounty's currency.
       #
       #   @return [Float]
       required :base_unit_amount, Float
@@ -34,7 +35,8 @@ module WhopSDK
 
       # @!attribute accepted_submissions_limit
       #   The number of submissions that can be approved before the bounty closes.
-      #   Defaults to 1.
+      #   Defaults to 1. The total pool (base_unit_amount times this limit) must be at
+      #   least 5 in the bounty's currency.
       #
       #   @return [Integer, nil]
       optional :accepted_submissions_limit, Integer, nil?: true
@@ -46,6 +48,13 @@ module WhopSDK
       #   @return [Array<String>, nil]
       optional :allowed_country_codes, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute business_goal_type
+      #   What the poster is trying to accomplish with a workforce bounty. Used for
+      #   product taxonomy and analytics, separate from the bounty's implementation type.
+      #
+      #   @return [Symbol, WhopSDK::Models::BountyCreateParams::BusinessGoalType, nil]
+      optional :business_goal_type, enum: -> { WhopSDK::BountyCreateParams::BusinessGoalType }, nil?: true
+
       # @!attribute experience_id
       #   An optional experience to scope the bounty to.
       #
@@ -74,7 +83,27 @@ module WhopSDK
       #   @return [String, nil]
       optional :post_title, String, nil?: true
 
-      # @!method initialize(base_unit_amount:, currency:, description:, title:, accepted_submissions_limit: nil, allowed_country_codes: nil, experience_id: nil, origin_account_id: nil, post_markdown_content: nil, post_title: nil, request_options: {})
+      # @!attribute scheduled_frequency
+      #   How often a scheduled bounty republishes a new bounty.
+      #
+      #   @return [Symbol, WhopSDK::Models::BountyCreateParams::ScheduledFrequency, nil]
+      optional :scheduled_frequency, enum: -> { WhopSDK::BountyCreateParams::ScheduledFrequency }, nil?: true
+
+      # @!attribute scheduled_publish_at
+      #   When to publish the bounty. When provided, the bounty is created as a hidden
+      #   draft and published at this time instead of immediately. Must be in the future.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_publish_at, Time, nil?: true
+
+      # @!attribute scheduled_timezone
+      #   The IANA timezone used for recurring occurrences. Required when
+      #   scheduled_publish_at is provided.
+      #
+      #   @return [String, nil]
+      optional :scheduled_timezone, String, nil?: true
+
+      # @!method initialize(base_unit_amount:, currency:, description:, title:, accepted_submissions_limit: nil, allowed_country_codes: nil, business_goal_type: nil, experience_id: nil, origin_account_id: nil, post_markdown_content: nil, post_title: nil, scheduled_frequency: nil, scheduled_publish_at: nil, scheduled_timezone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::BountyCreateParams} for more details.
       #
@@ -90,6 +119,8 @@ module WhopSDK
       #
       #   @param allowed_country_codes [Array<String>, nil] The ISO3166 country codes where this bounty should be visible. Empty means globa
       #
+      #   @param business_goal_type [Symbol, WhopSDK::Models::BountyCreateParams::BusinessGoalType, nil] What the poster is trying to accomplish with a workforce bounty. Used for produc
+      #
       #   @param experience_id [String, nil] An optional experience to scope the bounty to.
       #
       #   @param origin_account_id [String, nil] The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
@@ -99,7 +130,43 @@ module WhopSDK
       #
       #   @param post_title [String, nil] Optional title for the anchor forum post. Falls back to the bounty title when om
       #
+      #   @param scheduled_frequency [Symbol, WhopSDK::Models::BountyCreateParams::ScheduledFrequency, nil] How often a scheduled bounty republishes a new bounty.
+      #
+      #   @param scheduled_publish_at [Time, nil] When to publish the bounty. When provided, the bounty is created as a hidden dra
+      #
+      #   @param scheduled_timezone [String, nil] The IANA timezone used for recurring occurrences. Required when scheduled_publis
+      #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # What the poster is trying to accomplish with a workforce bounty. Used for
+      # product taxonomy and analytics, separate from the bounty's implementation type.
+      module BusinessGoalType
+        extend WhopSDK::Internal::Type::Enum
+
+        CLIPPING = :clipping
+        POST_ENGAGEMENT = :post_engagement
+        OWNED_ACCOUNT_GROWTH = :owned_account_growth
+        UGC_CONTENT = :ugc_content
+        LOCAL_ACTIVATION = :local_activation
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # How often a scheduled bounty republishes a new bounty.
+      module ScheduledFrequency
+        extend WhopSDK::Internal::Type::Enum
+
+        ONCE = :once
+        HOURLY = :hourly
+        DAILY = :daily
+        WEEKLY = :weekly
+        MONTHLY = :monthly
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/whop_sdk/models/bounty_create_response.rb

@@ -117,6 +117,7 @@ module WhopSDK
 
         PUBLISHED = :published
         ARCHIVED = :archived
+        SCHEDULED = :scheduled
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/bounty_list_params.rb

@@ -76,6 +76,7 @@ module WhopSDK
 
         PUBLISHED = :published
         ARCHIVED = :archived
+        SCHEDULED = :scheduled
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/bounty_list_response.rb

@@ -117,6 +117,7 @@ module WhopSDK
 
         PUBLISHED = :published
         ARCHIVED = :archived
+        SCHEDULED = :scheduled
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/bounty_retrieve_response.rb

@@ -117,6 +117,7 @@ module WhopSDK
 
         PUBLISHED = :published
         ARCHIVED = :archived
+        SCHEDULED = :scheduled
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/card_brands.rb

@@ -45,6 +45,7 @@ module WhopSDK
       HIPERCARD = :hipercard
       JCBLANKAPAY = :jcblankapay
       CMI = :cmi
+      AURA = :aura
       UNKNOWN = :unknown
 
       # @!method self.values