whop_sdk 0.0.37 → 0.0.39

data/lib/whop_sdk/models/ad_report_retrieve_response.rb

@@ -0,0 +1,312 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AdReports#retrieve
+    class AdReportRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute daily
+      #   Per-day breakdown over the date range, ordered ascending. Null when
+      #   `includeDaily` is false.
+      #
+      #   @return [Array<WhopSDK::Models::AdReportRetrieveResponse::Daily>, nil]
+      required :daily,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AdReportRetrieveResponse::Daily] },
+               nil?: true
+
+      # @!attribute summary
+      #   Aggregate totals and rates over the date range.
+      #
+      #   @return [WhopSDK::Models::AdReportRetrieveResponse::Summary]
+      required :summary, -> { WhopSDK::Models::AdReportRetrieveResponse::Summary }
+
+      # @!method initialize(daily:, summary:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AdReportRetrieveResponse} for more details.
+      #
+      #   An ads performance report. Returns a summary; daily breakdown is included when
+      #   `includeDaily` is true.
+      #
+      #   @param daily [Array<WhopSDK::Models::AdReportRetrieveResponse::Daily>, nil] Per-day breakdown over the date range, ordered ascending. Null when `includeDail
+      #
+      #   @param summary [WhopSDK::Models::AdReportRetrieveResponse::Summary] Aggregate totals and rates over the date range.
+
+      class Daily < WhopSDK::Internal::Type::BaseModel
+        # @!attribute clicks
+        #   Clicks on this date.
+        #
+        #   @return [Integer]
+        required :clicks, Integer
+
+        # @!attribute impressions
+        #   Impressions on this date.
+        #
+        #   @return [Integer]
+        required :impressions, Integer
+
+        # @!attribute reach
+        #   Unique users reached on this date.
+        #
+        #   @return [Integer]
+        required :reach, Integer
+
+        # @!attribute result_count
+        #   Count of the primary optimization result on this date.
+        #
+        #   @return [Integer, nil]
+        required :result_count, Integer, nil?: true
+
+        # @!attribute result_label_key
+        #   Types of optimization results tracked from external ad platforms
+        #
+        #   @return [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey, nil]
+        required :result_label_key,
+                 enum: -> { WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey },
+                 nil?: true
+
+        # @!attribute result_label_override
+        #   Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+        #
+        #   @return [String, nil]
+        required :result_label_override, String, nil?: true
+
+        # @!attribute spend
+        #   Charged spend on this date in the requested reporting currency — the amount
+        #   billed including platform fees, not the platform-side net spend.
+        #
+        #   @return [Float]
+        required :spend, Float
+
+        # @!attribute spend_currency
+        #   Currency of the `spend` value.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :spend_currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute stat_date
+        #   The date these stats cover (midnight UTC).
+        #
+        #   @return [Time]
+        required :stat_date, Time
+
+        # @!method initialize(clicks:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, spend:, spend_currency:, stat_date:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::AdReportRetrieveResponse::Daily} for more details.
+        #
+        #   Per-day ad performance for an ad campaign, ad group, or ad.
+        #
+        #   @param clicks [Integer] Clicks on this date.
+        #
+        #   @param impressions [Integer] Impressions on this date.
+        #
+        #   @param reach [Integer] Unique users reached on this date.
+        #
+        #   @param result_count [Integer, nil] Count of the primary optimization result on this date.
+        #
+        #   @param result_label_key [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey, nil] Types of optimization results tracked from external ad platforms
+        #
+        #   @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+        #
+        #   @param spend [Float] Charged spend on this date in the requested reporting currency — the amount bill
+        #
+        #   @param spend_currency [Symbol, WhopSDK::Models::Currency] Currency of the `spend` value.
+        #
+        #   @param stat_date [Time] The date these stats cover (midnight UTC).
+
+        # Types of optimization results tracked from external ad platforms
+        #
+        # @see WhopSDK::Models::AdReportRetrieveResponse::Daily#result_label_key
+        module ResultLabelKey
+          extend WhopSDK::Internal::Type::Enum
+
+          APP_INSTALLS = :app_installs
+          MESSAGING_CONVERSATIONS_STARTED = :messaging_conversations_started
+          POST_ENGAGEMENT = :post_engagement
+          EVENT_RESPONSES = :event_responses
+          IMPRESSIONS = :impressions
+          WEBSITE_PURCHASES = :website_purchases
+          LANDING_PAGE_VIEWS = :landing_page_views
+          LEADS = :leads
+          LINK_CLICKS = :link_clicks
+          QUALITY_CALLS = :quality_calls
+          APPOINTMENTS_BOOKED = :appointments_booked
+          MESSAGING_PURCHASES = :messaging_purchases
+          PAGE_LIKES = :page_likes
+          INSTAGRAM_PROFILE_VISITS = :instagram_profile_visits
+          REACH = :reach
+          REMINDERS_SET = :reminders_set
+          NEW_SUBSCRIBERS = :new_subscribers
+          VIDEO_VIEWS = :video_views
+          REGISTRATIONS = :registrations
+          CONTENT_VIEWS = :content_views
+          SEARCHES = :searches
+          WEBSITE_SCHEDULES = :website_schedules
+          WEBSITE_SUBMIT_APPLICATIONS = :website_submit_applications
+          CUSTOM = :custom
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see WhopSDK::Models::AdReportRetrieveResponse#summary
+      class Summary < WhopSDK::Internal::Type::BaseModel
+        # @!attribute clicks
+        #   Total clicks over the date range.
+        #
+        #   @return [Integer]
+        required :clicks, Integer
+
+        # @!attribute cost_per_result
+        #   Spend divided by `resultCount`. Null when there are no results.
+        #
+        #   @return [Float, nil]
+        required :cost_per_result, Float, nil?: true
+
+        # @!attribute cpc
+        #   Cost per click in the requested reporting currency.
+        #
+        #   @return [Float]
+        required :cpc, Float
+
+        # @!attribute cpm
+        #   Cost per thousand impressions in the requested reporting currency.
+        #
+        #   @return [Float, nil]
+        required :cpm, Float, nil?: true
+
+        # @!attribute ctr
+        #   Click-through rate (clicks / impressions).
+        #
+        #   @return [Float]
+        required :ctr, Float
+
+        # @!attribute frequency
+        #   Average number of times each reached user saw an ad.
+        #
+        #   @return [Float, nil]
+        required :frequency, Float, nil?: true
+
+        # @!attribute impressions
+        #   Total impressions over the date range.
+        #
+        #   @return [Integer]
+        required :impressions, Integer
+
+        # @!attribute reach
+        #   Unique users reached, deduplicated by the external ad platform.
+        #
+        #   @return [Integer]
+        required :reach, Integer
+
+        # @!attribute result_count
+        #   Count of the campaign's primary optimization result (purchases, clicks, etc.) —
+        #   see `resultLabelKey`.
+        #
+        #   @return [Integer, nil]
+        required :result_count, Integer, nil?: true
+
+        # @!attribute result_label_key
+        #   Types of optimization results tracked from external ad platforms
+        #
+        #   @return [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey, nil]
+        required :result_label_key,
+                 enum: -> { WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey },
+                 nil?: true
+
+        # @!attribute result_label_override
+        #   Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+        #
+        #   @return [String, nil]
+        required :result_label_override, String, nil?: true
+
+        # @!attribute roas
+        #   Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
+        #   external ad platform.
+        #
+        #   @return [Float, nil]
+        required :roas, Float, nil?: true
+
+        # @!attribute spend
+        #   Total spend over the date range in the requested reporting currency.
+        #
+        #   @return [Float]
+        required :spend, Float
+
+        # @!attribute spend_currency
+        #   The available currencies on the platform
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency, nil]
+        required :spend_currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+        # @!method initialize(clicks:, cost_per_result:, cpc:, cpm:, ctr:, frequency:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, roas:, spend:, spend_currency:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::AdReportRetrieveResponse::Summary} for more details.
+        #
+        #   Aggregate totals and rates over the date range.
+        #
+        #   @param clicks [Integer] Total clicks over the date range.
+        #
+        #   @param cost_per_result [Float, nil] Spend divided by `resultCount`. Null when there are no results.
+        #
+        #   @param cpc [Float] Cost per click in the requested reporting currency.
+        #
+        #   @param cpm [Float, nil] Cost per thousand impressions in the requested reporting currency.
+        #
+        #   @param ctr [Float] Click-through rate (clicks / impressions).
+        #
+        #   @param frequency [Float, nil] Average number of times each reached user saw an ad.
+        #
+        #   @param impressions [Integer] Total impressions over the date range.
+        #
+        #   @param reach [Integer] Unique users reached, deduplicated by the external ad platform.
+        #
+        #   @param result_count [Integer, nil] Count of the campaign's primary optimization result (purchases, clicks, etc.) —
+        #
+        #   @param result_label_key [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey, nil] Types of optimization results tracked from external ad platforms
+        #
+        #   @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+        #
+        #   @param roas [Float, nil] Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
+        #
+        #   @param spend [Float] Total spend over the date range in the requested reporting currency.
+        #
+        #   @param spend_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+
+        # Types of optimization results tracked from external ad platforms
+        #
+        # @see WhopSDK::Models::AdReportRetrieveResponse::Summary#result_label_key
+        module ResultLabelKey
+          extend WhopSDK::Internal::Type::Enum
+
+          APP_INSTALLS = :app_installs
+          MESSAGING_CONVERSATIONS_STARTED = :messaging_conversations_started
+          POST_ENGAGEMENT = :post_engagement
+          EVENT_RESPONSES = :event_responses
+          IMPRESSIONS = :impressions
+          WEBSITE_PURCHASES = :website_purchases
+          LANDING_PAGE_VIEWS = :landing_page_views
+          LEADS = :leads
+          LINK_CLICKS = :link_clicks
+          QUALITY_CALLS = :quality_calls
+          APPOINTMENTS_BOOKED = :appointments_booked
+          MESSAGING_PURCHASES = :messaging_purchases
+          PAGE_LIKES = :page_likes
+          INSTAGRAM_PROFILE_VISITS = :instagram_profile_visits
+          REACH = :reach
+          REMINDERS_SET = :reminders_set
+          NEW_SUBSCRIBERS = :new_subscribers
+          VIDEO_VIEWS = :video_views
+          REGISTRATIONS = :registrations
+          CONTENT_VIEWS = :content_views
+          SEARCHES = :searches
+          WEBSITE_SCHEDULES = :website_schedules
+          WEBSITE_SUBMIT_APPLICATIONS = :website_submit_applications
+          CUSTOM = :custom
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/ad_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Ads#retrieve
+    class AdRetrieveParams < 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_retrieve_response.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Ads#retrieve
+    class AdRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for this ad.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute ad_campaign
+      #   The ad campaign this ad belongs to.
+      #
+      #   @return [WhopSDK::Models::AdRetrieveResponse::AdCampaign]
+      required :ad_campaign, -> { WhopSDK::Models::AdRetrieveResponse::AdCampaign }
+
+      # @!attribute ad_group
+      #   The parent ad group this ad belongs to.
+      #
+      #   @return [WhopSDK::Models::AdRetrieveResponse::AdGroup]
+      required :ad_group, -> { WhopSDK::Models::AdRetrieveResponse::AdGroup }
+
+      # @!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::AdRetrieveResponse::Platform]
+      required :platform, enum: -> { WhopSDK::Models::AdRetrieveResponse::Platform }
+
+      # @!attribute status
+      #   Current delivery status of the ad.
+      #
+      #   @return [Symbol, WhopSDK::Models::AdRetrieveResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::AdRetrieveResponse::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:, ad_campaign:, ad_group:, created_at:, platform:, status:, title:, updated_at:)
+      #   An ad belonging to an ad group.
+      #
+      #   @param id [String] The unique identifier for this ad.
+      #
+      #   @param ad_campaign [WhopSDK::Models::AdRetrieveResponse::AdCampaign] The ad campaign this ad belongs to.
+      #
+      #   @param ad_group [WhopSDK::Models::AdRetrieveResponse::AdGroup] The parent ad group this ad belongs to.
+      #
+      #   @param created_at [Time] When the ad was created.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AdRetrieveResponse::Platform] The external ad platform this ad is running on (e.g., meta, tiktok).
+      #
+      #   @param status [Symbol, WhopSDK::Models::AdRetrieveResponse::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.
+
+      # @see WhopSDK::Models::AdRetrieveResponse#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 belongs to.
+        #
+        #   @param id [String] The unique identifier for this ad campaign.
+      end
+
+      # @see WhopSDK::Models::AdRetrieveResponse#ad_group
+      class AdGroup < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for this ad group.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The parent ad group this ad belongs to.
+        #
+        #   @param id [String] The unique identifier for this ad group.
+      end
+
+      # The external ad platform this ad is running on (e.g., meta, tiktok).
+      #
+      # @see WhopSDK::Models::AdRetrieveResponse#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::AdRetrieveResponse#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/authorized_user_roles.rb

