whop_sdk 0.0.2

data/rbi/whop_sdk/models/membership.rbi

@@ -0,0 +1,351 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Membership < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Membership, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the membership
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether this Membership is set to cancel at the end of the current billing
+      # cycle. Only applies for memberships that have a renewal plan.
+      sig { returns(T::Boolean) }
+      attr_accessor :cancel_at_period_end
+
+      # The epoch timestamp of when the customer initiated a cancellation.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :canceled_at
+
+      # The reason that the member canceled the membership (filled out by the member).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cancellation_reason
+
+      # The Company this Membership belongs to.
+      sig { returns(WhopSDK::Membership::Company) }
+      attr_reader :company
+
+      sig { params(company: WhopSDK::Membership::Company::OrHash).void }
+      attr_writer :company
+
+      # The timestamp, in seconds, that this Membership was created at.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+      attr_accessor :currency
+
+      # The license key for this Membership. This is only present if the membership
+      # grants access to an instance of the Whop Software app.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :license_key
+
+      # The URL for the customer to manage their membership.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :manage_url
+
+      # The Member that this Membership belongs to.
+      sig { returns(T.nilable(WhopSDK::Membership::Member)) }
+      attr_reader :member
+
+      sig do
+        params(member: T.nilable(WhopSDK::Membership::Member::OrHash)).void
+      end
+      attr_writer :member
+
+      # A JSON object used to store software licensing information. Ex. HWID
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :metadata
+
+      # Whether the membership's payments are currently paused.
+      sig { returns(T::Boolean) }
+      attr_accessor :payment_collection_paused
+
+      # The Plan this Membership is for.
+      sig { returns(WhopSDK::Membership::Plan) }
+      attr_reader :plan
+
+      sig { params(plan: WhopSDK::Membership::Plan::OrHash).void }
+      attr_writer :plan
+
+      # The Promo Code that is currently applied to this Membership.
+      sig { returns(T.nilable(WhopSDK::Membership::PromoCode)) }
+      attr_reader :promo_code
+
+      sig do
+        params(
+          promo_code: T.nilable(WhopSDK::Membership::PromoCode::OrHash)
+        ).void
+      end
+      attr_writer :promo_code
+
+      # The timestamp in seconds at which the current billing cycle for this
+      # subscription ends. Only applies for memberships that have a renewal plan.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :renewal_period_end
+
+      # The timestamp in seconds at which the current billing cycle for this
+      # subscription start. Only applies for memberships that have a renewal plan.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :renewal_period_start
+
+      # The status of the membership.
+      sig { returns(WhopSDK::MembershipStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # A timestamp of when the membership was last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The user this membership belongs to
+      sig { returns(T.nilable(WhopSDK::Membership::User)) }
+      attr_reader :user
+
+      sig { params(user: T.nilable(WhopSDK::Membership::User::OrHash)).void }
+      attr_writer :user
+
+      # A membership represents a purchase between a User and a Company for a specific
+      # Product.
+      sig do
+        params(
+          id: String,
+          cancel_at_period_end: T::Boolean,
+          canceled_at: T.nilable(Time),
+          cancellation_reason: T.nilable(String),
+          company: WhopSDK::Membership::Company::OrHash,
+          created_at: Time,
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          license_key: T.nilable(String),
+          manage_url: T.nilable(String),
+          member: T.nilable(WhopSDK::Membership::Member::OrHash),
+          metadata: T::Hash[Symbol, T.anything],
+          payment_collection_paused: T::Boolean,
+          plan: WhopSDK::Membership::Plan::OrHash,
+          promo_code: T.nilable(WhopSDK::Membership::PromoCode::OrHash),
+          renewal_period_end: T.nilable(Time),
+          renewal_period_start: T.nilable(Time),
+          status: WhopSDK::MembershipStatus::OrSymbol,
+          updated_at: Time,
+          user: T.nilable(WhopSDK::Membership::User::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the membership
+        id:,
+        # Whether this Membership is set to cancel at the end of the current billing
+        # cycle. Only applies for memberships that have a renewal plan.
+        cancel_at_period_end:,
+        # The epoch timestamp of when the customer initiated a cancellation.
+        canceled_at:,
+        # The reason that the member canceled the membership (filled out by the member).
+        cancellation_reason:,
+        # The Company this Membership belongs to.
+        company:,
+        # The timestamp, in seconds, that this Membership was created at.
+        created_at:,
+        # The available currencies on the platform
+        currency:,
+        # The license key for this Membership. This is only present if the membership
+        # grants access to an instance of the Whop Software app.
+        license_key:,
+        # The URL for the customer to manage their membership.
+        manage_url:,
+        # The Member that this Membership belongs to.
+        member:,
+        # A JSON object used to store software licensing information. Ex. HWID
+        metadata:,
+        # Whether the membership's payments are currently paused.
+        payment_collection_paused:,
+        # The Plan this Membership is for.
+        plan:,
+        # The Promo Code that is currently applied to this Membership.
+        promo_code:,
+        # The timestamp in seconds at which the current billing cycle for this
+        # subscription ends. Only applies for memberships that have a renewal plan.
+        renewal_period_end:,
+        # The timestamp in seconds at which the current billing cycle for this
+        # subscription start. Only applies for memberships that have a renewal plan.
+        renewal_period_start:,
+        # The status of the membership.
+        status:,
+        # A timestamp of when the membership was last updated
+        updated_at:,
+        # The user this membership belongs to
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cancel_at_period_end: T::Boolean,
+            canceled_at: T.nilable(Time),
+            cancellation_reason: T.nilable(String),
+            company: WhopSDK::Membership::Company,
+            created_at: Time,
+            currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
+            license_key: T.nilable(String),
+            manage_url: T.nilable(String),
+            member: T.nilable(WhopSDK::Membership::Member),
+            metadata: T::Hash[Symbol, T.anything],
+            payment_collection_paused: T::Boolean,
+            plan: WhopSDK::Membership::Plan,
+            promo_code: T.nilable(WhopSDK::Membership::PromoCode),
+            renewal_period_end: T.nilable(Time),
+            renewal_period_start: T.nilable(Time),
+            status: WhopSDK::MembershipStatus::TaggedSymbol,
+            updated_at: Time,
+            user: T.nilable(WhopSDK::Membership::User)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::Company, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID (tag) of the company.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the company.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The Company this Membership belongs to.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The ID (tag) of the company.
+          id:,
+          # The title of the company.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class Member < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::Member, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the member
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Member that this Membership belongs to.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the member
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::Plan, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the plan.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Plan this Membership is for.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the plan.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class PromoCode < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::PromoCode, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the promo.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Promo Code that is currently applied to this Membership.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the promo.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::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 this membership belongs to
+        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/membership_activated_webhook_event.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MembershipActivatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::MembershipActivatedWebhookEvent,
+            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 a purchase between a User and a Company for a specific
+      # Product.
+      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
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Membership::OrHash,
+          timestamp: Time,
+          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 a purchase between a User and a Company for a specific
+        # Product.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"membership.activated"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Membership,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/membership_cancel_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MembershipCancelParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::MembershipCancelParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The mode of cancellation for a membership
+      sig do
+        returns(
+          T.nilable(WhopSDK::MembershipCancelParams::CancellationMode::OrSymbol)
+        )
+      end
+      attr_accessor :cancellation_mode
+
+      sig do
+        params(
+          cancellation_mode:
+            T.nilable(
+              WhopSDK::MembershipCancelParams::CancellationMode::OrSymbol
+            ),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The mode of cancellation for a membership
+        cancellation_mode: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cancellation_mode:
+              T.nilable(
+                WhopSDK::MembershipCancelParams::CancellationMode::OrSymbol
+              ),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The mode of cancellation for a membership
+      module CancellationMode
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::MembershipCancelParams::CancellationMode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AT_PERIOD_END =
+          T.let(
+            :at_period_end,
+            WhopSDK::MembershipCancelParams::CancellationMode::TaggedSymbol
+          )
+        IMMEDIATE =
+          T.let(
+            :immediate,
+            WhopSDK::MembershipCancelParams::CancellationMode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::MembershipCancelParams::CancellationMode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/membership_deactivated_webhook_event.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MembershipDeactivatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::MembershipDeactivatedWebhookEvent,
+            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 a purchase between a User and a Company for a specific
+      # Product.
+      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
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Membership::OrHash,
+          timestamp: Time,
+          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 a purchase between a User and a Company for a specific
+        # Product.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"membership.deactivated"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Membership,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end