whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/person_list_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::People#list
+    class PersonListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The ID of the account, which will look like biz\_******\*******. Optional for
+      #   account API keys; required for credentials that can access multiple accounts.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute after
+      #   A cursor for fetching people after a previous page.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   A cursor for fetching people before a later page.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute direction
+      #   Sort direction. Defaults to desc.
+      #
+      #   @return [Symbol, WhopSDK::Models::PersonListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::PersonListParams::Direction }
+
+      # @!attribute filters
+      #   A JSON-encoded array of filters, each with field, operator, and value keys.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute first
+      #   The number of people to return (default 100, max 100).
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute from
+      #   Start of the time range as a Unix timestamp. Defaults to 366 days before `to`.
+      #
+      #   @return [Integer, nil]
+      optional :from, Integer
+
+      # @!attribute sort
+      #   Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to
+      #   last_seen_at.
+      #
+      #   @return [String, nil]
+      optional :sort, String
+
+      # @!attribute to
+      #   End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @return [Integer, nil]
+      optional :to, Integer
+
+      # @!method initialize(account_id: nil, after: nil, before: nil, direction: nil, filters: nil, first: nil, from: nil, sort: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PersonListParams} for more details.
+      #
+      #   @param account_id [String] The ID of the account, which will look like biz\_******\*******. Optional for
+      #   acco
+      #
+      #   @param after [String] A cursor for fetching people after a previous page.
+      #
+      #   @param before [String] A cursor for fetching people before a later page.
+      #
+      #   @param direction [Symbol, WhopSDK::Models::PersonListParams::Direction] Sort direction. Defaults to desc.
+      #
+      #   @param filters [String] A JSON-encoded array of filters, each with field, operator, and value keys.
+      #
+      #   @param first [Integer] The number of people to return (default 100, max 100).
+      #
+      #   @param from [Integer] Start of the time range as a Unix timestamp. Defaults to 366 days before `to`.
+      #
+      #   @param sort [String] Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to last_see
+      #
+      #   @param to [Integer] End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Sort direction. Defaults to desc.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/person_list_response.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::People#list
+    class PersonListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute first_seen_at
+      #
+      #   @return [Integer]
+      required :first_seen_at, Integer
+
+      # @!attribute last_seen_at
+      #
+      #   @return [Integer]
+      required :last_seen_at, Integer
+
+      # @!attribute person_id
+      #
+      #   @return [String]
+      required :person_id, String
+
+      # @!attribute purchase_count
+      #
+      #   @return [Integer]
+      required :purchase_count, Integer
+
+      # @!attribute ad_sets
+      #
+      #   @return [Array<WhopSDK::Models::PersonListResponse::AdSet>, nil]
+      optional :ad_sets, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonListResponse::AdSet] }
+
+      # @!attribute ads
+      #
+      #   @return [Array<WhopSDK::Models::PersonListResponse::Ad>, nil]
+      optional :ads, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonListResponse::Ad] }
+
+      # @!attribute aov
+      #
+      #   @return [Float, nil]
+      optional :aov, Float
+
+      # @!attribute campaigns
+      #
+      #   @return [Array<WhopSDK::Models::PersonListResponse::Campaign>, nil]
+      optional :campaigns,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonListResponse::Campaign] }
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute has_failed_payment
+      #
+      #   @return [Boolean, nil]
+      optional :has_failed_payment, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute ltv
+      #
+      #   @return [Float, nil]
+      optional :ltv, Float
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute phone
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!method initialize(id:, account_id:, first_seen_at:, last_seen_at:, person_id:, purchase_count:, ad_sets: nil, ads: nil, aov: nil, campaigns: nil, email: nil, has_failed_payment: nil, ltv: nil, name: nil, phone: nil)
+      #   @param id [String]
+      #   @param account_id [String]
+      #   @param first_seen_at [Integer]
+      #   @param last_seen_at [Integer]
+      #   @param person_id [String]
+      #   @param purchase_count [Integer]
+      #   @param ad_sets [Array<WhopSDK::Models::PersonListResponse::AdSet>]
+      #   @param ads [Array<WhopSDK::Models::PersonListResponse::Ad>]
+      #   @param aov [Float]
+      #   @param campaigns [Array<WhopSDK::Models::PersonListResponse::Campaign>]
+      #   @param email [String, nil]
+      #   @param has_failed_payment [Boolean]
+      #   @param ltv [Float]
+      #   @param name [String, nil]
+      #   @param phone [String, nil]
+
+      class AdSet < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute thumbnail_url
+        #
+        #   @return [String, nil]
+        optional :thumbnail_url, String, nil?: true
+
+        # @!method initialize(id:, name: nil, thumbnail_url: nil)
+        #   @param id [String]
+        #   @param name [String, nil]
+        #   @param thumbnail_url [String, nil]
+      end
+
+      class Ad < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute thumbnail_url
+        #
+        #   @return [String, nil]
+        optional :thumbnail_url, String, nil?: true
+
+        # @!method initialize(id:, name: nil, thumbnail_url: nil)
+        #   @param id [String]
+        #   @param name [String, nil]
+        #   @param thumbnail_url [String, nil]
+      end
+
+      class Campaign < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute thumbnail_url
+        #
+        #   @return [String, nil]
+        optional :thumbnail_url, String, nil?: true
+
+        # @!method initialize(id:, name: nil, thumbnail_url: nil)
+        #   @param id [String]
+        #   @param name [String, nil]
+        #   @param thumbnail_url [String, nil]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/person_retrieve_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::People#retrieve
+    class PersonRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute person_id
+      #
+      #   @return [String]
+      required :person_id, String
+
+      # @!attribute account_id
+      #   The ID of the account, which will look like biz\_******\*******. Optional for
+      #   account API keys; required for credentials that can access multiple accounts.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute from
+      #   Start of the time range as a Unix timestamp.
+      #
+      #   @return [Integer, nil]
+      optional :from, Integer
+
+      # @!attribute to
+      #   End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @return [Integer, nil]
+      optional :to, Integer
+
+      # @!method initialize(person_id:, account_id: nil, from: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PersonRetrieveParams} for more details.
+      #
+      #   @param person_id [String]
+      #
+      #   @param account_id [String] The ID of the account, which will look like biz\_******\*******. Optional for
+      #   acco
+      #
+      #   @param from [Integer] Start of the time range as a Unix timestamp.
+      #
+      #   @param to [Integer] End of the time range as a Unix timestamp. Defaults to now.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/person_retrieve_response.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::People#retrieve
+    class PersonRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [WhopSDK::Models::PersonRetrieveResponse::Data]
+      required :data, -> { WhopSDK::Models::PersonRetrieveResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [WhopSDK::Models::PersonRetrieveResponse::Data]
+
+      # @see WhopSDK::Models::PersonRetrieveResponse#data
+      class Data < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute account_id
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute first_seen_at
+        #
+        #   @return [Integer]
+        required :first_seen_at, Integer
+
+        # @!attribute last_seen_at
+        #
+        #   @return [Integer]
+        required :last_seen_at, Integer
+
+        # @!attribute person_id
+        #
+        #   @return [String]
+        required :person_id, String
+
+        # @!attribute purchase_count
+        #
+        #   @return [Integer]
+        required :purchase_count, Integer
+
+        # @!attribute ad_sets
+        #
+        #   @return [Array<WhopSDK::Models::PersonRetrieveResponse::Data::AdSet>, nil]
+        optional :ad_sets,
+                 -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonRetrieveResponse::Data::AdSet] }
+
+        # @!attribute ads
+        #
+        #   @return [Array<WhopSDK::Models::PersonRetrieveResponse::Data::Ad>, nil]
+        optional :ads, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonRetrieveResponse::Data::Ad] }
+
+        # @!attribute aov
+        #
+        #   @return [Float, nil]
+        optional :aov, Float
+
+        # @!attribute campaigns
+        #
+        #   @return [Array<WhopSDK::Models::PersonRetrieveResponse::Data::Campaign>, nil]
+        optional :campaigns,
+                 -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PersonRetrieveResponse::Data::Campaign] }
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute has_failed_payment
+        #
+        #   @return [Boolean, nil]
+        optional :has_failed_payment, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute ltv
+        #
+        #   @return [Float, nil]
+        optional :ltv, Float
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
+
+        # @!method initialize(id:, account_id:, first_seen_at:, last_seen_at:, person_id:, purchase_count:, ad_sets: nil, ads: nil, aov: nil, campaigns: nil, email: nil, has_failed_payment: nil, ltv: nil, name: nil, phone: nil)
+        #   @param id [String]
+        #   @param account_id [String]
+        #   @param first_seen_at [Integer]
+        #   @param last_seen_at [Integer]
+        #   @param person_id [String]
+        #   @param purchase_count [Integer]
+        #   @param ad_sets [Array<WhopSDK::Models::PersonRetrieveResponse::Data::AdSet>]
+        #   @param ads [Array<WhopSDK::Models::PersonRetrieveResponse::Data::Ad>]
+        #   @param aov [Float]
+        #   @param campaigns [Array<WhopSDK::Models::PersonRetrieveResponse::Data::Campaign>]
+        #   @param email [String, nil]
+        #   @param has_failed_payment [Boolean]
+        #   @param ltv [Float]
+        #   @param name [String, nil]
+        #   @param phone [String, nil]
+
+        class AdSet < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute thumbnail_url
+          #
+          #   @return [String, nil]
+          optional :thumbnail_url, String, nil?: true
+
+          # @!method initialize(id:, name: nil, thumbnail_url: nil)
+          #   @param id [String]
+          #   @param name [String, nil]
+          #   @param thumbnail_url [String, nil]
+        end
+
+        class Ad < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute thumbnail_url
+          #
+          #   @return [String, nil]
+          optional :thumbnail_url, String, nil?: true
+
+          # @!method initialize(id:, name: nil, thumbnail_url: nil)
+          #   @param id [String]
+          #   @param name [String, nil]
+          #   @param thumbnail_url [String, nil]
+        end
+
+        class Campaign < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute thumbnail_url
+          #
+          #   @return [String, nil]
+          optional :thumbnail_url, String, nil?: true
+
+          # @!method initialize(id:, name: nil, thumbnail_url: nil)
+          #   @param id [String]
+          #   @param name [String, nil]
+          #   @param thumbnail_url [String, nil]
+        end
+      end
+    end
+  end
+end