whop_sdk 0.0.5 → 0.0.6

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/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/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/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

data/rbi/whop_sdk/resources/webhooks.rbi

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

data/sig/whop_sdk/client.rbs

@@ -10,7 +10,7 @@ module WhopSDK
 
     attr_reader api_key: String
 
-    attr_reader app_id: String
+    attr_reader app_id: String?
 
     attr_reader apps: WhopSDK::Resources::Apps
 
@@ -76,6 +76,10 @@ module WhopSDK
 
     attr_reader access_tokens: WhopSDK::Resources::AccessTokens
 
+    attr_reader notifications: WhopSDK::Resources::Notifications
+
+    attr_reader disputes: WhopSDK::Resources::Disputes
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/whop_sdk/models/company.rbs

@@ -145,6 +145,7 @@ module WhopSDK
           | :linkedin
           | :twitch
           | :website
+          | :custom
 
         module Website
           extend WhopSDK::Internal::Type::Enum
@@ -157,6 +158,7 @@ module WhopSDK
           LINKEDIN: :linkedin
           TWITCH: :twitch
           WEBSITE: :website
+          CUSTOM: :custom
 
           def self?.values: -> ::Array[WhopSDK::Models::Company::SocialLink::website]
         end