whop_sdk 0.0.4 → 0.0.5

data/lib/whop_sdk/resources/shipments.rb

@@ -43,7 +43,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the shipment
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Shipment]

data/lib/whop_sdk/resources/support_channels.rb

@@ -40,7 +40,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the support channel to fetch
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::SupportChannel]

data/lib/whop_sdk/resources/transfers.rb

@@ -52,7 +52,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the transfer
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Transfer]

data/lib/whop_sdk/resources/users.rb

@@ -7,7 +7,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID (user_xxx) or username of the user
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::UserRetrieveResponse]
@@ -22,12 +23,17 @@ module WhopSDK
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::UserCheckAccessParams} for more details.
+      #
       # Check if a user has access (and their access level) to a resource
       #
       # @overload check_access(resource_id, id:, request_options: {})
       #
-      # @param resource_id [String]
-      # @param id [String]
+      # @param resource_id [String] The ID of the resource. Can be a company (biz_xxx), product (prod_xxx), or exper
+      #
+      # @param id [String] The ID (user_xxx) or username of the user
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::UserCheckAccessResponse]

data/lib/whop_sdk/version.rb

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

data/lib/whop_sdk.rb

@@ -9,6 +9,7 @@ require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -53,6 +54,8 @@ require_relative "whop_sdk/client"
 require_relative "whop_sdk/internal/cursor_page"
 require_relative "whop_sdk/models/access_level"
 require_relative "whop_sdk/models/access_pass_type"
+require_relative "whop_sdk/models/access_token_create_params"
+require_relative "whop_sdk/models/access_token_create_response"
 require_relative "whop_sdk/models/app"
 require_relative "whop_sdk/models/app_build"
 require_relative "whop_sdk/models/app_build_create_params"
@@ -126,11 +129,13 @@ require_relative "whop_sdk/models/course_student_list_response"
 require_relative "whop_sdk/models/course_student_retrieve_params"
 require_relative "whop_sdk/models/course_student_retrieve_response"
 require_relative "whop_sdk/models/course_update_params"
+require_relative "whop_sdk/models/course_visibilities"
 require_relative "whop_sdk/models/currency"
 require_relative "whop_sdk/models/custom_cta"
 require_relative "whop_sdk/models/direction"
 require_relative "whop_sdk/models/dms_post_types"
 require_relative "whop_sdk/models/email_notification_preferences"
+require_relative "whop_sdk/models/embed_type"
 require_relative "whop_sdk/models/entry"
 require_relative "whop_sdk/models/entry_approved_webhook_event"
 require_relative "whop_sdk/models/entry_approve_params"
@@ -292,6 +297,7 @@ require_relative "whop_sdk/models/who_can_post"
 require_relative "whop_sdk/models/who_can_post_types"
 require_relative "whop_sdk/models/who_can_react"
 require_relative "whop_sdk/models"
+require_relative "whop_sdk/resources/access_tokens"
 require_relative "whop_sdk/resources/app_builds"
 require_relative "whop_sdk/resources/apps"
 require_relative "whop_sdk/resources/authorized_users"

data/manifest.yaml

@@ -6,6 +6,7 @@ dependencies:
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/whop_sdk/client.rbi

@@ -110,6 +110,9 @@ module WhopSDK
     sig { returns(WhopSDK::Resources::CourseStudents) }
     attr_reader :course_students
 
+    sig { returns(WhopSDK::Resources::AccessTokens) }
+    attr_reader :access_tokens
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/whop_sdk/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module WhopSDK
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module WhopSDK
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/whop_sdk/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module WhopSDK
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: WhopSDK::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -274,9 +274,13 @@ module WhopSDK
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                WhopSDK::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/whop_sdk/models/access_level.rbi

@@ -2,7 +2,7 @@
 
 module WhopSDK
   module Models
-    # The access level a given user (or company) has to an access pass or company.
+    # The access level a given user (or company) has to a product or company.
     module AccessLevel
       extend WhopSDK::Internal::Type::Enum
 

data/rbi/whop_sdk/models/access_pass_type.rbi

@@ -2,7 +2,8 @@
 
 module WhopSDK
   module Models
-    # The different types an access pass can be.
+    # The different types an product can be. Only use 'regular'. The rest are for
+    # internal use
     module AccessPassType
       extend WhopSDK::Internal::Type::Enum
 

data/rbi/whop_sdk/models/access_token_create_params.rbi

