whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/event_list_response.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Events#list
+    class EventListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_name
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute event_time
+      #
+      #   @return [Integer]
+      required :event_time, Integer
+
+      # @!attribute context
+      #
+      #   @return [WhopSDK::Models::EventListResponse::Context, nil]
+      optional :context, -> { WhopSDK::Models::EventListResponse::Context }, nil?: true
+
+      # @!attribute currency
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute custom_name
+      #
+      #   @return [String, nil]
+      optional :custom_name, String, nil?: true
+
+      # @!attribute path
+      #
+      #   @return [String, nil]
+      optional :path, String, nil?: true
+
+      # @!attribute questions
+      #
+      #   @return [Array<WhopSDK::Models::EventListResponse::Question>, nil]
+      optional :questions,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::EventListResponse::Question] },
+               nil?: true
+
+      # @!attribute referrer_url
+      #
+      #   @return [String, nil]
+      optional :referrer_url, String, nil?: true
+
+      # @!attribute total_usd_amount
+      #
+      #   @return [Float, nil]
+      optional :total_usd_amount, Float, nil?: true
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!attribute user
+      #
+      #   @return [WhopSDK::Models::EventListResponse::User, nil]
+      optional :user, -> { WhopSDK::Models::EventListResponse::User }, nil?: true
+
+      # @!attribute value
+      #
+      #   @return [Float, nil]
+      optional :value, Float, nil?: true
+
+      # @!method initialize(id:, event_id:, event_name:, event_time:, context: nil, currency: nil, custom_name: nil, path: nil, questions: nil, referrer_url: nil, total_usd_amount: nil, url: nil, user: nil, value: nil)
+      #   @param id [String]
+      #   @param event_id [String]
+      #   @param event_name [String]
+      #   @param event_time [Integer]
+      #   @param context [WhopSDK::Models::EventListResponse::Context, nil]
+      #   @param currency [String, nil]
+      #   @param custom_name [String, nil]
+      #   @param path [String, nil]
+      #   @param questions [Array<WhopSDK::Models::EventListResponse::Question>, nil]
+      #   @param referrer_url [String, nil]
+      #   @param total_usd_amount [Float, nil]
+      #   @param url [String, nil]
+      #   @param user [WhopSDK::Models::EventListResponse::User, nil]
+      #   @param value [Float, nil]
+
+      # @see WhopSDK::Models::EventListResponse#context
+      class Context < WhopSDK::Internal::Type::BaseModel
+        # @!attribute ad_campaign_id
+        #
+        #   @return [String, nil]
+        optional :ad_campaign_id, String, nil?: true
+
+        # @!attribute ad_id
+        #
+        #   @return [String, nil]
+        optional :ad_id, String, nil?: true
+
+        # @!attribute ad_set_id
+        #
+        #   @return [String, nil]
+        optional :ad_set_id, String, nil?: true
+
+        # @!attribute utm_campaign
+        #
+        #   @return [String, nil]
+        optional :utm_campaign, String, nil?: true
+
+        # @!attribute utm_content
+        #
+        #   @return [String, nil]
+        optional :utm_content, String, nil?: true
+
+        # @!attribute utm_medium
+        #
+        #   @return [String, nil]
+        optional :utm_medium, String, nil?: true
+
+        # @!attribute utm_source
+        #
+        #   @return [String, nil]
+        optional :utm_source, String, nil?: true
+
+        # @!attribute utm_term
+        #
+        #   @return [String, nil]
+        optional :utm_term, String, nil?: true
+
+        # @!method initialize(ad_campaign_id: nil, ad_id: nil, ad_set_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
+        #   @param ad_campaign_id [String, nil]
+        #   @param ad_id [String, nil]
+        #   @param ad_set_id [String, nil]
+        #   @param utm_campaign [String, nil]
+        #   @param utm_content [String, nil]
+        #   @param utm_medium [String, nil]
+        #   @param utm_source [String, nil]
+        #   @param utm_term [String, nil]
+      end
+
+      class Question < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute answer
+        #
+        #   @return [String, nil]
+        optional :answer, String, nil?: true
+
+        # @!attribute key
+        #
+        #   @return [String, nil]
+        optional :key, String, nil?: true
+
+        # @!attribute options
+        #
+        #   @return [Array<String>, nil]
+        optional :options, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute question
+        #
+        #   @return [String, nil]
+        optional :question, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String, nil?: true
+
+        # @!method initialize(id: nil, answer: nil, key: nil, options: nil, question: nil, type: nil)
+        #   @param id [String, nil]
+        #   @param answer [String, nil]
+        #   @param key [String, nil]
+        #   @param options [Array<String>, nil]
+        #   @param question [String, nil]
+        #   @param type [String, nil]
+      end
+
+      # @see WhopSDK::Models::EventListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute city
+        #
+        #   @return [String, nil]
+        optional :city, String, nil?: true
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, nil?: true
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
+
+        # @!attribute state
+        #
+        #   @return [String, nil]
+        optional :state, String, nil?: true
+
+        # @!method initialize(city: nil, country: nil, email: nil, first_name: nil, last_name: nil, name: nil, phone: nil, state: nil)
+        #   @param city [String, nil]
+        #   @param country [String, nil]
+        #   @param email [String, nil]
+        #   @param first_name [String, nil]
+        #   @param last_name [String, nil]
+        #   @param name [String, nil]
+        #   @param phone [String, nil]
+        #   @param state [String, nil]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/experience.rb

