whop_sdk 0.0.14 → 0.0.15

data/lib/whop_sdk/resources/fee_markups.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class FeeMarkups
+      # Creates or updates a fee markup for a company.
+      #
+      # Required permissions:
+      #
+      # - `company:update_child_fees`
+      #
+      # @overload create(company_id:, fee_type:, fixed_fee_usd: nil, metadata: nil, notes: nil, percentage_fee: nil, request_options: {})
+      #
+      # @param company_id [String] The ID (tag) of the company you want to update the fee markup for.
+      #
+      # @param fee_type [Symbol, WhopSDK::Models::FeeMarkupType] The type of fee this markup applies to.
+      #
+      # @param fixed_fee_usd [Float, nil] The fixed fee in USD to charge (0-50).
+      #
+      # @param metadata [Hash{Symbol=>Object}, nil] Custom metadata to attach to this fee markup.
+      #
+      # @param notes [String, nil] Internal notes about this fee markup.
+      #
+      # @param percentage_fee [Float, nil] The percentage fee to charge (0-25).
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::FeeMarkupCreateResponse]
+      #
+      # @see WhopSDK::Models::FeeMarkupCreateParams
+      def create(params)
+        parsed, options = WhopSDK::FeeMarkupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "fee_markups",
+          body: parsed,
+          model: WhopSDK::Models::FeeMarkupCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::FeeMarkupListParams} for more details.
+      #
+      # Lists fee markups for a company.
+      #
+      # Required permissions:
+      #
+      # - `company:update_child_fees`
+      #
+      # @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, request_options: {})
+      #
+      # @param company_id [String] The ID (tag) of the company you want to list the fee markups for. If you pass yo
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::FeeMarkupListResponse>]
+      #
+      # @see WhopSDK::Models::FeeMarkupListParams
+      def list(params)
+        parsed, options = WhopSDK::FeeMarkupListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "fee_markups",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::FeeMarkupListResponse,
+          options: options
+        )
+      end
+
+      # Deletes a fee markup for a company.
+      #
+      # Required permissions:
+      #
+      # - `company:update_child_fees`
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the fee markup to delete.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::FeeMarkupDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["fee_markups/%1$s", id],
+          model: WhopSDK::Internal::Type::Boolean,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhopSDK
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/lib/whop_sdk.rb

@@ -180,6 +180,13 @@ require_relative "whop_sdk/models/experience_list_params"
 require_relative "whop_sdk/models/experience_list_response"
 require_relative "whop_sdk/models/experience_retrieve_params"
 require_relative "whop_sdk/models/experience_update_params"
+require_relative "whop_sdk/models/fee_markup_create_params"
+require_relative "whop_sdk/models/fee_markup_create_response"
+require_relative "whop_sdk/models/fee_markup_delete_params"
+require_relative "whop_sdk/models/fee_markup_delete_response"
+require_relative "whop_sdk/models/fee_markup_list_params"
+require_relative "whop_sdk/models/fee_markup_list_response"
+require_relative "whop_sdk/models/fee_markup_type"
 require_relative "whop_sdk/models/forum"
 require_relative "whop_sdk/models/forum_list_params"
 require_relative "whop_sdk/models/forum_list_response"
@@ -370,6 +377,7 @@ require_relative "whop_sdk/resources/course_students"
 require_relative "whop_sdk/resources/disputes"
 require_relative "whop_sdk/resources/entries"
 require_relative "whop_sdk/resources/experiences"
+require_relative "whop_sdk/resources/fee_markups"
 require_relative "whop_sdk/resources/forum_posts"
 require_relative "whop_sdk/resources/forums"
 require_relative "whop_sdk/resources/invoices"

data/rbi/whop_sdk/client.rbi

@@ -136,6 +136,9 @@ module WhopSDK
     sig { returns(WhopSDK::Resources::PaymentMethods) }
     attr_reader :payment_methods
 
+    sig { returns(WhopSDK::Resources::FeeMarkups) }
+    attr_reader :fee_markups
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/whop_sdk/models/checkout_configuration.rbi

@@ -20,6 +20,10 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :company_id
 
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+      attr_accessor :currency
+
       # The metadata to use for the checkout configuration
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
@@ -78,6 +82,7 @@ module WhopSDK
           id: String,
           affiliate_code: T.nilable(String),
           company_id: String,
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           mode: WhopSDK::CheckoutModes::OrSymbol,
           payment_method_configuration:
@@ -96,6 +101,8 @@ module WhopSDK
         affiliate_code:,
         # The ID of the company to use for the checkout configuration
         company_id:,
+        # The available currencies on the platform
+        currency:,
         # The metadata to use for the checkout configuration
         metadata:,
         # The mode of the checkout session.
@@ -120,6 +127,7 @@ module WhopSDK
             id: String,
             affiliate_code: T.nilable(String),
             company_id: String,
+            currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             mode: WhopSDK::CheckoutModes::TaggedSymbol,
             payment_method_configuration:

