whop_sdk 2.2.0 → 2.4.0

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_conversion_location.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataConversionLocation
+        extend Whop_sdk::Internal::Types::Enum
+
+        WEBSITE = "website"
+        PROFILE = "profile"
+        INSTAGRAM_AND_FACEBOOK = "instagram_and_facebook"
+        INSTAGRAM_PROFILE = "instagram_profile"
+        MESSAGING = "messaging"
+        ON_AD = "on_ad"
+        INSTANT_FORMS = "instant_forms"
+        INSTANT_FORMS_AND_MESSENGER = "instant_forms_and_messenger"
+        WEBSITE_AND_INSTANT_FORMS = "website_and_instant_forms"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_delivery_status.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataDeliveryStatus
+        extend Whop_sdk::Internal::Types::Enum
+
+        IN_APPEAL = "in_appeal"
+        ALL_ADS_REJECTED = "all_ads_rejected"
+        REJECTED = "rejected"
+        DRAFT = "draft"
+        NO_ADS = "no_ads"
+        CAMPAIGN_PAUSED = "campaign_paused"
+        PAUSED = "paused"
+        PROCESSING = "processing"
+        ISSUES = "issues"
+        SCHEDULED = "scheduled"
+        COMPLETED = "completed"
+        ADS_OFF = "ads_off"
+        LEARNING_LIMITED = "learning_limited"
+        LEARNING = "learning"
+        ACTIVE = "active"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_message_apps_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataMessageAppsItem
+        extend Whop_sdk::Internal::Types::Enum
+
+        MESSENGER = "messenger"
+        INSTAGRAM = "instagram"
+        WHATSAPP = "whatsapp"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_optimization_goal.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataOptimizationGoal
+        extend Whop_sdk::Internal::Types::Enum
+
+        CONVERSIONS = "conversions"
+        LINK_CLICKS = "link_clicks"
+        LANDING_PAGE_VIEWS = "landing_page_views"
+        REACH = "reach"
+        IMPRESSIONS = "impressions"
+        ENGAGEMENT = "engagement"
+        CONVERSATIONS = "conversations"
+        VIDEO_VIEWS = "video_views"
+        TWO_SECOND_VIEWS = "two_second_views"
+        PAGE_LIKES = "page_likes"
+        SOCIAL_PROFILE = "social_profile"
+        AD_RECALL_LIFT = "ad_recall_lift"
+        EVENT_RESPONSES = "event_responses"
+        REMINDERS_SET = "reminders_set"
+        LEAD_GENERATION = "lead_generation"
+        QUALITY_LEAD = "quality_lead"
+        VALUE = "value"
+        PROFILE_AND_PAGE_ENGAGEMENT = "profile_and_page_engagement"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_platform.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataPlatform
+        extend Whop_sdk::Internal::Types::Enum
+
+        META = "meta"
+        TIKTOK = "tiktok"
+        GOOGLE = "google"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadDataStatus
+        extend Whop_sdk::Internal::Types::Enum
+
+        ACTIVE = "active"
+        PAUSED = "paused"
+        REJECTED = "rejected"
+        DUPLICATING = "duplicating"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module PostAdGroupUpdatedPayloadType
+        extend Whop_sdk::Internal::Types::Enum
+
+        AD_GROUP_UPDATED = "ad_group.updated"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/update_ad_groups_request.rb

@@ -6,6 +6,8 @@ module Whop_sdk
       class UpdateAdGroupsRequest < Internal::Types::Model
         field :id, -> { String }, optional: false, nullable: false
 
+        field :ads_platform, -> { Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestXAdsPlatform }, optional: true, nullable: false, api_name: "X-Ads-Platform"
+
         field :audiences, -> { Whop_sdk::Types::AdGroupAudiencesBody }, optional: true, nullable: false
 
         field :bid_type, -> { Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestBidType }, optional: true, nullable: false
@@ -34,6 +36,8 @@ module Whop_sdk
 
         field :frequency_cap, -> { Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestFrequencyCap }, optional: true, nullable: false
 
