whop_sdk 0.0.2 → 0.0.3

data/rbi/whop_sdk/models/promo_code_list_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PromoCodeListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PromoCodeListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list promo codes for
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # Filter promo codes by plan ID(s)
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :plan_ids
+
+      # Filter promo codes by product ID(s)
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :product_ids
+
+      # Statuses for promo codes
+      sig { returns(T.nilable(WhopSDK::PromoCodeStatus::OrSymbol)) }
+      attr_accessor :status
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
+          status: T.nilable(WhopSDK::PromoCodeStatus::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to list promo codes for
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # Filter promo codes by plan ID(s)
+        plan_ids: nil,
+        # Filter promo codes by product ID(s)
+        product_ids: nil,
+        # Statuses for promo codes
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            plan_ids: T.nilable(T::Array[String]),
+            product_ids: T.nilable(T::Array[String]),
+            status: T.nilable(WhopSDK::PromoCodeStatus::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_code_list_response.rbi

@@ -0,0 +1,222 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PromoCodeListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::PromoCodeListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID of the promo.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount off (% or flat amount) for the promo.
+      sig { returns(Float) }
+      attr_accessor :amount_off
+
+      # Restricts promo use to only users who have churned from the company before.
+      sig { returns(T::Boolean) }
+      attr_accessor :churned_users_only
+
+      # The specific code used to apply the promo at checkout.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :code
+
+      # The timestamp of when the promo was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The monetary currency of the promo code.
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The duration setting for the promo code
+      sig { returns(T.nilable(WhopSDK::PromoDuration::TaggedSymbol)) }
+      attr_accessor :duration
+
+      # Restricts promo use to only be applied to already purchased memberships.
+      sig { returns(T::Boolean) }
+      attr_accessor :existing_memberships_only
+
+      # The date/time of when the promo expires.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # Restricts promo use to only users who have never purchased from the company
+      # before.
+      sig { returns(T::Boolean) }
+      attr_accessor :new_users_only
+
+      # Restricts promo use to only be applied once per customer.
+      sig { returns(T::Boolean) }
+      attr_accessor :one_per_customer
+
+      # The access pass associated with the promo code.
+      sig do
+        returns(T.nilable(WhopSDK::Models::PromoCodeListResponse::Product))
+      end
+      attr_reader :product
+
+      sig do
+        params(
+          product:
+            T.nilable(WhopSDK::Models::PromoCodeListResponse::Product::OrHash)
+        ).void
+      end
+      attr_writer :product
+
+      # The number of months the promo is applied for.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :promo_duration_months
+
+      # The type (% or flat amount) of the promo.
+      sig { returns(WhopSDK::PromoType::TaggedSymbol) }
+      attr_accessor :promo_type
+
+      # Indicates if the promo code is live or disabled.
+      sig { returns(WhopSDK::PromoCodeStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # The quantity limit on the number of uses.
+      sig { returns(Integer) }
+      attr_accessor :stock
+
+      # Whether or not the promo code has unlimited stock.
+      sig { returns(T::Boolean) }
+      attr_accessor :unlimited_stock
+
+      # The amount of times the promo codes has been used.
+      sig { returns(Integer) }
+      attr_accessor :uses
+
+      # An object representing a promo code for a plan.
+      sig do
+        params(
+          id: String,
+          amount_off: Float,
+          churned_users_only: T::Boolean,
+          code: T.nilable(String),
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          duration: T.nilable(WhopSDK::PromoDuration::OrSymbol),
+          existing_memberships_only: T::Boolean,
+          expires_at: T.nilable(Time),
+          new_users_only: T::Boolean,
+          one_per_customer: T::Boolean,
+          product:
+            T.nilable(WhopSDK::Models::PromoCodeListResponse::Product::OrHash),
+          promo_duration_months: T.nilable(Integer),
+          promo_type: WhopSDK::PromoType::OrSymbol,
+          status: WhopSDK::PromoCodeStatus::OrSymbol,
+          stock: Integer,
+          unlimited_stock: T::Boolean,
+          uses: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the promo.
+        id:,
+        # The amount off (% or flat amount) for the promo.
+        amount_off:,
+        # Restricts promo use to only users who have churned from the company before.
+        churned_users_only:,
+        # The specific code used to apply the promo at checkout.
+        code:,
+        # The timestamp of when the promo was created.
+        created_at:,
+        # The monetary currency of the promo code.
+        currency:,
+        # The duration setting for the promo code
+        duration:,
+        # Restricts promo use to only be applied to already purchased memberships.
+        existing_memberships_only:,
+        # The date/time of when the promo expires.
+        expires_at:,
+        # Restricts promo use to only users who have never purchased from the company
+        # before.
+        new_users_only:,
+        # Restricts promo use to only be applied once per customer.
+        one_per_customer:,
+        # The access pass associated with the promo code.
+        product:,
+        # The number of months the promo is applied for.
+        promo_duration_months:,
+        # The type (% or flat amount) of the promo.
+        promo_type:,
+        # Indicates if the promo code is live or disabled.
+        status:,
+        # The quantity limit on the number of uses.
+        stock:,
+        # Whether or not the promo code has unlimited stock.
+        unlimited_stock:,
+        # The amount of times the promo codes has been used.
+        uses:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount_off: Float,
+            churned_users_only: T::Boolean,
+            code: T.nilable(String),
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            duration: T.nilable(WhopSDK::PromoDuration::TaggedSymbol),
+            existing_memberships_only: T::Boolean,
+            expires_at: T.nilable(Time),
+            new_users_only: T::Boolean,
+            one_per_customer: T::Boolean,
+            product: T.nilable(WhopSDK::Models::PromoCodeListResponse::Product),
+            promo_duration_months: T.nilable(Integer),
+            promo_type: WhopSDK::PromoType::TaggedSymbol,
+            status: WhopSDK::PromoCodeStatus::TaggedSymbol,
+            stock: Integer,
+            unlimited_stock: T::Boolean,
+            uses: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PromoCodeListResponse::Product,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The access pass associated with the promo code.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_code_retrieve_params.rbi

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

@@ -0,0 +1,21 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # Statuses for promo codes
+    module PromoCodeStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::PromoCodeStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      ACTIVE = T.let(:active, WhopSDK::PromoCodeStatus::TaggedSymbol)
+      INACTIVE = T.let(:inactive, WhopSDK::PromoCodeStatus::TaggedSymbol)
+      ARCHIVED = T.let(:archived, WhopSDK::PromoCodeStatus::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::PromoCodeStatus::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_duration.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The duration setting for the promo code
+    module PromoDuration
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::PromoDuration) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      FOREVER = T.let(:forever, WhopSDK::PromoDuration::TaggedSymbol)
+      ONCE = T.let(:once, WhopSDK::PromoDuration::TaggedSymbol)
+      REPEATING = T.let(:repeating, WhopSDK::PromoDuration::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::PromoDuration::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/review_list_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ReviewListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ReviewListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the product
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # The maximum star rating of the review (inclusive)
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :max_stars
+
+      # The minimum star rating of the review (inclusive)
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :min_stars
+
+      sig do
+        params(
+          product_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          max_stars: T.nilable(Integer),
+          min_stars: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the product
+        product_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The maximum star rating of the review (inclusive)
+        max_stars: nil,
+        # The minimum star rating of the review (inclusive)
+        min_stars: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            product_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            max_stars: T.nilable(Integer),
+            min_stars: T.nilable(Integer),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end