whop_sdk 0.0.37 → 0.0.39

data/rbi/whop_sdk/models/ad_group_update_response.rbi

@@ -0,0 +1,274 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AdGroupUpdateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::AdGroupUpdateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for this ad group.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The ad campaign this ad group belongs to.
+      sig { returns(WhopSDK::Models::AdGroupUpdateResponse::AdCampaign) }
+      attr_reader :ad_campaign
+
+      sig do
+        params(
+          ad_campaign:
+            WhopSDK::Models::AdGroupUpdateResponse::AdCampaign::OrHash
+        ).void
+      end
+      attr_writer :ad_campaign
+
+      # Budget amount in dollars.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :budget
+
+      # The budget type for an ad campaign or ad group.
+      sig do
+        returns(
+          T.nilable(
+            WhopSDK::Models::AdGroupUpdateResponse::BudgetType::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :budget_type
+
+      # When the ad group was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The external ad platform this ad group is running on (e.g., meta, tiktok).
+      sig do
+        returns(WhopSDK::Models::AdGroupUpdateResponse::Platform::TaggedSymbol)
+      end
+      attr_accessor :platform
+
+      # Current operational status of the ad group.
+      sig do
+        returns(WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol)
+      end
+      attr_accessor :status
+
+      # Human-readable name shown on the external platform.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # When the ad group was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # An ad group (ad set) belonging to an ad campaign.
+      sig do
+        params(
+          id: String,
+          ad_campaign:
+            WhopSDK::Models::AdGroupUpdateResponse::AdCampaign::OrHash,
+          budget: T.nilable(Float),
+          budget_type:
+            T.nilable(
+              WhopSDK::Models::AdGroupUpdateResponse::BudgetType::OrSymbol
+            ),
+          created_at: Time,
+          platform: WhopSDK::Models::AdGroupUpdateResponse::Platform::OrSymbol,
+          status: WhopSDK::Models::AdGroupUpdateResponse::Status::OrSymbol,
+          title: T.nilable(String),
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for this ad group.
+        id:,
+        # The ad campaign this ad group belongs to.
+        ad_campaign:,
+        # Budget amount in dollars.
+        budget:,
+        # The budget type for an ad campaign or ad group.
+        budget_type:,
+        # When the ad group was created.
+        created_at:,
+        # The external ad platform this ad group is running on (e.g., meta, tiktok).
+        platform:,
+        # Current operational status of the ad group.
+        status:,
+        # Human-readable name shown on the external platform.
+        title:,
+        # When the ad group was last updated.
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            ad_campaign: WhopSDK::Models::AdGroupUpdateResponse::AdCampaign,
+            budget: T.nilable(Float),
+            budget_type:
+              T.nilable(
+                WhopSDK::Models::AdGroupUpdateResponse::BudgetType::TaggedSymbol
+              ),
+            created_at: Time,
+            platform:
+              WhopSDK::Models::AdGroupUpdateResponse::Platform::TaggedSymbol,
+            status:
+              WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol,
+            title: T.nilable(String),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AdCampaign < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AdGroupUpdateResponse::AdCampaign,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for this ad campaign.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ad campaign this ad group belongs to.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The unique identifier for this ad campaign.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      # The budget type for an ad campaign or ad group.
+      module BudgetType
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdGroupUpdateResponse::BudgetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAILY =
+          T.let(
+            :daily,
+            WhopSDK::Models::AdGroupUpdateResponse::BudgetType::TaggedSymbol
+          )
+        LIFETIME =
+          T.let(
+            :lifetime,
+            WhopSDK::Models::AdGroupUpdateResponse::BudgetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::AdGroupUpdateResponse::BudgetType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The external ad platform this ad group is running on (e.g., meta, tiktok).
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdGroupUpdateResponse::Platform)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        META =
+          T.let(
+            :meta,
+            WhopSDK::Models::AdGroupUpdateResponse::Platform::TaggedSymbol
+          )
+        TIKTOK =
+          T.let(
+            :tiktok,
+            WhopSDK::Models::AdGroupUpdateResponse::Platform::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::AdGroupUpdateResponse::Platform::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Current operational status of the ad group.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdGroupUpdateResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+        PAUSED =
+          T.let(
+            :paused,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(
+            :in_review,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+        FLAGGED =
+          T.let(
+            :flagged,
+            WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::AdGroupUpdateResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/ad_list_params.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AdListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AdListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
+      # company_id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ad_group_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
+      # company_id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :campaign_id
+
+      # Filter by company. Provide exactly one of ad_group_id, campaign_id, or
+      # company_id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
+      # Only return ads created after this timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_after
+
+      # Only return ads created before this timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # The status of an external ad.
+      sig { returns(T.nilable(WhopSDK::AdListParams::Status::OrSymbol)) }
+      attr_accessor :status
+
+      sig do
+        params(
+          ad_group_id: T.nilable(String),
+          after: T.nilable(String),
+          before: T.nilable(String),
+          campaign_id: T.nilable(String),
+          company_id: T.nilable(String),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          status: T.nilable(WhopSDK::AdListParams::Status::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
+        # company_id.
+        ad_group_id: nil,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
+        # company_id.
+        campaign_id: nil,
+        # Filter by company. Provide exactly one of ad_group_id, campaign_id, or
+        # company_id.
+        company_id: nil,
+        # Only return ads created after this timestamp.
+        created_after: nil,
+        # Only return ads created before this timestamp.
+        created_before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The status of an external ad.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            ad_group_id: T.nilable(String),
+            after: T.nilable(String),
+            before: T.nilable(String),
+            campaign_id: T.nilable(String),
+            company_id: T.nilable(String),
+            created_after: T.nilable(Time),
+            created_before: T.nilable(Time),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            status: T.nilable(WhopSDK::AdListParams::Status::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of an external ad.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::AdListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE = T.let(:active, WhopSDK::AdListParams::Status::TaggedSymbol)
+        PAUSED = T.let(:paused, WhopSDK::AdListParams::Status::TaggedSymbol)
+        INACTIVE = T.let(:inactive, WhopSDK::AdListParams::Status::TaggedSymbol)
+        IN_REVIEW =
+          T.let(:in_review, WhopSDK::AdListParams::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, WhopSDK::AdListParams::Status::TaggedSymbol)
+        FLAGGED = T.let(:flagged, WhopSDK::AdListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/ad_list_response.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AdListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::AdListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The unique identifier for this ad.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When the ad was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      sig { returns(WhopSDK::Models::AdListResponse::Platform::TaggedSymbol) }
+      attr_accessor :platform
+
+      # Current delivery status of the ad.
+      sig { returns(WhopSDK::Models::AdListResponse::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # The display title of the ad. Falls back to the creative set caption when unset.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # When the ad was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # An ad belonging to an ad group.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          platform: WhopSDK::Models::AdListResponse::Platform::OrSymbol,
+          status: WhopSDK::Models::AdListResponse::Status::OrSymbol,
+          title: T.nilable(String),
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for this ad.
+        id:,
+        # When the ad was created.
+        created_at:,
+        # The external ad platform this ad is running on (e.g., meta, tiktok).
+        platform:,
+        # Current delivery status of the ad.
+        status:,
+        # The display title of the ad. Falls back to the creative set caption when unset.
+        title:,
+        # When the ad was last updated.
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            platform: WhopSDK::Models::AdListResponse::Platform::TaggedSymbol,
+            status: WhopSDK::Models::AdListResponse::Status::TaggedSymbol,
+            title: T.nilable(String),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdListResponse::Platform)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        META =
+          T.let(:meta, WhopSDK::Models::AdListResponse::Platform::TaggedSymbol)
+        TIKTOK =
+          T.let(
+            :tiktok,
+            WhopSDK::Models::AdListResponse::Platform::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::Models::AdListResponse::Platform::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Current delivery status of the ad.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::AdListResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, WhopSDK::Models::AdListResponse::Status::TaggedSymbol)
+        PAUSED =
+          T.let(:paused, WhopSDK::Models::AdListResponse::Status::TaggedSymbol)
+        INACTIVE =
+          T.let(
+            :inactive,
+            WhopSDK::Models::AdListResponse::Status::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(
+            :in_review,
+            WhopSDK::Models::AdListResponse::Status::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            WhopSDK::Models::AdListResponse::Status::TaggedSymbol
+          )
+        FLAGGED =
+          T.let(:flagged, WhopSDK::Models::AdListResponse::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::Models::AdListResponse::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AdReportRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AdReportRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # Inclusive start of the reporting window.
+      sig { returns(Time) }
+      attr_accessor :from
+
+      # Inclusive end of the reporting window.
+      sig { returns(Time) }
+      attr_accessor :to
+
+      # The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
+      # `adId`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ad_campaign_id
+
+      # The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+      # `adId`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ad_group_id
+
+      # The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
+      # `adGroupId`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ad_id
+
+      # ISO 4217 currency code to report `spend` in. Defaults to the company's ads
+      # reporting currency.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :currency
+
+      # When true, includes a per-day breakdown alongside the summary.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_daily
+
+      sig do
+        params(
+          from: Time,
+          to: Time,
+          ad_campaign_id: T.nilable(String),
+          ad_group_id: T.nilable(String),
+          ad_id: T.nilable(String),
+          currency: T.nilable(String),
+          include_daily: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Inclusive start of the reporting window.
+        from:,
+        # Inclusive end of the reporting window.
+        to:,
+        # The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
+        # `adId`.
+        ad_campaign_id: nil,
+        # The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+        # `adId`.
+        ad_group_id: nil,
+        # The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
+        # `adGroupId`.
+        ad_id: nil,
+        # ISO 4217 currency code to report `spend` in. Defaults to the company's ads
+        # reporting currency.
+        currency: nil,
+        # When true, includes a per-day breakdown alongside the summary.
+        include_daily: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            from: Time,
+            to: Time,
+            ad_campaign_id: T.nilable(String),
+            ad_group_id: T.nilable(String),
+            ad_id: T.nilable(String),
+            currency: T.nilable(String),
+            include_daily: T.nilable(T::Boolean),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end