whop_sdk 0.0.2 → 0.0.3

data/lib/whop_sdk/resources/promo_codes.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class PromoCodes
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::PromoCodeCreateParams} for more details.
+      #
+      # Create a new promo code for a product or plan
+      #
+      # Required permissions:
+      #
+      # - `promo_code:create`
+      # - `access_pass:basic:read`
+      #
+      # @overload create(amount_off:, base_currency:, code:, company_id:, new_users_only:, promo_duration_months:, promo_type:, churned_users_only: nil, existing_memberships_only: nil, expires_at: nil, one_per_customer: nil, plan_ids: nil, product_id: nil, stock: nil, unlimited_stock: nil, request_options: {})
+      #
+      # @param amount_off [Float] The amount off (% or flat amount) for the promo.
+      #
+      # @param base_currency [Symbol, WhopSDK::Models::Currency] The monetary currency of the promo code.
+      #
+      # @param code [String] The specific code used to apply the promo at checkout.
+      #
+      # @param company_id [String] The id of the company to create the promo code for.
+      #
+      # @param new_users_only [Boolean] Restricts promo use to only users who have never purchased from the company befo
+      #
+      # @param promo_duration_months [Integer] The number of months this promo code is applied and valid for.
+      #
+      # @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
+      #
+      # @param churned_users_only [Boolean, nil] Restricts promo use to only users who have churned from the company before.
+      #
+      # @param existing_memberships_only [Boolean, nil] Whether this promo code is for existing memberships only (cancelations)
+      #
+      # @param expires_at [Time, nil] The date/time of when the promo expires.
+      #
+      # @param one_per_customer [Boolean, nil] Restricts promo use to only be applied once per customer.
+      #
+      # @param plan_ids [Array<String>, nil] The IDs of the plans that the promo code applies to. If product_id is provided,
+      #
+      # @param product_id [String, nil] The product to lock the promo code to, if any. If provided will filter out any p
+      #
+      # @param stock [Integer, nil] The quantity limit on the number of uses.
+      #
+      # @param unlimited_stock [Boolean, nil] Whether or not the promo code should have unlimited stock.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PromoCode]
+      #
+      # @see WhopSDK::Models::PromoCodeCreateParams
+      def create(params)
+        parsed, options = WhopSDK::PromoCodeCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "promo_codes",
+          body: parsed,
+          model: WhopSDK::PromoCode,
+          options: options
+        )
+      end
+
+      # Retrieves a promo code by ID
+      #
+      # Required permissions:
+      #
+      # - `promo_code:basic:read`
+      # - `access_pass:basic:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PromoCode]
+      #
+      # @see WhopSDK::Models::PromoCodeRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["promo_codes/%1$s", id],
+          model: WhopSDK::PromoCode,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists promo codes for a company
+      #
+      # Required permissions:
+      #
+      # - `promo_code:basic:read`
+      # - `access_pass:basic:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, plan_ids: nil, product_ids: nil, status: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list promo codes for
+      #
+      # @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 plan_ids [Array<String>, nil] Filter promo codes by plan ID(s)
+      #
+      # @param product_ids [Array<String>, nil] Filter promo codes by product ID(s)
+      #
+      # @param status [Symbol, WhopSDK::Models::PromoCodeStatus, nil] Statuses for promo codes
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::PromoCodeListResponse>]
+      #
+      # @see WhopSDK::Models::PromoCodeListParams
+      def list(params)
+        parsed, options = WhopSDK::PromoCodeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "promo_codes",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::PromoCodeListResponse,
+          options: options
+        )
+      end
+
+      # Archive a promo code, preventing further use
+      #
+      # Required permissions:
+      #
+      # - `promo_code:delete`
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::PromoCodeDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["promo_codes/%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/resources/reviews.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Reviews
+      # Retrieve a review by its ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::ReviewRetrieveResponse]
+      #
+      # @see WhopSDK::Models::ReviewRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["reviews/%1$s", id],
+          model: WhopSDK::Models::ReviewRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List all reviews
+      #
+      # @overload list(product_id:, after: nil, before: nil, first: nil, last: nil, max_stars: nil, min_stars: nil, request_options: {})
+      #
+      # @param product_id [String] The ID of the product
+      #
+      # @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 max_stars [Integer, nil] The maximum star rating of the review (inclusive)
+      #
+      # @param min_stars [Integer, nil] The minimum star rating of the review (inclusive)
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ReviewListResponse>]
+      #
+      # @see WhopSDK::Models::ReviewListParams
+      def list(params)
+        parsed, options = WhopSDK::ReviewListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "reviews",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::ReviewListResponse,
+          options: 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.2"
+  VERSION = "0.0.3"
 end

