whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/media_generate_params.rbi

@@ -0,0 +1,204 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MediaGenerateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::MediaGenerateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # What to generate. Up to 2,000 characters.
+      sig { returns(String) }
+      attr_accessor :prompt
+
+      # The kind of media to generate.
+      sig { returns(WhopSDK::MediaGenerateParams::Type::OrSymbol) }
+      attr_accessor :type
+
+      # Account ID, prefixed `biz_`. Defaults to the account the API key belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # Video length in seconds. Video only; defaults to 5.
+      sig do
+        returns(
+          T.nilable(WhopSDK::MediaGenerateParams::DurationSeconds::OrInteger)
+        )
+      end
+      attr_reader :duration_seconds
+
+      sig do
+        params(
+          duration_seconds:
+            WhopSDK::MediaGenerateParams::DurationSeconds::OrInteger
+        ).void
+      end
+      attr_writer :duration_seconds
+
+      # Optional reference image file IDs (`file_` prefixed), up to 4. For video, a
+      # single reference seeds the opening frame; multiple references guide subject and
+      # style instead.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :reference_media
+
+      sig { params(reference_media: T::Array[String]).void }
+      attr_writer :reference_media
+
+      # Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by
+      # Seedance 2.0 Fast or Mini; `4k` is only supported by Seedance 2.0.
+      sig do
+        returns(T.nilable(WhopSDK::MediaGenerateParams::Resolution::OrSymbol))
+      end
+      attr_reader :resolution
+
+      sig do
+        params(
+          resolution: WhopSDK::MediaGenerateParams::Resolution::OrSymbol
+        ).void
+      end
+      attr_writer :resolution
+
+      sig do
+        params(
+          prompt: String,
+          type: WhopSDK::MediaGenerateParams::Type::OrSymbol,
+          account_id: String,
+          duration_seconds:
+            WhopSDK::MediaGenerateParams::DurationSeconds::OrInteger,
+          reference_media: T::Array[String],
+          resolution: WhopSDK::MediaGenerateParams::Resolution::OrSymbol,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # What to generate. Up to 2,000 characters.
+        prompt:,
+        # The kind of media to generate.
+        type:,
+        # Account ID, prefixed `biz_`. Defaults to the account the API key belongs to.
+        account_id: nil,
+        # Video length in seconds. Video only; defaults to 5.
+        duration_seconds: nil,
+        # Optional reference image file IDs (`file_` prefixed), up to 4. For video, a
+        # single reference seeds the opening frame; multiple references guide subject and
+        # style instead.
+        reference_media: nil,
+        # Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by
+        # Seedance 2.0 Fast or Mini; `4k` is only supported by Seedance 2.0.
+        resolution: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            prompt: String,
+            type: WhopSDK::MediaGenerateParams::Type::OrSymbol,
+            account_id: String,
+            duration_seconds:
+              WhopSDK::MediaGenerateParams::DurationSeconds::OrInteger,
+            reference_media: T::Array[String],
+            resolution: WhopSDK::MediaGenerateParams::Resolution::OrSymbol,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The kind of media to generate.
+      module Type
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::MediaGenerateParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        VIDEO = T.let(:video, WhopSDK::MediaGenerateParams::Type::TaggedSymbol)
+        IMAGE = T.let(:image, WhopSDK::MediaGenerateParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::MediaGenerateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Video length in seconds. Video only; defaults to 5.
+      module DurationSeconds
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedInteger =
+          T.type_alias do
+            T.all(Integer, WhopSDK::MediaGenerateParams::DurationSeconds)
+          end
+        OrInteger = T.type_alias { Integer }
+
+        DURATION_SECONDS_5 =
+          T.let(5, WhopSDK::MediaGenerateParams::DurationSeconds::TaggedInteger)
+        DURATION_SECONDS_10 =
+          T.let(
+            10,
+            WhopSDK::MediaGenerateParams::DurationSeconds::TaggedInteger
+          )
+        DURATION_SECONDS_15 =
+          T.let(
+            15,
+            WhopSDK::MediaGenerateParams::DurationSeconds::TaggedInteger
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::MediaGenerateParams::DurationSeconds::TaggedInteger
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by
+      # Seedance 2.0 Fast or Mini; `4k` is only supported by Seedance 2.0.
+      module Resolution
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::MediaGenerateParams::Resolution)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        RESOLUTION_480P =
+          T.let(:"480p", WhopSDK::MediaGenerateParams::Resolution::TaggedSymbol)
+        RESOLUTION_720P =
+          T.let(:"720p", WhopSDK::MediaGenerateParams::Resolution::TaggedSymbol)
+        RESOLUTION_1080P =
+          T.let(
+            :"1080p",
+            WhopSDK::MediaGenerateParams::Resolution::TaggedSymbol
+          )
+        RESOLUTION_4K =
+          T.let(:"4k", WhopSDK::MediaGenerateParams::Resolution::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::MediaGenerateParams::Resolution::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/media_retrieve_params.rbi

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

data/rbi/whop_sdk/models/member_list_response.rbi

@@ -19,7 +19,8 @@ module WhopSDK
       sig { returns(WhopSDK::AccessLevel::TaggedSymbol) }
       attr_accessor :access_level
 
-      # The member's token balance for this company
+      # The member's token balance for this company. Computed live from the ledger, not
+      # from a cache.
       sig { returns(Float) }
       attr_accessor :company_token_balance
 
@@ -93,7 +94,8 @@ module WhopSDK
         # membership to any product on the company. If its no_access, the member does not
         # have access to the product.
         access_level:,
-        # The member's token balance for this company
+        # The member's token balance for this company. Computed live from the ledger, not
+        # from a cache.
         company_token_balance:,
         # The datetime the company member was created.
         created_at:,

data/rbi/whop_sdk/models/member_retrieve_response.rbi

@@ -33,7 +33,8 @@ module WhopSDK
       end
       attr_writer :company
 
-      # The member's token balance for this company
+      # The member's token balance for this company. Computed live from the ledger, not
+      # from a cache.
       sig { returns(Float) }
       attr_accessor :company_token_balance
 
@@ -110,7 +111,8 @@ module WhopSDK
         access_level:,
         # The company for the member.
         company:,
-        # The member's token balance for this company
+        # The member's token balance for this company. Computed live from the ledger, not
+        # from a cache.
         company_token_balance:,
         # The datetime the company member was created.
         created_at:,

data/rbi/whop_sdk/models/membership.rbi

@@ -82,7 +82,7 @@ module WhopSDK
       attr_writer :member
 
       # Custom key-value pairs for the membership (commonly used for software licensing,
-      # e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
+      # e.g., HWID). Max 50 keys, 100 chars per key, 500 chars per string value.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
 
@@ -215,7 +215,7 @@ module WhopSDK
         # the member record has not been created yet.
         member:,
         # Custom key-value pairs for the membership (commonly used for software licensing,
-        # e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
+        # e.g., HWID). Max 50 keys, 100 chars per key, 500 chars per string value.
         metadata:,
         # Whether recurring payment collection for this membership is temporarily paused
         # by the company.
@@ -384,15 +384,34 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom key-value pairs stored on the plan. Included in webhook payloads for
+        # payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+        # string value.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The plan the customer purchased to create this membership.
-        sig { params(id: String).returns(T.attached_class) }
+        sig do
+          params(
+            id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.anything])
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The unique identifier for the plan.
-          id:
+          id:,
+          # Custom key-value pairs stored on the plan. Included in webhook payloads for
+          # payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+          # string value.
+          metadata:
         )
         end
 
-        sig { override.returns({ id: String }) }
+        sig do
+          override.returns(
+            { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+          )
+        end
         def to_hash
         end
       end
@@ -407,23 +426,47 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom key-value pairs stored on the product and included in payment and
+        # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+        # per string value.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The display name of the product shown to customers on the product page and in
         # search results.
         sig { returns(String) }
         attr_accessor :title
 
         # The product this membership grants access to.
-        sig { params(id: String, title: String).returns(T.attached_class) }
+        sig do
+          params(
+            id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            title: String
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The unique identifier for the product.
           id:,
+          # Custom key-value pairs stored on the product and included in payment and
+          # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+          # per string value.
+          metadata:,
           # The display name of the product shown to customers on the product page and in
           # search results.
           title:
         )
         end
 
-        sig { override.returns({ id: String, title: String }) }
+        sig do
+          override.returns(
+            {
+              id: String,
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
+              title: String
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/whop_sdk/models/membership_list_response.rbi

@@ -91,7 +91,7 @@ module WhopSDK
       attr_writer :member
 
       # Custom key-value pairs for the membership (commonly used for software licensing,
-      # e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
+      # e.g., HWID). Max 50 keys, 100 chars per key, 500 chars per string value.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
 
@@ -238,7 +238,7 @@ module WhopSDK
         # the member record has not been created yet.
         member:,
         # Custom key-value pairs for the membership (commonly used for software licensing,
-        # e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
+        # e.g., HWID). Max 50 keys, 100 chars per key, 500 chars per string value.
         metadata:,
         # Whether recurring payment collection for this membership is temporarily paused
         # by the company.
@@ -371,15 +371,34 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom key-value pairs stored on the plan. Included in webhook payloads for
+        # payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+        # string value.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The plan the customer purchased to create this membership.
-        sig { params(id: String).returns(T.attached_class) }
+        sig do
+          params(
+            id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.anything])
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The unique identifier for the plan.
-          id:
+          id:,
+          # Custom key-value pairs stored on the plan. Included in webhook payloads for
+          # payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+          # string value.
+          metadata:
         )
         end
 
-        sig { override.returns({ id: String }) }
+        sig do
+          override.returns(
+            { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+          )
+        end
         def to_hash
         end
       end
@@ -397,23 +416,47 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom key-value pairs stored on the product and included in payment and
+        # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+        # per string value.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The display name of the product shown to customers on the product page and in
         # search results.
         sig { returns(String) }
         attr_accessor :title
 
         # The product this membership grants access to.
-        sig { params(id: String, title: String).returns(T.attached_class) }
+        sig do
+          params(
+            id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            title: String
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The unique identifier for the product.
           id:,
+          # Custom key-value pairs stored on the product and included in payment and
+          # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+          # per string value.
+          metadata:,
           # The display name of the product shown to customers on the product page and in
           # search results.
           title:
         )
         end
 
-        sig { override.returns({ id: String, title: String }) }
+        sig do
+          override.returns(
+            {
+              id: String,
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
+              title: String
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MembershipTrialEndingSoonWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::MembershipTrialEndingSoonWebhookEvent,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # A membership represents an active relationship between a user and a product. It
+      # tracks the user's access, billing status, and renewal schedule.
+      sig { returns(WhopSDK::Membership) }
+      attr_reader :data
+
+      sig { params(data: WhopSDK::Membership::OrHash).void }
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # The company ID that this webhook event is associated with
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Membership::OrHash,
+          timestamp: Time,
+          company_id: T.nilable(String),
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # A membership represents an active relationship between a user and a product. It
+        # tracks the user's access, billing status, and renewal schedule.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The company ID that this webhook event is associated with
+        company_id: nil,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"membership.trial_ending_soon"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Membership,
+            timestamp: Time,
+            type: Symbol,
+            company_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end