whop_sdk 0.0.39 → 0.0.40

data/rbi/whop_sdk/models/account.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Account < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Account, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the account, which will look like biz\_******\*******
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The URL of the account banner image
+      sig { returns(T.nilable(String)) }
+      attr_accessor :banner_image_url
+
+      # The high-level business category for the account
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_type
+
+      # When the account was created, as an ISO 8601 timestamp
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # A promotional description for the account
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The email address of the account owner
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # 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
+
+      # The URL of the account logo image
+      sig { returns(T.nilable(String)) }
+      attr_accessor :logo_url
+
+      # Arbitrary key/value metadata supplied when the account was created
+      sig { returns(T.anything) }
+      attr_accessor :metadata
+
+      # The parent account ID for connected accounts
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_account_id
+
+      # The account's public route identifier
+      sig { returns(String) }
+      attr_accessor :route
+
+      # Whether Whop sends transactional emails to customers on behalf of this account
+      sig { returns(T::Boolean) }
+      attr_accessor :send_customer_emails
+
+      sig { returns(T::Array[WhopSDK::AccountSocialLink]) }
+      attr_accessor :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(String) }
+      attr_accessor :title
+
+      # The account's primary crypto wallet, or null if none has been provisioned
+      sig { returns(T.nilable(WhopSDK::AccountWallet)) }
+      attr_reader :wallet
+
+      sig { params(wallet: T.nilable(WhopSDK::AccountWallet::OrHash)).void }
+      attr_writer :wallet
+
+      sig do
+        params(
+          id: String,
+          banner_image_url: T.nilable(String),
+          business_type: T.nilable(String),
+          created_at: String,
+          description: T.nilable(String),
+          email: T.nilable(String),
+          industry_group: T.nilable(String),
+          industry_type: T.nilable(String),
+          logo_url: T.nilable(String),
+          metadata: T.anything,
+          parent_account_id: T.nilable(String),
+          route: String,
+          send_customer_emails: T::Boolean,
+          social_links: T::Array[WhopSDK::AccountSocialLink::OrHash],
+          target_audience: T.nilable(String),
+          title: String,
+          wallet: T.nilable(WhopSDK::AccountWallet::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account, which will look like biz\_******\*******
+        id:,
+        # The URL of the account banner image
+        banner_image_url:,
+        # The high-level business category for the account
+        business_type:,
+        # When the account was created, as an ISO 8601 timestamp
+        created_at:,
+        # A promotional description for the account
+        description:,
+        # The email address of the account owner
+        email:,
+        # The industry group the account belongs to
+        industry_group:,
+        # The specific industry vertical the account operates in
+        industry_type:,
+        # The URL of the account logo image
+        logo_url:,
+        # Arbitrary key/value metadata supplied when the account was created
+        metadata:,
+        # The parent account ID for connected accounts
+        parent_account_id:,
+        # The account's public route identifier
+        route:,
+        # Whether Whop sends transactional emails to customers on behalf of this account
+        send_customer_emails:,
+        social_links:,
+        # The target audience for this account
+        target_audience:,
+        # The display name of the account
+        title:,
+        # The account's primary crypto wallet, or null if none has been provisioned
+        wallet:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            banner_image_url: T.nilable(String),
+            business_type: T.nilable(String),
+            created_at: String,
+            description: T.nilable(String),
+            email: T.nilable(String),
+            industry_group: T.nilable(String),
+            industry_type: T.nilable(String),
+            logo_url: T.nilable(String),
+            metadata: T.anything,
+            parent_account_id: T.nilable(String),
+            route: String,
+            send_customer_emails: T::Boolean,
+            social_links: T::Array[WhopSDK::AccountSocialLink],
+            target_audience: T.nilable(String),
+            title: String,
+            wallet: T.nilable(WhopSDK::AccountWallet)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_create_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The email address of the account owner. Required for business account API key
+      # requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # 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
+
+      sig do
+        params(
+          email: String,
+          metadata: T::Hash[Symbol, T.anything],
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The email address of the account owner. Required for business account API key
+        # requests.
+        email: nil,
+        # Arbitrary key/value metadata to store on the account.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            metadata: T::Hash[Symbol, T.anything],
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The page number to retrieve
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # The number of resources to return per page. There is a limit of 50 results per
+      # page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per
+
+      sig { params(per: Integer).void }
+      attr_writer :per
+
+      sig do
+        params(
+          page: Integer,
+          per: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The page number to retrieve
+        page: nil,
+        # The number of resources to return per page. There is a limit of 50 results per
+        # page.
+        per: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page: Integer,
+            per: Integer,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_list_response.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::AccountListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[WhopSDK::Account]) }
+      attr_accessor :accounts
+
+      sig { returns(WhopSDK::Models::AccountListResponse::Pagination) }
+      attr_reader :pagination
+
+      sig do
+        params(
+          pagination: WhopSDK::Models::AccountListResponse::Pagination::OrHash
+        ).void
+      end
+      attr_writer :pagination
+
+      sig do
+        params(
+          accounts: T::Array[WhopSDK::Account::OrHash],
+          pagination: WhopSDK::Models::AccountListResponse::Pagination::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(accounts:, pagination:)
+      end
+
+      sig do
+        override.returns(
+          {
+            accounts: T::Array[WhopSDK::Account],
+            pagination: WhopSDK::Models::AccountListResponse::Pagination
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Pagination < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AccountListResponse::Pagination,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # Current page number
+        sig { returns(Float) }
+        attr_accessor :current_page
+
+        # Next page number
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :next_page
+
+        # Previous page number
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :prev_page
+
+        # Total number of records
+        sig { returns(Float) }
+        attr_accessor :total_count
+
+        # Total number of pages
+        sig { returns(Float) }
+        attr_accessor :total_pages
+
+        sig do
+          params(
+            current_page: Float,
+            next_page: T.nilable(Float),
+            prev_page: T.nilable(Float),
+            total_count: Float,
+            total_pages: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Current page number
+          current_page:,
+          # Next page number
+          next_page:,
+          # Previous page number
+          prev_page:,
+          # Total number of records
+          total_count:,
+          # Total number of pages
+          total_pages:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              current_page: Float,
+              next_page: T.nilable(Float),
+              prev_page: T.nilable(Float),
+              total_count: Float,
+              total_pages: Float
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_me_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountMeParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountMeParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      sig do
+        params(
+          account_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(account_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { account_id: String, request_options: WhopSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/account_social_link.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccountSocialLink < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccountSocialLink, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the social link
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The optional display title for the social link
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The social link URL
+      sig { returns(String) }
+      attr_accessor :url
+
+      # The social platform for this link
+      sig { returns(WhopSDK::AccountSocialLink::Website::TaggedSymbol) }
+      attr_accessor :website
+
+      sig do
+        params(
+          id: String,
+          title: T.nilable(String),
+          url: String,
+          website: WhopSDK::AccountSocialLink::Website::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the social link
+        id:,
+        # The optional display title for the social link
+        title:,
+        # The social link URL
+        url:,
+        # The social platform for this link
+        website:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            title: T.nilable(String),
+            url: String,
+            website: WhopSDK::AccountSocialLink::Website::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The social platform for this link
+      module Website
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::AccountSocialLink::Website) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        X = T.let(:x, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        INSTAGRAM =
+          T.let(:instagram, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        FACEBOOK =
+          T.let(:facebook, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        TIKTOK =
+          T.let(:tiktok, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        YOUTUBE =
+          T.let(:youtube, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        LINKEDIN =
+          T.let(:linkedin, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        TWITCH =
+          T.let(:twitch, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        WEBSITE =
+          T.let(:website, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+        CUSTOM =
+          T.let(:custom, WhopSDK::AccountSocialLink::Website::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AccountSocialLink::Website::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end