whop_sdk 0.0.2

data/rbi/whop_sdk/models/plan_create_params.rbi

@@ -0,0 +1,309 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PlanCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PlanCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The company the plan should be created for.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The product the plan is related to.
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      # 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::PlanCreateParams::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::PlanCreateParams::Image)) }
+      attr_reader :image
+
+      sig do
+        params(image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash)).void
+      end
+      attr_writer :image
+
+      # An additional amount charged upon first purchase. Use only if a one time payment
+      # OR you want to charge an additional amount on top of the renewal price. Provided
+      # as a number in dollars. Eg: 10.43 for $10.43
+      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 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 type of plan that can be attached to an access pass
+      sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
+      attr_accessor :plan_type
+
+      # The methods of how a plan can be released.
+      sig { returns(T.nilable(WhopSDK::ReleaseMethod::OrSymbol)) }
+      attr_accessor :release_method
+
+      # The amount the customer is charged every billing period. Use only if a recurring
+      # payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+      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(
+          company_id: String,
+          product_id: String,
+          billing_period: T.nilable(Integer),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          custom_fields:
+            T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField::OrHash]),
+          description: T.nilable(String),
+          expiration_days: T.nilable(Integer),
+          image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash),
+          initial_price: T.nilable(Float),
+          internal_notes: T.nilable(String),
+          override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
+          release_method: T.nilable(WhopSDK::ReleaseMethod::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 company the plan should be created for.
+        company_id:,
+        # The product the plan is related to.
+        product_id:,
+        # 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. Use only if a one time payment
+        # OR you want to charge an additional amount on top of the renewal price. Provided
+        # as a number in dollars. Eg: 10.43 for $10.43
+        initial_price: nil,
+        # A personal description or notes section for the business.
+        internal_notes: 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 type of plan that can be attached to an access pass
+        plan_type: nil,
+        # The methods of how a plan can be released.
+        release_method: nil,
+        # The amount the customer is charged every billing period. Use only if a recurring
+        # payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+        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(
+          {
+            company_id: String,
+            product_id: String,
+            billing_period: T.nilable(Integer),
+            currency: T.nilable(WhopSDK::Currency::OrSymbol),
+            custom_fields:
+              T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField]),
+            description: T.nilable(String),
+            expiration_days: T.nilable(Integer),
+            image: T.nilable(WhopSDK::PlanCreateParams::Image),
+            initial_price: T.nilable(Float),
+            internal_notes: T.nilable(String),
+            override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+            plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
+            release_method: T.nilable(WhopSDK::ReleaseMethod::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::PlanCreateParams::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::PlanCreateParams::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

data/rbi/whop_sdk/models/plan_delete_params.rbi

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

@@ -0,0 +1,7 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    PlanDeleteResponse = T.let(T::Boolean, WhopSDK::Internal::Type::Converter)
+  end
+end

data/rbi/whop_sdk/models/plan_list_params.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PlanListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PlanListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company
+      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
+
+      # The direction of the sort.
+      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # 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 ways a relation of Plans can be ordered
+      sig { returns(T.nilable(WhopSDK::PlanListParams::Order::OrSymbol)) }
+      attr_accessor :order
+
+      # The plan type to filter the plans by
+      sig { returns(T.nilable(T::Array[WhopSDK::PlanType::OrSymbol])) }
+      attr_accessor :plan_types
+
+      # The product IDs to filter the plans by
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :product_ids
+
+      # The release method to filter the plans by
+      sig { returns(T.nilable(T::Array[WhopSDK::ReleaseMethod::OrSymbol])) }
+      attr_accessor :release_methods
+
+      # The visibility to filter the plans by
+      sig { returns(T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol])) }
+      attr_accessor :visibilities
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::PlanListParams::Order::OrSymbol),
+          plan_types: T.nilable(T::Array[WhopSDK::PlanType::OrSymbol]),
+          product_ids: T.nilable(T::Array[String]),
+          release_methods:
+            T.nilable(T::Array[WhopSDK::ReleaseMethod::OrSymbol]),
+          visibilities:
+            T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company
+        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,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ways a relation of Plans can be ordered
+        order: nil,
+        # The plan type to filter the plans by
+        plan_types: nil,
+        # The product IDs to filter the plans by
+        product_ids: nil,
+        # The release method to filter the plans by
+        release_methods: nil,
+        # The visibility to filter the plans by
+        visibilities: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            direction: T.nilable(WhopSDK::Direction::OrSymbol),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            order: T.nilable(WhopSDK::PlanListParams::Order::OrSymbol),
+            plan_types: T.nilable(T::Array[WhopSDK::PlanType::OrSymbol]),
+            product_ids: T.nilable(T::Array[String]),
+            release_methods:
+              T.nilable(T::Array[WhopSDK::ReleaseMethod::OrSymbol]),
+            visibilities:
+              T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The ways a relation of Plans can be ordered
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::PlanListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ID = T.let(:id, WhopSDK::PlanListParams::Order::TaggedSymbol)
+        ACTIVE_MEMBERS_COUNT =
+          T.let(
+            :active_members_count,
+            WhopSDK::PlanListParams::Order::TaggedSymbol
+          )
+        CREATED_AT =
+          T.let(:created_at, WhopSDK::PlanListParams::Order::TaggedSymbol)
+        INTERNAL_NOTES =
+          T.let(:internal_notes, WhopSDK::PlanListParams::Order::TaggedSymbol)
+        EXPIRES_AT =
+          T.let(:expires_at, WhopSDK::PlanListParams::Order::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::PlanListParams::Order::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end