whop_sdk 0.0.19 → 0.0.22

data/lib/whop_sdk/models/lead_list_response.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Leads#list
+    class LeadListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lead.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the lead was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute member
+      #   The converted member, if any.
+      #
+      #   @return [WhopSDK::Models::LeadListResponse::Member, nil]
+      required :member, -> { WhopSDK::Models::LeadListResponse::Member }, nil?: true
+
+      # @!attribute metadata
+      #   Custom metadata for the lead.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute product
+      #   The access pass the lead is interested in, if available.
+      #
+      #   @return [WhopSDK::Models::LeadListResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::LeadListResponse::Product }, nil?: true
+
+      # @!attribute referrer
+      #   The referrer URL that brought this lead.
+      #
+      #   @return [String, nil]
+      required :referrer, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the lead was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user who is the lead.
+      #
+      #   @return [WhopSDK::Models::LeadListResponse::User]
+      required :user, -> { WhopSDK::Models::LeadListResponse::User }
+
+      # @!method initialize(id:, created_at:, member:, metadata:, product:, referrer:, updated_at:, user:)
+      #   An object representing a lead (someone who is interested in a whop).
+      #
+      #   @param id [String] The ID of the lead.
+      #
+      #   @param created_at [Time] The timestamp of when the lead was created.
+      #
+      #   @param member [WhopSDK::Models::LeadListResponse::Member, nil] The converted member, if any.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
+      #
+      #   @param product [WhopSDK::Models::LeadListResponse::Product, nil] The access pass the lead is interested in, if available.
+      #
+      #   @param referrer [String, nil] The referrer URL that brought this lead.
+      #
+      #   @param updated_at [Time] The timestamp of when the lead was last updated.
+      #
+      #   @param user [WhopSDK::Models::LeadListResponse::User] The user who is the lead.
+
+      # @see WhopSDK::Models::LeadListResponse#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The converted member, if any.
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::LeadListResponse#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 access pass the lead is interested in, if available.
+        #
+        #   @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::LeadListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!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:, email:, name:, username:)
+        #   The user who is the lead.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email 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/lead_retrieve_params.rb

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Leads#retrieve
+    class LeadRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lead.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the lead was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute member
+      #   The converted member, if any.
+      #
+      #   @return [WhopSDK::Models::LeadRetrieveResponse::Member, nil]
+      required :member, -> { WhopSDK::Models::LeadRetrieveResponse::Member }, nil?: true
+
+      # @!attribute metadata
+      #   Custom metadata for the lead.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute product
+      #   The access pass the lead is interested in, if available.
+      #
+      #   @return [WhopSDK::Models::LeadRetrieveResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::LeadRetrieveResponse::Product }, nil?: true
+
+      # @!attribute referrer
+      #   The referrer URL that brought this lead.
+      #
+      #   @return [String, nil]
+      required :referrer, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the lead was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user who is the lead.
+      #
+      #   @return [WhopSDK::Models::LeadRetrieveResponse::User]
+      required :user, -> { WhopSDK::Models::LeadRetrieveResponse::User }
+
+      # @!method initialize(id:, created_at:, member:, metadata:, product:, referrer:, updated_at:, user:)
+      #   An object representing a lead (someone who is interested in a whop).
+      #
+      #   @param id [String] The ID of the lead.
+      #
+      #   @param created_at [Time] The timestamp of when the lead was created.
+      #
+      #   @param member [WhopSDK::Models::LeadRetrieveResponse::Member, nil] The converted member, if any.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
+      #
+      #   @param product [WhopSDK::Models::LeadRetrieveResponse::Product, nil] The access pass the lead is interested in, if available.
+      #
+      #   @param referrer [String, nil] The referrer URL that brought this lead.
+      #
+      #   @param updated_at [Time] The timestamp of when the lead was last updated.
+      #
+      #   @param user [WhopSDK::Models::LeadRetrieveResponse::User] The user who is the lead.
+
+      # @see WhopSDK::Models::LeadRetrieveResponse#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The converted member, if any.
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::LeadRetrieveResponse#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 access pass the lead is interested in, if available.
+        #
+        #   @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::LeadRetrieveResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!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:, email:, name:, username:)
+        #   The user who is the lead.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email 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/lead_update_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Leads#update
+    class LeadUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute metadata
+      #   Custom metadata for the lead.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute referrer
+      #   The url referrer of the lead.
+      #
+      #   @return [String, nil]
+      optional :referrer, String, nil?: true
+
+      # @!method initialize(metadata: nil, referrer: nil, request_options: {})
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
+      #
+      #   @param referrer [String, nil] The url referrer of the lead.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/lead_update_response.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Leads#update
+    class LeadUpdateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lead.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the lead was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute member
+      #   The converted member, if any.
+      #
+      #   @return [WhopSDK::Models::LeadUpdateResponse::Member, nil]
+      required :member, -> { WhopSDK::Models::LeadUpdateResponse::Member }, nil?: true
+
+      # @!attribute metadata
+      #   Custom metadata for the lead.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute product
+      #   The access pass the lead is interested in, if available.
+      #
+      #   @return [WhopSDK::Models::LeadUpdateResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::LeadUpdateResponse::Product }, nil?: true
+
+      # @!attribute referrer
+      #   The referrer URL that brought this lead.
+      #
+      #   @return [String, nil]
+      required :referrer, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the lead was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user who is the lead.
+      #
+      #   @return [WhopSDK::Models::LeadUpdateResponse::User]
+      required :user, -> { WhopSDK::Models::LeadUpdateResponse::User }
+
+      # @!method initialize(id:, created_at:, member:, metadata:, product:, referrer:, updated_at:, user:)
+      #   An object representing a lead (someone who is interested in a whop).
+      #
+      #   @param id [String] The ID of the lead.
+      #
+      #   @param created_at [Time] The timestamp of when the lead was created.
+      #
+      #   @param member [WhopSDK::Models::LeadUpdateResponse::Member, nil] The converted member, if any.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
+      #
+      #   @param product [WhopSDK::Models::LeadUpdateResponse::Product, nil] The access pass the lead is interested in, if available.
+      #
+      #   @param referrer [String, nil] The referrer URL that brought this lead.
+      #
+      #   @param updated_at [Time] The timestamp of when the lead was last updated.
+      #
+      #   @param user [WhopSDK::Models::LeadUpdateResponse::User] The user who is the lead.
+
+      # @see WhopSDK::Models::LeadUpdateResponse#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The converted member, if any.
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::LeadUpdateResponse#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 access pass the lead is interested in, if available.
+        #
+        #   @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::LeadUpdateResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!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:, email:, name:, username:)
+        #   The user who is the lead.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email 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/ledger_account_retrieve_response.rb

