whop_sdk 0.0.2

data/rbi/whop_sdk/models/forum_post_list_response.rbi

@@ -0,0 +1,172 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumPostListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::ForumPostListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for the entity
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount of comments on this post
+      sig { returns(Integer) }
+      attr_accessor :comment_count
+
+      # The content of the forum post in Markdown format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content
+
+      # Whether the forum post has been edited
+      sig { returns(T::Boolean) }
+      attr_accessor :is_edited
+
+      # Whether this forum post is pinned
+      sig { returns(T::Boolean) }
+      attr_accessor :is_pinned
+
+      # Whether the user that sent the post is an admin of the company
+      sig { returns(T::Boolean) }
+      attr_accessor :is_poster_admin
+
+      # The number of likes this post has received
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :like_count
+
+      # The ID of the parent forum post, if applicable
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_id
+
+      # The title of the forum post
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The user who created this forum post
+      sig { returns(WhopSDK::Models::ForumPostListResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(user: WhopSDK::Models::ForumPostListResponse::User::OrHash).void
+      end
+      attr_writer :user
+
+      # The number of times this message has been viewed
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :view_count
+
+      # Represents a post in forum
+      sig do
+        params(
+          id: String,
+          comment_count: Integer,
+          content: T.nilable(String),
+          is_edited: T::Boolean,
+          is_pinned: T::Boolean,
+          is_poster_admin: T::Boolean,
+          like_count: T.nilable(Integer),
+          parent_id: T.nilable(String),
+          title: T.nilable(String),
+          user: WhopSDK::Models::ForumPostListResponse::User::OrHash,
+          view_count: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the entity
+        id:,
+        # The amount of comments on this post
+        comment_count:,
+        # The content of the forum post in Markdown format
+        content:,
+        # Whether the forum post has been edited
+        is_edited:,
+        # Whether this forum post is pinned
+        is_pinned:,
+        # Whether the user that sent the post is an admin of the company
+        is_poster_admin:,
+        # The number of likes this post has received
+        like_count:,
+        # The ID of the parent forum post, if applicable
+        parent_id:,
+        # The title of the forum post
+        title:,
+        # The user who created this forum post
+        user:,
+        # The number of times this message has been viewed
+        view_count:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            comment_count: Integer,
+            content: T.nilable(String),
+            is_edited: T::Boolean,
+            is_pinned: T::Boolean,
+            is_poster_admin: T::Boolean,
+            like_count: T.nilable(Integer),
+            parent_id: T.nilable(String),
+            title: T.nilable(String),
+            user: WhopSDK::Models::ForumPostListResponse::User,
+            view_count: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::ForumPostListResponse::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who created this forum post
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/forum_post_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumPostRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumPostRetrieveParams, 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/forum_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumRetrieveParams, 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/forum_update_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # Email notification preference option for a forum feed
+      sig do
+        returns(T.nilable(WhopSDK::EmailNotificationPreferences::OrSymbol))
+      end
+      attr_accessor :email_notification_preference
+
+      # Who can comment on a forum feed
+      sig { returns(T.nilable(WhopSDK::WhoCanCommentTypes::OrSymbol)) }
+      attr_accessor :who_can_comment
+
+      # Who can post on a forum feed
+      sig { returns(T.nilable(WhopSDK::WhoCanPostTypes::OrSymbol)) }
+      attr_accessor :who_can_post
+
+      sig do
+        params(
+          email_notification_preference:
+            T.nilable(WhopSDK::EmailNotificationPreferences::OrSymbol),
+          who_can_comment: T.nilable(WhopSDK::WhoCanCommentTypes::OrSymbol),
+          who_can_post: T.nilable(WhopSDK::WhoCanPostTypes::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email notification preference option for a forum feed
+        email_notification_preference: nil,
+        # Who can comment on a forum feed
+        who_can_comment: nil,
+        # Who can post on a forum feed
+        who_can_post: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email_notification_preference:
+              T.nilable(WhopSDK::EmailNotificationPreferences::OrSymbol),
+            who_can_comment: T.nilable(WhopSDK::WhoCanCommentTypes::OrSymbol),
+            who_can_post: T.nilable(WhopSDK::WhoCanPostTypes::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/friendly_receipt_status.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The friendly status of a receipt
+    module FriendlyReceiptStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, WhopSDK::FriendlyReceiptStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      AUTO_REFUNDED =
+        T.let(:auto_refunded, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      REFUNDED = T.let(:refunded, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      PARTIALLY_REFUNDED =
+        T.let(:partially_refunded, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      DISPUTE_WARNING =
+        T.let(:dispute_warning, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      OPEN_RESOLUTION =
+        T.let(:open_resolution, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      OPEN_DISPUTE =
+        T.let(:open_dispute, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      FAILED = T.let(:failed, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      PRICE_TOO_LOW =
+        T.let(:price_too_low, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      SUCCEEDED =
+        T.let(:succeeded, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      DRAFTED = T.let(:drafted, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      UNCOLLECTIBLE =
+        T.let(:uncollectible, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      UNRESOLVED =
+        T.let(:unresolved, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      PAST_DUE = T.let(:past_due, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      PENDING = T.let(:pending, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      INCOMPLETE =
+        T.let(:incomplete, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+      CANCELED = T.let(:canceled, WhopSDK::FriendlyReceiptStatus::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[WhopSDK::FriendlyReceiptStatus::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/global_affiliate_status.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different statuses of the global affiliate program for an access pass.
+    module GlobalAffiliateStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, WhopSDK::GlobalAffiliateStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      ENABLED = T.let(:enabled, WhopSDK::GlobalAffiliateStatus::TaggedSymbol)
+      DISABLED = T.let(:disabled, WhopSDK::GlobalAffiliateStatus::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[WhopSDK::GlobalAffiliateStatus::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/industry_types.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different industry types a company can be in.
+    module IndustryTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::IndustryTypes) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TRADING = T.let(:trading, WhopSDK::IndustryTypes::TaggedSymbol)
+      SPORTS_BETTING =
+        T.let(:sports_betting, WhopSDK::IndustryTypes::TaggedSymbol)
+      RESELLING = T.let(:reselling, WhopSDK::IndustryTypes::TaggedSymbol)
+      FITNESS = T.let(:fitness, WhopSDK::IndustryTypes::TaggedSymbol)
+      AMAZON_FBA = T.let(:amazon_fba, WhopSDK::IndustryTypes::TaggedSymbol)
+      REAL_ESTATE = T.let(:real_estate, WhopSDK::IndustryTypes::TaggedSymbol)
+      KINDLE_BOOK_PUBLISHING =
+        T.let(:kindle_book_publishing, WhopSDK::IndustryTypes::TaggedSymbol)
+      DATING = T.let(:dating, WhopSDK::IndustryTypes::TaggedSymbol)
+      AGENCIES = T.let(:agencies, WhopSDK::IndustryTypes::TaggedSymbol)
+      HEALTH_AND_WELLNESS =
+        T.let(:health_and_wellness, WhopSDK::IndustryTypes::TaggedSymbol)
+      SOCIAL_MEDIA = T.let(:social_media, WhopSDK::IndustryTypes::TaggedSymbol)
+      SALES = T.let(:sales, WhopSDK::IndustryTypes::TaggedSymbol)
+      BUSINESS = T.let(:business, WhopSDK::IndustryTypes::TaggedSymbol)
+      ECOMMERCE = T.let(:ecommerce, WhopSDK::IndustryTypes::TaggedSymbol)
+      VIDEO_GAMES = T.let(:video_games, WhopSDK::IndustryTypes::TaggedSymbol)
+      HOME_SERVICES =
+        T.let(:home_services, WhopSDK::IndustryTypes::TaggedSymbol)
+      AI = T.let(:ai, WhopSDK::IndustryTypes::TaggedSymbol)
+      PUBLIC_SPEAKING =
+        T.let(:public_speaking, WhopSDK::IndustryTypes::TaggedSymbol)
+      PERSONAL_FINANCE =
+        T.let(:personal_finance, WhopSDK::IndustryTypes::TaggedSymbol)
+      CAREERS = T.let(:careers, WhopSDK::IndustryTypes::TaggedSymbol)
+      TRAVEL = T.let(:travel, WhopSDK::IndustryTypes::TaggedSymbol)
+      CLIPPING = T.let(:clipping, WhopSDK::IndustryTypes::TaggedSymbol)
+      SPIRITUALITY = T.let(:spirituality, WhopSDK::IndustryTypes::TaggedSymbol)
+      VAS = T.let(:vas, WhopSDK::IndustryTypes::TaggedSymbol)
+      PERSONAL_DEVELOPMENT =
+        T.let(:personal_development, WhopSDK::IndustryTypes::TaggedSymbol)
+      SOFTWARE = T.let(:software, WhopSDK::IndustryTypes::TaggedSymbol)
+      OTHER = T.let(:other, WhopSDK::IndustryTypes::TaggedSymbol)
+      MARKETING_AGENCY =
+        T.let(:marketing_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      SALES_AGENCY = T.let(:sales_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      AI_AGENCY = T.let(:ai_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      DESIGN_AGENCY =
+        T.let(:design_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      COACHING_AGENCY =
+        T.let(:coaching_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      DEVELOPMENT_AGENCY =
+        T.let(:development_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      RECRUITING_AGENCY =
+        T.let(:recruiting_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      CUSTOMER_SUPPORT_AGENCY =
+        T.let(:customer_support_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      CLIPPING_AGENCY =
+        T.let(:clipping_agency, WhopSDK::IndustryTypes::TaggedSymbol)
+      CLOTHING = T.let(:clothing, WhopSDK::IndustryTypes::TaggedSymbol)
+      SUPPLEMENTS = T.let(:supplements, WhopSDK::IndustryTypes::TaggedSymbol)
+      BEAUTY_AND_PERSONAL_CARE =
+        T.let(:beauty_and_personal_care, WhopSDK::IndustryTypes::TaggedSymbol)
+      FITNESS_GEAR = T.let(:fitness_gear, WhopSDK::IndustryTypes::TaggedSymbol)
+      ACCESSORIES = T.let(:accessories, WhopSDK::IndustryTypes::TaggedSymbol)
+      HOME_GOODS = T.let(:home_goods, WhopSDK::IndustryTypes::TaggedSymbol)
+      ELECTRONICS_AND_GADGETS =
+        T.let(:electronics_and_gadgets, WhopSDK::IndustryTypes::TaggedSymbol)
+      FOOD_AND_BEVERAGES =
+        T.let(:food_and_beverages, WhopSDK::IndustryTypes::TaggedSymbol)
+      GYM = T.let(:gym, WhopSDK::IndustryTypes::TaggedSymbol)
+      RESTAURANT = T.let(:restaurant, WhopSDK::IndustryTypes::TaggedSymbol)
+      RETAIL_STORE = T.let(:retail_store, WhopSDK::IndustryTypes::TaggedSymbol)
+      COFFEE_SHOP = T.let(:coffee_shop, WhopSDK::IndustryTypes::TaggedSymbol)
+      SALON_SPA = T.let(:salon_spa, WhopSDK::IndustryTypes::TaggedSymbol)
+      MEDICAL_DENTIST_OFFICE =
+        T.let(:medical_dentist_office, WhopSDK::IndustryTypes::TaggedSymbol)
+      HOTEL_LODGING =
+        T.let(:hotel_lodging, WhopSDK::IndustryTypes::TaggedSymbol)
+      AUTO_REPAIR_SHOP =
+        T.let(:auto_repair_shop, WhopSDK::IndustryTypes::TaggedSymbol)
+      MASTERMINDS = T.let(:masterminds, WhopSDK::IndustryTypes::TaggedSymbol)
+      WEBINARS = T.let(:webinars, WhopSDK::IndustryTypes::TaggedSymbol)
+      BOOTCAMPS = T.let(:bootcamps, WhopSDK::IndustryTypes::TaggedSymbol)
+      CONVENTION = T.let(:convention, WhopSDK::IndustryTypes::TaggedSymbol)
+      CONCERTS = T.let(:concerts, WhopSDK::IndustryTypes::TaggedSymbol)
+      MEETUPS = T.let(:meetups, WhopSDK::IndustryTypes::TaggedSymbol)
+      PARTIES = T.let(:parties, WhopSDK::IndustryTypes::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::IndustryTypes::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Invoice < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Invoice, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the invoice.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The date the invoice was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The plan that the invoice was created for.
+      sig { returns(WhopSDK::Invoice::CurrentPlan) }
+      attr_reader :current_plan
+
+      sig { params(current_plan: WhopSDK::Invoice::CurrentPlan::OrHash).void }
+      attr_writer :current_plan
+
+      # The date the invoice is due.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :due_date
+
+      # The email address that the invoice was created for.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email_address
+
+      # The token to fetch the invoice.
+      sig { returns(String) }
+      attr_accessor :fetch_invoice_token
+
+      # The number of the invoice.
+      sig { returns(String) }
+      attr_accessor :number
+
+      # The status of the invoice.
+      sig { returns(WhopSDK::InvoiceStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # The user that the invoice was created for.
+      sig { returns(T.nilable(WhopSDK::Invoice::User)) }
+      attr_reader :user
+
+      sig { params(user: T.nilable(WhopSDK::Invoice::User::OrHash)).void }
+      attr_writer :user
+
+      # A statement that defines an amount due by a customer.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          current_plan: WhopSDK::Invoice::CurrentPlan::OrHash,
+          due_date: T.nilable(Time),
+          email_address: T.nilable(String),
+          fetch_invoice_token: String,
+          number: String,
+          status: WhopSDK::InvoiceStatus::OrSymbol,
+          user: T.nilable(WhopSDK::Invoice::User::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the invoice.
+        id:,
+        # The date the invoice was created.
+        created_at:,
+        # The plan that the invoice was created for.
+        current_plan:,
+        # The date the invoice is due.
+        due_date:,
+        # The email address that the invoice was created for.
+        email_address:,
+        # The token to fetch the invoice.
+        fetch_invoice_token:,
+        # The number of the invoice.
+        number:,
+        # The status of the invoice.
+        status:,
+        # The user that the invoice was created for.
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            current_plan: WhopSDK::Invoice::CurrentPlan,
+            due_date: T.nilable(Time),
+            email_address: T.nilable(String),
+            fetch_invoice_token: String,
+            number: String,
+            status: WhopSDK::InvoiceStatus::TaggedSymbol,
+            user: T.nilable(WhopSDK::Invoice::User)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CurrentPlan < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Invoice::CurrentPlan, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the plan.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The respective currency identifier for the plan.
+        sig { returns(WhopSDK::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # The formatted price (including currency) for the plan.
+        sig { returns(String) }
+        attr_accessor :formatted_price
+
+        # The plan that the invoice was created for.
+        sig do
+          params(
+            id: String,
+            currency: WhopSDK::Currency::OrSymbol,
+            formatted_price: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The internal ID of the plan.
+          id:,
+          # The respective currency identifier for the plan.
+          currency:,
+          # The formatted price (including currency) for the plan.
+          formatted_price:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              currency: WhopSDK::Currency::TaggedSymbol,
+              formatted_price: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Invoice::User, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user that the invoice was created for.
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end