growsurf-ruby 1.4.0 → 1.5.1

data/lib/growsurf_ruby/models/campaign_create_params.rb

@@ -27,6 +27,19 @@ module GrowsurfRuby
       #   @return [String, nil]
       optional :currency_iso, String, api_name: :currencyISO
 
+      # @!attribute goal
+      #   What the program is for, which seeds share settings that suit that audience.
+      #   Programs selling to businesses (`CUSTOMERS`, `USERS`, `B2B_SAAS_SELF_SERVICE`,
+      #   `B2B_SAAS_ENTERPRISE`) start with the LinkedIn share button visible; consumer,
+      #   financial, education, insurance, newsletter, and waitlist programs
+      #   (`B2C_SUBSCRIPTIONS`, `FINANCIAL_SERVICES`, `ONLINE_EDUCATION`,
+      #   `ONLINE_INSURANCE`, `SUBSCRIBERS`, `WAITLIST`) start with it hidden. Omit it and
+      #   every share button keeps its standard default. Set only when the program is
+      #   created; it is not accepted on update.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal, nil]
+      optional :goal, enum: -> { GrowsurfRuby::CampaignCreateParams::Goal }
+
       # @!attribute name
       #
       #   @return [String, nil]
@@ -38,7 +51,7 @@ module GrowsurfRuby
       optional :rewards,
                -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::RewardCreateParams] }
 
-      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {})
+      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, goal: nil, name: nil, rewards: nil, request_options: {})
       #   @param type [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type]
       #
       #   @param company_logo_image_url [String]
@@ -47,6 +60,8 @@ module GrowsurfRuby
       #
       #   @param currency_iso [String]
       #
+      #   @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds share settings that suit that audience.
+      #
       #   @param name [String]
       #
       #   @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>]
