whop_sdk 0.0.2

data/rbi/whop_sdk/models/invoice_list_item.rbi

@@ -0,0 +1,207 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoiceListItem < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoiceListItem, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the invoice.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The date the invoice was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The plan that the invoice was created for.
+      sig { returns(WhopSDK::InvoiceListItem::CurrentPlan) }
+      attr_reader :current_plan
+
+      sig do
+        params(current_plan: WhopSDK::InvoiceListItem::CurrentPlan::OrHash).void
+      end
+      attr_writer :current_plan
+
+      # The date the invoice is due.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :due_date
+
+      # The email address that the invoice was created for.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email_address
+
+      # The token to fetch the invoice.
+      sig { returns(String) }
+      attr_accessor :fetch_invoice_token
+
+      # The number of the invoice.
+      sig { returns(String) }
+      attr_accessor :number
+
+      # The status of the invoice.
+      sig { returns(WhopSDK::InvoiceStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # The user that the invoice was created for.
+      sig { returns(T.nilable(WhopSDK::InvoiceListItem::User)) }
+      attr_reader :user
+
+      sig do
+        params(user: T.nilable(WhopSDK::InvoiceListItem::User::OrHash)).void
+      end
+      attr_writer :user
+
+      # A statement that defines an amount due by a customer.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          current_plan: WhopSDK::InvoiceListItem::CurrentPlan::OrHash,
+          due_date: T.nilable(Time),
+          email_address: T.nilable(String),
+          fetch_invoice_token: String,
+          number: String,
+          status: WhopSDK::InvoiceStatus::OrSymbol,
+          user: T.nilable(WhopSDK::InvoiceListItem::User::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the invoice.
+        id:,
+        # The date the invoice was created.
+        created_at:,
+        # The plan that the invoice was created for.
+        current_plan:,
+        # The date the invoice is due.
+        due_date:,
+        # The email address that the invoice was created for.
+        email_address:,
+        # The token to fetch the invoice.
+        fetch_invoice_token:,
+        # The number of the invoice.
+        number:,
+        # The status of the invoice.
+        status:,
+        # The user that the invoice was created for.
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            current_plan: WhopSDK::InvoiceListItem::CurrentPlan,
+            due_date: T.nilable(Time),
+            email_address: T.nilable(String),
+            fetch_invoice_token: String,
+            number: String,
+            status: WhopSDK::InvoiceStatus::TaggedSymbol,
+            user: T.nilable(WhopSDK::InvoiceListItem::User)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CurrentPlan < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::InvoiceListItem::CurrentPlan,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the plan.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The respective currency identifier for the plan.
+        sig { returns(WhopSDK::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # The formatted price (including currency) for the plan.
+        sig { returns(String) }
+        attr_accessor :formatted_price
+
+        # The plan that the invoice was created for.
+        sig do
+          params(
+            id: String,
+            currency: WhopSDK::Currency::OrSymbol,
+            formatted_price: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The internal ID of the plan.
+          id:,
+          # The respective currency identifier for the plan.
+          currency:,
+          # The formatted price (including currency) for the plan.
+          formatted_price:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              currency: WhopSDK::Currency::TaggedSymbol,
+              formatted_price: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::InvoiceListItem::User, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user that the invoice was created for.
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_list_params.rbi

@@ -0,0 +1,185 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoiceListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoiceListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list invoices for
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # The direction of the sort.
+      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # The filters to apply to the invoices
+      sig { returns(T.nilable(WhopSDK::InvoiceListParams::Filters)) }
+      attr_reader :filters
+
+      sig do
+        params(
+          filters: T.nilable(WhopSDK::InvoiceListParams::Filters::OrHash)
+        ).void
+      end
+      attr_writer :filters
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # Which columns can be used to sort.
+      sig { returns(T.nilable(WhopSDK::InvoiceListParams::Order::OrSymbol)) }
+      attr_accessor :order
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            direction: T.nilable(WhopSDK::Direction::OrSymbol),
+            filters: T.nilable(WhopSDK::InvoiceListParams::Filters),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            order: T.nilable(WhopSDK::InvoiceListParams::Order::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Filters < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::InvoiceListParams::Filters,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The access pass IDs to filter the invoices by
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :access_pass_ids
+
+        # The collection methods to filter the invoices by
+        sig do
+          returns(T.nilable(T::Array[WhopSDK::CollectionMethod::OrSymbol]))
+        end
+        attr_accessor :collection_methods
+
+        # The statuses to filter the invoices by
+        sig { returns(T.nilable(T::Array[WhopSDK::InvoiceStatus::OrSymbol])) }
+        attr_accessor :statuses
+
+        # The filters to apply to the invoices
+        sig do
+          params(
+            access_pass_ids: T.nilable(T::Array[String]),
+            collection_methods:
+              T.nilable(T::Array[WhopSDK::CollectionMethod::OrSymbol]),
+            statuses: T.nilable(T::Array[WhopSDK::InvoiceStatus::OrSymbol])
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The access pass IDs to filter the invoices by
+          access_pass_ids: nil,
+          # The collection methods to filter the invoices by
+          collection_methods: nil,
+          # The statuses to filter the invoices by
+          statuses: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              access_pass_ids: T.nilable(T::Array[String]),
+              collection_methods:
+                T.nilable(T::Array[WhopSDK::CollectionMethod::OrSymbol]),
+              statuses: T.nilable(T::Array[WhopSDK::InvoiceStatus::OrSymbol])
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # Which columns can be used to sort.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::InvoiceListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ID = T.let(:id, WhopSDK::InvoiceListParams::Order::TaggedSymbol)
+        CREATED_AT =
+          T.let(:created_at, WhopSDK::InvoiceListParams::Order::TaggedSymbol)
+        DUE_DATE =
+          T.let(:due_date, WhopSDK::InvoiceListParams::Order::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::InvoiceListParams::Order::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_paid_webhook_event.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoicePaidWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoicePaidWebhookEvent, WhopSDK::Internal::AnyHash)
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # A statement that defines an amount due by a customer.
+      sig { returns(WhopSDK::Invoice) }
+      attr_reader :data
+
+      sig { params(data: WhopSDK::Invoice::OrHash).void }
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Invoice::OrHash,
+          timestamp: Time,
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # A statement that defines an amount due by a customer.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"invoice.paid"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Invoice,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_past_due_webhook_event.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoicePastDueWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoicePastDueWebhookEvent, WhopSDK::Internal::AnyHash)
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # A statement that defines an amount due by a customer.
+      sig { returns(WhopSDK::Invoice) }
+      attr_reader :data
+
+      sig { params(data: WhopSDK::Invoice::OrHash).void }
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Invoice::OrHash,
+          timestamp: Time,
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # A statement that defines an amount due by a customer.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"invoice.past_due"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Invoice,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoiceRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoiceRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_status.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different statuses an invoice can be in
+    module InvoiceStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::InvoiceStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      OPEN = T.let(:open, WhopSDK::InvoiceStatus::TaggedSymbol)
+      PAID = T.let(:paid, WhopSDK::InvoiceStatus::TaggedSymbol)
+      PAST_DUE = T.let(:past_due, WhopSDK::InvoiceStatus::TaggedSymbol)
+      VOID = T.let(:void, WhopSDK::InvoiceStatus::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::InvoiceStatus::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_void_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoiceVoidParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoiceVoidParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/invoice_void_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    InvoiceVoidResponse = T.let(T::Boolean, WhopSDK::Internal::Type::Converter)
+  end
+end

data/rbi/whop_sdk/models/invoice_voided_webhook_event.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class InvoiceVoidedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::InvoiceVoidedWebhookEvent, WhopSDK::Internal::AnyHash)
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # A statement that defines an amount due by a customer.
+      sig { returns(WhopSDK::Invoice) }
+      attr_reader :data
+
+      sig { params(data: WhopSDK::Invoice::OrHash).void }
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::Invoice::OrHash,
+          timestamp: Time,
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # A statement that defines an amount due by a customer.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"invoice.voided"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::Invoice,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end