+        field :keywords, -> { Internal::Types::Array[Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestKeywordsItem] }, optional: true, nullable: false
+
         field :languages, -> { Internal::Types::Array[String] }, optional: true, nullable: false
 
         field :message_apps, -> { Internal::Types::Array[Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestMessageAppsItem] }, optional: true, nullable: false

data/lib/whop_sdk/ad_groups/types/update_ad_groups_request_keywords_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      class UpdateAdGroupsRequestKeywordsItem < Internal::Types::Model
+        field :match_type, -> { Whop_sdk::AdGroups::Types::UpdateAdGroupsRequestKeywordsItemMatchType }, optional: true, nullable: false
+
+        field :negative, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :text, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/update_ad_groups_request_keywords_item_match_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module UpdateAdGroupsRequestKeywordsItemMatchType
+        extend Whop_sdk::Internal::Types::Enum
+
+        BROAD = "broad"
+        PHRASE = "phrase"
+        EXACT = "exact"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_groups/types/update_ad_groups_request_x_ads_platform.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdGroups
+    module Types
+      module UpdateAdGroupsRequestXAdsPlatform
+        extend Whop_sdk::Internal::Types::Enum
+
+        META = "meta"
+        GOOGLE = "google"
+        TIKTOK = "tiktok"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/client.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    class Client
+      # @param client [Whop_sdk::Internal::Http::RawClient]
+      # @param base_url [String, nil]
+      # @param environment [Hash[Symbol, String], nil]
+      #
+      # @return [void]
+      def initialize(client:, base_url: nil, environment: nil)
+        @client = client
+        @base_url = base_url
+        @environment = environment
+      end
+
+      # List the pixels you added for businesses whose campaigns you claimed.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :account_id
+      # @option params [Integer, nil] :first
+      # @option params [String, nil] :after
+      # @option params [Integer, nil] :last
+      # @option params [String, nil] :before
+      # @option params [Whop_sdk::AdPixels::Types::ListAdPixelsRequestOrder, nil] :order
+      # @option params [Whop_sdk::AdPixels::Types::ListAdPixelsRequestDirection, nil] :direction
+      #
+      # @example
+      #   client.ad_pixels.list
+      #
+      # @return [Whop_sdk::AdPixels::Types::ListAdPixelsResponse]
+      def list(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["account_id"] = params[:account_id] if params.key?(:account_id)
+        query_params["first"] = params[:first] if params.key?(:first)
+        query_params["after"] = params[:after] if params.key?(:after)
+        query_params["last"] = params[:last] if params.key?(:last)
+        query_params["before"] = params[:before] if params.key?(:before)
+        query_params["order"] = params[:order] if params.key?(:order)
+        query_params["direction"] = params[:direction] if params.key?(:direction)
+
+        Whop_sdk::Internal::CursorItemIterator.new(
+          cursor_field: :end_cursor,
+          item_field: :data,
+          initial_cursor: query_params["after"]
+        ) do |next_cursor|
+          query_params["after"] = next_cursor
+          request = Whop_sdk::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+            method: "GET",
+            path: "ad_pixels",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Whop_sdk::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            parsed_response = (response.body.to_s.empty? ? nil : Whop_sdk::AdPixels::Types::ListAdPixelsResponse.load(response.body))
+            [parsed_response, response]
+          else
+            error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+
+      # Add your pixel for a business whose campaigns you claimed. Whop checks the access token with the ad platform,
+      # then sends the pixel the conversions credited to your claimed campaigns for that business. Each business takes
+      # one pixel, and each pixel can serve one business.
+      #
+      # @param request_options [Hash]
+      # @param params [Whop_sdk::AdPixels::Types::CreateAdPixelsRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.ad_pixels.create(
+      #     access_token: "new-token",
+      #     account_id: "biz_xxxxxxxxxxxxxx",
+      #     external_id: "998877665544",
+      #     platform: "meta"
+      #   )
+      #
+      # @return [Whop_sdk::Types::AdPixel]
+      def create(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "POST",
+          path: "ad_pixels",
+          body: Whop_sdk::AdPixels::Types::CreateAdPixelsRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Whop_sdk::Types::AdPixel.load(response.body))
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.ad_pixels.retrieve(id: "id")
+      #
+      # @return [Whop_sdk::Types::AdPixel]
+      def retrieve(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "GET",
+          path: "ad_pixels/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Whop_sdk::Types::AdPixel.load(response.body))
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Remove the pixel and its access token. Whop stops sending it conversions.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.ad_pixels.delete(id: "id")
+      #
+      # @return [Whop_sdk::AdPixels::Types::DeleteAdPixelsResponse]
+      def delete(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "DELETE",
+          path: "ad_pixels/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Whop_sdk::AdPixels::Types::DeleteAdPixelsResponse.load(response.body))
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Replace the pixel's access token. Whop checks the new token with the ad platform and resumes deliveries to an
+      # `errored` pixel.
+      #
+      # @param request_options [Hash]
+      # @param params [Whop_sdk::AdPixels::Types::UpdateAdPixelsRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.ad_pixels.update(
+      #     id: "id",
+      #     access_token: "new-token"
+      #   )
+      #
+      # @return [Whop_sdk::Types::AdPixel]
+      def update(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request_data = Whop_sdk::AdPixels::Types::UpdateAdPixelsRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "PATCH",
+          path: "ad_pixels/#{URI.encode_uri_component(params[:id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Whop_sdk::Types::AdPixel.load(response.body))
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/create_ad_pixels_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class CreateAdPixelsRequest < Internal::Types::Model
+        field :access_token, -> { String }, optional: false, nullable: false
+
+        field :account_id, -> { String }, optional: false, nullable: false
+
+        field :external_id, -> { String }, optional: false, nullable: false
+
+        field :platform, -> { Whop_sdk::AdPixels::Types::CreateAdPixelsRequestPlatform }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/{trades/types/update_leverage_trades_request_provider.rb → ad_pixels/types/create_ad_pixels_request_platform.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Whop_sdk
-  module Trades
+  module AdPixels
     module Types
-      module UpdateLeverageTradesRequestProvider
+      module CreateAdPixelsRequestPlatform
         extend Whop_sdk::Internal::Types::Enum
 
-        HYPERLIQUID = "hyperliquid"
+        META = "meta"
       end
     end
   end

data/lib/whop_sdk/ad_pixels/types/delete_ad_pixels_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class DeleteAdPixelsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/delete_ad_pixels_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class DeleteAdPixelsResponse < Internal::Types::Model
+        field :deleted, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class ListAdPixelsRequest < Internal::Types::Model
+        field :account_id, -> { String }, optional: true, nullable: false
+
+        field :first, -> { Integer }, optional: true, nullable: false
+
+        field :after, -> { String }, optional: true, nullable: false
+
+        field :last, -> { Integer }, optional: true, nullable: false
+
+        field :before, -> { String }, optional: true, nullable: false
+
+        field :order, -> { Whop_sdk::AdPixels::Types::ListAdPixelsRequestOrder }, optional: true, nullable: false
+
+        field :direction, -> { Whop_sdk::AdPixels::Types::ListAdPixelsRequestDirection }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request_direction.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      module ListAdPixelsRequestDirection
+        extend Whop_sdk::Internal::Types::Enum
+
+        ASC = "asc"
+        DESC = "desc"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request_order.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      module ListAdPixelsRequestOrder
+        extend Whop_sdk::Internal::Types::Enum
+
+        CREATED_AT = "created_at"
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class ListAdPixelsResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Whop_sdk::Types::AdPixel] }, optional: false, nullable: false
+
+        field :page_info, -> { Whop_sdk::AdPixels::Types::ListAdPixelsResponsePageInfo }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_response_page_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class ListAdPixelsResponsePageInfo < Internal::Types::Model
+        field :end_cursor, -> { String }, optional: false, nullable: true
+
+        field :has_next_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :has_previous_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :start_cursor, -> { String }, optional: false, nullable: true
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/retrieve_ad_pixels_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class RetrieveAdPixelsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/ad_pixels/types/update_ad_pixels_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module AdPixels
+    module Types
+      class UpdateAdPixelsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :access_token, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end