whop_sdk 0.0.2

data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CheckoutConfigurationListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::CheckoutConfigurationListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID of the checkout configuration
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The affiliate code to use for the checkout configuration
+      sig { returns(T.nilable(String)) }
+      attr_accessor :affiliate_code
+
+      # The ID of the company to use for the checkout configuration
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The metadata to use for the checkout configuration
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :metadata
+
+      # The plan to use for the checkout configuration
+      sig { returns(WhopSDK::Models::CheckoutConfigurationListResponse::Plan) }
+      attr_reader :plan
+
+      sig do
+        params(
+          plan: WhopSDK::Models::CheckoutConfigurationListResponse::Plan::OrHash
+        ).void
+      end
+      attr_writer :plan
+
+      # The URL to redirect the user to after the checkout configuration is created
+      sig { returns(String) }
+      attr_accessor :purchase_url
+
+      # The URL to redirect the user to after the checkout configuration is created
+      sig { returns(T.nilable(String)) }
+      attr_accessor :redirect_url
+
+      # A checkout configuration object. Can be used to create a reusable custom
+      # configuration for a checkout, including attaching plans, affiliates and custom
+      # metadata to the checkout. This configuration can be re-used by multiple users.
+      # All successful payments and memberships resulting from a checkout will contain
+      # the passed metadata.
+      sig do
+        params(
+          id: String,
+          affiliate_code: T.nilable(String),
+          company_id: String,
+          metadata: T::Hash[Symbol, T.anything],
+          plan:
+            WhopSDK::Models::CheckoutConfigurationListResponse::Plan::OrHash,
+          purchase_url: String,
+          redirect_url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the checkout configuration
+        id:,
+        # The affiliate code to use for the checkout configuration
+        affiliate_code:,
+        # The ID of the company to use for the checkout configuration
+        company_id:,
+        # The metadata to use for the checkout configuration
+        metadata:,
+        # The plan to use for the checkout configuration
+        plan:,
+        # The URL to redirect the user to after the checkout configuration is created
+        purchase_url:,
+        # The URL to redirect the user to after the checkout configuration is created
+        redirect_url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            affiliate_code: T.nilable(String),
+            company_id: String,
+            metadata: T::Hash[Symbol, T.anything],
+            plan: WhopSDK::Models::CheckoutConfigurationListResponse::Plan,
+            purchase_url: String,
+            redirect_url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CheckoutConfigurationListResponse::Plan,
+              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 respective currency identifier for the plan.
+        sig { returns(WhopSDK::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # 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
+
+        # Indicates if the plan is a one time payment or recurring.
+        sig { returns(WhopSDK::PlanType::TaggedSymbol) }
+        attr_accessor :plan_type
+
+        # 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
+
+        # Shows or hides the plan from public/business view.
+        sig { returns(WhopSDK::Visibility::TaggedSymbol) }
+        attr_accessor :visibility
+
+        # The plan to use for the checkout configuration
+        sig do
+          params(
+            id: String,
+            billing_period: T.nilable(Integer),
+            currency: WhopSDK::Currency::OrSymbol,
+            expiration_days: T.nilable(Integer),
+            initial_price: Float,
+            plan_type: WhopSDK::PlanType::OrSymbol,
+            release_method: WhopSDK::ReleaseMethod::OrSymbol,
+            renewal_price: Float,
+            trial_period_days: T.nilable(Integer),
+            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 respective currency identifier for the plan.
+          currency:,
+          # 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:,
+          # Indicates if the plan is a one time payment or recurring.
+          plan_type:,
+          # 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:,
+          # Shows or hides the plan from public/business view.
+          visibility:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              billing_period: T.nilable(Integer),
+              currency: WhopSDK::Currency::TaggedSymbol,
+              expiration_days: T.nilable(Integer),
+              initial_price: Float,
+              plan_type: WhopSDK::PlanType::TaggedSymbol,
+              release_method: WhopSDK::ReleaseMethod::TaggedSymbol,
+              renewal_price: Float,
+              trial_period_days: T.nilable(Integer),
+              visibility: WhopSDK::Visibility::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/checkout_configuration_retrieve_params.rbi

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

@@ -0,0 +1,24 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The method of collection for an invoice.
+    module CollectionMethod
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::CollectionMethod) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SEND_INVOICE =
+        T.let(:send_invoice, WhopSDK::CollectionMethod::TaggedSymbol)
+      CHARGE_AUTOMATICALLY =
+        T.let(:charge_automatically, WhopSDK::CollectionMethod::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[WhopSDK::CollectionMethod::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/company.rbi

@@ -0,0 +1,307 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Company < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Company, WhopSDK::Internal::AnyHash) }
+
+      # The ID (tag) of the company.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::TaggedSymbol)) }
+      attr_accessor :business_type
+
+      # When the company was created (signed up)
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The creator pitch for the company.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::TaggedSymbol)) }
+      attr_accessor :industry_type
+
+      # The company's logo.
+      sig { returns(T.nilable(WhopSDK::Company::Logo)) }
+      attr_reader :logo
+
+      sig { params(logo: T.nilable(WhopSDK::Company::Logo::OrHash)).void }
+      attr_writer :logo
+
+      # The number of members in the company.
+      sig { returns(Integer) }
+      attr_accessor :member_count
+
+      # The user who owns this company
+      sig { returns(WhopSDK::Company::OwnerUser) }
+      attr_reader :owner_user
+
+      sig { params(owner_user: WhopSDK::Company::OwnerUser::OrHash).void }
+      attr_writer :owner_user
+
+      # The number of reviews that have been published for the company.
+      sig { returns(Integer) }
+      attr_accessor :published_reviews_count
+
+      # The slug/route of the company on the Whop site.
+      sig { returns(String) }
+      attr_accessor :route
+
+      # The social media accounts of the company
+      sig { returns(T::Array[WhopSDK::Company::SocialLink]) }
+      attr_accessor :social_links
+
+      # The title of the company.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The time the company was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # If the company is Whop Verified
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      # An object representing a (sanitized) company.
+      sig do
+        params(
+          id: String,
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          created_at: Time,
+          description: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          logo: T.nilable(WhopSDK::Company::Logo::OrHash),
+          member_count: Integer,
+          owner_user: WhopSDK::Company::OwnerUser::OrHash,
+          published_reviews_count: Integer,
+          route: String,
+          social_links: T::Array[WhopSDK::Company::SocialLink::OrHash],
+          title: String,
+          updated_at: Time,
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID (tag) of the company.
+        id:,
+        # The different business types a company can be.
+        business_type:,
+        # When the company was created (signed up)
+        created_at:,
+        # The creator pitch for the company.
+        description:,
+        # The different industry types a company can be in.
+        industry_type:,
+        # The company's logo.
+        logo:,
+        # The number of members in the company.
+        member_count:,
+        # The user who owns this company
+        owner_user:,
+        # The number of reviews that have been published for the company.
+        published_reviews_count:,
+        # The slug/route of the company on the Whop site.
+        route:,
+        # The social media accounts of the company
+        social_links:,
+        # The title of the company.
+        title:,
+        # The time the company was last updated.
+        updated_at:,
+        # If the company is Whop Verified
+        verified:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business_type: T.nilable(WhopSDK::BusinessTypes::TaggedSymbol),
+            created_at: Time,
+            description: T.nilable(String),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::TaggedSymbol),
+            logo: T.nilable(WhopSDK::Company::Logo),
+            member_count: Integer,
+            owner_user: WhopSDK::Company::OwnerUser,
+            published_reviews_count: Integer,
+            route: String,
+            social_links: T::Array[WhopSDK::Company::SocialLink],
+            title: String,
+            updated_at: Time,
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Company::Logo, WhopSDK::Internal::AnyHash)
+          end
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # The company's logo.
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+
+      class OwnerUser < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Company::OwnerUser, 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 who owns this company
+        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
+
+      class SocialLink < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Company::SocialLink, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The URL
+        sig { returns(String) }
+        attr_accessor :url
+
+        # The website
+        sig { returns(WhopSDK::Company::SocialLink::Website::TaggedSymbol) }
+        attr_accessor :website
+
+        # A social link attached to a resource on the site.
+        sig do
+          params(
+            id: String,
+            url: String,
+            website: WhopSDK::Company::SocialLink::Website::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID
+          id:,
+          # The URL
+          url:,
+          # The website
+          website:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              url: String,
+              website: WhopSDK::Company::SocialLink::Website::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The website
+        module Website
+          extend WhopSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, WhopSDK::Company::SocialLink::Website)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          X = T.let(:x, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+          INSTAGRAM =
+            T.let(
+              :instagram,
+              WhopSDK::Company::SocialLink::Website::TaggedSymbol
+            )
+          FACEBOOK =
+            T.let(
+              :facebook,
+              WhopSDK::Company::SocialLink::Website::TaggedSymbol
+            )
+          TIKTOK =
+            T.let(:tiktok, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+          YOUTUBE =
+            T.let(:youtube, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+          LINKEDIN =
+            T.let(
+              :linkedin,
+              WhopSDK::Company::SocialLink::Website::TaggedSymbol
+            )
+          TWITCH =
+            T.let(:twitch, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+          WEBSITE =
+            T.let(:website, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[WhopSDK::Company::SocialLink::Website::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/company_retrieve_params.rbi

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