whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/ad_campaign_create_params.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdCampaigns#create
+    class AdCampaignCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute objective
+      #   The goal the campaign optimizes toward.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignCreateParams::Objective]
+      required :objective, enum: -> { WhopSDK::AdCampaignCreateParams::Objective }
+
+      # @!attribute platform
+      #   The ad network the campaign runs on.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignCreateParams::Platform]
+      required :platform, enum: -> { WhopSDK::AdCampaignCreateParams::Platform }
+
+      # @!attribute title
+      #   The title of the campaign.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute account_id
+      #   The account to create the campaign under. Defaults to the account-scoped key's
+      #   own account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute bid_type
+      #   CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      #   maximum_target (bid cap). CBO only.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignCreateParams::BidType, nil]
+      optional :bid_type, enum: -> { WhopSDK::AdCampaignCreateParams::BidType }
+
+      # @!attribute budget_amount
+      #   The campaign budget, in USD. Required for CBO (budget_optimization:
+      #   ad_campaign); omit for ABO.
+      #
+      #   @return [Float, nil]
+      optional :budget_amount, Float
+
+      # @!attribute budget_optimization
+      #   Which level owns the budget — the campaign (CBO) or each ad group (ABO).
+      #   Defaults to ad_group.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetOptimization, nil]
+      optional :budget_optimization, enum: -> { WhopSDK::AdCampaignCreateParams::BudgetOptimization }
+
+      # @!attribute budget_type
+      #   Whether the budget is spent per day or over the campaign's lifetime. Defaults to
+      #   daily.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetType, nil]
+      optional :budget_type, enum: -> { WhopSDK::AdCampaignCreateParams::BudgetType }
+
+      # @!attribute desired_cost_per_result
+      #   Target/cap cost per result in USD for average_target / maximum_target bidding.
+      #   CBO only.
+      #
+      #   @return [Float, nil]
+      optional :desired_cost_per_result, Float
+
+      # @!attribute ends_at
+      #   Campaign schedule end (ISO 8601). CBO only.
+      #
+      #   @return [String, nil]
+      optional :ends_at, String
+
+      # @!attribute special_ad_categories
+      #   Regulated categories the campaign falls under. Ads in these categories are
+      #   subject to extra targeting restrictions.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::AdCampaignCreateParams::SpecialAdCategory>, nil]
+      optional :special_ad_categories,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdCampaignCreateParams::SpecialAdCategory] }
+
+      # @!attribute starts_at
+      #   Campaign schedule start (ISO 8601). CBO only.
+      #
+      #   @return [String, nil]
+      optional :starts_at, String
+
+      # @!method initialize(objective:, platform:, title:, account_id: nil, bid_type: nil, budget_amount: nil, budget_optimization: nil, budget_type: nil, desired_cost_per_result: nil, ends_at: nil, special_ad_categories: nil, starts_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AdCampaignCreateParams} for more details.
+      #
+      #   @param objective [Symbol, WhopSDK::Models::AdCampaignCreateParams::Objective] The goal the campaign optimizes toward.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdCampaignCreateParams::Platform] The ad network the campaign runs on.
+      #
+      #   @param title [String] The title of the campaign.
+      #
+      #   @param account_id [String] The account to create the campaign under. Defaults to the account-scoped key's o
+      #
+      #   @param bid_type [Symbol, WhopSDK::Models::AdCampaignCreateParams::BidType] CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maxi
+      #
+      #   @param budget_amount [Float] The campaign budget, in USD. Required for CBO (budget_optimization: ad_campaign)
+      #
+      #   @param budget_optimization [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetOptimization] Which level owns the budget — the campaign (CBO) or each ad group (ABO). Default
+      #
+      #   @param budget_type [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetType] Whether the budget is spent per day or over the campaign's lifetime. Defaults to
+      #
+      #   @param desired_cost_per_result [Float] Target/cap cost per result in USD for average_target / maximum_target bidding. C
+      #
+      #   @param ends_at [String] Campaign schedule end (ISO 8601). CBO only.
+      #
+      #   @param special_ad_categories [Array<Symbol, WhopSDK::Models::AdCampaignCreateParams::SpecialAdCategory>] Regulated categories the campaign falls under. Ads in these categories are subje
+      #
+      #   @param starts_at [String] Campaign schedule start (ISO 8601). CBO only.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The goal the campaign optimizes toward.
+      module Objective
+        extend WhopSDK::Internal::Type::Enum
+
+        AWARENESS = :awareness
+        TRAFFIC = :traffic
+        ENGAGEMENT = :engagement
+        LEADS = :leads
+        SALES = :sales
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The ad network the campaign runs on.
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        META = :meta
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      # maximum_target (bid cap). CBO only.
+      module BidType
+        extend WhopSDK::Internal::Type::Enum
+
+        MINIMUM_COST = :minimum_cost
+        AVERAGE_TARGET = :average_target
+        MAXIMUM_TARGET = :maximum_target
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Which level owns the budget — the campaign (CBO) or each ad group (ABO).
+      # Defaults to ad_group.
+      module BudgetOptimization
+        extend WhopSDK::Internal::Type::Enum
+
+        AD_CAMPAIGN = :ad_campaign
+        AD_GROUP = :ad_group
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Whether the budget is spent per day or over the campaign's lifetime. Defaults to
+      # daily.
+      module BudgetType
+        extend WhopSDK::Internal::Type::Enum
+
+        DAILY = :daily
+        LIFETIME = :lifetime
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SpecialAdCategory
+        extend WhopSDK::Internal::Type::Enum
+
+        HOUSING = :housing
+        EMPLOYMENT = :employment
+        FINANCIAL_PRODUCTS = :financial_products
+        POLITICS = :politics
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/{payout_method_retrieve_params.rb → ad_campaign_delete_params.rb}