data/lib/whop_sdk.rb

@@ -69,12 +69,15 @@ require_relative "whop_sdk/models/app_retrieve_params"
 require_relative "whop_sdk/models/app_statuses"
 require_relative "whop_sdk/models/app_update_params"
 require_relative "whop_sdk/models/app_view_type"
+require_relative "whop_sdk/models/assessment_question_types"
 require_relative "whop_sdk/models/authorized_user_list_params"
 require_relative "whop_sdk/models/authorized_user_list_response"
 require_relative "whop_sdk/models/authorized_user_retrieve_params"
 require_relative "whop_sdk/models/authorized_user_retrieve_response"
 require_relative "whop_sdk/models/authorized_user_roles"
+require_relative "whop_sdk/models/billing_reasons"
 require_relative "whop_sdk/models/business_types"
+require_relative "whop_sdk/models/card_brands"
 require_relative "whop_sdk/models/chat_channel"
 require_relative "whop_sdk/models/chat_channel_list_params"
 require_relative "whop_sdk/models/chat_channel_list_response"
@@ -88,11 +91,34 @@ require_relative "whop_sdk/models/checkout_configuration_retrieve_params"
 require_relative "whop_sdk/models/collection_method"
 require_relative "whop_sdk/models/company"
 require_relative "whop_sdk/models/company_retrieve_params"
+require_relative "whop_sdk/models/course"
+require_relative "whop_sdk/models/course_chapter"
+require_relative "whop_sdk/models/course_chapter_create_params"
+require_relative "whop_sdk/models/course_chapter_delete_params"
+require_relative "whop_sdk/models/course_chapter_delete_response"
+require_relative "whop_sdk/models/course_chapter_list_params"
+require_relative "whop_sdk/models/course_chapter_list_response"
+require_relative "whop_sdk/models/course_chapter_retrieve_params"
+require_relative "whop_sdk/models/course_chapter_update_params"
+require_relative "whop_sdk/models/course_create_params"
+require_relative "whop_sdk/models/course_delete_params"
+require_relative "whop_sdk/models/course_delete_response"
+require_relative "whop_sdk/models/course_lesson_create_params"
+require_relative "whop_sdk/models/course_lesson_delete_params"
+require_relative "whop_sdk/models/course_lesson_delete_response"
 require_relative "whop_sdk/models/course_lesson_interaction"
 require_relative "whop_sdk/models/course_lesson_interaction_completed_webhook_event"
 require_relative "whop_sdk/models/course_lesson_interaction_list_item"
 require_relative "whop_sdk/models/course_lesson_interaction_list_params"
 require_relative "whop_sdk/models/course_lesson_interaction_retrieve_params"
+require_relative "whop_sdk/models/course_lesson_list_params"
+require_relative "whop_sdk/models/course_lesson_list_response"
+require_relative "whop_sdk/models/course_lesson_retrieve_params"
+require_relative "whop_sdk/models/course_lesson_update_params"
+require_relative "whop_sdk/models/course_list_params"
+require_relative "whop_sdk/models/course_list_response"
+require_relative "whop_sdk/models/course_retrieve_params"
+require_relative "whop_sdk/models/course_update_params"
 require_relative "whop_sdk/models/currency"
 require_relative "whop_sdk/models/custom_cta"
 require_relative "whop_sdk/models/direction"
@@ -116,6 +142,7 @@ require_relative "whop_sdk/models/experience_create_params"
 require_relative "whop_sdk/models/experience_delete_params"
 require_relative "whop_sdk/models/experience_delete_response"
 require_relative "whop_sdk/models/experience_detach_params"
+require_relative "whop_sdk/models/experience_duplicate_params"
 require_relative "whop_sdk/models/experience_list_params"
 require_relative "whop_sdk/models/experience_list_response"
 require_relative "whop_sdk/models/experience_retrieve_params"
@@ -128,6 +155,7 @@ require_relative "whop_sdk/models/forum_post_create_params"
 require_relative "whop_sdk/models/forum_post_list_params"
 require_relative "whop_sdk/models/forum_post_list_response"
 require_relative "whop_sdk/models/forum_post_retrieve_params"
+require_relative "whop_sdk/models/forum_post_update_params"
 require_relative "whop_sdk/models/forum_retrieve_params"
 require_relative "whop_sdk/models/forum_update_params"
 require_relative "whop_sdk/models/friendly_receipt_status"
@@ -146,8 +174,12 @@ require_relative "whop_sdk/models/invoice_status"
 require_relative "whop_sdk/models/invoice_voided_webhook_event"
 require_relative "whop_sdk/models/invoice_void_params"
 require_relative "whop_sdk/models/invoice_void_response"
