whop_sdk 0.0.37 → 0.0.39

data/rbi/whop_sdk/models/ad_retrieve_response.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AdRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::AdRetrieveResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The unique identifier for this ad.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The ad campaign this ad belongs to.
+      sig { returns(WhopSDK::Models::AdRetrieveResponse::AdCampaign) }
+      attr_reader :ad_campaign
+
+      sig do
+        params(
+          ad_campaign: WhopSDK::Models::AdRetrieveResponse::AdCampaign::OrHash
+        ).void
+      end
+      attr_writer :ad_campaign
+
+      # The parent ad group this ad belongs to.
+      sig { returns(WhopSDK::Models::AdRetrieveResponse::AdGroup) }
+      attr_reader :ad_group
+
+      sig do
+        params(
+          ad_group: WhopSDK::Models::AdRetrieveResponse::AdGroup::OrHash
+        ).void
+      end
+      attr_writer :ad_group
+
+      # When the ad was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      sig do
+        returns(WhopSDK::Models::AdRetrieveResponse::Platform::TaggedSymbol)
+      end
+      attr_accessor :platform
+
+      # Current delivery status of the ad.
+      sig { returns(WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # The display title of the ad. Falls back to the creative set caption when unset.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # When the ad was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # An ad belonging to an ad group.
+      sig do
+        params(
+          id: String,
+          ad_campaign: WhopSDK::Models::AdRetrieveResponse::AdCampaign::OrHash,
+          ad_group: WhopSDK::Models::AdRetrieveResponse::AdGroup::OrHash,
+          created_at: Time,
+          platform: WhopSDK::Models::AdRetrieveResponse::Platform::OrSymbol,
+          status: WhopSDK::Models::AdRetrieveResponse::Status::OrSymbol,
+          title: T.nilable(String),
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for this ad.
+        id:,
+        # The ad campaign this ad belongs to.
+        ad_campaign:,
+        # The parent ad group this ad belongs to.
+        ad_group:,
+        # When the ad was created.
+        created_at:,
+        # The external ad platform this ad is running on (e.g., meta, tiktok).
+        platform:,
+        # Current delivery status of the ad.
+        status:,
+        # The display title of the ad. Falls back to the creative set caption when unset.
+        title:,
+        # When the ad was last updated.
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            ad_campaign: WhopSDK::Models::AdRetrieveResponse::AdCampaign,
+            ad_group: WhopSDK::Models::AdRetrieveResponse::AdGroup,
+            created_at: Time,
+            platform:
+              WhopSDK::Models::AdRetrieveResponse::Platform::TaggedSymbol,
+            status: WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol,
+            title: T.nilable(String),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AdCampaign < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AdRetrieveResponse::AdCampaign,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for this ad campaign.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ad campaign this ad belongs to.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The unique identifier for this ad campaign.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class AdGroup < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AdRetrieveResponse::AdGroup,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for this ad group.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The parent ad group this ad belongs to.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The unique identifier for this ad group.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdRetrieveResponse::Platform)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        META =
+          T.let(
+            :meta,
+            WhopSDK::Models::AdRetrieveResponse::Platform::TaggedSymbol
+          )
+        TIKTOK =
+          T.let(
+            :tiktok,
+            WhopSDK::Models::AdRetrieveResponse::Platform::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::AdRetrieveResponse::Platform::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Current delivery status of the ad.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdRetrieveResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+        PAUSED =
+          T.let(
+            :paused,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(
+            :in_review,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+        FLAGGED =
+          T.let(
+            :flagged,
+            WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::Models::AdRetrieveResponse::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/authorized_user_roles.rbi

@@ -15,6 +15,8 @@ module WhopSDK
       SALES_MANAGER =
         T.let(:sales_manager, WhopSDK::AuthorizedUserRoles::TaggedSymbol)
       MODERATOR = T.let(:moderator, WhopSDK::AuthorizedUserRoles::TaggedSymbol)
+      ADVERTISER =
+        T.let(:advertiser, WhopSDK::AuthorizedUserRoles::TaggedSymbol)
       APP_MANAGER =
         T.let(:app_manager, WhopSDK::AuthorizedUserRoles::TaggedSymbol)
       SUPPORT = T.let(:support, WhopSDK::AuthorizedUserRoles::TaggedSymbol)

data/rbi/whop_sdk/models/bounty_create_params.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class BountyCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::BountyCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The amount paid to each approved submission. The total bounty pool funded is
+      # this amount times accepted_submissions_limit.
+      sig { returns(Float) }
+      attr_accessor :base_unit_amount
+
+      # The currency for the bounty pool funding amount.
+      sig { returns(WhopSDK::Currency::OrSymbol) }
+      attr_accessor :currency
+
+      # The description of the bounty.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The title of the bounty.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The number of submissions that can be approved before the bounty closes.
+      # Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :accepted_submissions_limit
+
+      # The ISO3166 country codes where this bounty should be visible. Empty means
+      # globally visible.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :allowed_country_codes
+
+      # An optional experience to scope the bounty to.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :experience_id
+
+      # The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
+      # Defaults to the requester's personal balance when omitted. The requester must be
+      # the user themself or an owner/admin of the company.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :origin_account_id
+
+      # Optional markdown body for the anchor forum post. Falls back to the bounty
+      # description when omitted.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :post_markdown_content
+
+      # Optional title for the anchor forum post. Falls back to the bounty title when
+      # omitted.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :post_title
+
+      sig do
+        params(
+          base_unit_amount: Float,
+          currency: WhopSDK::Currency::OrSymbol,
+          description: String,
+          title: String,
+          accepted_submissions_limit: T.nilable(Integer),
+          allowed_country_codes: T.nilable(T::Array[String]),
+          experience_id: T.nilable(String),
+          origin_account_id: T.nilable(String),
+          post_markdown_content: T.nilable(String),
+          post_title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The amount paid to each approved submission. The total bounty pool funded is
+        # this amount times accepted_submissions_limit.
+        base_unit_amount:,
+        # The currency for the bounty pool funding amount.
+        currency:,
+        # The description of the bounty.
+        description:,
+        # The title of the bounty.
+        title:,
+        # The number of submissions that can be approved before the bounty closes.
+        # Defaults to 1.
+        accepted_submissions_limit: nil,
+        # The ISO3166 country codes where this bounty should be visible. Empty means
+        # globally visible.
+        allowed_country_codes: nil,
+        # An optional experience to scope the bounty to.
+        experience_id: nil,
+        # The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
+        # Defaults to the requester's personal balance when omitted. The requester must be
+        # the user themself or an owner/admin of the company.
+        origin_account_id: nil,
+        # Optional markdown body for the anchor forum post. Falls back to the bounty
+        # description when omitted.
+        post_markdown_content: nil,
+        # Optional title for the anchor forum post. Falls back to the bounty title when
+        # omitted.
+        post_title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            base_unit_amount: Float,
+            currency: WhopSDK::Currency::OrSymbol,
+            description: String,
+            title: String,
+            accepted_submissions_limit: T.nilable(Integer),
+            allowed_country_codes: T.nilable(T::Array[String]),
+            experience_id: T.nilable(String),
+            origin_account_id: T.nilable(String),
+            post_markdown_content: T.nilable(String),
+            post_title: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/bounty_create_response.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class BountyCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::BountyCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for the bounty.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The underlying bounty implementation type.
+      sig do
+        returns(WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol)
+      end
+      attr_accessor :bounty_type
+
+      # The datetime the bounty was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The currency used for the bounty funds.
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The description of the bounty.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The current lifecycle status of the bounty.
+      sig do
+        returns(WhopSDK::Models::BountyCreateResponse::Status::TaggedSymbol)
+      end
+      attr_accessor :status
+
+      # The title of the bounty.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The total amount currently funded in the bounty pool for payout.
+      sig { returns(Float) }
+      attr_accessor :total_available
+
+      # The total amount paid out for this bounty.
+      sig { returns(Float) }
+      attr_accessor :total_paid
+
+      # The datetime the bounty was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The number of watcher votes required before the submission can resolve.
+      sig { returns(Integer) }
+      attr_accessor :vote_threshold
+
+      # A privately accessible bounty.
+      sig do
+        params(
+          id: String,
+          bounty_type:
+            WhopSDK::Models::BountyCreateResponse::BountyType::OrSymbol,
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          description: String,
+          status: WhopSDK::Models::BountyCreateResponse::Status::OrSymbol,
+          title: String,
+          total_available: Float,
+          total_paid: Float,
+          updated_at: Time,
+          vote_threshold: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the bounty.
+        id:,
+        # The underlying bounty implementation type.
+        bounty_type:,
+        # The datetime the bounty was created.
+        created_at:,
+        # The currency used for the bounty funds.
+        currency:,
+        # The description of the bounty.
+        description:,
+        # The current lifecycle status of the bounty.
+        status:,
+        # The title of the bounty.
+        title:,
+        # The total amount currently funded in the bounty pool for payout.
+        total_available:,
+        # The total amount paid out for this bounty.
+        total_paid:,
+        # The datetime the bounty was last updated.
+        updated_at:,
+        # The number of watcher votes required before the submission can resolve.
+        vote_threshold:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            bounty_type:
+              WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol,
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            description: String,
+            status: WhopSDK::Models::BountyCreateResponse::Status::TaggedSymbol,
+            title: String,
+            total_available: Float,
+            total_paid: Float,
+            updated_at: Time,
+            vote_threshold: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The underlying bounty implementation type.
+      module BountyType
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::BountyCreateResponse::BountyType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CLASSIC =
+          T.let(
+            :classic,
+            WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol
+          )
+        USER_FUNDED =
+          T.let(
+            :user_funded,
+            WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol
+          )
+        WORKFORCE =
+          T.let(
+            :workforce,
+            WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::BountyCreateResponse::BountyType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The current lifecycle status of the bounty.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::BountyCreateResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLISHED =
+          T.let(
+            :published,
+            WhopSDK::Models::BountyCreateResponse::Status::TaggedSymbol
+          )
+        ARCHIVED =
+          T.let(
+            :archived,
+            WhopSDK::Models::BountyCreateResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::BountyCreateResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/bounty_list_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class BountyListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::BountyListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # The direction of the sort.
+      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # The experience to list bounties for. When omitted, returns bounties with no
+      # experience.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :experience_id
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # The available bounty statuses to choose from.
+      sig { returns(T.nilable(WhopSDK::BountyListParams::Status::OrSymbol)) }
+      attr_accessor :status
+
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          experience_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          status: T.nilable(WhopSDK::BountyListParams::Status::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # The experience to list bounties for. When omitted, returns bounties with no
+        # experience.
+        experience_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The available bounty statuses to choose from.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: T.nilable(String),
+            before: T.nilable(String),
+            direction: T.nilable(WhopSDK::Direction::OrSymbol),
+            experience_id: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            status: T.nilable(WhopSDK::BountyListParams::Status::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The available bounty statuses to choose from.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::BountyListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLISHED =
+          T.let(:published, WhopSDK::BountyListParams::Status::TaggedSymbol)
+        ARCHIVED =
+          T.let(:archived, WhopSDK::BountyListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::BountyListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end