@@ -63,6 +78,27 @@ module GrowsurfRuby
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # What the program is for, which seeds share settings that suit that audience.
+      #
+      # @see GrowsurfRuby::Models::CampaignCreateParams#goal
+      module Goal
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CUSTOMERS = :CUSTOMERS
+        USERS = :USERS
+        SUBSCRIBERS = :SUBSCRIBERS
+        WAITLIST = :WAITLIST
+        B2B_SAAS_SELF_SERVICE = :B2B_SAAS_SELF_SERVICE
+        B2B_SAAS_ENTERPRISE = :B2B_SAAS_ENTERPRISE
+        B2C_SUBSCRIPTIONS = :B2C_SUBSCRIPTIONS
+        FINANCIAL_SERVICES = :FINANCIAL_SERVICES
+        ONLINE_EDUCATION = :ONLINE_EDUCATION
+        ONLINE_INSURANCE = :ONLINE_INSURANCE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/growsurf_ruby/models/campaign_engagement_analytics.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # Current participant engagement for the selected program, period, and platform.
+    class CampaignEngagementAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      required :coverage_start_at, Integer, api_name: :coverageStartAt, nil?: true
+      required :metric_contract_version, Integer, api_name: :metricContractVersion
+      required :program_type, enum: -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::ProgramType }, api_name: :programType
+      required :timezone, String
+      required :interval, enum: -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Interval }
+      required :platform, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::PlatformFilter }
+      required :period, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Period }
+      required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+      required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+      required :totals, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Totals }
+      required :previous_period,
+               -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::PreviousPeriod },
+               api_name: :previousPeriod
+      required :comparison, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Comparison }
+      required :series,
+               -> {
+                 GrowsurfRuby::Internal::Type::ArrayOf[
+                   GrowsurfRuby::Models::CampaignEngagementAnalytics::SeriesPoint
+                 ]
+               }
+      required :breakdowns, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Breakdowns }
+
+      module ProgramType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :REFERRAL
+        AFFILIATE = :AFFILIATE
+      end
+
+      module Interval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+      end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ALL = :ALL
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+      end
+
+      module BreakdownPlatform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+      end
+
+      class Metric < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :value, Float, nil?: true
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        optional :delta, Float
+      end
+
+      class Totals < GrowsurfRuby::Internal::Type::BaseModel
+        required :active_participants, -> { Metric }, api_name: :activeParticipants
+        required :sharing_participants, -> { Metric }, api_name: :sharingParticipants
+        required :sharing_rate, -> { Metric }, api_name: :sharingRate
+        required :repeat_active_participants, -> { Metric }, api_name: :repeatActiveParticipants
+        required :repeat_sharing_participants, -> { Metric }, api_name: :repeatSharingParticipants
+        required :retained_active_participants, -> { Metric }, api_name: :retainedActiveParticipants
+        required :portal_views, -> { Metric }, api_name: :portalViews
+        required :share_actions, -> { Metric }, api_name: :shareActions
+      end
+
+      class Period < GrowsurfRuby::Internal::Type::BaseModel
+        required :from, Integer
+        required :to, Integer
+        required :effective_from, Integer, api_name: :effectiveFrom, nil?: true
+        required :previous_from, Integer, api_name: :previousFrom
+        required :previous_to, Integer, api_name: :previousTo
+      end
+
+      class PlatformFilter < GrowsurfRuby::Internal::Type::BaseModel
+        required :requested, enum: -> { Platform }
+        required :applied, enum: -> { Platform }
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+      end
+
+      class PreviousPeriod < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        required :totals, -> { Totals }, nil?: true
+      end
+
+      class ComparisonMetrics < GrowsurfRuby::Internal::Type::BaseModel
+        optional :active_participants, -> { Metric }, api_name: :activeParticipants
+        optional :sharing_participants, -> { Metric }, api_name: :sharingParticipants
+        optional :repeat_active_participants, -> { Metric }, api_name: :repeatActiveParticipants
+        optional :repeat_sharing_participants, -> { Metric }, api_name: :repeatSharingParticipants
+        optional :portal_views, -> { Metric }, api_name: :portalViews
+        optional :share_actions, -> { Metric }, api_name: :shareActions
+      end
+
+      class Comparison < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        required :metrics, -> { ComparisonMetrics }, nil?: true
+      end
+
+      class SeriesPoint < GrowsurfRuby::Internal::Type::BaseModel
+        required :from, Integer
+        required :to, Integer
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :portal_views, Integer, api_name: :portalViews
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      class PlatformBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { BreakdownPlatform }
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :portal_views, Integer, api_name: :portalViews
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      module PortalSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DEFAULT_LAUNCHER = :DEFAULT_LAUNCHER
+        SDK_OPEN = :SDK_OPEN
+        CSS_CLASS = :CSS_CLASS
+        EMBEDDABLE_ELEMENT = :EMBEDDABLE_ELEMENT
+        HOSTED_PORTAL = :HOSTED_PORTAL
+        NATIVE_WINDOW = :NATIVE_WINDOW
+        UNKNOWN = :UNKNOWN
+      end
+
+      class PortalSourceBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { PortalSource }
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :portal_views, Integer, api_name: :portalViews
+      end
+
+      class ShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, String
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      class FirstShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, String
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+      end
+
+      class Breakdowns < GrowsurfRuby::Internal::Type::BaseModel
+        required :platforms, -> { GrowsurfRuby::Internal::Type::ArrayOf[PlatformBreakdown] }
+        required :portal_view_sources,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[PortalSourceBreakdown] },
+                 api_name: :portalViewSources
+        required :share_channels,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[ShareChannelBreakdown] },
+                 api_name: :shareChannels
+        required :first_share_channels,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[FirstShareChannelBreakdown] },
+                 api_name: :firstShareChannels
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_activation_analytics
+    class CampaignRetrieveActivationAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      required :id, String
+      optional :cohort_from, Integer
+      optional :cohort_to, Integer
+      optional :cohort_interval,
+               enum: -> { GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::CohortInterval }
+      optional :observation_window_days,
+               enum: -> { GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::ObservationWindowDays }
+      optional :timezone, String
+
+      module CohortInterval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+      end
+
+      module ObservationWindowDays
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        SEVEN = 7
+        THIRTY = 30
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb

@@ -33,18 +33,27 @@ module GrowsurfRuby
       #   `clicked`, `bounced`, `spamComplaints`, and per-email-type metrics. When `email` and
       #   an interval are both requested, each `series` item also contains counts for emails
       #   sent during that period. Combine `email` with `previousPeriod` to include the same
-      #   email metrics in both windows.
+      #   email metrics in both windows. `engagement` adds covered participant activity
+      #   totals, comparisons, series, and breakdowns.
       #
       #   @return [String, nil]
       optional :include, String
 
       # @!attribute interval
       #   When set to `day`, `week`, or `month`, the response also includes a `series` array
-      #   with per-period totals. Defaults to `total` (no series).
+      #   with per-period totals and uses the same bucket size for `engagement.series`.
+      #   Defaults to `total` (no legacy series); `engagement.series` uses daily buckets when
+      #   `interval` is `total` or omitted.
       #
       #   @return [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval, nil]
       optional :interval, enum: -> { GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval }
 
+      # @!attribute platform
+      #   Participant platform used for `engagement`. Defaults to `ALL`.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform, nil]
+      optional :platform, enum: -> { GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform }
+
       # @!attribute start_date
       #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
       #   Required if `days` is not set.
@@ -52,7 +61,13 @@ module GrowsurfRuby
       #   @return [Integer, nil]
       optional :start_date, Integer
 
-      # @!method initialize(id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
+      # @!attribute timezone
+      #   IANA timezone used for engagement periods and buckets. Defaults to `UTC`.
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(id:, days: nil, end_date: nil, include: nil, interval: nil, platform: nil, start_date: nil, timezone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
       #
@@ -66,12 +81,18 @@ module GrowsurfRuby
       #
       #   @param interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
       #
+      #   @param platform [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform] Participant platform used for `engagement`. Defaults to `ALL`.
+      #
       #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
       #
+      #   @param timezone [String] IANA timezone used for engagement periods and buckets. Defaults to `UTC`.
+      #
       #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
       # When set to `day`, `week`, or `month`, the response also includes a `series` array
-      # with per-period totals. Defaults to `total` (no series).
+      # with per-period totals and uses the same bucket size for `engagement.series`.
+      # Defaults to `total` (no legacy series); `engagement.series` uses daily buckets when
+      # `interval` is `total` or omitted.
       module Interval
         extend GrowsurfRuby::Internal::Type::Enum
 
@@ -83,6 +104,18 @@ module GrowsurfRuby
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ALL = :ALL
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb

@@ -22,6 +22,9 @@ module GrowsurfRuby
       # Present only when `include` contains `email`.
       optional :email, -> { GrowsurfRuby::Models::EmailAnalytics }
 
+      # Present only when `include` contains `engagement`.
+      optional :engagement, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics }
+
       # @!attribute previous_period
       #   Present only when `include` contains `previousPeriod`.
       #

data/lib/growsurf_ruby/models/commission_structure.rb

@@ -32,7 +32,10 @@ module GrowsurfRuby
       optional :duration_in_months, Integer, api_name: :durationInMonths, nil?: true
 
       # @!attribute event
-      #   The event that generates a commission. Missing legacy values read as `SALE`.
+      #   The event that generates a commission. `CLICK` and `LEAD` require `FIXED`
+      #   with a positive `amount`; `amountISO` defaults to the program currency when
+      #   omitted. `SALE` supports `FIXED` or `PERCENT`. Missing legacy values read as
+      #   `SALE`.
       #
       #   @return [Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil]
       optional :event, enum: -> { GrowsurfRuby::CommissionStructure::Event }, nil?: true

data/lib/growsurf_ruby/models/participant_commission_list.rb

@@ -80,7 +80,7 @@ module GrowsurfRuby
         # @!attribute approved_at
         #
         #   @return [Integer, nil]
-        optional :approved_at, Integer, api_name: :approvedAt
+        optional :approved_at, Integer, api_name: :approvedAt, nil?: true
 
         # @!attribute campaign_currency_iso
         #
@@ -95,7 +95,7 @@ module GrowsurfRuby
         # @!attribute exchange_rate_at
         #
         #   @return [Integer, nil]
-        optional :exchange_rate_at, Integer, api_name: :exchangeRateAt
+        optional :exchange_rate_at, Integer, api_name: :exchangeRateAt, nil?: true
 
         # @!attribute fx_error
         #
@@ -110,12 +110,12 @@ module GrowsurfRuby
         # @!attribute paid_at
         #
         #   @return [Integer, nil]
-        optional :paid_at, Integer, api_name: :paidAt
+        optional :paid_at, Integer, api_name: :paidAt, nil?: true
 
         # @!attribute payout_queued_at
         #
         #   @return [Integer, nil]
-        optional :payout_queued_at, Integer, api_name: :payoutQueuedAt
+        optional :payout_queued_at, Integer, api_name: :payoutQueuedAt, nil?: true
 
         # @!attribute provider
         #
