whop_sdk 0.0.24 → 0.0.26

data/lib/whop_sdk/models/company_token_transaction.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CompanyTokenTransactions#create
+    class CompanyTokenTransaction < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the transaction
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The transaction amount (always positive)
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute company
+      #   The company
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransaction::Company]
+      required :company, -> { WhopSDK::CompanyTokenTransaction::Company }
+
+      # @!attribute created_at
+      #   When the transaction was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   Optional description
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute idempotency_key
+      #   Optional idempotency key to prevent duplicate transactions
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute linked_transaction_id
+      #   For transfers, the ID of the linked transaction
+      #
+      #   @return [String, nil]
+      required :linked_transaction_id, String, nil?: true
+
+      # @!attribute member
+      #   The member
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransaction::Member]
+      required :member, -> { WhopSDK::CompanyTokenTransaction::Member }
+
+      # @!attribute transaction_type
+      #   The type of transaction
+      #
+      #   @return [Symbol, WhopSDK::Models::BotTokenTransactionTypes]
+      required :transaction_type, enum: -> { WhopSDK::BotTokenTransactionTypes }
+
+      # @!attribute user
+      #   The user whose balance changed
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransaction::User]
+      required :user, -> { WhopSDK::CompanyTokenTransaction::User }
+
+      # @!method initialize(id:, amount:, company:, created_at:, description:, idempotency_key:, linked_transaction_id:, member:, transaction_type:, user:)
+      #   A token transaction within a company
+      #
+      #   @param id [String] The ID of the transaction
+      #
+      #   @param amount [Float] The transaction amount (always positive)
+      #
+      #   @param company [WhopSDK::Models::CompanyTokenTransaction::Company] The company
+      #
+      #   @param created_at [Time] When the transaction was created
+      #
+      #   @param description [String, nil] Optional description
+      #
+      #   @param idempotency_key [String, nil] Optional idempotency key to prevent duplicate transactions
+      #
+      #   @param linked_transaction_id [String, nil] For transfers, the ID of the linked transaction
+      #
+      #   @param member [WhopSDK::Models::CompanyTokenTransaction::Member] The member
+      #
+      #   @param transaction_type [Symbol, WhopSDK::Models::BotTokenTransactionTypes] The type of transaction
+      #
+      #   @param user [WhopSDK::Models::CompanyTokenTransaction::User] The user whose balance changed
+
+      # @see WhopSDK::Models::CompanyTokenTransaction#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID 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 written name of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The company
+        #
+        #   @param id [String] The ID of the company
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The written name of the company.
+      end
+
+      # @see WhopSDK::Models::CompanyTokenTransaction#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The member
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::CompanyTokenTransaction#user
+      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 username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user whose balance changed
+        #
+        #   @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.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/company_token_transaction_create_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CompanyTokenTransactions#create
+    class CompanyTokenTransactionCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   The positive amount of tokens
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute company_id
+      #   The company ID
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute destination_user_id
+      #   Required for transfers - the user to receive tokens
+      #
+      #   @return [String]
+      required :destination_user_id, String
+
+      # @!attribute transaction_type
+      #
+      #   @return [Symbol, :subtract]
+      required :transaction_type, const: :subtract
+
+      # @!attribute user_id
+      #   The user ID whose balance will change
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute description
+      #   Optional description for the transaction
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute idempotency_key
+      #   Optional key to prevent duplicate transactions
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String, nil?: true
+
+      # @!method initialize(amount:, company_id:, destination_user_id:, user_id:, description: nil, idempotency_key: nil, transaction_type: :subtract, request_options: {})
+      #   @param amount [Float] The positive amount of tokens
+      #
+      #   @param company_id [String] The company ID
+      #
+      #   @param destination_user_id [String] Required for transfers - the user to receive tokens
+      #
+      #   @param user_id [String] The user ID whose balance will change
+      #
+      #   @param description [String, nil] Optional description for the transaction
+      #
+      #   @param idempotency_key [String, nil] Optional key to prevent duplicate transactions
+      #
+      #   @param transaction_type [Symbol, :subtract]
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/company_token_transaction_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CompanyTokenTransactions#list
+    class CompanyTokenTransactionListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company
+      #
+      #   @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 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 transaction_type
+      #   The type of token transaction
+      #
+      #   @return [Symbol, WhopSDK::Models::BotTokenTransactionTypes, nil]
+      optional :transaction_type, enum: -> { WhopSDK::BotTokenTransactionTypes }, nil?: true
+
+      # @!attribute user_id
+      #   Filter by user ID
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, first: nil, last: nil, transaction_type: nil, user_id: nil, request_options: {})
+      #   @param company_id [String] The ID of the company
+      #
+      #   @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 first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param transaction_type [Symbol, WhopSDK::Models::BotTokenTransactionTypes, nil] The type of token transaction
+      #
+      #   @param user_id [String, nil] Filter by user ID
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/company_token_transaction_list_response.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CompanyTokenTransactions#list
+    class CompanyTokenTransactionListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the transaction
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The transaction amount (always positive)
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute company
+      #   The company
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransactionListResponse::Company]
+      required :company, -> { WhopSDK::Models::CompanyTokenTransactionListResponse::Company }
+
+      # @!attribute created_at
+      #   When the transaction was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   Optional description
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute idempotency_key
+      #   Optional idempotency key to prevent duplicate transactions
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute linked_transaction_id
+      #   For transfers, the ID of the linked transaction
+      #
+      #   @return [String, nil]
+      required :linked_transaction_id, String, nil?: true
+
+      # @!attribute member
+      #   The member
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransactionListResponse::Member]
+      required :member, -> { WhopSDK::Models::CompanyTokenTransactionListResponse::Member }
+
+      # @!attribute transaction_type
+      #   The type of transaction
+      #
+      #   @return [Symbol, WhopSDK::Models::BotTokenTransactionTypes]
+      required :transaction_type, enum: -> { WhopSDK::BotTokenTransactionTypes }
+
+      # @!attribute user
+      #   The user whose balance changed
+      #
+      #   @return [WhopSDK::Models::CompanyTokenTransactionListResponse::User]
+      required :user, -> { WhopSDK::Models::CompanyTokenTransactionListResponse::User }
+
+      # @!method initialize(id:, amount:, company:, created_at:, description:, idempotency_key:, linked_transaction_id:, member:, transaction_type:, user:)
+      #   A token transaction within a company
+      #
+      #   @param id [String] The ID of the transaction
+      #
+      #   @param amount [Float] The transaction amount (always positive)
+      #
+      #   @param company [WhopSDK::Models::CompanyTokenTransactionListResponse::Company] The company
+      #
+      #   @param created_at [Time] When the transaction was created
+      #
+      #   @param description [String, nil] Optional description
+      #
+      #   @param idempotency_key [String, nil] Optional idempotency key to prevent duplicate transactions
+      #
+      #   @param linked_transaction_id [String, nil] For transfers, the ID of the linked transaction
+      #
+      #   @param member [WhopSDK::Models::CompanyTokenTransactionListResponse::Member] The member
+      #
+      #   @param transaction_type [Symbol, WhopSDK::Models::BotTokenTransactionTypes] The type of transaction
+      #
+      #   @param user [WhopSDK::Models::CompanyTokenTransactionListResponse::User] The user whose balance changed
+
+      # @see WhopSDK::Models::CompanyTokenTransactionListResponse#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID 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 written name of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The company
+        #
+        #   @param id [String] The ID of the company
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The written name of the company.
+      end
+
+      # @see WhopSDK::Models::CompanyTokenTransactionListResponse#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The member
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::CompanyTokenTransactionListResponse#user
+      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 username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user whose balance changed
+        #
+        #   @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.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/company_token_transaction_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CompanyTokenTransactions#retrieve
+    class CompanyTokenTransactionRetrieveParams < 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/dm_channel.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::DmChannels#create
+    class DmChannel < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time the entity was created (in milliseconds since Unix epoch)
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute last_message_at
+      #   When the last message was sent
+      #
+      #   @return [Time, nil]
+      required :last_message_at, Time, nil?: true
+
+      # @!attribute name
+      #   The custom name of the DM channel, if any
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!method initialize(id:, created_at:, last_message_at:, name:)
+      #   Represents a DM channel
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param created_at [String] The time the entity was created (in milliseconds since Unix epoch)
+      #
+      #   @param last_message_at [Time, nil] When the last message was sent
+      #
+      #   @param name [String, nil] The custom name of the DM channel, if any
+    end
+  end
+end