@@ -0,0 +1,126 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccessTokenCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AccessTokenCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # 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.
+      sig { returns(T::Array[String]) }
+      attr_accessor :scoped_actions
+
+      # The ID of the target resource (Company, User, etc.) for which the access token
+      # is being created.
+      sig { returns(String) }
+      attr_accessor :target_resource_id
+
+      # The type of the target resource (company, user, product, experience, etc.).
+      sig do
+        returns(WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol)
+      end
+      attr_accessor :target_resource_type
+
+      # The expiration timestamp for the access token. If not provided, a default
+      # expiration time of 1 hour will be used. The expiration can be set to a maximum
+      # of 3 hours from the current time.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      sig do
+        params(
+          scoped_actions: T::Array[String],
+          target_resource_id: String,
+          target_resource_type:
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol,
+          expires_at: T.nilable(Time),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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.
+        scoped_actions:,
+        # The ID of the target resource (Company, User, etc.) for which the access token
+        # is being created.
+        target_resource_id:,
+        # The type of the target resource (company, user, product, experience, etc.).
+        target_resource_type:,
+        # The expiration timestamp for the access token. If not provided, a default
+        # expiration time of 1 hour will be used. The expiration can be set to a maximum
+        # of 3 hours from the current time.
+        expires_at: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            scoped_actions: T::Array[String],
+            target_resource_id: String,
+            target_resource_type:
+              WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol,
+            expires_at: T.nilable(Time),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of the target resource (company, user, product, experience, etc.).
+      module TargetResourceType
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AccessTokenCreateParams::TargetResourceType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        COMPANY =
+          T.let(
+            :company,
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+          )
+        PRODUCT =
+          T.let(
+            :product,
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+          )
+        EXPERIENCE =
+          T.let(
+            :experience,
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+          )
+        APP =
+          T.let(
+            :app,
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+          )
+        USER =
+          T.let(
+            :user,
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::AccessTokenCreateParams::TargetResourceType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/access_token_create_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AccessTokenCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::AccessTokenCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The JWT access token string.
+      sig { returns(String) }
+      attr_accessor :token
+
+      # The expiration timestamp of the access token.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # An object representing an access token used for authenticating API requests.
+      sig { params(token: String, expires_at: Time).returns(T.attached_class) }
+      def self.new(
+        # The JWT access token string.
+        token:,
+        # The expiration timestamp of the access token.
+        expires_at:
+      )
+      end
+
+      sig { override.returns({ token: String, expires_at: Time }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi

@@ -174,7 +174,7 @@ module WhopSDK
         end
         attr_writer :payment_method_configuration
 
-        # The type of plan that can be attached to an access pass
+        # The type of plan that can be attached to a product
         sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
         attr_accessor :plan_type
 
@@ -291,7 +291,7 @@ module WhopSDK
           # The explicit payment method configuration for the plan. If not provided, the
           # platform or company's defaults will apply.
           payment_method_configuration: nil,
-          # The type of plan that can be attached to an access pass
+          # The type of plan that can be attached to a product
           plan_type: nil,
           # Pass this object to create a new product for this plan. We will use the product
           # external identifier to find or create an existing product.
@@ -621,7 +621,7 @@ module WhopSDK
           sig { returns(T.nilable(Float)) }
           attr_accessor :global_affiliate_percentage
 
-          # The different statuses of the global affiliate program for an access pass.
+          # The different statuses of the global affiliate program for a product.
           sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
           attr_accessor :global_affiliate_status
 
@@ -689,7 +689,7 @@ module WhopSDK
             description: nil,
             # The percentage of the revenue that goes to the global affiliate program.
             global_affiliate_percentage: nil,
-            # The different statuses of the global affiliate program for an access pass.
+            # The different statuses of the global affiliate program for a product.
             global_affiliate_status: nil,
             # The headline of the product.
             headline: nil,

data/rbi/whop_sdk/models/course.rbi

@@ -32,6 +32,10 @@ module WhopSDK
       sig { returns(WhopSDK::Languages::TaggedSymbol) }
       attr_accessor :language
 
+      # The order of the course within its experience
+      sig { returns(String) }
+      attr_accessor :order
+
       # Whether the course requires students to complete the previous lesson before
       # moving on to the next one
       sig { returns(T::Boolean) }
@@ -58,6 +62,11 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :updated_at
 
+      # The visibility of the course. Determines how / whether this course is visible to
+      # users.
+      sig { returns(WhopSDK::CourseVisibilities::TaggedSymbol) }
+      attr_accessor :visibility
+
       # A course from the courses app
       sig do
         params(
@@ -67,11 +76,13 @@ module WhopSDK
           created_at: Time,
           description: T.nilable(String),
           language: WhopSDK::Languages::OrSymbol,
+          order: String,
           require_completing_lessons_in_order: T::Boolean,
           tagline: T.nilable(String),
           thumbnail: T.nilable(WhopSDK::Course::Thumbnail::OrHash),
           title: T.nilable(String),
-          updated_at: Time
+          updated_at: Time,
+          visibility: WhopSDK::CourseVisibilities::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -89,6 +100,8 @@ module WhopSDK
         # The language spoken in the video content of the course, used to generate closed
         # captions in the right language
         language:,
+        # The order of the course within its experience
+        order:,
         # Whether the course requires students to complete the previous lesson before
         # moving on to the next one
         require_completing_lessons_in_order:,
@@ -99,7 +112,10 @@ module WhopSDK
         # The title of the course
         title:,
         # The timestamp of when the course was last updated
-        updated_at:
+        updated_at:,
+        # The visibility of the course. Determines how / whether this course is visible to
+        # users.
+        visibility:
       )
       end
 
@@ -112,11 +128,13 @@ module WhopSDK
             created_at: Time,
             description: T.nilable(String),
             language: WhopSDK::Languages::TaggedSymbol,
+            order: String,
             require_completing_lessons_in_order: T::Boolean,
             tagline: T.nilable(String),
             thumbnail: T.nilable(WhopSDK::Course::Thumbnail),
             title: T.nilable(String),
-            updated_at: Time
+            updated_at: Time,
+            visibility: WhopSDK::CourseVisibilities::TaggedSymbol
           }
         )
       end

data/rbi/whop_sdk/models/course_create_params.rbi

@@ -28,6 +28,12 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :cover_image
 
+      # The decimal order position of the course within its experience. If not provided,
+      # it will be set to the next sequential order. Use fractional values (e.g., 1.5)
+      # to place between existing courses.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :order
+
       # Whether the course requires students to complete the previous lesson before
       # moving on to the next one
       sig { returns(T.nilable(T::Boolean)) }
@@ -50,12 +56,18 @@ module WhopSDK
       end
       attr_accessor :thumbnail
 
+      # The available visibilities for a course. Determines how / whether a course is
+      # visible to users.
+      sig { returns(T.nilable(WhopSDK::CourseVisibilities::OrSymbol)) }
+      attr_accessor :visibility
+
       sig do
         params(
           experience_id: String,
           title: String,
           certificate_after_completion_enabled: T.nilable(T::Boolean),
           cover_image: T.nilable(String),
+          order: T.nilable(String),
           require_completing_lessons_in_order: T.nilable(T::Boolean),
           tagline: T.nilable(String),
           thumbnail:
@@ -65,6 +77,7 @@ module WhopSDK
                 WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID::OrHash
               )
             ),
+          visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -78,6 +91,10 @@ module WhopSDK
         certificate_after_completion_enabled: nil,
         # The cover image URL of the course
         cover_image: nil,
+        # The decimal order position of the course within its experience. If not provided,
+        # it will be set to the next sequential order. Use fractional values (e.g., 1.5)
+        # to place between existing courses.
+        order: nil,
         # Whether the course requires students to complete the previous lesson before
         # moving on to the next one
         require_completing_lessons_in_order: nil,
@@ -85,6 +102,9 @@ module WhopSDK
         tagline: nil,
         # The thumbnail for the course in png, jpeg, or gif format
         thumbnail: nil,
+        # The available visibilities for a course. Determines how / whether a course is
+        # visible to users.
+        visibility: nil,
         request_options: {}
       )
       end
@@ -96,6 +116,7 @@ module WhopSDK
             title: String,
             certificate_after_completion_enabled: T.nilable(T::Boolean),
             cover_image: T.nilable(String),
+            order: T.nilable(String),
             require_completing_lessons_in_order: T.nilable(T::Boolean),
             tagline: T.nilable(String),
             thumbnail:
@@ -105,6 +126,7 @@ module WhopSDK
                   WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID
                 )
               ),
+            visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
             request_options: WhopSDK::RequestOptions
           }
         )