@@ -125,7 +125,7 @@ module GrowsurfRuby
         # @!attribute reversed_at
         #
         #   @return [Integer, nil]
-        optional :reversed_at, Integer, api_name: :reversedAt
+        optional :reversed_at, Integer, api_name: :reversedAt, nil?: true
 
         # @!attribute sale_amount_in_campaign_currency
         #

data/lib/growsurf_ruby/models/participant_payout_list.rb

@@ -79,12 +79,12 @@ module GrowsurfRuby
         # @!attribute exchange_rate_at
         #
         #   @return [Integer, nil]
-        optional :exchange_rate_at, Integer, api_name: :exchangeRateAt
+        optional :exchange_rate_at, Integer, api_name: :exchangeRateAt, nil?: true
 
         # @!attribute failed_at
         #
         #   @return [Integer, nil]
-        optional :failed_at, Integer, api_name: :failedAt
+        optional :failed_at, Integer, api_name: :failedAt, nil?: true
 
         # @!attribute fx_error
         #
@@ -94,7 +94,7 @@ module GrowsurfRuby
         # @!attribute issued_at
         #
         #   @return [Integer, nil]
-        optional :issued_at, Integer, api_name: :issuedAt
+        optional :issued_at, Integer, api_name: :issuedAt, nil?: true
 
         # @!attribute provider
         #
@@ -104,12 +104,12 @@ module GrowsurfRuby
         # @!attribute queued_at
         #
         #   @return [Integer, nil]
-        optional :queued_at, Integer, api_name: :queuedAt
+        optional :queued_at, Integer, api_name: :queuedAt, nil?: true
 
         # @!attribute reversed_at
         #
         #   @return [Integer, nil]
-        optional :reversed_at, Integer, api_name: :reversedAt
+        optional :reversed_at, Integer, api_name: :reversedAt, nil?: true
 
         # @!method initialize(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil, queued_at: nil, reversed_at: nil)
         #   @param id [String]

data/lib/growsurf_ruby/models.rb

@@ -41,6 +41,10 @@ module GrowsurfRuby
 
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  AnalyticsAvailability = GrowsurfRuby::Models::AnalyticsAvailability
+
+  AnalyticsUnavailableReason = GrowsurfRuby::Models::AnalyticsUnavailableReason
+
   AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
 
   AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
@@ -81,6 +85,9 @@ module GrowsurfRuby
   CampaignRetrieveAffiliateApplicationParams =
     GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
 
+  CampaignRetrieveActivationAnalyticsParams =
+    GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams
+
   CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams

data/lib/growsurf_ruby/resources/account.rb

@@ -3,20 +3,30 @@
 module GrowsurfRuby
   module Resources
     class Account
-      # Creates a new GrowSurf account. This is the only endpoint that does not require
-      # an API key. The response includes an API key for the new account, shown once in
-      # the response. The key is locked until the team owner's email address is
-      # verified: authenticated program and resource endpoints return a `403` with error
-      # code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
-      # /team/owner/verification-email`, then retry). A welcome email is sent to the
-      # address with the verification link and a set-password link for dashboard access.
-      # Accounts whose email is never verified are deleted automatically after 7 days.
-      # For security, the API key is rotated the first time the account owner signs in
-      # to the GrowSurf dashboard. Some actions (such as emailing participants)
-      # additionally require GrowSurf to verify the team first. By creating an account
-      # you agree, on behalf of the account holder, to GrowSurf's [Terms of
-      # Service](https://growsurf.com/terms) and [Privacy
-      # Policy](https://growsurf.com/privacy).
+      # Creates a new GrowSurf account. This is the only endpoint that does not require an API
+      # key. Before calling it, an authorized account owner must review and approve GrowSurf's
+      # [Terms of Service](https://growsurf.com/terms) and [Privacy
+      # Policy](https://growsurf.com/privacy). The account starts a 14-day Business trial
+      # without a credit card. The response includes an API key for the new account, shown once
+      # in the response. The key is a secret: store it in a secret manager and do not put it in
+      # logs, screenshots, URLs, model context, analytics, or generated output. A lost key
+      # cannot be recovered through this API, so do not create an account here unless you can
+      # store the key somewhere that outlives the current conversation. If you cannot, ask the
+      # account owner to connect GrowSurf's hosted MCP server at `https://mcp.growsurf.com`
+      # instead, which keeps the credential with your tool rather than in chat. The key is
+      # locked until the team owner's email address is verified: authenticated program and
+      # resource endpoints return a `403` with error code `EMAIL_NOT_VERIFIED_ERROR` until then
+      # (resend the email via `POST /team/owner/verification-email`, then retry). Verification
+      # unlocks this same key
+      # - keep it and retry rather than requesting a replacement. A welcome email is
+      # sent to the address with the verification link and a set-password link for
+      # dashboard access. Accounts whose email is never verified are deleted
+      # automatically after 7 days. Separately, for security, the API key is replaced
+      # the first time the account owner signs in to the GrowSurf dashboard; email
+      # verification does not trigger that, and the previous key then returns a `403`
+      # with error code `NOT_AUTHORIZED_ERROR`. Some actions (such as emailing participants)
+      # additionally require GrowSurf to verify the team first. Calling this endpoint
+      # accepts those policies on the account holder's behalf.
       #
       # @overload create(email:, company: nil, first_name: nil, last_name: nil, request_options: {})
       #

