whop_sdk 0.0.39 → 0.0.40

data/rbi/whop_sdk/models/account_update_params.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # Whether prospective affiliates must submit an application before promoting this
+      # account.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :affiliate_application_required
+
+      sig { params(affiliate_application_required: T::Boolean).void }
+      attr_writer :affiliate_application_required
+
+      # Guidelines shown to affiliates promoting this account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :affiliate_instructions
+
+      # Attachment input for the account banner image.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :banner_image
+
+      # The high-level business category for the account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_type
+
+      # A promotional description for the account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The ID of the product to feature for affiliates. Pass null to clear.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :featured_affiliate_product_id
+
+      # The industry group the account belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :industry_group
+
+      # The specific industry vertical the account operates in.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :industry_type
+
+      # Attachment input for the account logo.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :logo
+
+      # Arbitrary key/value metadata to store on the account.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+      attr_writer :metadata
+
+      # The unique URL slug for the account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :route
+
+      # Whether Whop sends transactional emails to customers on behalf of this account.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :send_customer_emails
+
+      sig { params(send_customer_emails: T::Boolean).void }
+      attr_writer :send_customer_emails
+
+      # The full list of social links to display for the account.
+      sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+      attr_reader :social_links
+
+      sig { params(social_links: T::Array[T::Hash[Symbol, T.anything]]).void }
+      attr_writer :social_links
+
+      # The target audience for this account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :target_audience
+
+      # The display name of the account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      sig do
+        params(
+          account_id: String,
+          affiliate_application_required: T::Boolean,
+          affiliate_instructions: T.nilable(String),
+          banner_image: T.nilable(T::Hash[Symbol, T.anything]),
+          business_type: T.nilable(String),
+          description: T.nilable(String),
+          featured_affiliate_product_id: T.nilable(String),
+          industry_group: T.nilable(String),
+          industry_type: T.nilable(String),
+          logo: T.nilable(T::Hash[Symbol, T.anything]),
+          metadata: T::Hash[Symbol, T.anything],
+          route: T.nilable(String),
+          send_customer_emails: T::Boolean,
+          social_links: T::Array[T::Hash[Symbol, T.anything]],
+          target_audience: T.nilable(String),
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        account_id:,
+        # Whether prospective affiliates must submit an application before promoting this
+        # account.
+        affiliate_application_required: nil,
+        # Guidelines shown to affiliates promoting this account.
+        affiliate_instructions: nil,
+        # Attachment input for the account banner image.
+        banner_image: nil,
+        # The high-level business category for the account.
+        business_type: nil,
+        # A promotional description for the account.
+        description: nil,
+        # The ID of the product to feature for affiliates. Pass null to clear.
+        featured_affiliate_product_id: nil,
+        # The industry group the account belongs to.
+        industry_group: nil,
+        # The specific industry vertical the account operates in.
+        industry_type: nil,
+        # Attachment input for the account logo.
+        logo: nil,
+        # Arbitrary key/value metadata to store on the account.
+        metadata: nil,
+        # The unique URL slug for the account.
+        route: nil,
+        # Whether Whop sends transactional emails to customers on behalf of this account.
+        send_customer_emails: nil,
+        # The full list of social links to display for the account.
+        social_links: nil,
+        # The target audience for this account.
+        target_audience: nil,
+        # The display name of the account.
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            affiliate_application_required: T::Boolean,
+            affiliate_instructions: T.nilable(String),
+            banner_image: T.nilable(T::Hash[Symbol, T.anything]),
+            business_type: T.nilable(String),
+            description: T.nilable(String),
+            featured_affiliate_product_id: T.nilable(String),
+            industry_group: T.nilable(String),
+            industry_type: T.nilable(String),
+            logo: T.nilable(T::Hash[Symbol, T.anything]),
+            metadata: T::Hash[Symbol, T.anything],
+            route: T.nilable(String),
+            send_customer_emails: T::Boolean,
+            social_links: T::Array[T::Hash[Symbol, T.anything]],
+            target_audience: T.nilable(String),
+            title: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_wallet.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountWallet < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountWallet, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the wallet, which will look like wallet\_******\*******
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The on-chain address of the wallet
+      sig { returns(String) }
+      attr_accessor :address
+
+      # The blockchain network the wallet lives on
+      sig { returns(WhopSDK::AccountWallet::Network::TaggedSymbol) }
+      attr_accessor :network
+
+      sig do
+        params(
+          id: String,
+          address: String,
+          network: WhopSDK::AccountWallet::Network::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the wallet, which will look like wallet\_******\*******
+        id:,
+        # The on-chain address of the wallet
+        address:,
+        # The blockchain network the wallet lives on
+        network:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            address: String,
+            network: WhopSDK::AccountWallet::Network::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The blockchain network the wallet lives on
+      module Network
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::AccountWallet::Network) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SOLANA = T.let(:solana, WhopSDK::AccountWallet::Network::TaggedSymbol)
+        ETHEREUM =
+          T.let(:ethereum, WhopSDK::AccountWallet::Network::TaggedSymbol)
+        BITCOIN = T.let(:bitcoin, WhopSDK::AccountWallet::Network::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AccountWallet::Network::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/ad.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Ad < WhopSDK::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(WhopSDK::Ad, WhopSDK::Internal::AnyHash) }
+
+      # The unique identifier for this ad.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The ad campaign this ad belongs to.
+      sig { returns(WhopSDK::Ad::AdCampaign) }
+      attr_reader :ad_campaign
+
+      sig { params(ad_campaign: WhopSDK::Ad::AdCampaign::OrHash).void }
+      attr_writer :ad_campaign
+
+      # The parent ad group this ad belongs to.
+      sig { returns(WhopSDK::Ad::AdGroup) }
+      attr_reader :ad_group
+
+      sig { params(ad_group: WhopSDK::Ad::AdGroup::OrHash).void }
+      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 { returns(WhopSDK::AdCampaignPlatform::TaggedSymbol) }
+      attr_accessor :platform
+
+      # Current delivery status of the ad.
+      sig { returns(WhopSDK::ExternalAdStatus::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::Ad::AdCampaign::OrHash,
+          ad_group: WhopSDK::Ad::AdGroup::OrHash,
+          created_at: Time,
+          platform: WhopSDK::AdCampaignPlatform::OrSymbol,
+          status: WhopSDK::ExternalAdStatus::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::Ad::AdCampaign,
+            ad_group: WhopSDK::Ad::AdGroup,
+            created_at: Time,
+            platform: WhopSDK::AdCampaignPlatform::TaggedSymbol,
+            status: WhopSDK::ExternalAdStatus::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::Ad::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::Ad::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
+    end
+  end
+end

data/rbi/whop_sdk/models/ad_budget_type.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The budget type for an ad campaign or ad group.
+    module AdBudgetType
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::AdBudgetType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DAILY = T.let(:daily, WhopSDK::AdBudgetType::TaggedSymbol)
+      LIFETIME = T.let(:lifetime, WhopSDK::AdBudgetType::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::AdBudgetType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end