whop_sdk 0.0.37 → 0.0.39

data/lib/whop_sdk/models/ad_group_update_response.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdGroups#update
+    class AdGroupUpdateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for this ad group.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute ad_campaign
+      #   The ad campaign this ad group belongs to.
+      #
+      #   @return [WhopSDK::Models::AdGroupUpdateResponse::AdCampaign]
+      required :ad_campaign, -> { WhopSDK::Models::AdGroupUpdateResponse::AdCampaign }
+
+      # @!attribute budget
+      #   Budget amount 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::AdGroupUpdateResponse::BudgetType, nil]
+      required :budget_type, enum: -> { WhopSDK::Models::AdGroupUpdateResponse::BudgetType }, nil?: true
+
+      # @!attribute created_at
+      #   When the ad group was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute platform
+      #   The external ad platform this ad group is running on (e.g., meta, tiktok).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdGroupUpdateResponse::Platform]
+      required :platform, enum: -> { WhopSDK::Models::AdGroupUpdateResponse::Platform }
+
+      # @!attribute status
+      #   Current operational status of the ad group.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdGroupUpdateResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::AdGroupUpdateResponse::Status }
+
+      # @!attribute title
+      #   Human-readable name shown on the external platform.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the ad group was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, ad_campaign:, budget:, budget_type:, created_at:, platform:, status:, title:, updated_at:)
+      #   An ad group (ad set) belonging to an ad campaign.
+      #
+      #   @param id [String] The unique identifier for this ad group.
+      #
+      #   @param ad_campaign [WhopSDK::Models::AdGroupUpdateResponse::AdCampaign] The ad campaign this ad group belongs to.
+      #
+      #   @param budget [Float, nil] Budget amount in dollars.
+      #
+      #   @param budget_type [Symbol, WhopSDK::Models::AdGroupUpdateResponse::BudgetType, nil] The budget type for an ad campaign or ad group.
+      #
+      #   @param created_at [Time] When the ad group was created.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdGroupUpdateResponse::Platform] The external ad platform this ad group is running on (e.g., meta, tiktok).
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdGroupUpdateResponse::Status] Current operational status of the ad group.
+      #
+      #   @param title [String, nil] Human-readable name shown on the external platform.
+      #
+      #   @param updated_at [Time] When the ad group was last updated.
+
+      # @see WhopSDK::Models::AdGroupUpdateResponse#ad_campaign
+      class AdCampaign < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for this ad campaign.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The ad campaign this ad group belongs to.
+        #
+        #   @param id [String] The unique identifier for this ad campaign.
+      end
+
+      # The budget type for an ad campaign or ad group.
+      #
+      # @see WhopSDK::Models::AdGroupUpdateResponse#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 ad group is running on (e.g., meta, tiktok).
+      #
+      # @see WhopSDK::Models::AdGroupUpdateResponse#platform
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        META = :meta
+        TIKTOK = :tiktok
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current operational status of the ad group.
+      #
+      # @see WhopSDK::Models::AdGroupUpdateResponse#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>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_list_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Ads#list
+    class AdListParams < WhopSDK::Internal::Type::BaseModel
+      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.
+      #
+      #   @return [String, nil]
+      optional :ad_group_id, String, nil?: true
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute campaign_id
+      #   Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
+      #   company_id.
+      #
+      #   @return [String, nil]
+      optional :campaign_id, String, nil?: true
+
+      # @!attribute company_id
+      #   Filter by company. Provide exactly one of ad_group_id, campaign_id, or
+      #   company_id.
+      #
+      #   @return [String, nil]
+      optional :company_id, String, nil?: true
+
+      # @!attribute created_after
+      #   Only return ads created after this timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_after, Time, nil?: true
+
+      # @!attribute created_before
+      #   Only return ads created before this timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_before, Time, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute status
+      #   The status of an external ad.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdListParams::Status, nil]
+      optional :status, enum: -> { WhopSDK::AdListParams::Status }, nil?: true
+
+      # @!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: {})
+      #   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 after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      #   @param campaign_id [String, nil] Filter by campaign. Provide exactly one of ad*group_id, campaign_id, or company*
+      #
+      #   @param company_id [String, nil] Filter by company. Provide exactly one of ad_group_id, campaign_id, or company_i
+      #
+      #   @param created_after [Time, nil] Only return ads created after this timestamp.
+      #
+      #   @param created_before [Time, nil] Only return ads created before this timestamp.
+      #
+      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdListParams::Status, nil] The status of an external ad.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The status of an external ad.
+      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>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_list_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Ads#list
+    class AdListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for this ad.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the ad was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute platform
+      #   The external ad platform this ad is running on (e.g., meta, tiktok).
+      #
+      #   @return [Symbol, WhopSDK::Models::AdListResponse::Platform]
+      required :platform, enum: -> { WhopSDK::Models::AdListResponse::Platform }
+
+      # @!attribute status
+      #   Current delivery status of the ad.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdListResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::AdListResponse::Status }
+
+      # @!attribute title
+      #   The display title of the ad. Falls back to the creative set caption when unset.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the ad was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, created_at:, platform:, status:, title:, updated_at:)
+      #   An ad belonging to an ad group.
+      #
+      #   @param id [String] The unique identifier for this ad.
+      #
+      #   @param created_at [Time] When the ad was created.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdListResponse::Platform] The external ad platform this ad is running on (e.g., meta, tiktok).
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdListResponse::Status] Current delivery status of the ad.
+      #
+      #   @param title [String, nil] The display title of the ad. Falls back to the creative set caption when unset.
+      #
+      #   @param updated_at [Time] When the ad was last updated.
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      #
+      # @see WhopSDK::Models::AdListResponse#platform
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        META = :meta
+        TIKTOK = :tiktok
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current delivery status of the ad.
+      #
+      # @see WhopSDK::Models::AdListResponse#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>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_report_retrieve_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdReports#retrieve
+    class AdReportRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute from
+      #   Inclusive start of the reporting window.
+      #
+      #   @return [Time]
+      required :from, Time
+
+      # @!attribute to
+      #   Inclusive end of the reporting window.
+      #
+      #   @return [Time]
+      required :to, Time
+
+      # @!attribute ad_campaign_id
+      #   The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
+      #   `adId`.
+      #
+      #   @return [String, nil]
+      optional :ad_campaign_id, String, nil?: true
+
+      # @!attribute ad_group_id
+      #   The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+      #   `adId`.
+      #
+      #   @return [String, nil]
+      optional :ad_group_id, String, nil?: true
+
+      # @!attribute ad_id
+      #   The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
+      #   `adGroupId`.
+      #
+      #   @return [String, nil]
+      optional :ad_id, String, nil?: true
+
+      # @!attribute currency
+      #   ISO 4217 currency code to report `spend` in. Defaults to the company's ads
+      #   reporting currency.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute include_daily
+      #   When true, includes a per-day breakdown alongside the summary.
+      #
+      #   @return [Boolean, nil]
+      optional :include_daily, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, currency: nil, include_daily: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AdReportRetrieveParams} for more details.
+      #
+      #   @param from [Time] Inclusive start of the reporting window.
+      #
+      #   @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_group_id [String, nil] The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+      #
+      #   @param ad_id [String, nil] The unique identifier of an ad. Mutually exclusive with `adCampaignId` and `adGr
+      #
+      #   @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 request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end