@@ -151,7 +151,7 @@ module WhopSDK
         required :id, String
 
         # @!attribute route
-        #   The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @return [String]
         required :route, String
@@ -163,14 +163,11 @@ module WhopSDK
         required :title, String
 
         # @!method initialize(id:, route:, title:)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::Experience::Company} for more details.
-        #
         #   The company that owns this experience.
         #
         #   @param id [String] The unique identifier for the company.
         #
-        #   @param route [String] The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   @param route [String] URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @param title [String] The display name of the company shown to customers.
       end
@@ -202,8 +199,8 @@ module WhopSDK
         required :id, String
 
         # @!attribute route
-        #   The URL slug used in the product's public link (e.g., 'my-product' in
-        #   whop.com/company/my-product).
+        #   URL slug in the product's public link, e.g. `pickaxe-analytics` in
+        #   whop.com/company/pickaxe-analytics.
         #
         #   @return [String]
         required :route, String
@@ -224,7 +221,7 @@ module WhopSDK
         #
         #   @param id [String] The unique identifier for the product.
         #
-        #   @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
+        #   @param route [String] URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/comp
         #
         #   @param title [String] The display name of the product shown to customers on the product page and in se
       end

data/lib/whop_sdk/models/experience_list_response.rb

@@ -142,7 +142,7 @@ module WhopSDK
         required :id, String
 
         # @!attribute route
-        #   The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @return [String]
         required :route, String
@@ -154,14 +154,11 @@ module WhopSDK
         required :title, String
 
         # @!method initialize(id:, route:, title:)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::ExperienceListResponse::Company} for more details.
-        #
         #   The company that owns this experience.
         #
         #   @param id [String] The unique identifier for the company.
         #
-        #   @param route [String] The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   @param route [String] URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @param title [String] The display name of the company shown to customers.
       end

data/lib/whop_sdk/models/file_create_params.rb

@@ -18,8 +18,8 @@ module WhopSDK
       #   Controls whether an uploaded file is publicly accessible or requires
       #   authentication to access.
       #
-      #   @return [Symbol, WhopSDK::Models::FileCreateParams::Visibility, nil]
-      optional :visibility, enum: -> { WhopSDK::FileCreateParams::Visibility }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::FileVisibility, nil]
+      optional :visibility, enum: -> { WhopSDK::FileVisibility }, nil?: true
 
       # @!method initialize(filename:, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -27,21 +27,9 @@ module WhopSDK
       #
       #   @param filename [String] The name of the file including its extension (e.g., "photo.png" or "document.pdf
       #
-      #   @param visibility [Symbol, WhopSDK::Models::FileCreateParams::Visibility, nil] Controls whether an uploaded file is publicly accessible or requires authenticat
+      #   @param visibility [Symbol, WhopSDK::Models::FileVisibility, nil] Controls whether an uploaded file is publicly accessible or requires authenticat
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
-
-      # Controls whether an uploaded file is publicly accessible or requires
-      # authentication to access.
-      module Visibility
-        extend WhopSDK::Internal::Type::Enum
-
-        PUBLIC = :public
-        PRIVATE = :private
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/whop_sdk/models/file_create_response.rb

@@ -59,8 +59,8 @@ module WhopSDK
       # @!attribute visibility
       #   Whether the file is publicly accessible or requires authentication.
       #
-      #   @return [Symbol, WhopSDK::Models::FileCreateResponse::Visibility]
-      required :visibility, enum: -> { WhopSDK::Models::FileCreateResponse::Visibility }
+      #   @return [Symbol, WhopSDK::Models::FileVisibility]
+      required :visibility, enum: -> { WhopSDK::FileVisibility }
 
       # @!method initialize(id:, content_type:, filename:, size:, upload_headers:, upload_status:, upload_url:, url:, visibility:)
       #   Some parameter documentations has been truncated, see
@@ -84,20 +84,7 @@ module WhopSDK
       #
       #   @param url [String, nil] The URL for accessing the file. For public files, this is a permanent CDN URL. F
       #
