whop_sdk 0.0.2 → 0.0.4

data/lib/whop_sdk/models/review_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#list
+    class ReviewListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   The ID of the product
+      #
+      #   @return [String]
+      required :product_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 max_stars
+      #   The maximum star rating of the review (inclusive)
+      #
+      #   @return [Integer, nil]
+      optional :max_stars, Integer, nil?: true
+
+      # @!attribute min_stars
+      #   The minimum star rating of the review (inclusive)
+      #
+      #   @return [Integer, nil]
+      optional :min_stars, Integer, nil?: true
+
+      # @!method initialize(product_id:, after: nil, before: nil, first: nil, last: nil, max_stars: nil, min_stars: nil, request_options: {})
+      #   @param product_id [String] The ID of the product
+      #
+      #   @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 max_stars [Integer, nil] The maximum star rating of the review (inclusive)
+      #
+      #   @param min_stars [Integer, nil] The minimum star rating of the review (inclusive)
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/review_list_response.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#list
+    class ReviewListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the review.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attachments
+      #   The attachments attached to the review.
+      #
+      #   @return [Array<WhopSDK::Models::ReviewListResponse::Attachment>]
+      required :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReviewListResponse::Attachment] }
+
+      # @!attribute created_at
+      #   The timestamp of when the review was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the review.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute joined_at
+      #   The timestamp of when the user joined the product.
+      #
+      #   @return [Time, nil]
+      required :joined_at, Time, nil?: true
+
+      # @!attribute paid_for_product
+      #   Whether or not the user paid for the product. If null, the payment status is
+      #   unknown.
+      #
+      #   @return [Boolean, nil]
+      required :paid_for_product, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute published_at
+      #   The timestamp of when the review was published.
+      #
+      #   @return [Time, nil]
+      required :published_at, Time, nil?: true
+
+      # @!attribute stars
+      #   The number of stars the user gave the product.
+      #
+      #   @return [Integer]
+      required :stars, Integer
+
+      # @!attribute status
+      #   The status of the review.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReviewStatus]
+      required :status, enum: -> { WhopSDK::ReviewStatus }
+
+      # @!attribute title
+      #   The title of the review.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the review was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user account that performed the action.
+      #
+      #   @return [WhopSDK::Models::ReviewListResponse::User]
+      required :user, -> { WhopSDK::Models::ReviewListResponse::User }
+
+      # @!method initialize(id:, attachments:, created_at:, description:, joined_at:, paid_for_product:, published_at:, stars:, status:, title:, updated_at:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ReviewListResponse} for more details.
+      #
+      #   An object representing a user review of a company.
+      #
+      #   @param id [String] The internal ID of the review.
+      #
+      #   @param attachments [Array<WhopSDK::Models::ReviewListResponse::Attachment>] The attachments attached to the review.
+      #
+      #   @param created_at [Time] The timestamp of when the review was created.
+      #
+      #   @param description [String, nil] The description of the review.
+      #
+      #   @param joined_at [Time, nil] The timestamp of when the user joined the product.
+      #
+      #   @param paid_for_product [Boolean, nil] Whether or not the user paid for the product. If null, the payment status is unk
+      #
+      #   @param published_at [Time, nil] The timestamp of when the review was published.
+      #
+      #   @param stars [Integer] The number of stars the user gave the product.
+      #
+      #   @param status [Symbol, WhopSDK::Models::ReviewStatus] The status of the review.
+      #
+      #   @param title [String, nil] The title of the review.
+      #
+      #   @param updated_at [Time] The timestamp of when the review was last updated.
+      #
+      #   @param user [WhopSDK::Models::ReviewListResponse::User] The user account that performed the action.
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the attachment
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content_type
+        #   The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @return [String, nil]
+        required :content_type, String, nil?: true
+
+        # @!attribute filename
+        #   The name of the file
+        #
+        #   @return [String, nil]
+        required :filename, String, nil?: true
+
+        # @!attribute url
+        #   This is the URL you use to render optimized attachments on the client. This
+        #   should be used for apps.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(id:, content_type:, filename:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ReviewListResponse::Attachment} for more details.
+        #
+        #   Represents an image attachment
+        #
+        #   @param id [String] The ID of the attachment
+        #
+        #   @param content_type [String, nil] The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @param filename [String, nil] The name of the file
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      # @see WhopSDK::Models::ReviewListResponse#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 account that performed the action.
+        #
+        #   @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/review_retrieve_params.rb

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

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#retrieve
+    class ReviewRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the review.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attachments
+      #   The attachments attached to the review.
+      #
+      #   @return [Array<WhopSDK::Models::ReviewRetrieveResponse::Attachment>]
+      required :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReviewRetrieveResponse::Attachment] }
+
+      # @!attribute company
+      #   The company the review is for.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::Company]
+      required :company, -> { WhopSDK::Models::ReviewRetrieveResponse::Company }
+
+      # @!attribute created_at
+      #   The timestamp of when the review was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the review.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute joined_at
+      #   The timestamp of when the user joined the product.
+      #
+      #   @return [Time, nil]
+      required :joined_at, Time, nil?: true
+
+      # @!attribute paid_for_product
+      #   Whether or not the user paid for the product. If null, the payment status is
+      #   unknown.
+      #
+      #   @return [Boolean, nil]
+      required :paid_for_product, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute product
+      #   The product the review is for.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::Product]
+      required :product, -> { WhopSDK::Models::ReviewRetrieveResponse::Product }
+
+      # @!attribute published_at
+      #   The timestamp of when the review was published.
+      #
+      #   @return [Time, nil]
+      required :published_at, Time, nil?: true
+
+      # @!attribute stars
+      #   The number of stars the user gave the product.
+      #
+      #   @return [Integer]
+      required :stars, Integer
+
+      # @!attribute status
+      #   The status of the review.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReviewStatus]
+      required :status, enum: -> { WhopSDK::ReviewStatus }
+
+      # @!attribute title
+      #   The title of the review.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the review was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user account that performed the action.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::User]
+      required :user, -> { WhopSDK::Models::ReviewRetrieveResponse::User }
+
+      # @!method initialize(id:, attachments:, company:, created_at:, description:, joined_at:, paid_for_product:, product:, published_at:, stars:, status:, title:, updated_at:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ReviewRetrieveResponse} for more details.
+      #
+      #   An object representing a user review of a company.
+      #
+      #   @param id [String] The internal ID of the review.
+      #
+      #   @param attachments [Array<WhopSDK::Models::ReviewRetrieveResponse::Attachment>] The attachments attached to the review.
+      #
+      #   @param company [WhopSDK::Models::ReviewRetrieveResponse::Company] The company the review is for.
+      #
+      #   @param created_at [Time] The timestamp of when the review was created.
+      #
+      #   @param description [String, nil] The description of the review.
+      #
+      #   @param joined_at [Time, nil] The timestamp of when the user joined the product.
+      #
+      #   @param paid_for_product [Boolean, nil] Whether or not the user paid for the product. If null, the payment status is unk
+      #
+      #   @param product [WhopSDK::Models::ReviewRetrieveResponse::Product] The product the review is for.
+      #
+      #   @param published_at [Time, nil] The timestamp of when the review was published.
+      #
+      #   @param stars [Integer] The number of stars the user gave the product.
+      #
+      #   @param status [Symbol, WhopSDK::Models::ReviewStatus] The status of the review.
+      #
+      #   @param title [String, nil] The title of the review.
+      #
+      #   @param updated_at [Time] The timestamp of when the review was last updated.
+      #
+      #   @param user [WhopSDK::Models::ReviewRetrieveResponse::User] The user account that performed the action.
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the attachment
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content_type
+        #   The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @return [String, nil]
+        required :content_type, String, nil?: true
+
+        # @!attribute filename
+        #   The name of the file
+        #
+        #   @return [String, nil]
+        required :filename, String, nil?: true
+
+        # @!attribute url
+        #   This is the URL you use to render optimized attachments on the client. This
+        #   should be used for apps.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(id:, content_type:, filename:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ReviewRetrieveResponse::Attachment} for more details.
+        #
+        #   Represents an image attachment
+        #
+        #   @param id [String] The ID of the attachment
+        #
+        #   @param content_type [String, nil] The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @param filename [String, nil] The name of the file
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      # @see WhopSDK::Models::ReviewRetrieveResponse#company
+      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
+
+        # @!method initialize(id:, route:, title:)
+        #   The company the review is for.
+        #
+        #   @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.
+      end
+
+      # @see WhopSDK::Models::ReviewRetrieveResponse#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The product the review is for.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+
+      # @see WhopSDK::Models::ReviewRetrieveResponse#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 account that performed the action.
+        #
+        #   @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/review_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The statuses a review can have
+    module ReviewStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      PENDING = :pending
+      PUBLISHED = :published
+      REMOVED = :removed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/transfer.rb

