whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/ad_list_params.rb

@@ -7,105 +7,190 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute ad_group_id
-      #   Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
-      #   company_id.
+      # @!attribute account_id
+      #   The account the ads belong to. Defaults to the account-scoped key's own account.
       #
       #   @return [String, nil]
-      optional :ad_group_id, String, nil?: true
+      optional :account_id, String
 
-      # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      # @!attribute ad_campaign_id
+      #   Only return ads in this ad campaign.
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
+      optional :ad_campaign_id, String
 
-      # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
+      # @!attribute ad_group_id
+      #   Only return ads in this ad group.
       #
       #   @return [String, nil]
-      optional :before, String, nil?: true
+      optional :ad_group_id, String
 
-      # @!attribute campaign_id
-      #   Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
-      #   company_id.
+      # @!attribute after
+      #   Cursor to fetch the page after (from page_info.end_cursor).
       #
       #   @return [String, nil]
-      optional :campaign_id, String, nil?: true
+      optional :after, String
 
-      # @!attribute company_id
-      #   Filter by company. Provide exactly one of ad_group_id, campaign_id, or
-      #   company_id.
+      # @!attribute before
+      #   Cursor to fetch the page before (from page_info.start_cursor).
       #
       #   @return [String, nil]
-      optional :company_id, String, nil?: true
+      optional :before, String
 
       # @!attribute created_after
       #   Only return ads created after this timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_after, Time, nil?: true
+      #   @return [String, nil]
+      optional :created_after, String
 
       # @!attribute created_before
       #   Only return ads created before this timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_before, Time, nil?: true
+      #   @return [String, nil]
+      optional :created_before, String
+
+      # @!attribute direction
+      #   The sort direction. Defaults to desc.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::AdListParams::Direction }
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   The number of ads to return.
       #
       #   @return [Integer, nil]
-      optional :first, Integer, nil?: true
+      optional :first, Integer
 
       # @!attribute last
-      #   Returns the last _n_ elements from the list.
+      #   The number of ads to return from the end of the range.
       #
       #   @return [Integer, nil]
-      optional :last, Integer, nil?: true
+      optional :last, Integer
+
+      # @!attribute order
+      #   The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
+      #   …) rank over the stats_from/stats_to window across the whole list, not just the
+      #   current page. results, cost_per_result and return_on_ad_spend rank by the same
+      #   Whop pixel-attributed values the response reports.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::AdListParams::Order }
+
+      # @!attribute query
+      #   Filter ads by a title or ID substring.
+      #
+      #   @return [String, nil]
+      optional :query, String
+
+      # @!attribute stats_from
+      #   Start of the stats window. Defaults to all-time.
+      #
+      #   @return [String, nil]
+      optional :stats_from, String
+
+      # @!attribute stats_to
+      #   End of the stats window. Defaults to now.
+      #
+      #   @return [String, nil]
+      optional :stats_to, String
 
       # @!attribute status
-      #   The status of an external ad.
+      #   Only return ads with this status.
       #
       #   @return [Symbol, WhopSDK::Models::AdListParams::Status, nil]
-      optional :status, enum: -> { WhopSDK::AdListParams::Status }, nil?: true
+      optional :status, enum: -> { WhopSDK::AdListParams::Status }
 
-      # @!method initialize(ad_group_id: nil, after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, status: nil, request_options: {})
+      # @!attribute time_zone
+      #   IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare
+      #   stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to
+      #   UTC.
+      #
+      #   @return [String, nil]
+      optional :time_zone, String
+
+      # @!method initialize(account_id: nil, ad_campaign_id: nil, ad_group_id: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, stats_from: nil, stats_to: nil, status: nil, time_zone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::AdListParams} for more details.
       #
-      #   @param ad_group_id [String, nil] Filter by ad group. Provide exactly one of ad*group_id, campaign_id, or company*
+      #   @param account_id [String] The account the ads belong to. Defaults to the account-scoped key's own account.
+      #
+      #   @param ad_campaign_id [String] Only return ads in this ad campaign.
+      #
+      #   @param ad_group_id [String] Only return ads in this ad group.
+      #
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @param created_after [String] Only return ads created after this timestamp.
       #
-      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #   @param created_before [String] Only return ads created before this timestamp.
       #
-      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #   @param direction [Symbol, WhopSDK::Models::AdListParams::Direction] The sort direction. Defaults to desc.
       #
-      #   @param campaign_id [String, nil] Filter by campaign. Provide exactly one of ad*group_id, campaign_id, or company*
+      #   @param first [Integer] The number of ads to return.
       #
-      #   @param company_id [String, nil] Filter by company. Provide exactly one of ad_group_id, campaign_id, or company_i
+      #   @param last [Integer] The number of ads to return from the end of the range.
       #
-      #   @param created_after [Time, nil] Only return ads created after this timestamp.
+      #   @param order [Symbol, WhopSDK::Models::AdListParams::Order] The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
       #
-      #   @param created_before [Time, nil] Only return ads created before this timestamp.
+      #   @param query [String] Filter ads by a title or ID substring.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param stats_from [String] Start of the stats window. Defaults to all-time.
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #   @param stats_to [String] End of the stats window. Defaults to now.
       #