@@ -10,6 +10,7 @@ module WhopSDK
       ADMIN = :admin
       SALES_MANAGER = :sales_manager
       MODERATOR = :moderator
+      ADVERTISER = :advertiser
       APP_MANAGER = :app_manager
       SUPPORT = :support
       MANAGER = :manager

data/lib/whop_sdk/models/bounty_create_params.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Bounties#create
+    class BountyCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute base_unit_amount
+      #   The amount paid to each approved submission. The total bounty pool funded is
+      #   this amount times accepted_submissions_limit.
+      #
+      #   @return [Float]
+      required :base_unit_amount, Float
+
+      # @!attribute currency
+      #   The currency for the bounty pool funding amount.
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute description
+      #   The description of the bounty.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute title
+      #   The title of the bounty.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute accepted_submissions_limit
+      #   The number of submissions that can be approved before the bounty closes.
+      #   Defaults to 1.
+      #
+      #   @return [Integer, nil]
+      optional :accepted_submissions_limit, Integer, nil?: true
+
+      # @!attribute allowed_country_codes
+      #   The ISO3166 country codes where this bounty should be visible. Empty means
+      #   globally visible.
+      #
+      #   @return [Array<String>, nil]
+      optional :allowed_country_codes, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute experience_id
+      #   An optional experience to scope the bounty to.
+      #
+      #   @return [String, nil]
+      optional :experience_id, String, nil?: true
+
+      # @!attribute origin_account_id
+      #   The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
+      #   Defaults to the requester's personal balance when omitted. The requester must be
+      #   the user themself or an owner/admin of the company.
+      #
+      #   @return [String, nil]
+      optional :origin_account_id, String, nil?: true
+
+      # @!attribute post_markdown_content
+      #   Optional markdown body for the anchor forum post. Falls back to the bounty
+      #   description when omitted.
+      #
+      #   @return [String, nil]
+      optional :post_markdown_content, String, nil?: true
+
+      # @!attribute post_title
+      #   Optional title for the anchor forum post. Falls back to the bounty title when
+      #   omitted.
+      #
+      #   @return [String, nil]
+      optional :post_title, String, nil?: true
+
+      # @!method initialize(base_unit_amount:, currency:, description:, title:, accepted_submissions_limit: nil, allowed_country_codes: nil, experience_id: nil, origin_account_id: nil, post_markdown_content: nil, post_title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::BountyCreateParams} for more details.
+      #
+      #   @param base_unit_amount [Float] The amount paid to each approved submission. The total bounty pool funded is thi
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The currency for the bounty pool funding amount.
+      #
+      #   @param description [String] The description of the bounty.
+      #
+      #   @param title [String] The title of the bounty.
+      #
+      #   @param accepted_submissions_limit [Integer, nil] The number of submissions that can be approved before the bounty closes. Default
+      #
+      #   @param allowed_country_codes [Array<String>, nil] The ISO3166 country codes where this bounty should be visible. Empty means globa
+      #
+      #   @param experience_id [String, nil] An optional experience to scope the bounty to.
+      #
+      #   @param origin_account_id [String, nil] The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
+      #   D
+      #
+      #   @param post_markdown_content [String, nil] Optional markdown body for the anchor forum post. Falls back to the bounty descr
+      #
+      #   @param post_title [String, nil] Optional title for the anchor forum post. Falls back to the bounty title when om
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end