whop_sdk 0.0.5 → 0.0.7

data/rbi/whop_sdk/models/forum_post_update_params.rbi

@@ -39,6 +39,12 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :title
 
+      # The visibility types for forum posts
+      sig do
+        returns(T.nilable(WhopSDK::ForumPostUpdateParams::Visibility::OrSymbol))
+      end
+      attr_accessor :visibility
+
       sig do
         params(
           attachments:
@@ -53,6 +59,8 @@ module WhopSDK
           content: T.nilable(String),
           is_pinned: T.nilable(T::Boolean),
           title: T.nilable(String),
+          visibility:
+            T.nilable(WhopSDK::ForumPostUpdateParams::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -66,6 +74,8 @@ module WhopSDK
         is_pinned: nil,
         # The title of the post. Only visible if paywalled.
         title: nil,
+        # The visibility types for forum posts
+        visibility: nil,
         request_options: {}
       )
       end
@@ -85,6 +95,8 @@ module WhopSDK
             content: T.nilable(String),
             is_pinned: T.nilable(T::Boolean),
             title: T.nilable(String),
+            visibility:
+              T.nilable(WhopSDK::ForumPostUpdateParams::Visibility::OrSymbol),
             request_options: WhopSDK::RequestOptions
           }
         )
@@ -172,6 +184,36 @@ module WhopSDK
         def self.variants
         end
       end
+
+      # The visibility types for forum posts
+      module Visibility
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::ForumPostUpdateParams::Visibility)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MEMBERS_ONLY =
+          T.let(
+            :members_only,
+            WhopSDK::ForumPostUpdateParams::Visibility::TaggedSymbol
+          )
+        GLOBALLY_VISIBLE =
+          T.let(
+            :globally_visible,
+            WhopSDK::ForumPostUpdateParams::Visibility::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::ForumPostUpdateParams::Visibility::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi

@@ -216,6 +216,11 @@ module WhopSDK
             :pending,
             WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerAccountAuditStatus::TaggedSymbol
           )
