whop_sdk 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47dbcf6d251bc786986b0862e0ed904004a5ed20ba919298f7c3405f0cb3b508
-  data.tar.gz: a32801e2c4cb776d9d140b96dfe7ddfed67276a505836ab747e753e1b2ea1ae9
+  metadata.gz: 3eecc254b8ba9c6ee8fd458763a9749b1478efc921f4f3c696823cae79f31a1c
+  data.tar.gz: 0b085d7a2c1551bc99016a562266d326312f8da3b3a6104a08426677f9b89c1e
 SHA512:
-  metadata.gz: 0a9770a71da93ee3e6bf5e6d19936c53bd534e546809a4e9d9dfa56dbff804ead817e512a4e815bb71c983c088260422a729ab2dd3003d8bf69bf6180bcdc7b2
-  data.tar.gz: 4a3ec25658c045e9cd3789a0d9bfde24993dd1f4092dc46dd3808d04b244b4af954bf1b4a3e54688f796ba865cc13151ebba8693fb18808f82fbf889c8971e80
+  metadata.gz: 4ed891547df3d339cbec397a7d78e55e7c00610187dc5cb80acf05e6fc2e93e0952020f55723e98b2f5230a220424d3bdf8498f70ac472f8f5e2aed37dfa0e6e
+  data.tar.gz: 9d9ca43b7fc87ff4df8a9e050d15503631e25070369381116c362b6cae95cf0740de7a3488325538928974349c1687e7147f729d8794bbbe44ca2ef79b125259

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 0.0.7 (2025-11-13)
+
+Full Changelog: [v0.0.6...v0.0.7](https://github.com/whopio/whopsdk-ruby/compare/v0.0.6...v0.0.7)
+
+### Features
+
+* **api:** api update ([ebffee5](https://github.com/whopio/whopsdk-ruby/commit/ebffee5d68b29d6a7219b6f5446229c1734a9c58))
+* **api:** api update ([9984831](https://github.com/whopio/whopsdk-ruby/commit/9984831a51353e776c0e3dd6c4e58bc7ecf94cb3))
+* **api:** api update ([89cb635](https://github.com/whopio/whopsdk-ruby/commit/89cb635fcb034579638e5946bf7d773639848f80))
+* **api:** api update ([71c9708](https://github.com/whopio/whopsdk-ruby/commit/71c9708ff5359af68c59e22eafe8c9b2af8be588))
+* **api:** api update ([f0ed1e2](https://github.com/whopio/whopsdk-ruby/commit/f0ed1e29b2293b5bb408b7d3c12722df36add5b7))
+* **api:** api update ([117f8ff](https://github.com/whopio/whopsdk-ruby/commit/117f8ff26be6ccd0e004d74e65c3ad866ae31d64))
+
+## 0.0.6 (2025-11-10)
+
+Full Changelog: [v0.0.5...v0.0.6](https://github.com/whopio/whopsdk-ruby/compare/v0.0.5...v0.0.6)
+
+### Features
+
+* **api:** api update ([40bd47a](https://github.com/whopio/whopsdk-ruby/commit/40bd47ab707c869f865202b879d2818a1365c785))
+* **api:** manual updates ([59f44e4](https://github.com/whopio/whopsdk-ruby/commit/59f44e454e7c1727a1d8566b316f7e61e98ce00b))
+* **api:** manual updates ([f4dcf3a](https://github.com/whopio/whopsdk-ruby/commit/f4dcf3a5be316eaa0452b4786c7c986c75a3d8b2))
+
+
+### Bug Fixes
+
+* **api:** allow optional app id in constructor ([#4](https://github.com/whopio/whopsdk-ruby/issues/4)) ([7e6bd87](https://github.com/whopio/whopsdk-ruby/commit/7e6bd873a73acb9f76c24a51945f94fb0eb65d13))
+
 ## 0.0.5 (2025-11-08)
 
 Full Changelog: [v0.0.4...v0.0.5](https://github.com/whopio/whopsdk-ruby/compare/v0.0.4...v0.0.5)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "whop_sdk", "~> 0.0.5"
+gem "whop_sdk", "~> 0.0.7"
 ```
 
 <!-- x-release-please-end -->
@@ -29,8 +29,7 @@ require "bundler/setup"
 require "whop_sdk"
 
 whop = WhopSDK::Client.new(
-  api_key: ENV["WHOP_API_KEY"], # This is the default and can be omitted
-  app_id: "app_xxxxxxxxxxxxxx"
+  api_key: ENV["WHOP_API_KEY"] # This is the default and can be omitted
 )
 
 page = whop.payments.list(company_id: "biz_xxxxxxxxxxxxxx")
@@ -111,8 +110,7 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 whop = WhopSDK::Client.new(
-  max_retries: 0, # default is 2
-  app_id: "app_xxxxxxxxxxxxxx"
+  max_retries: 0 # default is 2
 )
 
 # Or, configure per-request:
@@ -126,8 +124,7 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 whop = WhopSDK::Client.new(
-  timeout: nil, # default is 60
-  app_id: "app_xxxxxxxxxxxxxx"
+  timeout: nil # default is 60
 )
 
 # Or, configure per-request:

data/lib/whop_sdk/client.rb

@@ -19,7 +19,9 @@ module WhopSDK
     # @return [String]
     attr_reader :api_key
 
-    # @return [String]
+    # When using the SDK in app mode pass this parameter to allow verifying user
+    # tokens
+    # @return [String, nil]
     attr_reader :app_id
 
     # @return [WhopSDK::Resources::Apps]
@@ -118,6 +120,12 @@ module WhopSDK
     # @return [WhopSDK::Resources::AccessTokens]
     attr_reader :access_tokens
 
+    # @return [WhopSDK::Resources::Notifications]
+    attr_reader :notifications
+
+    # @return [WhopSDK::Resources::Disputes]
+    attr_reader :disputes
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -132,7 +140,8 @@ module WhopSDK
     # @param api_key [String, nil] The app API key from an app from the /dashboard/developer page Defaults to
     # `ENV["WHOP_API_KEY"]`
     #
-    # @param app_id [String, nil] Defaults to `ENV["WHOP_APP_ID"]`
+    # @param app_id [String, nil] When using the SDK in app mode pass this parameter to allow verifying user
+    # tokens Defaults to `ENV["WHOP_APP_ID"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["WHOP_BASE_URL"]`
@@ -155,15 +164,12 @@ module WhopSDK
     )
       base_url ||= "https://api.whop.com/api/v1"
 
-      if app_id.nil?
-        raise ArgumentError.new("app_id is required, and can be set via environ: \"WHOP_APP_ID\"")
-      end
       if api_key.nil?
         raise ArgumentError.new("api_key is required, and can be set via environ: \"WHOP_API_KEY\"")
       end
 
       headers = {
-        "x-whop-app-id" => (@app_id = app_id.to_s)
+        "x-whop-app-id" => (@app_id = app_id&.to_s)
       }
 
       @api_key = api_key.to_s
@@ -209,6 +215,8 @@ module WhopSDK
       @reviews = WhopSDK::Resources::Reviews.new(client: self)
       @course_students = WhopSDK::Resources::CourseStudents.new(client: self)
       @access_tokens = WhopSDK::Resources::AccessTokens.new(client: self)
+      @notifications = WhopSDK::Resources::Notifications.new(client: self)
+      @disputes = WhopSDK::Resources::Disputes.new(client: self)
     end
 
     # Verifies a Whop user token
@@ -221,6 +229,9 @@ module WhopSDK
     # @raise [StandardError] If verification fails
     def verify_user_token!(token_or_headers, **opts)
       opts[:app_id] ||= app_id
+      unless opts[:app_id]
+        raise StandardError, "You must set app_id in the Whop client if you want to verify user tokens"
+      end
       Helpers::VerifyUserToken.verify_user_token!(token_or_headers, **opts)
     end
 

data/lib/whop_sdk/models/access_token_create_params.rb

@@ -7,25 +7,13 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute scoped_actions
-      #   Array of desired scoped actions for the access token. This list must be a subset
-      #   of the API keys's existing permissions. Otherwise, an error will be raised.
-      #
-      #   @return [Array<String>]
-      required :scoped_actions, WhopSDK::Internal::Type::ArrayOf[String]
-
-      # @!attribute target_resource_id
-      #   The ID of the target resource (Company, User, etc.) for which the access token
-      #   is being created.
+      # @!attribute company_id
+      #   The ID of the Company to generate the token for. The API key must have
+      #   permission to access this Company, such as the being the company the API key
+      #   belongs to or a sub-merchant of it
       #
       #   @return [String]
-      required :target_resource_id, String
-
-      # @!attribute target_resource_type
-      #   The type of the target resource (company, user, product, experience, etc.).
-      #
-      #   @return [Symbol, WhopSDK::Models::AccessTokenCreateParams::TargetResourceType]
-      required :target_resource_type, enum: -> { WhopSDK::AccessTokenCreateParams::TargetResourceType }
+      required :company_id, String
 
       # @!attribute expires_at
       #   The expiration timestamp for the access token. If not provided, a default
@@ -35,33 +23,35 @@ module WhopSDK
       #   @return [Time, nil]
       optional :expires_at, Time, nil?: true
 
-      # @!method initialize(scoped_actions:, target_resource_id:, target_resource_type:, expires_at: nil, request_options: {})
+      # @!attribute scoped_actions
+      #   Array of desired scoped actions for the access token. If sent as an empty array
+      #   or not provided, all permissions from the API key making the request will be
+      #   available on the token. If sending an explicit list, they must be a subset of
+      #   the API keys's existing permissions. Otherwise, an error will be raised.
+      #
+      #   @return [Array<String>, nil]
+      optional :scoped_actions, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute user_id
+      #   The ID of the User to generate the token for. The API key must have permission
+      #   to access this User.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(company_id:, user_id:, expires_at: nil, scoped_actions: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::AccessTokenCreateParams} for more details.
       #
-      #   @param scoped_actions [Array<String>] Array of desired scoped actions for the access token. This list must be a subset
-      #
-      #   @param target_resource_id [String] The ID of the target resource (Company, User, etc.) for which the access token i
+      #   @param company_id [String] The ID of the Company to generate the token for. The API key must have permissio
       #
-      #   @param target_resource_type [Symbol, WhopSDK::Models::AccessTokenCreateParams::TargetResourceType] The type of the target resource (company, user, product, experience, etc.).
+      #   @param user_id [String] The ID of the User to generate the token for. The API key must have permission t
       #
       #   @param expires_at [Time, nil] The expiration timestamp for the access token. If not provided, a default expira
       #
+      #   @param scoped_actions [Array<String>, nil] Array of desired scoped actions for the access token. If sent as an empty array
+      #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
-
-      # The type of the target resource (company, user, product, experience, etc.).
-      module TargetResourceType
-        extend WhopSDK::Internal::Type::Enum
-
-        COMPANY = :company
-        PRODUCT = :product
-        EXPERIENCE = :experience
-        APP = :app
-        USER = :user
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/whop_sdk/models/card_brands.rb

@@ -21,6 +21,7 @@ module WhopSDK
       RUPAY = :rupay
       JCBRUPAY = :jcbrupay
       ELO = :elo
+      MAESTRO = :maestro
       UNKNOWN = :unknown
 
       # @!method self.values

data/lib/whop_sdk/models/checkout_configuration_create_params.rb

@@ -57,18 +57,18 @@ module WhopSDK
         #   @return [String]
         required :company_id, String
 
+        # @!attribute currency
+        #   The respective currency identifier for the plan.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :currency, enum: -> { WhopSDK::Currency }
+
         # @!attribute billing_period
         #   The interval at which the plan charges (renewal plans).
         #
         #   @return [Integer, nil]
         optional :billing_period, Integer, nil?: true
 
-        # @!attribute currency
-        #   The available currencies on the platform
-        #
-        #   @return [Symbol, WhopSDK::Models::Currency, nil]
-        optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
-
         # @!attribute custom_fields
         #   An array of custom field objects.
         #
@@ -181,7 +181,7 @@ module WhopSDK
         #   @return [Symbol, WhopSDK::Models::Visibility, nil]
         optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
 
-        # @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
+        # @!method initialize(company_id:, currency:, billing_period: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
         #   Some parameter documentations has been truncated, see
         #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan} for more details.
         #
@@ -189,9 +189,9 @@ module WhopSDK
         #
         #   @param company_id [String] The company the plan should be created for.
         #
-        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+        #   @param currency [Symbol, WhopSDK::Models::Currency] The respective currency identifier for the plan.
         #
-        #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
         #
         #   @param custom_fields [Array<WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::CustomField>, nil] An array of custom field objects.
         #

data/lib/whop_sdk/models/company.rb

@@ -220,6 +220,7 @@ module WhopSDK
           LINKEDIN = :linkedin
           TWITCH = :twitch
           WEBSITE = :website
+          CUSTOM = :custom
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/whop_sdk/models/currency.rb

@@ -90,6 +90,7 @@ module WhopSDK
       UZS = :uzs
       RUB = :rub
       BTC = :btc
+      CNY = :cny
 
       # @!method self.values
       #   @return [Array<Symbol>]