@@ -45,6 +45,12 @@ module WhopSDK
       #   @return [Float, nil]
       required :fee_amount, Float, nil?: true
 
+      # @!attribute metadata
+      #   A hash of metadata attached to the transfer
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute notes
       #   The notes of the credit transaction transfer
       #
@@ -63,7 +69,7 @@ module WhopSDK
       #   @return [String]
       required :origin_ledger_account_id, String
 
-      # @!method initialize(id:, amount:, created_at:, currency:, destination:, destination_ledger_account_id:, fee_amount:, notes:, origin:, origin_ledger_account_id:)
+      # @!method initialize(id:, amount:, created_at:, currency:, destination:, destination_ledger_account_id:, fee_amount:, metadata:, notes:, origin:, origin_ledger_account_id:)
       #   Credit Transaction Transfer
       #
       #   @param id [String] The unique identifier of the credit transaction transfer
@@ -80,6 +86,8 @@ module WhopSDK
       #
       #   @param fee_amount [Float, nil] The decimal fee of the credit transaction transfer
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] A hash of metadata attached to the transfer
+      #
       #   @param notes [String, nil] The notes of the credit transaction transfer
       #
       #   @param origin [WhopSDK::Models::Transfer::Origin::User, WhopSDK::Models::Transfer::Origin::Company, nil] The sender of the credit transaction transfer