data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi

@@ -29,6 +29,10 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :affiliate_code
 
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::OrSymbol)) }
+      attr_accessor :currency
+
       # The metadata to use for the checkout configuration
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
@@ -77,6 +81,7 @@ module WhopSDK
           plan_id: String,
           company_id: String,
           affiliate_code: T.nilable(String),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           payment_method_configuration:
             T.nilable(
@@ -97,6 +102,8 @@ module WhopSDK
         company_id:,
         # The affiliate code to use for the checkout configuration
         affiliate_code: nil,
+        # The available currencies on the platform
+        currency: nil,
         # The metadata to use for the checkout configuration
         metadata: nil,
         # This currently only works for configurations made in 'setup' mode. The explicit
@@ -115,6 +122,7 @@ module WhopSDK
           {
             plan: WhopSDK::CheckoutConfigurationCreateParams::Plan,
             affiliate_code: T.nilable(String),
+            currency: T.nilable(WhopSDK::Currency::OrSymbol),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             mode: Symbol,
             payment_method_configuration:

data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi

@@ -23,6 +23,10 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :company_id
 
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+      attr_accessor :currency
+
       # The metadata to use for the checkout configuration
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
@@ -90,6 +94,7 @@ module WhopSDK
           id: String,
           affiliate_code: T.nilable(String),
           company_id: String,
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           mode: WhopSDK::CheckoutModes::OrSymbol,
           payment_method_configuration:
@@ -111,6 +116,8 @@ module WhopSDK
         affiliate_code:,
         # The ID of the company to use for the checkout configuration
         company_id:,
+        # The available currencies on the platform
+        currency:,
         # The metadata to use for the checkout configuration
         metadata:,
         # The mode of the checkout session.
@@ -135,6 +142,7 @@ module WhopSDK
             id: String,
             affiliate_code: T.nilable(String),
             company_id: String,
+            currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             mode: WhopSDK::CheckoutModes::TaggedSymbol,
             payment_method_configuration:

data/rbi/whop_sdk/models/experience.rbi

@@ -35,6 +35,10 @@ module WhopSDK
       sig { params(image: T.nilable(WhopSDK::Experience::Image::OrHash)).void }
       attr_writer :image
 
+      # Whether the experience is visible to the public
+      sig { returns(T::Boolean) }
+      attr_accessor :is_public
+
       # The written name of the description.
       sig { returns(String) }
       attr_accessor :name
@@ -57,6 +61,7 @@ module WhopSDK
           company: WhopSDK::Experience::Company::OrHash,
           created_at: Time,
           image: T.nilable(WhopSDK::Experience::Image::OrHash),
+          is_public: T::Boolean,
           name: String,
           order: T.nilable(String),
           products: T::Array[WhopSDK::Experience::Product::OrHash]
@@ -73,6 +78,8 @@ module WhopSDK
         created_at:,
         # The logo for the experience.
         image:,
+        # Whether the experience is visible to the public
+        is_public:,
         # The written name of the description.
         name:,
         # The order of the experience in the section
@@ -92,6 +99,7 @@ module WhopSDK
             company: WhopSDK::Experience::Company,
             created_at: Time,
             image: T.nilable(WhopSDK::Experience::Image),
+            is_public: T::Boolean,
             name: String,
             order: T.nilable(String),
             products: T::Array[WhopSDK::Experience::Product]

data/rbi/whop_sdk/models/experience_create_params.rbi

@@ -19,6 +19,10 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :company_id
 
+      # Whether the experience is publicly accessible
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_public
+
       # The name of the experience
       sig { returns(T.nilable(String)) }
       attr_accessor :name
@@ -31,6 +35,7 @@ module WhopSDK
         params(
           app_id: String,
           company_id: String,
+          is_public: T.nilable(T::Boolean),
           name: T.nilable(String),
           section_id: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -41,6 +46,8 @@ module WhopSDK
         app_id:,
         # The ID of the company to create the experience for
         company_id:,
+        # Whether the experience is publicly accessible
+        is_public: nil,
         # The name of the experience
         name: nil,
         # The ID of the section to create the experience in
@@ -54,6 +61,7 @@ module WhopSDK
           {
             app_id: String,
             company_id: String,
+            is_public: T.nilable(T::Boolean),
             name: T.nilable(String),
             section_id: T.nilable(String),
             request_options: WhopSDK::RequestOptions

data/rbi/whop_sdk/models/experience_list_response.rbi

@@ -51,6 +51,10 @@ module WhopSDK
       end
       attr_writer :image
 
+      # Whether the experience is visible to the public
+      sig { returns(T::Boolean) }
+      attr_accessor :is_public
+
       # The written name of the description.
       sig { returns(String) }
       attr_accessor :name
@@ -68,6 +72,7 @@ module WhopSDK
           created_at: Time,
           image:
             T.nilable(WhopSDK::Models::ExperienceListResponse::Image::OrHash),
+          is_public: T::Boolean,
           name: String,
           order: T.nilable(String)
         ).returns(T.attached_class)
@@ -83,6 +88,8 @@ module WhopSDK
         created_at:,
         # The logo for the experience.
         image:,
+        # Whether the experience is visible to the public
+        is_public:,
         # The written name of the description.
         name:,
         # The order of the experience in the section
@@ -98,6 +105,7 @@ module WhopSDK
             company: WhopSDK::Models::ExperienceListResponse::Company,
             created_at: Time,
             image: T.nilable(WhopSDK::Models::ExperienceListResponse::Image),
+            is_public: T::Boolean,
             name: String,
             order: T.nilable(String)
           }

data/rbi/whop_sdk/models/experience_update_params.rbi

@@ -19,6 +19,10 @@ module WhopSDK
       end
       attr_accessor :access_level
 
+      # Whether the experience is publicly accessible.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_public
+
       # The logo for the experience
       sig do
         returns(
@@ -48,6 +52,7 @@ module WhopSDK
         params(
           access_level:
             T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
+          is_public: T.nilable(T::Boolean),
           logo:
             T.nilable(
               T.any(
@@ -64,6 +69,8 @@ module WhopSDK
       def self.new(
         # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
         access_level: nil,
+        # Whether the experience is publicly accessible.
+        is_public: nil,
         # The logo for the experience
         logo: nil,
         # The name of the experience.
@@ -81,6 +88,7 @@ module WhopSDK
           {
             access_level:
               T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
+            is_public: T.nilable(T::Boolean),
             logo:
               T.nilable(
                 T.any(

data/rbi/whop_sdk/models/fee_markup_create_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class FeeMarkupCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::FeeMarkupCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID (tag) of the company you want to update the fee markup for.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The type of fee this markup applies to.
+      sig { returns(WhopSDK::FeeMarkupType::OrSymbol) }
+      attr_accessor :fee_type
+
+      # The fixed fee in USD to charge (0-50).
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fixed_fee_usd
+
+      # Custom metadata to attach to this fee markup.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # Internal notes about this fee markup.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # The percentage fee to charge (0-25).
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :percentage_fee
+
+      sig do
+        params(
+          company_id: String,
+          fee_type: WhopSDK::FeeMarkupType::OrSymbol,
+          fixed_fee_usd: T.nilable(Float),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          notes: T.nilable(String),
+          percentage_fee: T.nilable(Float),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID (tag) of the company you want to update the fee markup for.
+        company_id:,
+        # The type of fee this markup applies to.
+        fee_type:,
+        # The fixed fee in USD to charge (0-50).
+        fixed_fee_usd: nil,
+        # Custom metadata to attach to this fee markup.
+        metadata: nil,
+        # Internal notes about this fee markup.
+        notes: nil,
+        # The percentage fee to charge (0-25).
+        percentage_fee: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            fee_type: WhopSDK::FeeMarkupType::OrSymbol,
+            fixed_fee_usd: T.nilable(Float),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            notes: T.nilable(String),
+            percentage_fee: T.nilable(Float),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/fee_markup_create_response.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class FeeMarkupCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::FeeMarkupCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier of the fee markup.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When this fee markup was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The type of fee this markup applies to.
+      sig { returns(WhopSDK::FeeMarkupType::TaggedSymbol) }
+      attr_accessor :fee_type
+
+      # The fixed fee in USD to charge (0-50).
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fixed_fee_usd
+
+      # Internal notes about this fee markup.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # The percentage fee to charge (0-25).
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :percentage_fee
+
+      # When this fee markup was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Represents a fee markup configuration for a company
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          fee_type: WhopSDK::FeeMarkupType::OrSymbol,
+          fixed_fee_usd: T.nilable(Float),
+          notes: T.nilable(String),
+          percentage_fee: T.nilable(Float),
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier of the fee markup.
+        id:,
+        # When this fee markup was created.
+        created_at:,
+        # The type of fee this markup applies to.
+        fee_type:,
+        # The fixed fee in USD to charge (0-50).
+        fixed_fee_usd:,
+        # Internal notes about this fee markup.
+        notes:,
+        # The percentage fee to charge (0-25).
+        percentage_fee:,
+        # When this fee markup was last updated.
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            fee_type: WhopSDK::FeeMarkupType::TaggedSymbol,
+            fixed_fee_usd: T.nilable(Float),
+            notes: T.nilable(String),
+            percentage_fee: T.nilable(Float),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/fee_markup_delete_params.rbi

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

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

data/rbi/whop_sdk/models/fee_markup_list_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class FeeMarkupListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::FeeMarkupListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID (tag) of the company you want to list the fee markups for. If you pass
+      # your platform account, you will get the platform default markups.
+      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
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID (tag) of the company you want to list the fee markups for. If you pass
+        # your platform account, you will get the platform default markups.
+        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,
+        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),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end