whop_sdk 0.0.37 → 0.0.39

data/lib/whop_sdk/models/ad_campaign_list_response.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdCampaigns#list
+    class AdCampaignListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for this ad campaign.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute budget
+      #   Total budget in dollars.
+      #
+      #   @return [Float, nil]
+      required :budget, Float, nil?: true
+
+      # @!attribute budget_type
+      #   The budget type for an ad campaign or ad group.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignListResponse::BudgetType, nil]
+      required :budget_type, enum: -> { WhopSDK::Models::AdCampaignListResponse::BudgetType }, nil?: true
+
+      # @!attribute created_at
+      #   When the ad campaign was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute platform
+      #   The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignListResponse::Platform]
+      required :platform, enum: -> { WhopSDK::Models::AdCampaignListResponse::Platform }
+
+      # @!attribute status
+      #   Current status of the campaign (active, paused, or inactive).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignListResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::AdCampaignListResponse::Status }
+
+      # @!attribute title
+      #   The campaign name shown in the Whop dashboard.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute total_spend
+      #   Total amount spent in dollars.
+      #
+      #   @return [Float]
+      required :total_spend, Float
+
+      # @!attribute updated_at
+      #   When the ad campaign was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, budget:, budget_type:, created_at:, platform:, status:, title:, total_spend:, updated_at:)
+      #   An advertising campaign running on an external platform or within Whop.
+      #
+      #   @param id [String] The unique identifier for this ad campaign.
+      #
+      #   @param budget [Float, nil] Total budget in dollars.
+      #
+      #   @param budget_type [Symbol, WhopSDK::Models::AdCampaignListResponse::BudgetType, nil] The budget type for an ad campaign or ad group.
+      #
+      #   @param created_at [Time] When the ad campaign was created.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdCampaignListResponse::Platform] The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdCampaignListResponse::Status] Current status of the campaign (active, paused, or inactive).
+      #
+      #   @param title [String] The campaign name shown in the Whop dashboard.
+      #
+      #   @param total_spend [Float] Total amount spent in dollars.
+      #
+      #   @param updated_at [Time] When the ad campaign was last updated.
+
+      # The budget type for an ad campaign or ad group.
+      #
+      # @see WhopSDK::Models::AdCampaignListResponse#budget_type
+      module BudgetType
+        extend WhopSDK::Internal::Type::Enum
+
+        DAILY = :daily
+        LIFETIME = :lifetime
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      # @see WhopSDK::Models::AdCampaignListResponse#platform
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        META = :meta
+        TIKTOK = :tiktok
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current status of the campaign (active, paused, or inactive).
+      #
+      # @see WhopSDK::Models::AdCampaignListResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAUSED = :paused
+        PAYMENT_FAILED = :payment_failed
+        DRAFT = :draft
+        IN_REVIEW = :in_review
+        FLAGGED = :flagged
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_campaign_pause_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdCampaigns#pause
+    class AdCampaignPauseParams < 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_campaign_pause_response.rb

