growsurf-ruby 0.8.0 → 1.1.0

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

@@ -33,7 +33,7 @@ module GrowsurfRuby
 
         # Updates a participant by GrowSurf participant ID or email address.
         #
-        # @overload update(participant_id_or_email, id:, email: nil, first_name: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        # @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: {})
         #
         # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
         #
@@ -47,6 +47,10 @@ module GrowsurfRuby
         #
         # @param metadata [Hash{Symbol=>Object}] Body param: Shallow custom metadata object.
         #
+        # @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
@@ -102,6 +106,39 @@ module GrowsurfRuby
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteParams} for more details.
+        #
+        # Deletes a list of participants from a program in one request. Each entry in
+        # `participants` is a GrowSurf participant ID or an email address (mixed lists
+        # are allowed). Up to `200` entries per request — chunk larger lists across
+        # multiple calls. The response reports a per-row `status` for every submitted
+        # entry, so a `200` can include rows that were `NOT_FOUND` or failed. Deletion
+        # is permanent and removes the participants' referrals, rewards, commissions,
+        # and payout records.
+        #
+        # @overload bulk_delete(id, participants:, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param participants [Array<String>] GrowSurf participant IDs and/or email addresses to delete. Mixed entries are al
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteParams
+        def bulk_delete(id, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantBulkDeleteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/participants/bulk-delete", id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {GrowsurfRuby::Models::Campaign::ParticipantAddParams} for more details.
         #
@@ -126,7 +163,7 @@ module GrowsurfRuby
         #
         # @param mobile_instance_id [String] Optional app-install scoped identifier for native mobile anti-fraud. Recommended
         #
-        # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
+        # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus] The referral credit status; only meaningful when `referred_by` resolves to a ref
         #
         # @param referred_by [String] Referrer participant ID or email address.
         #
@@ -305,6 +342,13 @@ module GrowsurfRuby
         # Records a sale made by a referred customer and generates affiliate commissions
         # for their referrer when applicable.
         #
+        # At least one transaction identifier is required: one of +external_id+,
+        # +transaction_id+, +order_id+, +payment_id+, +invoice_id+, +payment_intent_id+,
+        # or +charge_id+. +customer_id+ and +subscription_id+ do not count, since they
+        # identify the customer or subscription rather than the specific transaction.
+        # Without an identifier, resending the same sale creates a duplicate commission
+        # and double-pays the referrer; the server rejects such requests with HTTP 400.
+        #
         # @overload record_transaction(participant_id_or_email, id:, currency:, gross_amount:, amount_cash_net: nil, amount_paid: nil, charge_id: nil, customer_id: nil, description: nil, external_id: nil, invoice_id: nil, invoice_subtotal_excluding_tax: nil, invoice_total: nil, invoice_total_excluding_tax: nil, net_amount: nil, order_id: nil, paid_at: nil, payment_id: nil, payment_intent_id: nil, subscription_id: nil, tax_amount: nil, total_tax_amount: nil, total_tax_amounts: nil, total_taxes: nil, transaction_id: nil, request_options: {})
         #
         # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
@@ -438,6 +482,8 @@ module GrowsurfRuby
         end
 
         # Sends email invites on behalf of a participant to a list of email addresses.
+        # Sending invites via the API requires a verified custom email domain on the
+        # program; the request fails until one is verified.
         #
         # @overload send_invites(participant_id_or_email, id:, email_addresses:, message_text:, subject_text:, request_options: {})
         #
@@ -534,6 +580,128 @@ module GrowsurfRuby
           )
         end
 