@@ -2,8 +2,8 @@
 
 module WhopSDK
   module Models
-    # @see WhopSDK::Resources::PayoutMethods#retrieve
-    class PayoutMethodRetrieveParams < WhopSDK::Internal::Type::BaseModel
+    # @see WhopSDK::Resources::AdCampaigns#delete
+    class AdCampaignDeleteParams < WhopSDK::Internal::Type::BaseModel
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 

data/lib/whop_sdk/models/ad_campaign_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    AdCampaignDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/ad_campaign_list_params.rb

@@ -7,91 +7,175 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute company_id
-      #   The unique identifier of the company to list ad campaigns for.
+      # @!attribute account_id
+      #   The account the campaigns belong to. Defaults to the account-scoped key's own
+      #   account.
       #
-      #   @return [String]
-      required :company_id, String
+      #   @return [String, nil]
+      optional :account_id, String
 
       # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      #   Cursor to fetch the page after (from page_info.end_cursor).
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
+      optional :after, String
 
       # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
+      #   Cursor to fetch the page before (from page_info.start_cursor).
       #
       #   @return [String, nil]
-      optional :before, String, nil?: true
+      optional :before, String
 
       # @!attribute created_after
-      #   Only return ad campaigns created after this timestamp.
+      #   Only return campaigns 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 ad campaigns created before this timestamp.
+      #   Only return campaigns created before this timestamp.
+      #
+      #   @return [String, nil]
+      optional :created_before, String
+
+      # @!attribute direction
+      #   The sort direction. Defaults to desc.
       #
-      #   @return [Time, nil]
-      optional :created_before, Time, nil?: true
+      #   @return [Symbol, WhopSDK::Models::AdCampaignListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::AdCampaignListParams::Direction }
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   The number of campaigns 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 campaigns 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::AdCampaignListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::AdCampaignListParams::Order }
 
       # @!attribute query
-      #   Case-insensitive substring match against the campaign title.
+      #   Filter campaigns by a title or ID substring.
       #
       #   @return [String, nil]
-      optional :query, String, nil?: true
+      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 ad campaign.
+      #   Only return campaigns with this status.
       #
       #   @return [Symbol, WhopSDK::Models::AdCampaignListParams::Status, nil]
-      optional :status, enum: -> { WhopSDK::AdCampaignListParams::Status }, nil?: true
+      optional :status, enum: -> { WhopSDK::AdCampaignListParams::Status }
+
+      # @!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(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
-      #   @param company_id [String] The unique identifier of the company to list ad campaigns for.
+      # @!method initialize(account_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::AdCampaignListParams} for more details.
+      #
+      #   @param account_id [String] The account the campaigns belong to. Defaults to the account-scoped key's own ac
+      #
+      #   @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 campaigns 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 campaigns 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::AdCampaignListParams::Direction] The sort direction. Defaults to desc.
       #
-      #   @param created_after [Time, nil] Only return ad campaigns created after this timestamp.
+      #   @param first [Integer] The number of campaigns to return.
       #
-      #   @param created_before [Time, nil] Only return ad campaigns created before this timestamp.
+      #   @param last [Integer] The number of campaigns to return from the end of the range.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param order [Symbol, WhopSDK::Models::AdCampaignListParams::Order] The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #   @param query [String] Filter campaigns by a title or ID substring.
       #
-      #   @param query [String, nil] Case-insensitive substring match against the campaign title.
+      #   @param stats_from [String] Start of the stats window. Defaults to all-time.
       #
-      #   @param status [Symbol, WhopSDK::Models::AdCampaignListParams::Status, nil] The status of an ad campaign.
+      #   @param stats_to [String] End of the stats window. Defaults to now.
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdCampaignListParams::Status] Only return campaigns 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 ad campaign.
+      # 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 campaigns with this status.
       module Status
         extend WhopSDK::Internal::Type::Enum
 
+        DRAFT = :draft
         ACTIVE = :active
         PAUSED = :paused
         PAYMENT_FAILED = :payment_failed
