whop_sdk 0.0.2

data/lib/whop_sdk/resources/invoices.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Invoices
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::InvoiceCreateParams} for more details.
+      #
+      # Creates an invoice
+      #
+      # Required permissions:
+      #
+      # - `invoice:create`
+      # - `plan:basic:read`
+      #
+      # @overload create(collection_method:, company_id:, due_date:, plan:, charge_buyer_fee: nil, customer_name: nil, email_address: nil, member_id: nil, payment_token_id: nil, product: nil, product_id: nil, request_options: {})
+      #
+      # @param collection_method [Symbol, WhopSDK::Models::CollectionMethod] The method of collection for this invoice. If using charge_automatically, you mu
+      #
+      # @param company_id [String] The company ID to create this invoice for.
+      #
+      # @param due_date [Time] The date the invoice is due, if applicable.
+      #
+      # @param plan [WhopSDK::Models::InvoiceCreateParams::Plan] The properties of the plan to create for this invoice.
+      #
+      # @param charge_buyer_fee [Boolean, nil] Whether or not to charge the customer a buyer fee.
+      #
+      # @param customer_name [String, nil] The name of the customer to create this invoice for. This is required if you wan
+      #
+      # @param email_address [String, nil] The email address to create this invoice for. This is required if you want to cr
+      #
+      # @param member_id [String, nil] The member ID to create this invoice for. Include this if you want to create an
+      #
+      # @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
+      #
+      # @param product [WhopSDK::Models::InvoiceCreateParams::Product, nil] The properties of the product to create for this invoice. Include this if you wa
+      #
+      # @param product_id [String, nil] The product ID to create this invoice for. Include this if you want to create an
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::InvoiceCreateResponse]
+      #
+      # @see WhopSDK::Models::InvoiceCreateParams
+      def create(params)
+        parsed, options = WhopSDK::InvoiceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "invoices",
+          body: parsed,
+          model: WhopSDK::Models::InvoiceCreateResponse,
+          options: options
+        )
+      end
+
+      # Retrieves an invoice by ID or token
+      #
+      # Required permissions:
+      #
+      # - `invoice:basic:read`
+      # - `plan:basic:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Invoice]
+      #
+      # @see WhopSDK::Models::InvoiceRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["invoices/%1$s", id],
+          model: WhopSDK::Invoice,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists invoices
+      #
+      # Required permissions:
+      #
+      # - `invoice:basic:read`
+      # - `plan:basic:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, direction: nil, filters: nil, first: nil, last: nil, order: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list invoices for
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param filters [WhopSDK::Models::InvoiceListParams::Filters, nil] The filters to apply to the invoices
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param order [Symbol, WhopSDK::Models::InvoiceListParams::Order, nil] Which columns can be used to sort.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::InvoiceListItem>]
+      #
+      # @see WhopSDK::Models::InvoiceListParams
+      def list(params)
+        parsed, options = WhopSDK::InvoiceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "invoices",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::InvoiceListItem,
+          options: options
+        )
+      end
+
+      # Void an invoice
+      #
+      # Required permissions:
+      #
+      # - `invoice:update`
+      #
+      # @overload void(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::InvoiceVoidParams
+      def void(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["invoices/%1$s/void", id],
+          model: WhopSDK::Internal::Type::Boolean,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/ledger_accounts.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class LedgerAccounts
+      # Retrieves a ledger account by ID
+      #
+      # Required permissions:
+      #
+      # - `company:balance:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::LedgerAccountRetrieveResponse]
+      #
+      # @see WhopSDK::Models::LedgerAccountRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["ledger_accounts/%1$s", id],
+          model: WhopSDK::Models::LedgerAccountRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/members.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+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`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::MemberRetrieveResponse]
+      #
+      # @see WhopSDK::Models::MemberRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["members/%1$s", id],
+          model: WhopSDK::Models::MemberRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::MemberListParams} for more details.
+      #
+      # List the members of a company
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      # - `member:email:read`
+      # - `member:phone:read`
+      #
+      # @overload list(company_id:, access_level: nil, access_pass_ids: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, most_recent_actions: nil, order: nil, plan_ids: nil, promo_code_ids: nil, query: nil, statuses: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list members for
+      #
+      # @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to an access pass or company.
+      #
+      # @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the members by
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param created_after [Time, nil] The minimum creation date to filter by
+      #
+      # @param created_before [Time, nil] The maximum creation date to filter by
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param most_recent_actions [Array<Symbol, WhopSDK::Models::MemberMostRecentActions>, nil] The most recent actions to filter the members by
+      #
+      # @param order [Symbol, WhopSDK::Models::MemberListParams::Order, nil] Which columns can be used to sort.
+      #
+      # @param plan_ids [Array<String>, nil] The plan IDs to filter the members by
+      #
+      # @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the members by
+      #
+      # @param query [String, nil] The name, username, or email to filter the members by. The email filter will onl
+      #
+      # @param statuses [Array<Symbol, WhopSDK::Models::MemberStatuses>, nil] The statuses to filter the members by
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::MemberListResponse>]
+      #
+      # @see WhopSDK::Models::MemberListParams
+      def list(params)
+        parsed, options = WhopSDK::MemberListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "members",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::MemberListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/memberships.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Memberships
+      # Retrieves a membership by ID or license key
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Membership]
+      #
+      # @see WhopSDK::Models::MembershipRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["memberships/%1$s", id],
+          model: WhopSDK::Membership,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a membership
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      #
+      # @overload update(id, metadata: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param metadata [Hash{Symbol=>Object}, nil] The metadata to update the membership with.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Membership]
+      #
+      # @see WhopSDK::Models::MembershipUpdateParams
+      def update(id, params = {})
+        parsed, options = WhopSDK::MembershipUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["memberships/%1$s", id],
+          body: parsed,
+          model: WhopSDK::Membership,
+          options: options
+        )
+      end
+
+      # Lists memberships
+      #
+      # Required permissions:
+      #
+      # - `member:basic:read`
+      #
+      # @overload list(company_id:, access_pass_ids: nil, after: nil, before: nil, cancel_options: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, promo_code_ids: nil, statuses: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list memberships for
+      #
+      # @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the memberships by
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param cancel_options [Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil] The cancel options to filter the memberships by
+      #
+      # @param created_after [Time, nil] The minimum creation date to filter by
+      #
+      # @param created_before [Time, nil] The maximum creation date to filter by
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param order [Symbol, WhopSDK::Models::MembershipListParams::Order, nil] Which columns can be used to sort.
+      #
+      # @param plan_ids [Array<String>, nil] The plan IDs to filter the memberships by
+      #
+      # @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the memberships by
+      #
+      # @param statuses [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil] The membership status to filter the memberships by
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::MembershipListResponse>]
+      #
+      # @see WhopSDK::Models::MembershipListParams
+      def list(params)
+        parsed, options = WhopSDK::MembershipListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "memberships",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::MembershipListResponse,
+          options: options
+        )
+      end
+
+      # Cancels a membership either immediately or at the end of the current billing
+      # period
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      #
+      # @overload cancel(id, cancellation_mode: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param cancellation_mode [Symbol, WhopSDK::Models::MembershipCancelParams::CancellationMode, nil] The mode of cancellation for a membership
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Membership]
+      #
+      # @see WhopSDK::Models::MembershipCancelParams
+      def cancel(id, params = {})
+        parsed, options = WhopSDK::MembershipCancelParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["memberships/%1$s/cancel", id],
+          body: parsed,
+          model: WhopSDK::Membership,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::MembershipPauseParams} for more details.
+      #
+      # Pauses a membership's payments
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      #
+      # @overload pause(id, void_payments: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param void_payments [Boolean, nil] Whether to void past_due payments associated with the membership to prevent futu
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Membership]
+      #
+      # @see WhopSDK::Models::MembershipPauseParams
+      def pause(id, params = {})
+        parsed, options = WhopSDK::MembershipPauseParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["memberships/%1$s/pause", id],
+          body: parsed,
+          model: WhopSDK::Membership,
+          options: options
+        )
+      end
+
+      # Resumes a membership's payments
+      #
+      # Required permissions:
+      #
+      # - `member:manage`
+      # - `member:basic:read`
+      #
+      # @overload resume(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Membership]
+      #
+      # @see WhopSDK::Models::MembershipResumeParams
+      def resume(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["memberships/%1$s/resume", id],
+          model: WhopSDK::Membership,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/messages.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Messages
+      # Creates a new message
+      #
+      # Required permissions:
+      #
+      # - `chat:message:create`
+      #
+      # @overload create(channel_id:, content:, attachments: nil, poll: nil, request_options: {})
+      #
+      # @param channel_id [String] The ID of the channel or experience to send to.
+      #
+      # @param content [String] The content of the message in Markdown format.
+      #
+      # @param attachments [Array<WhopSDK::Models::MessageCreateParams::Attachment>, nil] The attachments for this message, such as videos or images.
+      #
+      # @param poll [WhopSDK::Models::MessageCreateParams::Poll, nil] The poll for this message
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Message]
+      #
+      # @see WhopSDK::Models::MessageCreateParams
+      def create(params)
+        parsed, options = WhopSDK::MessageCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "messages",
+          body: parsed,
+          model: WhopSDK::Message,
+          options: options
+        )
+      end
+
+      # Retrieves a message
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Message]
+      #
+      # @see WhopSDK::Models::MessageRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["messages/%1$s", id],
+          model: WhopSDK::Message,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists messages inside a channel
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      #
+      # @overload list(channel_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
+      #
+      # @param channel_id [String] The ID of the channel or the experience ID to list messages for
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::MessageListResponse>]
+      #
+      # @see WhopSDK::Models::MessageListParams
+      def list(params)
+        parsed, options = WhopSDK::MessageListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "messages",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::MessageListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end