data/lib/whop_sdk/models/dm_channel_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::DmChannels#create
+    class DmChannelCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute with_user_ids
+      #   The user ids to create a DM with. Can be email, username or user_id (tag)
+      #
+      #   @return [Array<String>]
+      required :with_user_ids, WhopSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute company_id
+      #   The ID of the company to scope this DM channel to.
+      #
+      #   @return [String, nil]
+      optional :company_id, String, nil?: true
+
+      # @!attribute custom_name
+      #   The custom name for the DM channel
+      #
+      #   @return [String, nil]
+      optional :custom_name, String, nil?: true
+
+      # @!method initialize(with_user_ids:, company_id: nil, custom_name: nil, request_options: {})
+      #   @param with_user_ids [Array<String>] The user ids to create a DM with. Can be email, username or user_id (tag)
+      #
+      #   @param company_id [String, nil] The ID of the company to scope this DM channel to.
+      #
+      #   @param custom_name [String, nil] The custom name for the DM channel
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/dm_channel_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::DmChannels#delete
+    class DmChannelDeleteParams < 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/dm_channel_delete_response.rb

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

data/lib/whop_sdk/models/dm_channel_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::DmChannels#list
+    class DmChannelListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!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 company_id
+      #   Filter DM channels scoped to a specific company
+      #
+      #   @return [String, nil]
+      optional :company_id, String, 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
+
+      # @!method initialize(after: nil, before: nil, company_id: nil, first: nil, last: nil, request_options: {})
+      #   @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 company_id [String, nil] Filter DM channels scoped to a specific company
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/whop_sdk/models/dm_channel_list_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::DmChannels#list
+    class DmChannelListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time the entity was created (in milliseconds since Unix epoch)
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute last_message_at
+      #   When the last message was sent
+      #
+      #   @return [Time, nil]
+      required :last_message_at, Time, nil?: true
+
+      # @!attribute name
+      #   The custom name of the DM channel, if any
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!method initialize(id:, created_at:, last_message_at:, name:)
+      #   Represents a DM channel
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param created_at [String] The time the entity was created (in milliseconds since Unix epoch)
+      #
+      #   @param last_message_at [Time, nil] When the last message was sent
+      #
+      #   @param name [String, nil] The custom name of the DM channel, if any
+    end
+  end
+end