-      #   @param visibility [Symbol, WhopSDK::Models::FileCreateResponse::Visibility] Whether the file is publicly accessible or requires authentication.
-
-      # Whether the file is publicly accessible or requires authentication.
-      #
-      # @see WhopSDK::Models::FileCreateResponse#visibility
-      module Visibility
-        extend WhopSDK::Internal::Type::Enum
-
-        PUBLIC = :public
-        PRIVATE = :private
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param visibility [Symbol, WhopSDK::Models::FileVisibility] Whether the file is publicly accessible or requires authentication.
     end
   end
 end

data/lib/whop_sdk/models/file_retrieve_response.rb

@@ -45,8 +45,8 @@ module WhopSDK
       # @!attribute visibility
       #   Whether the file is publicly accessible or requires authentication.
       #
-      #   @return [Symbol, WhopSDK::Models::FileRetrieveResponse::Visibility]
-      required :visibility, enum: -> { WhopSDK::Models::FileRetrieveResponse::Visibility }
+      #   @return [Symbol, WhopSDK::Models::FileVisibility]
+      required :visibility, enum: -> { WhopSDK::FileVisibility }
 
       # @!method initialize(id:, content_type:, filename:, size:, upload_status:, url:, visibility:)
       #   Some parameter documentations has been truncated, see
@@ -66,20 +66,7 @@ module WhopSDK
       #
       #   @param url [String, nil] The URL for accessing the file. For public files, this is a permanent CDN URL. F
       #
-      #   @param visibility [Symbol, WhopSDK::Models::FileRetrieveResponse::Visibility] Whether the file is publicly accessible or requires authentication.
-
-      # Whether the file is publicly accessible or requires authentication.
-      #
-      # @see WhopSDK::Models::FileRetrieveResponse#visibility
-      module Visibility
-        extend WhopSDK::Internal::Type::Enum
-
-        PUBLIC = :public
-        PRIVATE = :private
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param visibility [Symbol, WhopSDK::Models::FileVisibility] Whether the file is publicly accessible or requires authentication.
     end
   end
 end

data/lib/whop_sdk/models/file_visibility.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # Controls whether an uploaded file is publicly accessible or requires
+    # authentication to access.
+    module FileVisibility
+      extend WhopSDK::Internal::Type::Enum
+
+      PUBLIC = :public
+      PRIVATE = :private
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/financial_activity_list_params.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::FinancialActivity#list
+    class FinancialActivityListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute available_after
+      #   Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD`
+      #   settlement date (UTC), distinct from posted_at. Requires currency.
+      #
+      #   @return [Date, nil]
+      optional :available_after, Date
+
+      # @!attribute available_before
+      #   Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD`
+      #   settlement date (UTC). Set equal to available_after for a single day. Requires
+      #   currency.
+      #
+      #   @return [Date, nil]
+      optional :available_before, Date
+
+      # @!attribute currency
+      #   Optional currency code filter, for example `usd`.
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!attribute cursor
+      #   Cursor returned by the previous page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute include_owned_accounts
+      #   When true, aggregates the authenticated user's personal ledger with the
+      #   businesses they own (owner role with balance read) into one feed. Requires
+      #   user_id to be the authenticated user; cannot be combined with account_id or the
+      #   settlement-date filters. Each returned row includes the owning `account`.
+      #
+      #   @return [Boolean, nil]
+      optional :include_owned_accounts, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute limit
+      #   Maximum number of rows to return.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute line_types
+      #   Optional ledger line categories to include. Some categories (for example
+      #   `onchain_deposit`, which covers inbound crypto deposits such as MoonPay onramps)
+      #   are only returned when explicitly requested here.
+      #
+      #   @return [Array<String>, nil]
+      optional :line_types, WhopSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute posted_after
+      #   Only include rows posted after this ISO 8601 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :posted_after, Time
+
+      # @!attribute posted_before
+      #   Only include rows posted before this ISO 8601 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :posted_before, Time
+
+      # @!attribute user_id
+      #   The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(account_id: nil, available_after: nil, available_before: nil, currency: nil, cursor: nil, include_owned_accounts: nil, limit: nil, line_types: nil, posted_after: nil, posted_before: nil, user_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::FinancialActivityListParams} for more details.
+      #
+      #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @param available_after [Date] Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD`
+      #
+      #   @param available_before [Date] Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD`
+      #
+      #   @param currency [String] Optional currency code filter, for example `usd`.
+      #
+      #   @param cursor [String] Cursor returned by the previous page.
+      #
+      #   @param include_owned_accounts [Boolean] When true, aggregates the authenticated user's personal ledger with the business
+      #
+      #   @param limit [Integer] Maximum number of rows to return.
+      #
+      #   @param line_types [Array<String>] Optional ledger line categories to include. Some categories (for example `onchai
+      #
+      #   @param posted_after [Time] Only include rows posted after this ISO 8601 timestamp.
+      #
+      #   @param posted_before [Time] Only include rows posted before this ISO 8601 timestamp.
+      #
+      #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end