-      #   @param status [Symbol, WhopSDK::Models::AdListParams::Status, nil] The status of an external ad.
+      #   @param status [Symbol, WhopSDK::Models::AdListParams::Status] Only return ads with this status.
+      #
+      #   @param time_zone [String] IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare s
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      # The status of an external ad.
+      # The sort direction. Defaults to desc.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
+      # …) rank over the stats_from/stats_to window across the whole list, not just the
+      # current page. results, cost_per_result and return_on_ad_spend rank by the same
+      # Whop pixel-attributed values the response reports.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        UPDATED_AT = :updated_at
+        SPEND = :spend
+        IMPRESSIONS = :impressions
+        REACH = :reach
+        CLICKS = :clicks
+        UNIQUE_CLICKS = :unique_clicks
+        FREQUENCY = :frequency
+        CLICK_THROUGH_RATE = :click_through_rate
+        RESULTS = :results
+        COST_PER_MILLE = :cost_per_mille
+        COST_PER_CLICK = :cost_per_click
+        COST_PER_RESULT = :cost_per_result
+        RETURN_ON_AD_SPEND = :return_on_ad_spend
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Only return ads with this status.
       module Status
         extend WhopSDK::Internal::Type::Enum
 
         ACTIVE = :active
         PAUSED = :paused
-        INACTIVE = :inactive
         IN_REVIEW = :in_review
         REJECTED = :rejected
-        FLAGGED = :flagged
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/ad_pause_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Ads#pause
+    class AdPauseParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/ad_report_retrieve_params.rb

@@ -19,26 +19,40 @@ module WhopSDK
       #   @return [Time]
       required :to, Time
 
-      # @!attribute ad_campaign_id
-      #   The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
-      #   `adId`.
+      # @!attribute ad_campaign_ids
+      #   Scope the report to these ad campaigns (max 100); stats are summed across them.
+      #   Mutually exclusive with `companyId`, `adGroupIds`, and `adIds`.
       #
-      #   @return [String, nil]
-      optional :ad_campaign_id, String, nil?: true
+      #   @return [Array<String>, nil]
+      optional :ad_campaign_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!attribute ad_group_id
-      #   The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
-      #   `adId`.
+      # @!attribute ad_group_ids
+      #   Scope the report to these ad groups (max 100); stats are summed across them.
+      #   Mutually exclusive with `companyId`, `adCampaignIds`, and `adIds`.
       #
-      #   @return [String, nil]
-      optional :ad_group_id, String, nil?: true
+      #   @return [Array<String>, nil]
+      optional :ad_group_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute ad_ids
+      #   Scope the report to these ads (max 100); stats are summed across them. Mutually
+      #   exclusive with `companyId`, `adCampaignIds`, and `adGroupIds`.
+      #
+      #   @return [Array<String>, nil]
+      optional :ad_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute breakdown
+      #   Entity level to group an ad report by.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdReportRetrieveParams::Breakdown, nil]
+      optional :breakdown, enum: -> { WhopSDK::AdReportRetrieveParams::Breakdown }, nil?: true
 
-      # @!attribute ad_id
-      #   The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
-      #   `adGroupId`.
+      # @!attribute company_id
+      #   The unique identifier of a company. Mutually exclusive with `adCampaignIds`,
+      #   `adGroupIds`, and `adIds`. Use with `breakdown` to fan out across every
+      #   campaign, ad group, or ad in the company without paging.
       #
       #   @return [String, nil]
-      optional :ad_id, String, nil?: true
+      optional :company_id, String, nil?: true
 
       # @!attribute currency
       #   ISO 4217 currency code to report `spend` in. Defaults to the company's ads
@@ -47,13 +61,13 @@ module WhopSDK
       #   @return [String, nil]
       optional :currency, String, nil?: true
 
-      # @!attribute include_daily
-      #   When true, includes a per-day breakdown alongside the summary.
+      # @!attribute granularity
+      #   Bucket size for external ad stat rows.
       #
-      #   @return [Boolean, nil]
-      optional :include_daily, WhopSDK::Internal::Type::Boolean, nil?: true
+      #   @return [Symbol, WhopSDK::Models::Granularities, nil]
+      optional :granularity, enum: -> { WhopSDK::Granularities }, nil?: true
 
-      # @!method initialize(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, currency: nil, include_daily: nil, request_options: {})
+      # @!method initialize(from:, to:, ad_campaign_ids: nil, ad_group_ids: nil, ad_ids: nil, breakdown: nil, company_id: nil, currency: nil, granularity: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::AdReportRetrieveParams} for more details.
       #
@@ -61,17 +75,33 @@ module WhopSDK
       #
       #   @param to [Time] Inclusive end of the reporting window.
       #
-      #   @param ad_campaign_id [String, nil] The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
+      #   @param ad_campaign_ids [Array<String>, nil] Scope the report to these ad campaigns (max 100); stats are summed across them.
       #
-      #   @param ad_group_id [String, nil] The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+      #   @param ad_group_ids [Array<String>, nil] Scope the report to these ad groups (max 100); stats are summed across them. Mut
       #
-      #   @param ad_id [String, nil] The unique identifier of an ad. Mutually exclusive with `adCampaignId` and `adGr
+      #   @param ad_ids [Array<String>, nil] Scope the report to these ads (max 100); stats are summed across them. Mutually
+      #
+      #   @param breakdown [Symbol, WhopSDK::Models::AdReportRetrieveParams::Breakdown, nil] Entity level to group an ad report by.
+      #
+      #   @param company_id [String, nil] The unique identifier of a company. Mutually exclusive with `adCampaignIds`, `ad
       #
       #   @param currency [String, nil] ISO 4217 currency code to report `spend` in. Defaults to the company's ads repor
       #
-      #   @param include_daily [Boolean, nil] When true, includes a per-day breakdown alongside the summary.
+      #   @param granularity [Symbol, WhopSDK::Models::Granularities, nil] Bucket size for external ad stat rows.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Entity level to group an ad report by.
+      module Breakdown
+        extend WhopSDK::Internal::Type::Enum
+
+        CAMPAIGN = :campaign
+        AD_GROUP = :ad_group
+        AD = :ad
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end