+require_relative "whop_sdk/models/languages"
 require_relative "whop_sdk/models/ledger_account_retrieve_params"
 require_relative "whop_sdk/models/ledger_account_retrieve_response"
+require_relative "whop_sdk/models/lesson"
+require_relative "whop_sdk/models/lesson_types"
+require_relative "whop_sdk/models/lesson_visibilities"
 require_relative "whop_sdk/models/member_list_params"
 require_relative "whop_sdk/models/member_list_response"
 require_relative "whop_sdk/models/member_most_recent_actions"
@@ -170,11 +202,13 @@ require_relative "whop_sdk/models/message_create_params"
 require_relative "whop_sdk/models/message_list_params"
 require_relative "whop_sdk/models/message_list_response"
 require_relative "whop_sdk/models/message_retrieve_params"
+require_relative "whop_sdk/models/message_update_params"
 require_relative "whop_sdk/models/page_info"
 require_relative "whop_sdk/models/payment"
 require_relative "whop_sdk/models/payment_failed_webhook_event"
 require_relative "whop_sdk/models/payment_list_params"
 require_relative "whop_sdk/models/payment_list_response"
+require_relative "whop_sdk/models/payment_method_types"
 require_relative "whop_sdk/models/payment_pending_webhook_event"
 require_relative "whop_sdk/models/payment_refund_params"
 require_relative "whop_sdk/models/payment_retrieve_params"
@@ -198,6 +232,15 @@ require_relative "whop_sdk/models/product_list_item"
 require_relative "whop_sdk/models/product_list_params"
 require_relative "whop_sdk/models/product_retrieve_params"
 require_relative "whop_sdk/models/product_update_params"
+require_relative "whop_sdk/models/promo_code"
+require_relative "whop_sdk/models/promo_code_create_params"
+require_relative "whop_sdk/models/promo_code_delete_params"
+require_relative "whop_sdk/models/promo_code_delete_response"
+require_relative "whop_sdk/models/promo_code_list_params"
+require_relative "whop_sdk/models/promo_code_list_response"
+require_relative "whop_sdk/models/promo_code_retrieve_params"
+require_relative "whop_sdk/models/promo_code_status"
+require_relative "whop_sdk/models/promo_duration"
 require_relative "whop_sdk/models/promo_type"
 require_relative "whop_sdk/models/reaction"
 require_relative "whop_sdk/models/reaction_create_params"
@@ -206,6 +249,11 @@ require_relative "whop_sdk/models/reaction_list_response"
 require_relative "whop_sdk/models/reaction_retrieve_params"
 require_relative "whop_sdk/models/receipt_status"
 require_relative "whop_sdk/models/release_method"
+require_relative "whop_sdk/models/review_list_params"
+require_relative "whop_sdk/models/review_list_response"
+require_relative "whop_sdk/models/review_retrieve_params"
+require_relative "whop_sdk/models/review_retrieve_response"
+require_relative "whop_sdk/models/review_status"
 require_relative "whop_sdk/models/shipment"
 require_relative "whop_sdk/models/shipment_carrier"
 require_relative "whop_sdk/models/shipment_create_params"
@@ -244,7 +292,10 @@ require_relative "whop_sdk/resources/authorized_users"
 require_relative "whop_sdk/resources/chat_channels"
 require_relative "whop_sdk/resources/checkout_configurations"
 require_relative "whop_sdk/resources/companies"
+require_relative "whop_sdk/resources/course_chapters"
 require_relative "whop_sdk/resources/course_lesson_interactions"
+require_relative "whop_sdk/resources/course_lessons"
+require_relative "whop_sdk/resources/courses"
 require_relative "whop_sdk/resources/entries"
 require_relative "whop_sdk/resources/experiences"
 require_relative "whop_sdk/resources/forum_posts"
@@ -257,7 +308,9 @@ require_relative "whop_sdk/resources/messages"
 require_relative "whop_sdk/resources/payments"
 require_relative "whop_sdk/resources/plans"
 require_relative "whop_sdk/resources/products"
+require_relative "whop_sdk/resources/promo_codes"
 require_relative "whop_sdk/resources/reactions"
+require_relative "whop_sdk/resources/reviews"
 require_relative "whop_sdk/resources/shipments"
 require_relative "whop_sdk/resources/support_channels"
 require_relative "whop_sdk/resources/transfers"

data/rbi/whop_sdk/client.rbi

@@ -92,6 +92,21 @@ module WhopSDK
     sig { returns(WhopSDK::Resources::Forums) }
     attr_reader :forums
 