-        DRAFT = :draft
-        IN_REVIEW = :in_review
-        FLAGGED = :flagged
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb

@@ -12,8 +12,33 @@ module WhopSDK
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute stats_from
+      #   Start of the stats window.
+      #
+      #   @return [String, nil]
+      optional :stats_from, String
+
+      # @!attribute stats_to
+      #   End of the stats window.
+      #
+      #   @return [String, nil]
+      optional :stats_to, String
+
+      # @!attribute time_zone
+      #   IANA timezone the stats window is interpreted in. Defaults to UTC.
+      #
+      #   @return [String, nil]
+      optional :time_zone, String
+
+      # @!method initialize(id:, stats_from: nil, stats_to: nil, time_zone: nil, request_options: {})
       #   @param id [String]
+      #
+      #   @param stats_from [String] Start of the stats window.
+      #
+      #   @param stats_to [String] End of the stats window.
+      #
+      #   @param time_zone [String] IANA timezone the stats window is interpreted in. Defaults to UTC.
+      #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/whop_sdk/models/ad_campaign_update_params.rb

@@ -12,22 +12,115 @@ module WhopSDK
       #   @return [String]
       required :id, String
 
-      # @!attribute budget
-      #   The campaign budget in dollars. The interpretation (daily or lifetime) follows
-      #   the campaign's existing budget type.
+      # @!attribute bid_type
+      #   CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      #   maximum_target (bid cap). Switching to minimum_cost clears the cap amounts
+      #   stored on the campaign's ad groups. CBO only.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BidType, nil]
+      optional :bid_type, enum: -> { WhopSDK::AdCampaignUpdateParams::BidType }
+
+      # @!attribute budget_amount
+      #   The campaign budget, in the account's currency. Interpreted as daily or lifetime
+      #   per the campaign's existing budget type.
       #
       #   @return [Float, nil]
-      optional :budget, Float, nil?: true
+      optional :budget_amount, Float
+
+      # @!attribute budget_optimization
+      #   Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only
+      #   changeable before the campaign is live on Meta; switching to ad_campaign
+      #   requires budget_amount in the same request, and switching to ad_group clears the
+      #   campaign budget.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BudgetOptimization, nil]
+      optional :budget_optimization, enum: -> { WhopSDK::AdCampaignUpdateParams::BudgetOptimization }
+
+      # @!attribute ends_at
+      #   Campaign schedule end (ISO 8601). CBO only.
+      #
+      #   @return [String, nil]
+      optional :ends_at, String
+
+      # @!attribute starts_at
+      #   Campaign schedule start (ISO 8601). CBO only.
+      #
+      #   @return [String, nil]
+      optional :starts_at, String
+
+      # @!attribute status
+      #   Set to active to launch a draft campaign (moderates and pushes it live).
+      #   Live-campaign pause and resume use the pause and unpause actions.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignUpdateParams::Status, nil]
+      optional :status, enum: -> { WhopSDK::AdCampaignUpdateParams::Status }
 
-      # @!method initialize(id:, budget: nil, request_options: {})
+      # @!attribute title
+      #   The name of the campaign.
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(id:, bid_type: nil, budget_amount: nil, budget_optimization: nil, ends_at: nil, starts_at: nil, status: nil, title: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::AdCampaignUpdateParams} for more details.
       #
       #   @param id [String]
       #
-      #   @param budget [Float, nil] The campaign budget in dollars. The interpretation (daily or lifetime) follows t
+      #   @param bid_type [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BidType] CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maxi
+      #
+      #   @param budget_amount [Float] The campaign budget, in the account's currency. Interpreted as daily or lifetime
+      #
+      #   @param budget_optimization [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BudgetOptimization] Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only ch
+      #
+      #   @param ends_at [String] Campaign schedule end (ISO 8601). CBO only.
+      #
+      #   @param starts_at [String] Campaign schedule start (ISO 8601). CBO only.
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdCampaignUpdateParams::Status] Set to active to launch a draft campaign (moderates and pushes it live). Live-ca
+      #
+      #   @param title [String] The name of the campaign.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      # maximum_target (bid cap). Switching to minimum_cost clears the cap amounts
+      # stored on the campaign's ad groups. CBO only.
+      module BidType
+        extend WhopSDK::Internal::Type::Enum
+
+        MINIMUM_COST = :minimum_cost
+        AVERAGE_TARGET = :average_target
+        MAXIMUM_TARGET = :maximum_target
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only
+      # changeable before the campaign is live on Meta; switching to ad_campaign
+      # requires budget_amount in the same request, and switching to ad_group clears the
+      # campaign budget.
+      module BudgetOptimization
+        extend WhopSDK::Internal::Type::Enum
+
+        AD_CAMPAIGN = :ad_campaign
+        AD_GROUP = :ad_group
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Set to active to launch a draft campaign (moderates and pushes it live).
+      # Live-campaign pause and resume use the pause and unpause actions.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end