whop_sdk 0.0.2

data/rbi/whop_sdk/models/plan_list_response.rbi

@@ -0,0 +1,296 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PlanListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::PlanListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The internal ID of the plan.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The interval at which the plan charges (renewal plans).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :billing_period
+
+      # The company for the plan.
+      sig { returns(T.nilable(WhopSDK::Models::PlanListResponse::Company)) }
+      attr_reader :company
+
+      sig do
+        params(
+          company: T.nilable(WhopSDK::Models::PlanListResponse::Company::OrHash)
+        ).void
+      end
+      attr_writer :company
+
+      # When the plan was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The respective currency identifier for the plan.
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The description of the plan.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The interval at which the plan charges (expiration plans).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :expiration_days
+
+      # The price a person has to pay for a plan on the initial purchase.
+      sig { returns(Float) }
+      attr_accessor :initial_price
+
+      # A personal description or notes section for the business.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :internal_notes
+
+      # The invoice associated with this plan.
+      sig { returns(T.nilable(WhopSDK::Models::PlanListResponse::Invoice)) }
+      attr_reader :invoice
+
+      sig do
+        params(
+          invoice: T.nilable(WhopSDK::Models::PlanListResponse::Invoice::OrHash)
+        ).void
+      end
+      attr_writer :invoice
+
+      # The number of members for the plan.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :member_count
+
+      # Indicates if the plan is a one time payment or recurring.
+      sig { returns(WhopSDK::PlanType::TaggedSymbol) }
+      attr_accessor :plan_type
+
+      # The access pass for the plan.
+      sig { returns(T.nilable(WhopSDK::Models::PlanListResponse::Product)) }
+      attr_reader :product
+
+      sig do
+        params(
+          product: T.nilable(WhopSDK::Models::PlanListResponse::Product::OrHash)
+        ).void
+      end
+      attr_writer :product
+
+      # The direct link to purchase the product.
+      sig { returns(String) }
+      attr_accessor :purchase_url
+
+      # This is the release method the business uses to sell this plan.
+      sig { returns(WhopSDK::ReleaseMethod::TaggedSymbol) }
+      attr_accessor :release_method
+
+      # The price a person has to pay for a plan on the renewal purchase.
+      sig { returns(Float) }
+      attr_accessor :renewal_price
+
+      # The number of free trial days added before a renewal plan.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_period_days
+
+      # When the plan was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Shows or hides the plan from public/business view.
+      sig { returns(WhopSDK::Visibility::TaggedSymbol) }
+      attr_accessor :visibility
+
+      # An object representing a (sanitized) plan of an access pass.
+      sig do
+        params(
+          id: String,
+          billing_period: T.nilable(Integer),
+          company:
+            T.nilable(WhopSDK::Models::PlanListResponse::Company::OrHash),
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          description: T.nilable(String),
+          expiration_days: T.nilable(Integer),
+          initial_price: Float,
+          internal_notes: T.nilable(String),
+          invoice:
+            T.nilable(WhopSDK::Models::PlanListResponse::Invoice::OrHash),
+          member_count: T.nilable(Integer),
+          plan_type: WhopSDK::PlanType::OrSymbol,
+          product:
+            T.nilable(WhopSDK::Models::PlanListResponse::Product::OrHash),
+          purchase_url: String,
+          release_method: WhopSDK::ReleaseMethod::OrSymbol,
+          renewal_price: Float,
+          trial_period_days: T.nilable(Integer),
+          updated_at: Time,
+          visibility: WhopSDK::Visibility::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The internal ID of the plan.
+        id:,
+        # The interval at which the plan charges (renewal plans).
+        billing_period:,
+        # The company for the plan.
+        company:,
+        # When the plan was created.
+        created_at:,
+        # The respective currency identifier for the plan.
+        currency:,
+        # The description of the plan.
+        description:,
+        # The interval at which the plan charges (expiration plans).
+        expiration_days:,
+        # The price a person has to pay for a plan on the initial purchase.
+        initial_price:,
+        # A personal description or notes section for the business.
+        internal_notes:,
+        # The invoice associated with this plan.
+        invoice:,
+        # The number of members for the plan.
+        member_count:,
+        # Indicates if the plan is a one time payment or recurring.
+        plan_type:,
+        # The access pass for the plan.
+        product:,
+        # The direct link to purchase the product.
+        purchase_url:,
+        # This is the release method the business uses to sell this plan.
+        release_method:,
+        # The price a person has to pay for a plan on the renewal purchase.
+        renewal_price:,
+        # The number of free trial days added before a renewal plan.
+        trial_period_days:,
+        # When the plan was last updated.
+        updated_at:,
+        # Shows or hides the plan from public/business view.
+        visibility:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            billing_period: T.nilable(Integer),
+            company: T.nilable(WhopSDK::Models::PlanListResponse::Company),
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            description: T.nilable(String),
+            expiration_days: T.nilable(Integer),
+            initial_price: Float,
+            internal_notes: T.nilable(String),
+            invoice: T.nilable(WhopSDK::Models::PlanListResponse::Invoice),
+            member_count: T.nilable(Integer),
+            plan_type: WhopSDK::PlanType::TaggedSymbol,
+            product: T.nilable(WhopSDK::Models::PlanListResponse::Product),
+            purchase_url: String,
+            release_method: WhopSDK::ReleaseMethod::TaggedSymbol,
+            renewal_price: Float,
+            trial_period_days: T.nilable(Integer),
+            updated_at: Time,
+            visibility: WhopSDK::Visibility::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PlanListResponse::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 for the plan.
+        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 Invoice < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PlanListResponse::Invoice,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the invoice.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The invoice associated with this plan.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the invoice.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PlanListResponse::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 for the plan.
+        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/plan_retrieve_params.rbi

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

@@ -0,0 +1,20 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The type of plan that can be attached to an access pass
+    module PlanType
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::PlanType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      RENEWAL = T.let(:renewal, WhopSDK::PlanType::TaggedSymbol)
+      ONE_TIME = T.let(:one_time, WhopSDK::PlanType::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::PlanType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/plan_update_params.rbi

@@ -0,0 +1,279 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PlanUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PlanUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The interval at which the plan charges (renewal plans).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :billing_period
+
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::OrSymbol)) }
+      attr_accessor :currency
+
+      # An array of custom field objects.
+      sig do
+        returns(T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField]))
+      end
+      attr_accessor :custom_fields
+
+      # The description of the plan.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The interval at which the plan charges (expiration plans).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :expiration_days
+
+      # An image for the plan. This will be visible on the product page to customers.
+      sig { returns(T.nilable(WhopSDK::PlanUpdateParams::Image)) }
+      attr_reader :image
+
+      sig do
+        params(image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash)).void
+      end
+      attr_writer :image
+
+      # An additional amount charged upon first purchase.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :initial_price
+
+      # A personal description or notes section for the business.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :internal_notes
+
+      # Whether or not to offer a discount to cancel a subscription.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :offer_cancel_discount
+
+      # Whether or not the tax is included in a plan's price (or if it hasn't been set
+      # up)
+      sig { returns(T.nilable(WhopSDK::TaxType::OrSymbol)) }
+      attr_accessor :override_tax_type
+
+      # The amount the customer is charged every billing period.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :renewal_price
+
+      # The title of the plan. This will be visible on the product page to customers.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The number of free trial days added before a renewal plan.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_period_days
+
+      # Visibility of a resource
+      sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
+      attr_accessor :visibility
+
+      sig do
+        params(
+          billing_period: T.nilable(Integer),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          custom_fields:
+            T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField::OrHash]),
+          description: T.nilable(String),
+          expiration_days: T.nilable(Integer),
+          image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash),
+          initial_price: T.nilable(Float),
+          internal_notes: T.nilable(String),
+          offer_cancel_discount: T.nilable(T::Boolean),
+          override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          renewal_price: T.nilable(Float),
+          title: T.nilable(String),
+          trial_period_days: T.nilable(Integer),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The interval at which the plan charges (renewal plans).
+        billing_period: nil,
+        # The available currencies on the platform
+        currency: nil,
+        # An array of custom field objects.
+        custom_fields: nil,
+        # The description of the plan.
+        description: nil,
+        # The interval at which the plan charges (expiration plans).
+        expiration_days: nil,
+        # An image for the plan. This will be visible on the product page to customers.
+        image: nil,
+        # An additional amount charged upon first purchase.
+        initial_price: nil,
+        # A personal description or notes section for the business.
+        internal_notes: nil,
+        # Whether or not to offer a discount to cancel a subscription.
+        offer_cancel_discount: nil,
+        # Whether or not the tax is included in a plan's price (or if it hasn't been set
+        # up)
+        override_tax_type: nil,
+        # The amount the customer is charged every billing period.
+        renewal_price: nil,
+        # The title of the plan. This will be visible on the product page to customers.
+        title: nil,
+        # The number of free trial days added before a renewal plan.
+        trial_period_days: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billing_period: T.nilable(Integer),
+            currency: T.nilable(WhopSDK::Currency::OrSymbol),
+            custom_fields:
+              T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField]),
+            description: T.nilable(String),
+            expiration_days: T.nilable(Integer),
+            image: T.nilable(WhopSDK::PlanUpdateParams::Image),
+            initial_price: T.nilable(Float),
+            internal_notes: T.nilable(String),
+            offer_cancel_discount: T.nilable(T::Boolean),
+            override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+            renewal_price: T.nilable(Float),
+            title: T.nilable(String),
+            trial_period_days: T.nilable(Integer),
+            visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::PlanUpdateParams::CustomField,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The type of the custom field.
+        sig { returns(Symbol) }
+        attr_accessor :field_type
+
+        # The name of the custom field.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The ID of the custom field (if being updated)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # The order of the field.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :order
+
+        # The placeholder value of the field.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :placeholder
+
+        # Whether or not the field is required.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :required
+
+        sig do
+          params(
+            name: String,
+            id: T.nilable(String),
+            order: T.nilable(Integer),
+            placeholder: T.nilable(String),
+            required: T.nilable(T::Boolean),
+            field_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name of the custom field.
+          name:,
+          # The ID of the custom field (if being updated)
+          id: nil,
+          # The order of the field.
+          order: nil,
+          # The placeholder value of the field.
+          placeholder: nil,
+          # Whether or not the field is required.
+          required: nil,
+          # The type of the custom field.
+          field_type: :text
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field_type: Symbol,
+              name: String,
+              id: T.nilable(String),
+              order: T.nilable(Integer),
+              placeholder: T.nilable(String),
+              required: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Image < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::PlanUpdateParams::Image, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of an existing attachment object. Use this when updating a resource and
+        # keeping a subset of the attachments. Don't use this unless you know what you're
+        # doing.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # This ID should be used the first time you upload an attachment. It is the ID of
+        # the direct upload that was created when uploading the file to S3 via the
+        # mediaDirectUpload mutation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :direct_upload_id
+
+        # An image for the plan. This will be visible on the product page to customers.
+        sig do
+          params(
+            id: T.nilable(String),
+            direct_upload_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of an existing attachment object. Use this when updating a resource and
+          # keeping a subset of the attachments. Don't use this unless you know what you're
+          # doing.
+          id: nil,
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          direct_upload_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end