+        # Sends an email to a participant. Provide EITHER `email_type` to trigger one of the
+        # program's configured email templates, OR `subject` + `body` for a free-form email.
+        # Free-form emails are sent with the same compliance handling (company name,
+        # postal address, and an unsubscribe link are added automatically, and unsubscribed
+        # participants are suppressed). Sending requires the account to be verified by the
+        # GrowSurf team. Requires a verified custom email domain on the program (set up
+        # in Campaign Editor > 3. Emails > Email Settings). Returns `400` until one is
+        # verified.
+        # The email is accepted for delivery.
+        #
+        # @overload email(participant_id_or_email, id:, body: nil, email_type: nil, preheader: nil, subject: 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 body [String] Body param: HTML body for a free-form email. You can personalize it with dynamic text, inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`. See [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
+        #
+        # @param email_type [String] Body param: The program email template to send (template mode). Send the camelCase
+        #
+        # @param preheader [String] Body param: Optional preheader text for a free-form email.
+        #
+        # @param subject [String] Body param: Subject line for a free-form email. Supports dynamic text (`{{...}}` tokens), the same as the body.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantEmailResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantEmailParams
+        def email(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantEmailParams.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/email", id, participant_id_or_email],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::ParticipantEmailResponse,
+            options: options
+          )
+        end
+
+        # Returns a participant's activity logs, most recent first (offset/limit paginated).
+        #
+        # @overload list_activity_logs(participant_id_or_email, id:, limit: nil, offset: 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 limit [Integer] Query param: Number of logs to return (1–100, default 20).
+        #
+        # @param offset [Integer] Query param: Number of logs to skip.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantListActivityLogsParams
+        def list_activity_logs(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantListActivityLogsParams.dump_request(params)
+          query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+          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/activity-logs", id, participant_id_or_email],
+            query: query,
+            model: GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams} for more
+        # 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.
+        #
+        # @overload retrieve_analytics(participant_id_or_email, id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
+        #
+        # @param participant_id_or_email [String] GrowSurf participant ID or URL-encoded participant email address.
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #
+        # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        #
+        # @param include [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include] Set to `series` to also return this participant's own activity per period.
+        #
+        # @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        #
+        # @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams
+        def retrieve_analytics(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/participant/%2$s/analytics", id, participant_id_or_email],
+            query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
+            model: GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [GrowsurfRuby::Client]

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

@@ -4,7 +4,7 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # Retrieves the active, visible, and enabled rewards configured for a program.
+        # Retrieves the rewards configured for a program.
         #
         # @overload list(id, request_options: {})
         #
@@ -16,7 +16,7 @@ module GrowsurfRuby
         def list(id, params = {})
           @client.request(
             method: :get,
-            path: ["campaign/%1$s/rewards", id],
+            path: ["campaign/%1$s/reward-configs", id],
             model: GrowsurfRuby::Models::Campaign::CampaignRewardListResponse,
             options: params[:request_options]
           )
@@ -25,7 +25,7 @@ module GrowsurfRuby
         # Creates a reward for a program. The reward `type` must be compatible with the
         # program type.
         #
-        # @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: 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, title: nil, request_options: {})
+        # @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: {})
         #
         # @param id [String] Path param: GrowSurf program ID.
         #
@@ -35,17 +35,15 @@ module GrowsurfRuby
         #
         # @param conversions_required [Integer] Body param
         #
-        # @param coupon_code [String] Body param
+        # @param coupon_code [String] Body param: Legacy static coupon code shown to the referrer in the reward-won emai
         #
         # @param description [String] Body param
         #
         # @param image_url [String] Body param
         #
-        # @param is_active [Boolean] Body param
+        # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
         #
-        # @param is_unlimited [Boolean] Body param
-        #
-        # @param is_visible [Boolean] Body param
+        # @param is_visible [Boolean] Body param: Whether the reward is enabled. When `false` the reward is disabled: hi
         #
         # @param limit [Integer] Body param
         #
@@ -53,22 +51,26 @@ module GrowsurfRuby
         #
         # @param metadata [Hash{Symbol=>Object}] Body param: Custom key/value metadata (single-level; values are stored as string
         #
-        # @param next_milestone_prefix [String] Body param
+        # @param next_milestone_prefix [String] Body param: Text shown before a participant's referral count in milestone-prog
         #
-        # @param next_milestone_suffix [String] Body param
+        # @param next_milestone_suffix [String] Body param: Text shown after a participant's referral count in milestone-progr
         #
-        # @param number_of_winners [Integer] Body param
+        # @param number_of_winners [Integer] Body param: The number of winners (`LEADERBOARD` rewards only). With `limitDur
         #
         # @param order [Integer] Body param
         #
-        # @param referral_coupon_code [String] Body param
+        # @param referral_coupon_code [String] Body param: Legacy static coupon code shown to the referred friend (double-si
         #
         # @param referral_description [String] Body param
         #
         # @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 title [String] Body param
         #
+        # @param value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the reward (the referrer's side of a double-sided
+        #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [GrowsurfRuby::Models::Campaign::Reward]
@@ -78,19 +80,19 @@ module GrowsurfRuby
           parsed, options = GrowsurfRuby::Campaign::RewardCreateParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["campaign/%1$s/rewards", id],
+            path: ["campaign/%1$s/reward-configs", id],
             body: parsed,
             model: GrowsurfRuby::Models::Campaign::Reward,
             options: options
           )
         end
 
-        # Updates an existing program reward. Only the fields you send are changed;
+        # Updates an existing campaign reward. Only the fields you send are changed;
         # `type` is immutable and must not be supplied.
         #
-        # @overload update(reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: 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, title: nil, request_options: {})
+        # @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: {})
         #
-        # @param reward_id [String] Path param: Program reward ID.
+        # @param campaign_reward_id [String] Path param: Campaign reward ID.
         #
         # @param id [String] Path param: GrowSurf program ID.
         #
@@ -98,17 +100,15 @@ module GrowsurfRuby
         #
         # @param conversions_required [Integer] Body param
         #
-        # @param coupon_code [String] Body param
+        # @param coupon_code [String] Body param: Legacy static coupon code shown to the referrer in the reward-won emai
         #
         # @param description [String] Body param
         #
         # @param image_url [String] Body param
         #
-        # @param is_active [Boolean] Body param
+        # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
         #
-        # @param is_unlimited [Boolean] Body param
-        #
-        # @param is_visible [Boolean] Body param
+        # @param is_visible [Boolean] Body param: Whether the reward is enabled. When `false` the reward is disabled: hi
         #
         # @param limit [Integer] Body param
         #
@@ -116,28 +116,32 @@ module GrowsurfRuby
         #
         # @param metadata [Hash{Symbol=>Object}] Body param: Custom key/value metadata (single-level; values are stored as string
         #