+    sig { returns(WhopSDK::Resources::PromoCodes) }
+    attr_reader :promo_codes
+
+    sig { returns(WhopSDK::Resources::Courses) }
+    attr_reader :courses
+
+    sig { returns(WhopSDK::Resources::CourseChapters) }
+    attr_reader :course_chapters
+
+    sig { returns(WhopSDK::Resources::CourseLessons) }
+    attr_reader :course_lessons
+
+    sig { returns(WhopSDK::Resources::Reviews) }
+    attr_reader :reviews
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/whop_sdk/models/assessment_question_types.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The available types for an assessment question
+    module AssessmentQuestionTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, WhopSDK::AssessmentQuestionTypes) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SHORT_ANSWER =
+        T.let(:short_answer, WhopSDK::AssessmentQuestionTypes::TaggedSymbol)
+      TRUE_FALSE =
+        T.let(:true_false, WhopSDK::AssessmentQuestionTypes::TaggedSymbol)
+      MULTIPLE_CHOICE =
+        T.let(:multiple_choice, WhopSDK::AssessmentQuestionTypes::TaggedSymbol)
+      MULTIPLE_SELECT =
+        T.let(:multiple_select, WhopSDK::AssessmentQuestionTypes::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[WhopSDK::AssessmentQuestionTypes::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/billing_reasons.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The reason why a specific payment was billed
+    module BillingReasons
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::BillingReasons) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SUBSCRIPTION_CREATE =
+        T.let(:subscription_create, WhopSDK::BillingReasons::TaggedSymbol)
+      SUBSCRIPTION_CYCLE =
+        T.let(:subscription_cycle, WhopSDK::BillingReasons::TaggedSymbol)
+      SUBSCRIPTION_UPDATE =
+        T.let(:subscription_update, WhopSDK::BillingReasons::TaggedSymbol)
+      ONE_TIME = T.let(:one_time, WhopSDK::BillingReasons::TaggedSymbol)
+      MANUAL = T.let(:manual, WhopSDK::BillingReasons::TaggedSymbol)
+      SUBSCRIPTION = T.let(:subscription, WhopSDK::BillingReasons::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::BillingReasons::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/card_brands.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # Possible card brands that a payment token can have
+    module CardBrands
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::CardBrands) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      MASTERCARD = T.let(:mastercard, WhopSDK::CardBrands::TaggedSymbol)
+      VISA = T.let(:visa, WhopSDK::CardBrands::TaggedSymbol)
+      AMEX = T.let(:amex, WhopSDK::CardBrands::TaggedSymbol)
+      DISCOVER = T.let(:discover, WhopSDK::CardBrands::TaggedSymbol)
+      UNIONPAY = T.let(:unionpay, WhopSDK::CardBrands::TaggedSymbol)
+      JCB = T.let(:jcb, WhopSDK::CardBrands::TaggedSymbol)
+      DINERS = T.let(:diners, WhopSDK::CardBrands::TaggedSymbol)
+      LINK = T.let(:link, WhopSDK::CardBrands::TaggedSymbol)
+      TROY = T.let(:troy, WhopSDK::CardBrands::TaggedSymbol)
+      VISADANKORT = T.let(:visadankort, WhopSDK::CardBrands::TaggedSymbol)
+      VISABANCONTACT = T.let(:visabancontact, WhopSDK::CardBrands::TaggedSymbol)
+      CHINA_UNION_PAY =
+        T.let(:china_union_pay, WhopSDK::CardBrands::TaggedSymbol)
+      RUPAY = T.let(:rupay, WhopSDK::CardBrands::TaggedSymbol)
+      JCBRUPAY = T.let(:jcbrupay, WhopSDK::CardBrands::TaggedSymbol)
+      ELO = T.let(:elo, WhopSDK::CardBrands::TaggedSymbol)
+      UNKNOWN = T.let(:unknown, WhopSDK::CardBrands::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::CardBrands::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/checkout_configuration.rbi

@@ -31,7 +31,8 @@ module WhopSDK
       sig { params(plan: WhopSDK::CheckoutConfiguration::Plan::OrHash).void }
       attr_writer :plan
 
-      # The URL to redirect the user to after the checkout configuration is created
+      # A URL you can send to customers to complete a checkout. It looks like
+      # `/checkout/plan_xxxx?session={id}`
       sig { returns(String) }
       attr_accessor :purchase_url
 
@@ -66,7 +67,8 @@ module WhopSDK
         metadata:,
         # The plan to use for the checkout configuration
         plan:,
-        # The URL to redirect the user to after the checkout configuration is created
+        # A URL you can send to customers to complete a checkout. It looks like
+        # `/checkout/plan_xxxx?session={id}`
         purchase_url:,
         # The URL to redirect the user to after the checkout configuration is created
         redirect_url: