growsurf-ruby 1.2.1 → 1.4.0

data/lib/growsurf_ruby/models.rb

@@ -41,6 +41,10 @@ module GrowsurfRuby
 
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
+
+  AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
+
   Team = GrowsurfRuby::Models::Team
 
   TeamUpdateParams = GrowsurfRuby::Models::TeamUpdateParams
@@ -49,11 +53,17 @@ module GrowsurfRuby
 
   CampaignAPI = GrowsurfRuby::Models::CampaignAPI
 
+  CampaignCreateAffiliateInviteParams = GrowsurfRuby::Models::CampaignCreateAffiliateInviteParams
+
   CampaignCreateMobileParticipantTokenParams =
     GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
   CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
 
+  CampaignListAffiliateApplicationsParams = GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams
+
+  CampaignListAffiliateInvitesParams = GrowsurfRuby::Models::CampaignListAffiliateInvitesParams
+
   CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
 
   CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
@@ -66,10 +76,19 @@ module GrowsurfRuby
 
   CampaignListReferralsParams = GrowsurfRuby::Models::CampaignListReferralsParams
 
+  CampaignResendAffiliateInviteParams = GrowsurfRuby::Models::CampaignResendAffiliateInviteParams
+
+  CampaignRetrieveAffiliateApplicationParams =
+    GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
+
   CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  CampaignReviewAffiliateApplicationParams = GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams
+
+  CampaignRevokeAffiliateInviteParams = GrowsurfRuby::Models::CampaignRevokeAffiliateInviteParams
+
   CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
 
   CommissionStructure = GrowsurfRuby::Models::CommissionStructure

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

@@ -4,12 +4,13 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Design
-        # Retrieves a program's design configuration — the same surface as the dashboard
-        # Program Editor's **Design** tab: the GrowSurf window layout, header, share
-        # channels + invite, signup form, portal/landing pages, theme styling, and the
-        # referral/affiliate summary + status sections. This is a large object whose
-        # available fields depend on the program type; the response includes every field
-        # and its current value, which is the same shape you send back on `PATCH`.
+        # 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.
+        # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
+        # `null` fields are returned as `null`; omitted and `null` fields use localized defaults.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -27,17 +28,18 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's design configuration. 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.
+        # 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;
+        # 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.
         #
         # @overload update(id, body, request_options: {})
         #
         # @param id [String] GrowSurf program ID.
         #
-        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge.
+        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge, such as
+        #   `{ payoutDestinationConfirmation: { headline: "Confirm your {{payoutProvider}} payout email" } }`.
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -6,9 +6,9 @@ module GrowsurfRuby
       class Options
         # Retrieves a program's options — the same surface as the dashboard Program
         # Editor's **Options** tab. Includes reward/fraud approval, anti-fraud lists +
-        # toggles, referral cookie/credit windows, reCAPTCHA, payout threshold + tax
-        # settings (affiliate only), and notification-email settings.
-        # `fraud.recaptcha.secretKey` is never returned.
+        # toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment +
+        # application review, payout threshold + tax settings (affiliate only), and
+        # notification-email settings. `fraud.recaptcha.secretKey` is never returned.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -28,10 +28,10 @@ module GrowsurfRuby
 
         # Updates a program's options. Only the fields you send are changed. Some fields
         # are program-type specific (`requireManualRewardApproval`/`autoFulfillRewards`
-        # are referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
-        # affiliate programs require `requireParticipantAuth: true`).
-        # `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null`
-        # means "never expires".
+        # are referral-only; `affiliateApplicationMode`/`affiliateReapplicationPolicy`
+        # and `payoutThreshold`/`taxDocumentation` are affiliate-only, and affiliate
+        # programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
+        # is write-only. `referralCreditWindowDays: null` means "never expires".
         #
         # @overload update(id, body, request_options: {})
         #

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

@@ -31,14 +31,20 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a participant by GrowSurf participant ID or email address.
+        # Updates a participant by GrowSurf participant ID or email address. For affiliate
+        # programs, set `affiliateStatus` to `APPROVED`, `SUSPENDED`, or `BANNED`.
+        # `APPROVED` enrolls the participant as an affiliate. `SUSPENDED` and `BANNED`
+        # require an existing affiliate. This endpoint does not accept `isAffiliate`, and
+        # affiliate enrollment cannot be removed through REST.
         #
-        # @overload update(participant_id_or_email, id:, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, paypal_email: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        # @overload update(participant_id_or_email, id:, affiliate_status: nil, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
         #
         # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
         #
         # @param id [String] Path param: GrowSurf program ID.
         #
+        # @param affiliate_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::AffiliateStatus] Body param: Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected for non-affiliates.
+        #
         # @param email [String] Body param
         #
         # @param first_name [String] Body param
@@ -49,8 +55,6 @@ module GrowsurfRuby
         #
         # @param notes [String] Body param: Freeform internal notes about the participant (internal only, never ex
         #
-        # @param paypal_email [String] Body param: The participant's PayPal email address, used for affiliate payouts.
-        #
         # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus] Body param
         #
         # @param referred_by [String] Body param
@@ -143,9 +147,15 @@ module GrowsurfRuby
         # {GrowsurfRuby::Models::Campaign::ParticipantAddParams} for more details.
         #
         # Adds a new participant to the program. If the email already exists, the existing
-        # participant is returned.
+        # participant is returned unchanged. For affiliate programs, set `isAffiliate` to
+        # `true` to enroll a new participant as an approved affiliate or `false` to create
+        # a non-affiliate. If you omit `isAffiliate`, a valid `referredBy` creates a
+        # referred non-affiliate; without a valid referrer, the new participant is enrolled
+        # as an approved affiliate. You can send a valid `referredBy` with
+        # `isAffiliate: true` to keep the referral attribution and enroll the participant
+        # as an affiliate.
         #
-        # @overload add(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil, request_options: {})
+        # @overload add(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, is_affiliate: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil, request_options: {})
         #
         # @param id [String] GrowSurf program ID.
         #
@@ -157,6 +167,8 @@ module GrowsurfRuby
         #
         # @param ip_address [String]
         #
+        # @param is_affiliate [Boolean] Affiliate programs only. Controls affiliate enrollment for a new participant. `true` enrolls the participant with `affiliateStatus: APPROVED`; `false` creates a non-affiliate without `affiliateStatus`. Existing participants are returned unchanged.
+        #
         # @param last_name [String]
         #
         # @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
@@ -670,9 +682,14 @@ module GrowsurfRuby
         # details.
         #
         # Retrieves analytics for a single participant — all-time engagement counters,
-        # leaderboard ranks, and per-channel share counts (plus affiliate money metrics
-        # for affiliate programs). Useful for segmenting and re-engaging participants.
-        # Pass `include=series` to also get this participant's own activity over time.
+        # leaderboard ranks, and per-channel share counts (plus affiliate revenue,
+        # commission, and payout metrics for affiliate programs). Pass `include=email`
+        # for `sent` (accepted for delivery), `delivered`, `opened`, `clicked`,
+        # `bounced`, and `spamComplaints` metrics attributed to this participant,
+        # including invitations they sent. Use `include=email,series` to include the
+        # same counts in each UTC series bucket. `days`, `startDate`, and `endDate`
+        # filter only the optional `series` and `email` data. They do not filter the
+        # top-level `analytics`, `ranks`, or `shareCount` values.
         #
         # @overload retrieve_analytics(participant_id_or_email, id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
         #
@@ -680,15 +697,15 @@ module GrowsurfRuby
         #
         # @param id [String] GrowSurf program ID.
         #
-        # @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        # @param days [Integer] Last number of days for optional `series` and `email` analytics. Defaults to 365. Maxi
         #
-        # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        # @param end_date [Integer] End of a custom `series` and `email` analytics window as a Unix timestamp in milli
         #
-        # @param include [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include] Set to `series` to also return this participant's own activity per period.
+        # @param include [String] Comma-separated optional data. `series` returns this participant's own activity
         #
-        # @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used when `include` contains `series`).
         #
-        # @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        # @param start_date [Integer] Start of a custom `series` and `email` analytics window as a Unix timestamp in mi
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -711,6 +728,76 @@ module GrowsurfRuby
           )
         end
 
+        # Returns a participant's payout-destination status across every payout provider
+        # enabled for the program (PayPal and/or Wise). For each provider it reports the
+        # current status, the confirmed claim email, the legal recipient type, and — when a
+        # delivery bounced or a recipient was invalidated — the repair reason.
+        # `activeProvider` is the provider that currently gets paid, or `null` until the
+        # participant confirms one.
+        #
+        # @overload get_payout_destination(participant_id_or_email, id:, request_options: {})
+        #
+        # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationParams
+        def get_payout_destination(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/participant/%2$s/payout-destination", id, participant_id_or_email],
+            model: GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse,
+            options: options
+          )
+        end
+
+        # Sends the participant a one-time link to confirm their payout destination for
+        # the chosen provider. Only the participant can open the link and confirm — this
+        # endpoint just triggers the message. The provider must be enabled for the
+        # program.
+        #
+        # @overload request_payout_destination_confirmation(participant_id_or_email, id:, provider:, request_options: {})
+        #
+        # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param provider [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider] Body param: The payout provider the participant should confirm a destination for.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams
+        def request_payout_destination_confirmation(participant_id_or_email, params)
+          parsed, options =
+            GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: [
+              "campaign/%1$s/participant/%2$s/payout-destination/request-confirmation",
+              id,
+              participant_id_or_email
+            ],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [GrowsurfRuby::Client]

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

@@ -30,7 +30,7 @@ module GrowsurfRuby
         # Enabling an active reward of a type automatically enables that reward type on
         # the program.
         #
-        # @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        # @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
         #
         # @param id [String] Path param: GrowSurf program ID.
         #
@@ -44,6 +44,8 @@ module GrowsurfRuby
         #
         # @param description [String] Body param
         #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event] Body param: The referral event that earns this Campaign Reward. Use `LEAD` or `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. When omitted, it defaults to `CONVERSION`.
+        #
         # @param image_url [String] Body param
         #
         # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
@@ -70,7 +72,7 @@ module GrowsurfRuby
         #
         # @param referred_reward_upfront [Boolean] Body param
         #
-        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the referred friend's side of a double-sided rewa
+        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax treatment override for the referred friend's side of a double-sided rewa
         #
         # @param title [String] Body param
         #
@@ -98,7 +100,7 @@ module GrowsurfRuby
         # copy; removing a key that campaign copy still references returns a `409` listing
         # the referencing fields.
         #
-        # @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        # @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
         #
         # @param campaign_reward_id [String] Path param: Campaign reward ID.
         #
@@ -112,6 +114,8 @@ module GrowsurfRuby
         #
         # @param description [String] Body param
         #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event] Body param: The referral event that earns this Campaign Reward. Use `LEAD` or `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. When omitted, the stored event is preserved.
+        #
         # @param image_url [String] Body param
         #
         # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
@@ -138,7 +142,7 @@ module GrowsurfRuby
         #
         # @param referred_reward_upfront [Boolean] Body param
         #
-        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the referred friend's side of a double-sided rewa
+        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax treatment override for the referred friend's side of a double-sided rewa
         #
         # @param title [String] Body param
         #

data/lib/growsurf_ruby/resources/campaign.rb

@@ -76,7 +76,7 @@ module GrowsurfRuby
         )
       end
 
-      # Creates a new program, plus any optional program rewards. The new program is
+      # Creates a new program, plus any optional campaign rewards. The new program is
       # created in `DRAFT` status and owned by the API key's bound team.
       #
       # @overload create(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {})
@@ -89,7 +89,7 @@ module GrowsurfRuby
       #
       # @param currency_iso [String] ISO 4217 currency code. Defaults to USD. Chosen when the program is created and immutable afterward — it cannot be changed on update.
       #
-      # @param name [String] The program name. Defaults to "Untitled Program".
+      # @param name [String] The program name. Defaults to a generated friendly label plus the creation date.
       #
       # @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>] Optional inline rewards to create with the program.
       #
@@ -162,6 +162,36 @@ module GrowsurfRuby
         )
       end
 
+      # Invites someone to join the affiliate program. GrowSurf emails them a single-use
+      # accept link; accepting it enrolls them as an approved affiliate without going
+      # through the public application. One active invite can exist per email address.
+      #
+      # @overload create_affiliate_invite(id, email:, first_name: nil, last_name: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param email [String] Valid email address to invite. Maximum 255 characters.
+      #
+      # @param first_name [String] Invitee first name, used in the invite email. Maximum 255 characters.
+      #
+      # @param last_name [String] Invitee last name. Maximum 255 characters.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateInvite]
+      #
+      # @see GrowsurfRuby::Models::CampaignCreateAffiliateInviteParams
+      def create_affiliate_invite(id, params)
+        parsed, options = GrowsurfRuby::CampaignCreateAffiliateInviteParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["campaign/%1$s/affiliate-invites", id],
+          body: parsed,
+          model: GrowsurfRuby::AffiliateInvite,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams} for more
       # details.
@@ -209,6 +239,67 @@ module GrowsurfRuby
         )
       end
 
+      # Lists an affiliate program's applications, newest first. Applications exist on
+      # programs that review public signups (an `affiliateApplicationMode` of
+      # `MANUAL_REVIEW` or `AUTO_APPROVE`). A pending applicant is not a participant
+      # until their application is approved.
+      #
+      # @overload list_affiliate_applications(id, limit: nil, offset: nil, status: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param limit [Integer] How many applications to return per page (1-100).
+      #
+      # @param offset [Integer] Offset number used to skip through a result set.
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::Status] Only return applications with this status.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateApplicationListResponse]
+      #
+      # @see GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams
+      def list_affiliate_applications(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListAffiliateApplicationsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/affiliate-applications", id],
+          query: query,
+          model: GrowsurfRuby::Models::AffiliateApplicationListResponse,
+          options: options
+        )
+      end
+
+      # Lists an affiliate program's enrollment invites, newest first.
+      #
+      # @overload list_affiliate_invites(id, limit: nil, offset: nil, status: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param limit [Integer] How many invites to return per page (1-100).
+      #
+      # @param offset [Integer] Offset number used to skip through a result set.
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::Status] Only return invites with this status.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateInviteListResponse]
+      #
+      # @see GrowsurfRuby::Models::CampaignListAffiliateInvitesParams
+      def list_affiliate_invites(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListAffiliateInvitesParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/affiliate-invites", id],
+          query: query,
+          model: GrowsurfRuby::Models::AffiliateInviteListResponse,
+          options: options
+        )
+      end
+
       # **Affiliate programs only.** Retrieves a paged list of all participant
       # commissions in an affiliate program.
       #
@@ -379,12 +470,72 @@ module GrowsurfRuby
         )
       end
 
+      # Re-sends a pending invite with a fresh accept link (the previous link stops
+      # working). Resends are rate limited per invite; retry after a few minutes if a
+      # resend was just sent.
+      #
+      # @overload resend_affiliate_invite(invite_id, id:, request_options: {})
+      #
+      # @param invite_id [String] Affiliate invite ID.
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateInvite]
+      #
+      # @see GrowsurfRuby::Models::CampaignResendAffiliateInviteParams
+      def resend_affiliate_invite(invite_id, params)
+        parsed, options = GrowsurfRuby::CampaignResendAffiliateInviteParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :post,
+          path: ["campaign/%1$s/affiliate-invites/%2$s/resend", id, invite_id],
+          model: GrowsurfRuby::AffiliateInvite,
+          options: options
+        )
+      end
+
+      # Returns one affiliate application, including its submitted form answers.
+      #
+      # @overload retrieve_affiliate_application(application_id, id:, request_options: {})
+      #
+      # @param application_id [String] Affiliate application ID.
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateApplication]
+      #
+      # @see GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
+      def retrieve_affiliate_application(application_id, params)
+        parsed, options = GrowsurfRuby::CampaignRetrieveAffiliateApplicationParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/affiliate-applications/%2$s", id, application_id],
+          model: GrowsurfRuby::AffiliateApplication,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
       #
       # Retrieves analytics for a program. Pass `interval` to also get a time-series
       # (`series`) alongside the totals, and `include` to add previous-period totals,
-      # status breakdowns, or derived rates — useful for detecting trends over time.
+      # status breakdowns, derived rates, or email performance. Add `email` to `include`
+      # for `sent` (accepted for delivery), `delivered`, `opened`, `clicked`, `bounced`,
+      # and `spamComplaints` metrics plus per-email-type breakdowns. Email rates are
+      # ratios from `0` to `1`, and `isPartial` identifies windows that begin before
+      # complete coverage.
       #
       # @overload retrieve_analytics(id, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
       #
@@ -394,7 +545,7 @@ module GrowsurfRuby
       #
       # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
       #
-      # @param include [String] Comma-separated list of optional enrichments (opt-in to keep the default response
+      # @param include [String] Comma-separated list of optional data to include: `previousPeriod` adds totals for
       #
       # @param interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
       #
@@ -417,6 +568,82 @@ module GrowsurfRuby
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams} for more
+      # details.
+      #
+      # Decides a pending application. Set `status` to `APPROVED` to enroll the applicant
+      # (this creates the participant, or upgrades an existing participant with the same
+      # email), or to `DENIED` with an optional `rejectionReason`. A denied applicant may
+      # reapply after the program's reapplication cooldown; send an earlier
+      # `reapplyAllowedAt` (without `status`) to shorten that wait for one applicant.
+      # Provide exactly one of `status` or `reapplyAllowedAt`. Denial-only fields are
+      # only valid with `status` set to `DENIED`. Approval is idempotent: repeating it
+      # returns the same participant.
+      #
+      # @overload review_affiliate_application(application_id, id:, allow_immediate_reapply: nil, reapply_allowed_at: nil, rejection_reason: nil, review_note: nil, status: nil, request_options: {})
+      #
+      # @param application_id [String] Affiliate application ID.
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param allow_immediate_reapply [Boolean] Only valid when `status` is `DENIED`; let the applicant reapply right away
+      #
+      # @param reapply_allowed_at [Integer] For an already-denied application, move the reapplication window to this earlier
+      #
+      # @param rejection_reason [String] Short reason recorded with a denial. Only valid when `status` is `DENIED`. Maximum 255 characters.
+      #
+      # @param review_note [String] Private note recorded with a denial. Only valid when `status` is `DENIED`; never shown to the applicant. Maximum 500 characters.
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::Status] The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateApplication]
+      #
+      # @see GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams
+      def review_affiliate_application(application_id, params)
+        parsed, options = GrowsurfRuby::CampaignReviewAffiliateApplicationParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :patch,
+          path: ["campaign/%1$s/affiliate-applications/%2$s", id, application_id],
+          body: parsed,
+          model: GrowsurfRuby::AffiliateApplication,
+          options: options
+        )
+      end
+
+      # Revokes a pending invite. Its emailed accept link stops working immediately.
+      #
+      # @overload revoke_affiliate_invite(invite_id, id:, request_options: {})
+      #
+      # @param invite_id [String] Affiliate invite ID.
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AffiliateInvite]
+      #
+      # @see GrowsurfRuby::Models::CampaignRevokeAffiliateInviteParams
+      def revoke_affiliate_invite(invite_id, params)
+        parsed, options = GrowsurfRuby::CampaignRevokeAffiliateInviteParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :delete,
+          path: ["campaign/%1$s/affiliate-invites/%2$s", id, invite_id],
+          model: GrowsurfRuby::AffiliateInvite,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [GrowsurfRuby::Client]

data/lib/growsurf_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrowsurfRuby
-  VERSION = "1.2.1"
+  VERSION = "1.4.0"
 end