@@ -288,13 +288,27 @@ module WhopSDK
                  -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::BusinessRepresentative },
                  nil?: true
 
+        # @!attribute email
+        #   The email address of the representative
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute latest_verification
+        #   The latest verification for the connected account.
+        #
+        #   @return [WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification, nil]
+        required :latest_verification,
+                 -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification },
+                 nil?: true
+
         # @!attribute phone
         #   The business representative's phone
         #
         #   @return [String, nil]
         required :phone, String, nil?: true
 
-        # @!method initialize(id:, address:, business_name:, business_representative:, phone:)
+        # @!method initialize(id:, address:, business_name:, business_representative:, email:, latest_verification:, phone:)
         #   The payout account associated with the LedgerAccount, if any.
         #
         #   @param id [String] Unique identifier for the object
@@ -305,6 +319,10 @@ module WhopSDK
         #
         #   @param business_representative [WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::BusinessRepresentative, nil] The business representative for this payout account
         #
+        #   @param email [String, nil] The email address of the representative
+        #
+        #   @param latest_verification [WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification, nil] The latest verification for the connected account.
+        #
         #   @param phone [String, nil] The business representative's phone
 
         # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails#address
@@ -363,6 +381,13 @@ module WhopSDK
 
         # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails#business_representative
         class BusinessRepresentative < WhopSDK::Internal::Type::BaseModel