data/lib/whop_sdk/models/transfer_create_params.rb

@@ -39,13 +39,19 @@ module WhopSDK
       #   @return [String, nil]
       optional :idempotence_key, String, nil?: true
 
+      # @!attribute metadata
+      #   A hash of metadata to attach to the transfer.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute notes
       #   Notes for the transfer. Maximum of 50 characters.
       #
       #   @return [String, nil]
       optional :notes, String, nil?: true
 
-      # @!method initialize(amount:, currency:, destination_id:, origin_id:, idempotence_key: nil, notes: nil, request_options: {})
+      # @!method initialize(amount:, currency:, destination_id:, origin_id:, idempotence_key: nil, metadata: nil, notes: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::TransferCreateParams} for more details.
       #
@@ -59,6 +65,8 @@ module WhopSDK
       #
       #   @param idempotence_key [String, nil] A unique key to ensure idempotence. Use a UUID or similar.
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] A hash of metadata to attach to the transfer.
+      #
       #   @param notes [String, nil] Notes for the transfer. Maximum of 50 characters.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]

data/lib/whop_sdk/models/transfer_list_response.rb

@@ -40,6 +40,12 @@ module WhopSDK
       #   @return [Float, nil]
       required :fee_amount, Float, nil?: true
 
+      # @!attribute metadata
+      #   A hash of metadata attached to the transfer
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute notes
       #   The notes of the credit transaction transfer
       #
@@ -52,7 +58,7 @@ module WhopSDK
       #   @return [String]
       required :origin_ledger_account_id, String
 
-      # @!method initialize(id:, amount:, created_at:, currency:, destination_ledger_account_id:, fee_amount:, notes:, origin_ledger_account_id:)
+      # @!method initialize(id:, amount:, created_at:, currency:, destination_ledger_account_id:, fee_amount:, metadata:, notes:, origin_ledger_account_id:)
       #   Credit Transaction Transfer
       #
       #   @param id [String] The unique identifier of the credit transaction transfer
@@ -67,6 +73,8 @@ module WhopSDK
       #
       #   @param fee_amount [Float, nil] The decimal fee of the credit transaction transfer
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] A hash of metadata attached to the transfer
+      #
       #   @param notes [String, nil] The notes of the credit transaction transfer
       #
       #   @param origin_ledger_account_id [String] The ID of the origin ledger account