whop_sdk 0.0.2

data/rbi/whop_sdk/resources/reactions.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Reactions
+      # Creates a new reaction
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          resource_id: String,
+          emoji: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Reaction)
+      end
+      def create(
+        # The ID of the post or message to react to.
+        resource_id:,
+        # The emoji to react with (e.g., :heart: or '😀'). It will be ignored in forums,
+        # as everything will be :heart:
+        emoji: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a reaction
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Reaction)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists reactions for a post or a message
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          resource_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ReactionListResponse]
+        )
+      end
+      def list(
+        # The ID of the post or message to list reactions for
+        resource_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,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: 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/shipments.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Shipments
+      # Creates a new shipment
+      #
+      # Required permissions:
+      #
+      # - `shipment:create`
+      # - `payment:basic:read`
+      sig do
+        params(
+          company_id: String,
+          payment_id: String,
+          tracking_code: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Shipment)
+      end
+      def create(
+        # The ID of the company to create the shipment for
+        company_id:,
+        # The ID of the payment to create the shipment for
+        payment_id:,
+        # The tracking code for the shipment
+        tracking_code:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a shipment by ID
+      #
+      # Required permissions:
+      #
+      # - `shipment:basic:read`
+      # - `payment:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Shipment)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists shipments for a payment
+      #
+      # Required permissions:
+      #
+      # - `shipment:basic:read`
+      # - `payment:basic:read`
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          company_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          payment_id: T.nilable(String),
+          user_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ShipmentListResponse]
+        )
+      end
+      def list(
+        # 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 ID of the company
+        company_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the payment
+        payment_id: nil,
+        # The ID of the user
+        user_id: 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/support_channels.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class SupportChannels
+      # Create a new support channel for a user in a company. If one already exists, it
+      # will return the existing one.
+      #
+      # Required permissions:
+      #
+      # - `support_chat:create`
+      sig do
+        params(
+          company_id: String,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::SupportChannel)
+      end
+      def create(
+        # The ID of the company to create the support chat in
+        company_id:,
+        # The ID of the user to create the support chat for
+        user_id:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a support channel
+      #
+      # Required permissions:
+      #
+      # - `support_chat:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::SupportChannel)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists chat channels inside a company
+      #
+      # Required permissions:
+      #
+      # - `support_chat: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),
+          open_: T.nilable(T::Boolean),
+          order: T.nilable(WhopSDK::SupportChannelListParams::Order::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::Models::SupportChannelListResponse
+          ]
+        )
+      end
+      def list(
+        # The ID of the company to list chat channels 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,
+        # Filter for tickets where customer sent the last message (needs response) AND not
+        # resolved. Set to true to only return open channels, false to only return
+        # resolved channels.
+        open_: nil,
+        # Sort options for message channels
+        order: 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/transfers.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Transfers
+      # Creates a new transfer between ledger accounts
+      #
+      # Required permissions:
+      #
+      # - `payout:transfer_funds`
+      sig do
+        params(
+          amount: Float,
+          currency: WhopSDK::Currency::OrSymbol,
+          destination_id: String,
+          origin_id: String,
+          idempotence_key: T.nilable(String),
+          notes: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Transfer)
+      end
+      def create(
+        # The amount to withdraw
+        amount:,
+        # The currency that is being withdrawn.
+        currency:,
+        # The ID of the destination account which will receive the funds (either a User
+        # ID, Company ID, or LedgerAccount ID)
+        destination_id:,
+        # The ID of the origin account which will send the funds (either a User ID,
+        # Company ID, or LedgerAccount ID)
+        origin_id:,
+        # A unique key to ensure idempotence. Use a UUID or similar.
+        idempotence_key: nil,
+        # Notes for the transfer. Maximum of 50 characters.
+        notes: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a transfer by ID
+      #
+      # Required permissions:
+      #
+      # - `payout:transfer:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Transfer)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists transfers
+      #
+      # Required permissions:
+      #
+      # - `payout:transfer:read`
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          destination_id: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::TransferListParams::Order::OrSymbol),
+          origin_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::TransferListResponse]
+        )
+      end
+      def list(
+        # 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,
+        # Filter transfers to only those that were sent to this destination account.
+        # (user_xxx, biz_xxx, ldgr_xxx)
+        destination_id: 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,
+        # Which columns can be used to sort.
+        order: nil,
+        # Filter transfers to only those that were sent from this origin account.
+        # (user_xxx, biz_xxx, ldgr_xxx)
+        origin_id: 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/users.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Users
+      # Retrieves a user by ID or username
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::UserRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Check if a user has access (and their access level) to a resource
+      sig do
+        params(
+          resource_id: String,
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::UserCheckAccessResponse)
+      end
+      def check_access(resource_id, id:, 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

@@ -0,0 +1,38 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Webhooks
+      sig do
+        params(payload: String).returns(
+          T.any(
+            WhopSDK::InvoiceCreatedWebhookEvent,
+            WhopSDK::InvoicePaidWebhookEvent,
+            WhopSDK::InvoicePastDueWebhookEvent,
+            WhopSDK::InvoiceVoidedWebhookEvent,
+            WhopSDK::MembershipActivatedWebhookEvent,
+            WhopSDK::MembershipDeactivatedWebhookEvent,
+            WhopSDK::EntryCreatedWebhookEvent,
+            WhopSDK::EntryApprovedWebhookEvent,
+            WhopSDK::EntryDeniedWebhookEvent,
+            WhopSDK::EntryDeletedWebhookEvent,
+            WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
+            WhopSDK::PaymentSucceededWebhookEvent,
+            WhopSDK::PaymentFailedWebhookEvent,
+            WhopSDK::PaymentPendingWebhookEvent
+          )
+        )
+      end
+      def unwrap(
+        # The raw webhook payload as a string
+        payload
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module WhopSDK
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/whop_sdk/client.rbs

@@ -0,0 +1,77 @@
+module WhopSDK
+  class Client < WhopSDK::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader app_id: String
+
+    attr_reader apps: WhopSDK::Resources::Apps
+
+    attr_reader invoices: WhopSDK::Resources::Invoices
+
+    attr_reader course_lesson_interactions: WhopSDK::Resources::CourseLessonInteractions
+
+    attr_reader products: WhopSDK::Resources::Products
+
+    attr_reader companies: WhopSDK::Resources::Companies
+
+    attr_reader webhooks: WhopSDK::Resources::Webhooks
+
+    attr_reader plans: WhopSDK::Resources::Plans
+
+    attr_reader entries: WhopSDK::Resources::Entries
+
+    attr_reader forum_posts: WhopSDK::Resources::ForumPosts
+
+    attr_reader transfers: WhopSDK::Resources::Transfers
+
+    attr_reader ledger_accounts: WhopSDK::Resources::LedgerAccounts
+
+    attr_reader memberships: WhopSDK::Resources::Memberships
+
+    attr_reader authorized_users: WhopSDK::Resources::AuthorizedUsers
+
+    attr_reader app_builds: WhopSDK::Resources::AppBuilds
+
+    attr_reader shipments: WhopSDK::Resources::Shipments
+
+    attr_reader checkout_configurations: WhopSDK::Resources::CheckoutConfigurations
+
+    attr_reader messages: WhopSDK::Resources::Messages
+
+    attr_reader chat_channels: WhopSDK::Resources::ChatChannels
+
+    attr_reader users: WhopSDK::Resources::Users
+
+    attr_reader payments: WhopSDK::Resources::Payments
+
+    attr_reader support_channels: WhopSDK::Resources::SupportChannels
+
+    attr_reader experiences: WhopSDK::Resources::Experiences
+
+    attr_reader reactions: WhopSDK::Resources::Reactions
+
+    attr_reader members: WhopSDK::Resources::Members
+
+    attr_reader forums: WhopSDK::Resources::Forums
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?app_id: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/whop_sdk/errors.rbs

@@ -0,0 +1,117 @@
+module WhopSDK
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < WhopSDK::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < WhopSDK::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < WhopSDK::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < WhopSDK::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < WhopSDK::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < WhopSDK::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/whop_sdk/file_part.rbs

@@ -0,0 +1,21 @@
+module WhopSDK
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/whop_sdk/internal/cursor_page.rbs

@@ -0,0 +1,24 @@
+module WhopSDK
+  module Internal
+    class CursorPage[Elem]
+      include WhopSDK::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor page_info: PageInfo
+
+      def inspect: -> String
+
+      type page_info = { end_cursor: String }
+      class PageInfo < WhopSDK::Internal::Type::BaseModel
+        attr_reader end_cursor: String?
+
+        def end_cursor=: (String) -> String
+
+        def initialize: (?end_cursor: String) -> void
+
+        def to_hash: -> { end_cursor: String }
+      end
+    end
+  end
+end