whop_sdk 0.0.2

data/rbi/whop_sdk/resources/forums.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Forums
+      # Retrieves a forum
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Forum)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Updates a forum
+      #
+      # Required permissions:
+      #
+      # - `forum:moderate`
+      sig do
+        params(
+          id: String,
+          email_notification_preference:
+            T.nilable(WhopSDK::EmailNotificationPreferences::OrSymbol),
+          who_can_comment: T.nilable(WhopSDK::WhoCanCommentTypes::OrSymbol),
+          who_can_post: T.nilable(WhopSDK::WhoCanPostTypes::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Forum)
+      end
+      def update(
+        id,
+        # Email notification preference option for a forum feed
+        email_notification_preference: nil,
+        # Who can comment on a forum feed
+        who_can_comment: nil,
+        # Who can post on a forum feed
+        who_can_post: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists forums inside a company
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ForumListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list forums 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,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # If provided, only forums connected to this product are returned
+        product_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/invoices.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Invoices
+      # Creates an invoice
+      #
+      # Required permissions:
+      #
+      # - `invoice:create`
+      # - `plan:basic:read`
+      sig do
+        params(
+          collection_method: WhopSDK::CollectionMethod::OrSymbol,
+          company_id: String,
+          due_date: Time,
+          plan: WhopSDK::InvoiceCreateParams::Plan::OrHash,
+          charge_buyer_fee: T.nilable(T::Boolean),
+          customer_name: T.nilable(String),
+          email_address: T.nilable(String),
+          member_id: T.nilable(String),
+          payment_token_id: T.nilable(String),
+          product: T.nilable(WhopSDK::InvoiceCreateParams::Product::OrHash),
+          product_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::InvoiceCreateResponse)
+      end
+      def create(
+        # The method of collection for this invoice. If using charge_automatically, you
+        # must provide a payment_token.
+        collection_method:,
+        # The company ID to create this invoice for.
+        company_id:,
+        # The date the invoice is due, if applicable.
+        due_date:,
+        # The properties of the plan to create for this invoice.
+        plan:,
+        # Whether or not to charge the customer a buyer fee.
+        charge_buyer_fee: nil,
+        # The name of the customer to create this invoice for. This is required if you
+        # want to create an invoice for a customer who does not have a member of your
+        # company yet.
+        customer_name: nil,
+        # The email address to create this invoice for. This is required if you want to
+        # create an invoice for a user who does not have a member of your company yet.
+        email_address: nil,
+        # The member ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing member. If you do not have a member ID, you must provide
+        # an email_address and customer_name.
+        member_id: nil,
+        # The payment token ID to use for this invoice. If using charge_automatically, you
+        # must provide a payment_token.
+        payment_token_id: nil,
+        # The properties of the product to create for this invoice. Include this if you
+        # want to create an invoice for a new product.
+        product: nil,
+        # The product ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing product.
+        product_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves an invoice by ID or token
+      #
+      # Required permissions:
+      #
+      # - `invoice:basic:read`
+      # - `plan:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Invoice)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists invoices
+      #
+      # Required permissions:
+      #
+      # - `invoice:basic:read`
+      # - `plan:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          filters: T.nilable(WhopSDK::InvoiceListParams::Filters::OrHash),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::InvoiceListParams::Order::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Internal::CursorPage[WhopSDK::InvoiceListItem])
+      end
+      def list(
+        # The ID of the company to list invoices 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,
+        # The filters to apply to the invoices
+        filters: 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,
+        request_options: {}
+      )
+      end
+
+      # Void an invoice
+      #
+      # Required permissions:
+      #
+      # - `invoice:update`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def void(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/ledger_accounts.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class LedgerAccounts
+      # Retrieves a ledger account by ID
+      #
+      # Required permissions:
+      #
+      # - `company:balance:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::LedgerAccountRetrieveResponse)
+      end
+      def retrieve(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/members.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Members
+      # Retrieves a member of a company by ID
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      # - `member:email:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::MemberRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # List the members of a company
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      # - `member:email:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          company_id: String,
+          access_level: T.nilable(WhopSDK::AccessLevel::OrSymbol),
+          access_pass_ids: T.nilable(T::Array[String]),
+          after: T.nilable(String),
+          before: T.nilable(String),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          most_recent_actions:
+            T.nilable(T::Array[WhopSDK::MemberMostRecentActions::OrSymbol]),
+          order: T.nilable(WhopSDK::MemberListParams::Order::OrSymbol),
+          plan_ids: T.nilable(T::Array[String]),
+          promo_code_ids: T.nilable(T::Array[String]),
+          query: T.nilable(String),
+          statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::MemberListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list members for
+        company_id:,
+        # The access level a given user (or company) has to an access pass or company.
+        access_level: nil,
+        # The access pass IDs to filter the members by
+        access_pass_ids: nil,
+        # 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 minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_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,
+        # The most recent actions to filter the members by
+        most_recent_actions: nil,
+        # Which columns can be used to sort.
+        order: nil,
+        # The plan IDs to filter the members by
+        plan_ids: nil,
+        # The promo code IDs to filter the members by
+        promo_code_ids: nil,
+        # The name, username, or email to filter the members by. The email filter will
+        # only apply if the current actor has the `member:email:read` permission.
+        query: nil,
+        # The statuses to filter the members by
+        statuses: 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/memberships.rbi

@@ -0,0 +1,171 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Memberships
+      # Retrieves a membership by ID or license key
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Membership)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Update a membership
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Membership)
+      end
+      def update(
+        id,
+        # The metadata to update the membership with.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists memberships
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      sig do
+        params(
+          company_id: String,
+          access_pass_ids: T.nilable(T::Array[String]),
+          after: T.nilable(String),
+          before: T.nilable(String),
+          cancel_options:
+            T.nilable(
+              T::Array[WhopSDK::MembershipListParams::CancelOption::OrSymbol]
+            ),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::MembershipListParams::Order::OrSymbol),
+          plan_ids: T.nilable(T::Array[String]),
+          promo_code_ids: T.nilable(T::Array[String]),
+          statuses: T.nilable(T::Array[WhopSDK::MembershipStatus::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::MembershipListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list memberships for
+        company_id:,
+        # The access pass IDs to filter the memberships by
+        access_pass_ids: nil,
+        # 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 cancel options to filter the memberships by
+        cancel_options: nil,
+        # The minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_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,
+        # Which columns can be used to sort.
+        order: nil,
+        # The plan IDs to filter the memberships by
+        plan_ids: nil,
+        # The promo code IDs to filter the memberships by
+        promo_code_ids: nil,
+        # The membership status to filter the memberships by
+        statuses: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancels a membership either immediately or at the end of the current billing
+      # period
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          cancellation_mode:
+            T.nilable(
+              WhopSDK::MembershipCancelParams::CancellationMode::OrSymbol
+            ),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Membership)
+      end
+      def cancel(
+        id,
+        # The mode of cancellation for a membership
+        cancellation_mode: nil,
+        request_options: {}
+      )
+      end
+
+      # Pauses a membership's payments
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          void_payments: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Membership)
+      end
+      def pause(
+        id,
+        # Whether to void past_due payments associated with the membership to prevent
+        # future payment attempts.
+        void_payments: nil,
+        request_options: {}
+      )
+      end
+
+      # Resumes a membership's payments
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Membership)
+      end
+      def resume(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/messages.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Messages
+      # Creates a new message
+      #
+      # Required permissions:
+      #
+      # - `chat:message:create`
+      sig do
+        params(
+          channel_id: String,
+          content: String,
+          attachments:
+            T.nilable(
+              T::Array[WhopSDK::MessageCreateParams::Attachment::OrHash]
+            ),
+          poll: T.nilable(WhopSDK::MessageCreateParams::Poll::OrHash),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Message)
+      end
+      def create(
+        # The ID of the channel or experience to send to.
+        channel_id:,
+        # The content of the message in Markdown format.
+        content:,
+        # The attachments for this message, such as videos or images.
+        attachments: nil,
+        # The poll for this message
+        poll: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a message
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Message)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists messages inside a channel
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          channel_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::MessageListResponse]
+        )
+      end
+      def list(
+        # The ID of the channel or the experience ID to list messages for
+        channel_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
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end