+        PENDING_AI_REVIEW =
+          T.let(
+            :pending_ai_review,
+            WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerAccountAuditStatus::TaggedSymbol
+          )
         APPROVED =
           T.let(
             :approved,

data/rbi/whop_sdk/models/notification_create_params.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class NotificationCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::NotificationCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The id of the company to target. Only team members of this company will receive
+      # the notification. When clicked will take the user to your dashboard app view.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The content of the notification
+      sig { returns(String) }
+      attr_accessor :content
+
+      # The title of the notification
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Optional: ID of a Whop user whose profile picture will be used as the
+      # notification icon. If not provided, defaults to the experience or company
+      # avatar.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :icon_user_id
+
+      # The rest path to append to the generated deep link that opens your app. Use
+      # [restPath] in your app path in the dashboard to read this parameter.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :rest_path
+
+      # The subtitle of the notification
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subtitle
+
+      # If provided, this will only send to these users if they are also in the main
+      # scope (experience or company)
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :user_ids
+
+      # The id of the experience to target. All users with access to this experience
+      # (customers and admins) will receive the notification. When clicked, open your
+      # experience view.
+      sig { returns(String) }
+      attr_accessor :experience_id
+
+      sig do
+        params(
+          company_id: String,
+          content: String,
+          title: String,
+          experience_id: String,
+          icon_user_id: T.nilable(String),
+          rest_path: T.nilable(String),
+          subtitle: T.nilable(String),
+          user_ids: T.nilable(T::Array[String]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The id of the company to target. Only team members of this company will receive
+        # the notification. When clicked will take the user to your dashboard app view.
+        company_id:,
+        # The content of the notification
+        content:,
+        # The title of the notification
+        title:,
+        # The id of the experience to target. All users with access to this experience
+        # (customers and admins) will receive the notification. When clicked, open your
+        # experience view.
+        experience_id:,
+        # Optional: ID of a Whop user whose profile picture will be used as the
+        # notification icon. If not provided, defaults to the experience or company
+        # avatar.
+        icon_user_id: nil,
+        # The rest path to append to the generated deep link that opens your app. Use
+        # [restPath] in your app path in the dashboard to read this parameter.
+        rest_path: nil,
+        # The subtitle of the notification
+        subtitle: nil,
+        # If provided, this will only send to these users if they are also in the main
+        # scope (experience or company)
+        user_ids: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            content: String,
+            title: String,
+            icon_user_id: T.nilable(String),
+            rest_path: T.nilable(String),
+            subtitle: T.nilable(String),
+            user_ids: T.nilable(T::Array[String]),
+            experience_id: String,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/notification_create_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class NotificationCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::NotificationCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # Whether the notification was successfully queued for delivery
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      # Response from queuing a notification
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(
+        # Whether the notification was successfully queued for delivery
+        success:
+      )
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/shipment.rbi

@@ -23,10 +23,12 @@ module WhopSDK
       attr_accessor :delivery_estimate
 
       # The payment of the shipment
-      sig { returns(WhopSDK::Shipment::Payment) }
+      sig { returns(T.nilable(WhopSDK::Shipment::Payment)) }
       attr_reader :payment
 
-      sig { params(payment: WhopSDK::Shipment::Payment::OrHash).void }
+      sig do
+        params(payment: T.nilable(WhopSDK::Shipment::Payment::OrHash)).void
+      end
       attr_writer :payment
 
       # The service of the shipment
@@ -56,7 +58,7 @@ module WhopSDK
           carrier: WhopSDK::ShipmentCarrier::OrSymbol,
           created_at: Time,
           delivery_estimate: T.nilable(Time),
-          payment: WhopSDK::Shipment::Payment::OrHash,
+          payment: T.nilable(WhopSDK::Shipment::Payment::OrHash),
           service: T.nilable(String),
           status: WhopSDK::ShipmentStatus::OrSymbol,
           substatus: T.nilable(WhopSDK::ShipmentSubstatus::OrSymbol),
@@ -95,7 +97,7 @@ module WhopSDK
             carrier: WhopSDK::ShipmentCarrier::TaggedSymbol,
             created_at: Time,
             delivery_estimate: T.nilable(Time),
-            payment: WhopSDK::Shipment::Payment,
+            payment: T.nilable(WhopSDK::Shipment::Payment),
             service: T.nilable(String),
             status: WhopSDK::ShipmentStatus::TaggedSymbol,
             substatus: T.nilable(WhopSDK::ShipmentSubstatus::TaggedSymbol),

data/rbi/whop_sdk/models/shipment_list_response.rbi

@@ -28,12 +28,13 @@ module WhopSDK
       attr_accessor :delivery_estimate
 
       # The payment of the shipment
-      sig { returns(WhopSDK::Models::ShipmentListResponse::Payment) }
+      sig { returns(T.nilable(WhopSDK::Models::ShipmentListResponse::Payment)) }
       attr_reader :payment
 
       sig do
         params(
-          payment: WhopSDK::Models::ShipmentListResponse::Payment::OrHash
+          payment:
+            T.nilable(WhopSDK::Models::ShipmentListResponse::Payment::OrHash)
         ).void
       end
       attr_writer :payment
@@ -65,7 +66,8 @@ module WhopSDK
           carrier: WhopSDK::ShipmentCarrier::OrSymbol,
           created_at: Time,
           delivery_estimate: T.nilable(Time),
-          payment: WhopSDK::Models::ShipmentListResponse::Payment::OrHash,
+          payment:
+            T.nilable(WhopSDK::Models::ShipmentListResponse::Payment::OrHash),
           service: T.nilable(String),
           status: WhopSDK::ShipmentStatus::OrSymbol,
           substatus: T.nilable(WhopSDK::ShipmentSubstatus::OrSymbol),
@@ -104,7 +106,7 @@ module WhopSDK
             carrier: WhopSDK::ShipmentCarrier::TaggedSymbol,
             created_at: Time,
             delivery_estimate: T.nilable(Time),
-            payment: WhopSDK::Models::ShipmentListResponse::Payment,
+            payment: T.nilable(WhopSDK::Models::ShipmentListResponse::Payment),
             service: T.nilable(String),
             status: WhopSDK::ShipmentStatus::TaggedSymbol,
             substatus: T.nilable(WhopSDK::ShipmentSubstatus::TaggedSymbol),

data/rbi/whop_sdk/models/unwrap_webhook_event.rbi

@@ -21,7 +21,9 @@ module WhopSDK
             WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
             WhopSDK::PaymentSucceededWebhookEvent,
             WhopSDK::PaymentFailedWebhookEvent,
-            WhopSDK::PaymentPendingWebhookEvent
+            WhopSDK::PaymentPendingWebhookEvent,
+            WhopSDK::DisputeCreatedWebhookEvent,
+            WhopSDK::DisputeUpdatedWebhookEvent
           )
         end
 

data/rbi/whop_sdk/models.rbi

@@ -138,6 +138,22 @@ module WhopSDK
 
   Direction = WhopSDK::Models::Direction
 
+  Dispute = WhopSDK::Models::Dispute
+
+  DisputeCreatedWebhookEvent = WhopSDK::Models::DisputeCreatedWebhookEvent
+
+  DisputeListParams = WhopSDK::Models::DisputeListParams
+
+  DisputeRetrieveParams = WhopSDK::Models::DisputeRetrieveParams
+
+  DisputeStatuses = WhopSDK::Models::DisputeStatuses
+
+  DisputeSubmitEvidenceParams = WhopSDK::Models::DisputeSubmitEvidenceParams
+
+  DisputeUpdatedWebhookEvent = WhopSDK::Models::DisputeUpdatedWebhookEvent
+
+  DisputeUpdateEvidenceParams = WhopSDK::Models::DisputeUpdateEvidenceParams
+
   DmsPostTypes = WhopSDK::Models::DmsPostTypes
 
   EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
@@ -278,6 +294,8 @@ module WhopSDK
 
   MessageUpdateParams = WhopSDK::Models::MessageUpdateParams
 
+  NotificationCreateParams = WhopSDK::Models::NotificationCreateParams
+
   PageInfo = WhopSDK::Models::PageInfo
 
   Payment = WhopSDK::Models::Payment

data/rbi/whop_sdk/resources/access_tokens.rbi

@@ -3,31 +3,36 @@
 module WhopSDK
   module Resources
     class AccessTokens
-      # Creates an access token for a user to access a specific resource. These access
-      # tokens are designed to be used with Whop's embedded components.
+      # Create a short-lived access token to authenticate API requests on behalf of a
+      # Company or User. This token should be used with Whop's web and mobile embedded
+      # components. You must provide either a company_id or a user_id argument, but not
+      # both.
       sig do
         params(
-          scoped_actions: T::Array[String],
-          target_resource_id: String,
-          target_resource_type:
-            WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol,
+          company_id: String,
+          user_id: String,
           expires_at: T.nilable(Time),
+          scoped_actions: T.nilable(T::Array[String]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::AccessTokenCreateResponse)
       end
       def create(
-        # 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 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
+        company_id:,
+        # The ID of the User to generate the token for. The API key must have permission
+        # to access this User.
+        user_id:,
         # 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,
+        # 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.
+        scoped_actions: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/disputes.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Disputes
+      # Retrieves a Dispute by ID
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def retrieve(
+        # The ID of the dispute
+        id,
+        request_options: {}
+      )
+      end
+
+      # Lists disputes the current actor has access to
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::DisputeListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list disputes for
+        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,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      # Submit a payment dispute to the payment processor for review. Once submitted, no
+      # further edits can be made.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def submit_evidence(
+        # The ID of the dispute (Ex. dspt_xxxx) you want to finalize evidence submission
+        # for and send to the processor.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update a dispute with evidence data to attempt to win the dispute.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          access_activity_log: T.nilable(String),
+          billing_address: T.nilable(String),
+          cancellation_policy_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          cancellation_policy_disclosure: T.nilable(String),
+          customer_communication_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          customer_email_address: T.nilable(String),
+          customer_name: T.nilable(String),
+          notes: T.nilable(String),
+          product_description: T.nilable(String),
+          refund_policy_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          refund_policy_disclosure: T.nilable(String),
+          refund_refusal_explanation: T.nilable(String),
+          service_date: T.nilable(String),
+          uncategorized_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def update_evidence(
+        # The ID of the dispute you want to update.
+        id,
+        # An IP access log for the user from Whop.
+        access_activity_log: nil,
+        # The billing address of the user from their payment details.
+        billing_address: nil,
+        # A file containing the cancellation policy from the company.
+        cancellation_policy_attachment: nil,
+        # A cancellation policy disclosure from the company.
+        cancellation_policy_disclosure: nil,
+        # A file containing the customer communication from the company (An image).
+        customer_communication_attachment: nil,
+        # The email of the customer from their payment details.
+        customer_email_address: nil,
+        # The name of the customer from their payment details.
+        customer_name: nil,
+        # Additional notes the company chooses to submit regarding the dispute.
+        notes: nil,
+        # The description of the product from the company.
+        product_description: nil,
+        # A file containing the refund policy from the company.
+        refund_policy_attachment: nil,
+        # A refund policy disclosure from the company.
+        refund_policy_disclosure: nil,
+        # A description on why the refund is being refused by the company.
+        refund_refusal_explanation: nil,
+        # When the product was delivered by the company.
+        service_date: nil,
+        # A file that does not fit in the other categories.
+        uncategorized_attachment: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/forum_posts.rbi

@@ -28,6 +28,8 @@ module WhopSDK
           pinned: T.nilable(T::Boolean),
           poll: T.nilable(WhopSDK::ForumPostCreateParams::Poll::OrHash),
           title: T.nilable(String),
+          visibility:
+            T.nilable(WhopSDK::ForumPostCreateParams::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::ForumPost)
       end
@@ -57,6 +59,8 @@ module WhopSDK
         poll: nil,
         # The title of the post. Only visible if paywalled.
         title: nil,
+        # The visibility types for forum posts
+        visibility: nil,
         request_options: {}
       )
       end
@@ -95,6 +99,8 @@ module WhopSDK
           content: T.nilable(String),
           is_pinned: T.nilable(T::Boolean),
           title: T.nilable(String),
+          visibility:
+            T.nilable(WhopSDK::ForumPostUpdateParams::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::ForumPost)
       end
@@ -110,6 +116,8 @@ module WhopSDK
         is_pinned: nil,
         # The title of the post. Only visible if paywalled.
         title: nil,
+        # The visibility types for forum posts
+        visibility: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/notifications.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Notifications
+      # Queues a notification to be sent to users in an experience or company team
+      sig do
+        params(
+          company_id: String,
+          content: String,
+          title: String,
+          experience_id: String,
+          icon_user_id: T.nilable(String),
+          rest_path: T.nilable(String),
+          subtitle: T.nilable(String),
+          user_ids: T.nilable(T::Array[String]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::NotificationCreateResponse)
+      end
+      def create(
+        # The id of the company to target. Only team members of this company will receive
+        # the notification. When clicked will take the user to your dashboard app view.
+        company_id:,
+        # The content of the notification
+        content:,
+        # The title of the notification
+        title:,
+        # The id of the experience to target. All users with access to this experience
+        # (customers and admins) will receive the notification. When clicked, open your
+        # experience view.
+        experience_id:,
+        # Optional: ID of a Whop user whose profile picture will be used as the
+        # notification icon. If not provided, defaults to the experience or company
+        # avatar.
+        icon_user_id: nil,
+        # The rest path to append to the generated deep link that opens your app. Use
+        # [restPath] in your app path in the dashboard to read this parameter.
+        rest_path: nil,
+        # The subtitle of the notification
+        subtitle: nil,
+        # If provided, this will only send to these users if they are also in the main
+        # scope (experience or company)
+        user_ids: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end