+          # @!attribute date_of_birth
+          #   The date of birth of the business representative in ISO 8601 format
+          #   (YYYY-MM-DD).
+          #
+          #   @return [String, nil]
+          required :date_of_birth, String, nil?: true
+
           # @!attribute first_name
           #   The first name of the business representative.
           #
@@ -381,15 +406,116 @@ module WhopSDK
           #   @return [String, nil]
           required :middle_name, String, nil?: true
 
-          # @!method initialize(first_name:, last_name:, middle_name:)
+          # @!method initialize(date_of_birth:, first_name:, last_name:, middle_name:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::BusinessRepresentative}
+          #   for more details.
+          #
           #   The business representative for this payout account
           #
+          #   @param date_of_birth [String, nil] The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD)
+          #
           #   @param first_name [String, nil] The first name of the business representative.
           #
           #   @param last_name [String, nil] The last name of the business representative.
           #
           #   @param middle_name [String, nil] The middle name of the business representative.
         end
+
+        # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails#latest_verification
+        class LatestVerification < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   A unique identifier for the verification.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute last_error_code
+          #   An error code for a verification attempt.
+          #
+          #   @return [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::LastErrorCode, nil]
+          required :last_error_code,
+                   enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::LastErrorCode },
+                   nil?: true
+
+          # @!attribute last_error_reason
+          #   The last error reason that occurred during the verification.
+          #
+          #   @return [String, nil]
+          required :last_error_reason, String, nil?: true
+
+          # @!attribute status
+          #   The status of the verification.
+          #
+          #   @return [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::Status]
+          required :status,
+                   enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::Status }
+
+          # @!method initialize(id:, last_error_code:, last_error_reason:, status:)
+          #   The latest verification for the connected account.
+          #
+          #   @param id [String] A unique identifier for the verification.
+          #
+          #   @param last_error_code [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::LastErrorCode, nil] An error code for a verification attempt.
+          #
+          #   @param last_error_reason [String, nil] The last error reason that occurred during the verification.
+          #
+          #   @param status [Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification::Status] The status of the verification.
+
+          # An error code for a verification attempt.
+          #
+          # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification#last_error_code
+          module LastErrorCode
+            extend WhopSDK::Internal::Type::Enum
+
+            ABANDONED = :abandoned
+            CONSENT_DECLINED = :consent_declined
+            COUNTRY_NOT_SUPPORTED = :country_not_supported
+            DEVICE_NOT_SUPPORTED = :device_not_supported
+            DOCUMENT_EXPIRED = :document_expired
+            DOCUMENT_TYPE_NOT_SUPPORTED = :document_type_not_supported
+            DOCUMENT_UNVERIFIED_OTHER = :document_unverified_other
+            EMAIL_UNVERIFIED_OTHER = :email_unverified_other
+            EMAIL_VERIFICATION_DECLINED = :email_verification_declined
+            ID_NUMBER_INSUFFICIENT_DOCUMENT_DATA = :id_number_insufficient_document_data
+            ID_NUMBER_MISMATCH = :id_number_mismatch
+            ID_NUMBER_UNVERIFIED_OTHER = :id_number_unverified_other
+            PHONE_UNVERIFIED_OTHER = :phone_unverified_other
+            PHONE_VERIFICATION_DECLINED = :phone_verification_declined
+            SELFIE_DOCUMENT_MISSING_PHOTO = :selfie_document_missing_photo
+            SELFIE_FACE_MISMATCH = :selfie_face_mismatch
+            SELFIE_MANIPULATED = :selfie_manipulated
+            SELFIE_UNVERIFIED_OTHER = :selfie_unverified_other
+            UNDER_SUPPORTED_AGE = :under_supported_age
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The status of the verification.
+          #
+          # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification#status
+          module Status
+            extend WhopSDK::Internal::Type::Enum
+
+            REQUIRES_INPUT = :requires_input
+            PROCESSING = :processing
+            VERIFIED = :verified
+            CANCELED = :canceled
+            CREATED = :created
+            STARTED = :started
+            SUBMITTED = :submitted
+            APPROVED = :approved
+            DECLINED = :declined
+            RESUBMISSION_REQUESTED = :resubmission_requested
+            EXPIRED = :expired
+            ABANDONED = :abandoned
+            REVIEW = :review
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end