whop_sdk 0.0.2

data/lib/whop_sdk/models/invoice_list_params.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Invoices#list
+    class InvoiceListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list invoices for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+
+      # @!attribute filters
+      #   The filters to apply to the invoices
+      #
+      #   @return [WhopSDK::Models::InvoiceListParams::Filters, nil]
+      optional :filters, -> { WhopSDK::InvoiceListParams::Filters }, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute order
+      #   Which columns can be used to sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::InvoiceListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::InvoiceListParams::Order }, nil?: true
+
+      # @!method initialize(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}]
+
+      class Filters < WhopSDK::Internal::Type::BaseModel
+        # @!attribute access_pass_ids
+        #   The access pass IDs to filter the invoices by
+        #
+        #   @return [Array<String>, nil]
+        optional :access_pass_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute collection_methods
+        #   The collection methods to filter the invoices by
+        #
+        #   @return [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil]
+        optional :collection_methods,
+                 -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::CollectionMethod] },
+                 nil?: true
+
+        # @!attribute statuses
+        #   The statuses to filter the invoices by
+        #
+        #   @return [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil]
+        optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::InvoiceStatus] }, nil?: true
+
+        # @!method initialize(access_pass_ids: nil, collection_methods: nil, statuses: nil)
+        #   The filters to apply to the invoices
+        #
+        #   @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the invoices by
+        #
+        #   @param collection_methods [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil] The collection methods to filter the invoices by
+        #
+        #   @param statuses [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil] The statuses to filter the invoices by
+      end
+
+      # Which columns can be used to sort.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        ID = :id
+        CREATED_AT = :created_at
+        DUE_DATE = :due_date
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_paid_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class InvoicePaidWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   A statement that defines an amount due by a customer.
+      #
+      #   @return [WhopSDK::Models::Invoice]
+      required :data, -> { WhopSDK::Invoice }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"invoice.paid"]
+      required :type, const: :"invoice.paid"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"invoice.paid")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Invoice] A statement that defines an amount due by a customer.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"invoice.paid"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_past_due_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class InvoicePastDueWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   A statement that defines an amount due by a customer.
+      #
+      #   @return [WhopSDK::Models::Invoice]
+      required :data, -> { WhopSDK::Invoice }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"invoice.past_due"]
+      required :type, const: :"invoice.past_due"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"invoice.past_due")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Invoice] A statement that defines an amount due by a customer.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"invoice.past_due"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Invoices#retrieve
+    class InvoiceRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different statuses an invoice can be in
+    module InvoiceStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      OPEN = :open
+      PAID = :paid
+      PAST_DUE = :past_due
+      VOID = :void
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_void_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Invoices#void
+    class InvoiceVoidParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/invoice_void_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    InvoiceVoidResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/invoice_voided_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class InvoiceVoidedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   A statement that defines an amount due by a customer.
+      #
+      #   @return [WhopSDK::Models::Invoice]
+      required :data, -> { WhopSDK::Invoice }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"invoice.voided"]
+      required :type, const: :"invoice.voided"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"invoice.voided")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Invoice] A statement that defines an amount due by a customer.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"invoice.voided"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/ledger_account_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::LedgerAccounts#retrieve
+    class LedgerAccountRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/ledger_account_retrieve_response.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::LedgerAccounts#retrieve
+    class LedgerAccountRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the LedgerAccount.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute balances
+      #   The balances associated with the account.
+      #
+      #   @return [Array<WhopSDK::Models::LedgerAccountRetrieveResponse::Balance>]
+      required :balances,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::LedgerAccountRetrieveResponse::Balance] }
+
+      # @!attribute ledger_account_audit_status
+      #   The different statuses a LedgerAccountAudit can be
+      #
+      #   @return [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerAccountAuditStatus, nil]
+      required :ledger_account_audit_status,
+               enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerAccountAuditStatus },
+               nil?: true
+
+      # @!attribute ledger_type
+      #   The type of ledger account.
+      #
+      #   @return [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerType]
+      required :ledger_type, enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerType }
+
+      # @!attribute owner
+      #   The owner of the ledger account.
+      #
+      #   @return [WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User, WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company, nil]
+      required :owner, union: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::Owner }
+
+      # @!attribute payments_approval_status
+      #   The different approval statuses an account can have.
+      #
+      #   @return [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PaymentsApprovalStatus, nil]
+      required :payments_approval_status,
+               enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PaymentsApprovalStatus },
+               nil?: true
+
+      # @!attribute transfer_fee
+      #   The fee for transfers, if applicable.
+      #
+      #   @return [Float, nil]
+      required :transfer_fee, Float, nil?: true
+
+      # @!method initialize(id:, balances:, ledger_account_audit_status:, ledger_type:, owner:, payments_approval_status:, transfer_fee:)
+      #   Represents a LedgerAccount.
+      #
+      #   @param id [String] The ID of the LedgerAccount.
+      #
+      #   @param balances [Array<WhopSDK::Models::LedgerAccountRetrieveResponse::Balance>] The balances associated with the account.
+      #
+      #   @param ledger_account_audit_status [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerAccountAuditStatus, nil] The different statuses a LedgerAccountAudit can be
+      #
+      #   @param ledger_type [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerType] The type of ledger account.
+      #
+      #   @param owner [WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User, WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company, nil] The owner of the ledger account.
+      #
+      #   @param payments_approval_status [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PaymentsApprovalStatus, nil] The different approval statuses an account can have.
+      #
+      #   @param transfer_fee [Float, nil] The fee for transfers, if applicable.
+
+      class Balance < WhopSDK::Internal::Type::BaseModel
+        # @!attribute balance
+        #   The amount of the balance.
+        #
+        #   @return [Float]
+        required :balance, Float
+
+        # @!attribute currency
+        #   The currency of the balance.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute pending_balance
+        #   The amount of the balance that is pending.
+        #
+        #   @return [Float]
+        required :pending_balance, Float
+
+        # @!attribute reserve_balance
+        #   The amount of the balance that is reserved.
+        #
+        #   @return [Float]
+        required :reserve_balance, Float
+
+        # @!method initialize(balance:, currency:, pending_balance:, reserve_balance:)
+        #   A cached balance for a LedgerAccount in respect to a currency.
+        #
+        #   @param balance [Float] The amount of the balance.
+        #
+        #   @param currency [Symbol, WhopSDK::Models::Currency] The currency of the balance.
+        #
+        #   @param pending_balance [Float] The amount of the balance that is pending.
+        #
+        #   @param reserve_balance [Float] The amount of the balance that is reserved.
+      end
+
+      # The different statuses a LedgerAccountAudit can be
+      #
+      # @see WhopSDK::Models::LedgerAccountRetrieveResponse#ledger_account_audit_status
+      module LedgerAccountAuditStatus
+        extend WhopSDK::Internal::Type::Enum
+
+        RESERVES_IMPOSED = :reserves_imposed
+        REQUESTED_MORE_INFORMATION = :requested_more_information
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of ledger account.
+      #
+      # @see WhopSDK::Models::LedgerAccountRetrieveResponse#ledger_type
+      module LedgerType
+        extend WhopSDK::Internal::Type::Enum
+
+        PRIMARY = :primary
+        POOL = :pool
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The owner of the ledger account.
+      #
+      # @see WhopSDK::Models::LedgerAccountRetrieveResponse#owner
+      module Owner
+        extend WhopSDK::Internal::Type::Union
+
+        discriminator :typename
+
+        # An object representing a (sanitized) user of the site.
+        variant :User, -> { WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User }
+
+        # An object representing a (sanitized) company.
+        variant :Company, -> { WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company }
+
+        class User < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The internal ID of the user.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #   The name of the user from their Whop account.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :User]
+          required :typename, const: :User
+
+          # @!attribute username
+          #   The username of the user from their Whop account.
+          #
+          #   @return [String]
+          required :username, String
+
+          # @!method initialize(id:, name:, username:, typename: :User)
+          #   An object representing a (sanitized) user of the site.
+          #
+          #   @param id [String] The internal ID of the user.
+          #
+          #   @param name [String, nil] The name of the user from their Whop account.
+          #
+          #   @param username [String] The username of the user from their Whop account.
+          #
+          #   @param typename [Symbol, :User] The typename of this object
+        end
+
+        class Company < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID (tag) of the company.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute route
+          #   The slug/route of the company on the Whop site.
+          #
+          #   @return [String]
+          required :route, String
+
+          # @!attribute title
+          #   The title of the company.
+          #
+          #   @return [String]
+          required :title, String
+
+          # @!attribute typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :Company]
+          required :typename, const: :Company
+
+          # @!method initialize(id:, route:, title:, typename: :Company)
+          #   An object representing a (sanitized) company.
+          #
+          #   @param id [String] The ID (tag) of the company.
+          #
+          #   @param route [String] The slug/route of the company on the Whop site.
+          #
+          #   @param title [String] The title of the company.
+          #
+          #   @param typename [Symbol, :Company] The typename of this object
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User, WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company)]
+      end
+
+      # The different approval statuses an account can have.
+      #
+      # @see WhopSDK::Models::LedgerAccountRetrieveResponse#payments_approval_status
+      module PaymentsApprovalStatus
+        extend WhopSDK::Internal::Type::Enum
+
+        PENDING = :pending
+        APPROVED = :approved
+        MONITORING = :monitoring
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end