-        # @param next_milestone_prefix [String] Body param
+        # @param next_milestone_prefix [String] Body param: Text shown before a participant's referral count in milestone-prog
         #
-        # @param next_milestone_suffix [String] Body param
+        # @param next_milestone_suffix [String] Body param: Text shown after a participant's referral count in milestone-progr
         #
-        # @param number_of_winners [Integer] Body param
+        # @param number_of_winners [Integer] Body param: The number of winners (`LEADERBOARD` rewards only). With `limitDur
         #
         # @param order [Integer] Body param
         #
-        # @param referral_coupon_code [String] Body param
+        # @param referral_coupon_code [String] Body param: Legacy static coupon code shown to the referred friend (double-si
         #
         # @param referral_description [String] Body param
         #
         # @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 title [String] Body param
         #
+        # @param value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the reward (the referrer's side of a double-sided
+        #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [GrowsurfRuby::Models::Campaign::Reward]
         #
         # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams
-        def update(reward_id, params)
+        def update(campaign_reward_id, params)
           parsed, options = GrowsurfRuby::Campaign::RewardUpdateParams.dump_request(params)
           id =
             parsed.delete(:id) do
@@ -145,18 +149,18 @@ module GrowsurfRuby
             end
           @client.request(
             method: :patch,
-            path: ["campaign/%1$s/rewards/%2$s", id, reward_id],
+            path: ["campaign/%1$s/reward-configs/%2$s", id, campaign_reward_id],
             body: parsed,
             model: GrowsurfRuby::Models::Campaign::Reward,
             options: options
           )
         end
 
-        # Deletes a program reward.
+        # Deletes a campaign reward.
         #
-        # @overload delete(reward_id, id:, request_options: {})
+        # @overload delete(campaign_reward_id, id:, request_options: {})
         #
-        # @param reward_id [String] Program reward ID.
+        # @param campaign_reward_id [String] Campaign reward ID.
         #
         # @param id [String] GrowSurf program ID.
         #
@@ -165,7 +169,7 @@ module GrowsurfRuby
         # @return [GrowsurfRuby::Models::Campaign::DeleteRewardResponse]
         #
         # @see GrowsurfRuby::Models::Campaign::RewardDeleteParams
-        def delete(reward_id, params)
+        def delete(campaign_reward_id, params)
           parsed, options = GrowsurfRuby::Campaign::RewardDeleteParams.dump_request(params)
           id =
             parsed.delete(:id) do
@@ -173,7 +177,7 @@ module GrowsurfRuby
             end
           @client.request(
             method: :delete,
-            path: ["campaign/%1$s/rewards/%2$s", id, reward_id],
+            path: ["campaign/%1$s/reward-configs/%2$s", id, campaign_reward_id],
             model: GrowsurfRuby::Models::Campaign::DeleteRewardResponse,
             options: options
           )

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

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Webhooks
+        # Lists a program's webhooks (secrets are never returned).
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookListResponse]
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/webhooks", id],
+            model: GrowsurfRuby::Models::Campaign::WebhookListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Adds a webhook to the program.
+        #
+        # @overload create(id, payload_url:, events: nil, is_enabled: nil, secret: nil, request_options: {})
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param payload_url [String] Body param: The URL that receives webhook deliveries.
+        #
+        # @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>] Body param: The events this webhook is subscribed to. When omitted, it is subscri
+        #
+        # @param is_enabled [Boolean] Body param
+        #
+        # @param secret [String] Body param: Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC hea
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Webhook]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookCreateParams
+        def create(id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/webhooks", id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Webhook,
+            options: options
+          )
+        end
+
+        # Updates a webhook by id.
+        #
+        # @overload update(webhook_id, id:, events: nil, is_enabled: nil, payload_url: nil, secret: nil, request_options: {})
+        #
+        # @param webhook_id [String] Path param: The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>] Body param
+        #
+        # @param is_enabled [Boolean] Body param
+        #
+        # @param payload_url [String] Body param
+        #
+        # @param secret [String] Body param: Write-only.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Webhook]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookUpdateParams
+        def update(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookUpdateParams.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/webhooks/%2$s", id, webhook_id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Webhook,
+            options: options
+          )
+        end
+
+        # Removes a webhook by id.
+        #
+        # @overload delete(webhook_id, id:, request_options: {})
+        #
+        # @param webhook_id [String] The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookDeleteResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookDeleteParams
+        def delete(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookDeleteParams.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/webhooks/%2$s", id, webhook_id],
+            model: GrowsurfRuby::Models::Campaign::WebhookDeleteResponse,
+            options: options
+          )
+        end
+
+        # Sends a live test event to a webhook using its stored URL and secret.
+        #
+        # @overload test(webhook_id, id:, event: nil, request_options: {})
+        #
+        # @param webhook_id [String] Path param: The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent] Body param: The event to simulate. When omitted, the webhook's first enabled even
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookTestResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookTestParams
+        def test(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookTestParams.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/webhooks/%2$s/test", id, webhook_id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::WebhookTestResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end