data/lib/growsurf_ruby/resources/campaign/design.rb

@@ -7,8 +7,11 @@ module GrowsurfRuby
         # Retrieves a program's configured design fields: the dashboard Program Editor's **Design**
         # tab plus the payout-destination confirmation page copy configured from payout integration
         # cards. This includes the GrowSurf window layout, header, share channels and invites,
-        # signup form, portal and landing pages, theme styling, and referral or affiliate summary
-        # and status sections. The available fields depend on the program type.
+        # signup form, Resources presentation, portal and landing pages, theme styling, and referral
+        # or affiliate summary and status sections. `referredExperience` includes the Claim Offer Popup for both program
+        # types, with its colors under `theme.referredExperienceOfferPopup`.
+        # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
+        # unknown values mean `INITIALS`.
         # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
         # `null` fields are returned as `null`; omitted and `null` fields use localized defaults.
         #
@@ -29,7 +32,8 @@ module GrowsurfRuby
         end
 
         # Updates a program's design configuration, including the payout-destination confirmation
-        # page copy configured from payout integration cards. Only the fields you send are changed;
+        # page copy and the Claim Offer Popup under `referredExperience`. Only the fields you send
+        # are changed;
         # anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
         # Unknown fields, fields not available for the program type, and invalid values return a
         # `400`. Landing-page custom code and JavaScript are not editable via the API.
@@ -38,8 +42,10 @@ module GrowsurfRuby
         #
         # @param id [String] GrowSurf program ID.
         #
-        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge, such as
-        #   `{ payoutDestinationConfirmation: { headline: "Confirm your {{payoutProvider}} payout email" } }`.
+        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge. `resources`
+        #   accepts `isPublicDisplayed`, `title`, `viewResourcesLinkText`, `backLinkText`,
+        #   `copyButtonText`, `copiedText`, `emptyState`, and `icon` (`type`: `DEFAULT`, `IMAGE`, or `NONE`, plus
+        #   `imageUrl` for `IMAGE`). Resource items use the Program Resources operations.
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/growsurf_ruby/resources/campaign/emails.rb

@@ -8,7 +8,8 @@ module GrowsurfRuby
         # Program Editor's **Emails** tab. Returns each editable email template
         # (`subject`, `preheader`, `body`, `isEnabled`) plus the `settings` block (sender,
         # contact, and design). The set of email templates returned depends on the program
-        # type (referral vs affiliate).
+        # type (referral vs affiliate). `offerClaimed` is available to both program types and sends
+        # while the Claim Offer Popup is enabled.
         #
         # @overload retrieve(id, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign/integrations.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Integrations
+        # Lists every integration this program can connect, each with its current state.
+        # Integrations that do not apply to the program type are omitted (for example,
+        # Wise on a referral program). Read-only: connecting an integration is an OAuth or
+        # credential handshake completed in the GrowSurf dashboard, so it cannot be done
+        # over the API. `connected` means credentials are stored, `enabled` means the
+        # integration is switched on and working, and `autoDisabled` means GrowSurf
+        # switched it off after repeated delivery failures — its credentials are still
+        # stored, but it delivers nothing until it is reconnected in the dashboard.
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::IntegrationListResponse]
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/integrations", id],
+            model: GrowsurfRuby::Models::Campaign::IntegrationListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end