@@ -0,0 +1,328 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdCampaigns#pause
+    class AdCampaignPauseResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for this ad campaign.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute budget
+      #   Total budget in dollars.
+      #
+      #   @return [Float, nil]
+      required :budget, Float, nil?: true
+
+      # @!attribute budget_type
+      #   The budget type for an ad campaign or ad group.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::BudgetType, nil]
+      required :budget_type, enum: -> { WhopSDK::Models::AdCampaignPauseResponse::BudgetType }, nil?: true
+
+      # @!attribute created_at
+      #   When the ad campaign was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute created_by_user
+      #   The user who created this ad campaign.
+      #
+      #   @return [WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser]
+      required :created_by_user, -> { WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser }
+
+      # @!attribute meta_config
+      #   Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+      #   non-Meta campaigns.
+      #
+      #   @return [WhopSDK::Models::AdCampaignPauseResponse::MetaConfig, nil]
+      required :meta_config, -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig }, nil?: true
+
+      # @!attribute platform
+      #   The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::Platform]
+      required :platform, enum: -> { WhopSDK::Models::AdCampaignPauseResponse::Platform }
+
+      # @!attribute status
+      #   Current status of the campaign (active, paused, or inactive).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::AdCampaignPauseResponse::Status }
+
+      # @!attribute title
+      #   The campaign name shown in the Whop dashboard.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute total_spend
+      #   Total amount spent in dollars.
+      #
+      #   @return [Float]
+      required :total_spend, Float
+
+      # @!attribute updated_at
+      #   When the ad campaign was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, budget:, budget_type:, created_at:, created_by_user:, meta_config:, platform:, status:, title:, total_spend:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AdCampaignPauseResponse} for more details.
+      #
+      #   An advertising campaign running on an external platform or within Whop.
+      #
+      #   @param id [String] The unique identifier for this ad campaign.
+      #
+      #   @param budget [Float, nil] Total budget in dollars.
+      #
+      #   @param budget_type [Symbol, WhopSDK::Models::AdCampaignPauseResponse::BudgetType, nil] The budget type for an ad campaign or ad group.
+      #
+      #   @param created_at [Time] When the ad campaign was created.
+      #
+      #   @param created_by_user [WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser] The user who created this ad campaign.
+      #
+      #   @param meta_config [WhopSDK::Models::AdCampaignPauseResponse::MetaConfig, nil] Meta-specific campaign configuration (objective, budget mode, etc.). Null for no
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdCampaignPauseResponse::Platform] The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdCampaignPauseResponse::Status] Current status of the campaign (active, paused, or inactive).
+      #
+      #   @param title [String] The campaign name shown in the Whop dashboard.
+      #
+      #   @param total_spend [Float] Total amount spent in dollars.
+      #
+      #   @param updated_at [Time] When the ad campaign was last updated.
+
+      # The budget type for an ad campaign or ad group.
+      #
+      # @see WhopSDK::Models::AdCampaignPauseResponse#budget_type
+      module BudgetType
+        extend WhopSDK::Internal::Type::Enum
+
+        DAILY = :daily
+        LIFETIME = :lifetime
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::AdCampaignPauseResponse#created_by_user
+      class CreatedByUser < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The user's display name shown on their public profile.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The user's unique username shown on their public profile.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user who created this ad campaign.
+        #
+        #   @param id [String] The unique identifier for the user.
+        #
+        #   @param name [String, nil] The user's display name shown on their public profile.
+        #
+        #   @param username [String] The user's unique username shown on their public profile.
+      end
+
+      # @see WhopSDK::Models::AdCampaignPauseResponse#meta_config
+      class MetaConfig < WhopSDK::Internal::Type::BaseModel
+        # @!attribute bid_amount
+        #   Bid cap amount in cents. Only used when bid_strategy is bid_cap.
+        #
+        #   @return [Integer, nil]
+        required :bid_amount, Integer, nil?: true
+
+        # @!attribute bid_strategy
+        #   The bidding strategy used to optimize spend for this campaign.
+        #
+        #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::BidStrategy, nil]
+        required :bid_strategy,
+                 enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::BidStrategy },
+                 nil?: true
+
+        # @!attribute budget_optimization
+        #   Whether campaign budget optimization (CBO) is enabled, allowing the platform to
+        #   distribute budget across ad groups.
+        #
+        #   @return [Boolean, nil]
+        required :budget_optimization, WhopSDK::Internal::Type::Boolean, nil?: true
+
+        # @!attribute effective_status
+        #   The actual delivery status, accounting for platform overrides (e.g., in_review,
+        #   rejected).
+        #
+        #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::EffectiveStatus, nil]
+        required :effective_status,
+                 enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::EffectiveStatus },
+                 nil?: true
+
+        # @!attribute end_time
+        #   The scheduled end time of the campaign (ISO8601).
+        #
+        #   @return [String, nil]
+        required :end_time, String, nil?: true
+
+        # @!attribute objective
+        #   The campaign objective that determines how Meta optimizes delivery.
+        #
+        #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Objective, nil]
+        required :objective,
+                 enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Objective },
+                 nil?: true
+
+        # @!attribute special_categories
+        #   Special ad categories required by the platform (e.g., housing, employment,
+        #   credit).
+        #
+        #   @return [Array<String>, nil]
+        required :special_categories, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute start_time
+        #   The scheduled start time of the campaign (ISO8601).
+        #
+        #   @return [String, nil]
+        required :start_time, String, nil?: true
+
+        # @!attribute status
+        #   The campaign status as set by the advertiser (active or paused).
+        #
+        #   @return [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Status, nil]
+        required :status, enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Status }, nil?: true
+
+        # @!method initialize(bid_amount:, bid_strategy:, budget_optimization:, effective_status:, end_time:, objective:, special_categories:, start_time:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::AdCampaignPauseResponse::MetaConfig} for more details.
+        #
+        #   Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+        #   non-Meta campaigns.
+        #
+        #   @param bid_amount [Integer, nil] Bid cap amount in cents. Only used when bid_strategy is bid_cap.
+        #
+        #   @param bid_strategy [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::BidStrategy, nil] The bidding strategy used to optimize spend for this campaign.
+        #
+        #   @param budget_optimization [Boolean, nil] Whether campaign budget optimization (CBO) is enabled, allowing the platform to
+        #
+        #   @param effective_status [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::EffectiveStatus, nil] The actual delivery status, accounting for platform overrides (e.g., in_review,
+        #
+        #   @param end_time [String, nil] The scheduled end time of the campaign (ISO8601).
+        #
+        #   @param objective [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Objective, nil] The campaign objective that determines how Meta optimizes delivery.
+        #
+        #   @param special_categories [Array<String>, nil] Special ad categories required by the platform (e.g., housing, employment, credi
+        #
+        #   @param start_time [String, nil] The scheduled start time of the campaign (ISO8601).
+        #
+        #   @param status [Symbol, WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Status, nil] The campaign status as set by the advertiser (active or paused).
+
+        # The bidding strategy used to optimize spend for this campaign.
+        #
+        # @see WhopSDK::Models::AdCampaignPauseResponse::MetaConfig#bid_strategy
+        module BidStrategy
+          extend WhopSDK::Internal::Type::Enum
+
+          LOWEST_COST = :lowest_cost
+          BID_CAP = :bid_cap
+          COST_CAP = :cost_cap
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The actual delivery status, accounting for platform overrides (e.g., in_review,
+        # rejected).
+        #
+        # @see WhopSDK::Models::AdCampaignPauseResponse::MetaConfig#effective_status
+        module EffectiveStatus
+          extend WhopSDK::Internal::Type::Enum
+
+          ACTIVE = :active
+          PAUSED = :paused
+          DELETED = :deleted
+          IN_REVIEW = :in_review
+          REJECTED = :rejected
+          WITH_ISSUES = :with_issues
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The campaign objective that determines how Meta optimizes delivery.
+        #
+        # @see WhopSDK::Models::AdCampaignPauseResponse::MetaConfig#objective
+        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 campaign status as set by the advertiser (active or paused).
+        #
+        # @see WhopSDK::Models::AdCampaignPauseResponse::MetaConfig#status
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          ACTIVE = :active
+          PAUSED = :paused
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The external ad platform this campaign is running on (e.g., meta, tiktok).
+      #
+      # @see WhopSDK::Models::AdCampaignPauseResponse#platform
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        META = :meta
+        TIKTOK = :tiktok
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current status of the campaign (active, paused, or inactive).
+      #
+      # @see WhopSDK::Models::AdCampaignPauseResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAUSED = :paused
+        PAYMENT_FAILED = :payment_failed
+        DRAFT = :draft
+        IN_REVIEW = :in_review
+        FLAGGED = :flagged
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdCampaigns#retrieve
+    class AdCampaignRetrieveParams < 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