growsurf-ruby 1.0.0 → 1.1.0

data/lib/growsurf_ruby/resources/account.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+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, but the key is
+      # locked until the account's email address is verified: authenticated endpoints
+      # outside the `Accounts` group return a `403` with error code
+      # `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+      # /account/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 the GrowSurf team to verify the account
+      # 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).
+      #
+      # @overload create(email:, company: nil, first_name: nil, last_name: nil, request_options: {})
+      #
+      # @param email [String] The email address for the new account. Personal emails and disposable email addresses are not accepted.
+      #
+      # @param company [String]
+      #
+      # @param first_name [String]
+      #
+      # @param last_name [String]
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountCreateResponse]
+      #
+      # @see GrowsurfRuby::Models::AccountCreateParams
+      def create(params)
+        parsed, options = GrowsurfRuby::AccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "accounts",
+          body: parsed,
+          model: GrowsurfRuby::Models::AccountCreateResponse,
+          options: options
+        )
+      end
+
+      # Retrieves the account that owns the API key: profile and GrowSurf-team
+      # verification state.
+      # `verificationStatus` is `VERIFIED` once the GrowSurf team has verified the account
+      # — this is required before you can send participant emails from a program.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "account",
+          model: GrowsurfRuby::Account,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates your own account profile (`firstName`, `lastName`, `company`). Any other
+      # property is rejected with a `400` — in particular, the account `email` cannot be
+      # changed via the API, and billing/subscription is not editable here.
+      #
+      # @overload update(company: nil, first_name: nil, last_name: nil, request_options: {})
+      #
+      # @param company [String]
+      #
+      # @param first_name [String]
+      #
+      # @param last_name [String]
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      #
+      # @see GrowsurfRuby::Models::AccountUpdateParams
+      def update(params = {})
+        parsed, options = GrowsurfRuby::AccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: "account",
+          body: parsed,
+          model: GrowsurfRuby::Account,
+          options: options
+        )
+      end
+
+      # Generates a new API key and immediately revokes the old one. The key used to make
+      # this request stops working as soon as the response is returned — update every
+      # integration that used the old key with the new one. The account owner is
+      # notified by email whenever the key is rotated.
+      #
+      # @overload rotate_api_key(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountRotateAPIKeyResponse]
+      def rotate_api_key(params = {})
+        @client.request(
+          method: :post,
+          path: "account/api-key",
+          model: GrowsurfRuby::Models::AccountRotateAPIKeyResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Requests GrowSurf-team verification of your account (required before a program can
+      # email its participants). Idempotent — calling it again while a request is pending
+      # does not create a duplicate. Returns the account with its updated
+      # `verificationStatus`.
+      #
+      # @overload request_verification(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      def request_verification(params = {})
+        @client.request(
+          method: :post,
+          path: "account/verification-request",
+          model: GrowsurfRuby::Account,
+          options: params[:request_options]
+        )
+      end
+
+      # Resends the email-verification email to the account's email address. A `200`
+      # with `status: SENT` is only returned when an email was actually dispatched.
+      # Returns a `400` if the email is already verified, or a `429` if a verification
+      # email was sent too recently — wait a moment, then retry.
+      #
+      # @overload resend_verification_email(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountResendVerificationEmailResponse]
+      def resend_verification_email(params = {})
+        @client.request(
+          method: :post,
+          path: "account/verification-email",
+          model: GrowsurfRuby::Models::AccountResendVerificationEmailResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [GrowsurfRuby::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -9,7 +9,8 @@ module GrowsurfRuby
         # form, portal/landing pages, theme styling, and summary/status sections).
         #
         # This is a large, deeply nested object whose available fields depend on the
-        # program type. See the API reference for the full field list.
+        # program type; the response includes every field and its current value, which
+        # is the same shape you send back on update.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -27,13 +28,14 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's design configuration. Only the fields you send are changed (a
-        # surgical merge; arrays such as `signup.fields` replace wholesale). Unknown
-        # fields, fields not available for the program type, and invalid values return a
-        # `400`.
+        # 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`.
         #
-        # The request body is a partial {CampaignDesign} object — see the API reference for
-        # the full field list.
+        # The request body is a partial {CampaignDesign} object. To see the full object
+        # with every field and its current value, `GET` this resource, then `PATCH` back
+        # only the fields you want to change.
         #
         # @overload update(id, body, request_options: {})
         #

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

@@ -8,7 +8,8 @@ module GrowsurfRuby
         # Program Editor's **Emails** tab (per-email templates plus sender, contact, and
         # design settings).
         #
-        # This is a large, nested object. See the API reference for the full field list.
+        # To see the full object with every field and its current value, `GET` this
+        # resource, then `PATCH` back only the fields you want to change.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -26,11 +27,13 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's email configuration. Only the fields you send are changed.
-        # Unknown fields and invalid values return a `400`.
+        # Updates a program's email configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. Unknown fields and invalid values return a
+        # `400`.
         #
-        # The request body is a partial {CampaignEmails} object — see the API reference for
-        # the full field list.
+        # The request body is a partial {CampaignEmails} object. To see the full object
+        # with every field and its current value, `GET` this resource, then `PATCH` back
+        # only the fields you want to change.
         #
         # @overload update(id, body, request_options: {})
         #

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

@@ -8,8 +8,9 @@ module GrowsurfRuby
         # dashboard Program Editor's **Installation** tab (signup and mobile SDK
         # installation settings).
         #
-        # This is a nested object whose available fields depend on the program type. See
-        # the API reference for the full field list.
+        # This is a nested object whose available fields depend on the program type. To
+        # see the full object with every field and its current value, `GET` this
+        # resource, then `PATCH` back only the fields you want to change.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -28,11 +29,12 @@ module GrowsurfRuby
         end
 
         # Updates a program's installation configuration. Only the fields you send are
-        # changed. Unknown fields, fields not available for the program type, and invalid
-        # values return a `400`.
+        # changed; anything you leave out is untouched. Unknown fields, fields not
+        # available for the program type, and invalid values return a `400`.
         #
-        # The request body is a partial {CampaignInstallation} object — see the API
-        # reference for the full field list.
+        # The request body is a partial {CampaignInstallation} object. To see the full
+        # object with every field and its current value, `GET` this resource, then
+        # `PATCH` back only the fields you want to change.
         #
         # @overload update(id, body, request_options: {})
         #

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

@@ -8,7 +8,8 @@ module GrowsurfRuby
         # Program Editor's **Options** tab (fraud/reCAPTCHA, tax documentation,
         # notification emails, and other program settings).
         #
-        # This is a large, nested object. See the API reference for the full field list.
+        # To see the full object with every field and its current value, `GET` this
+        # resource, then `PATCH` back only the fields you want to change.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -26,11 +27,13 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's options configuration. Only the fields you send are changed.
-        # Unknown fields and invalid values return a `400`.
+        # Updates a program's options configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. Unknown fields and invalid values return a
+        # `400`.
         #
-        # The request body is a partial {CampaignOptions} object — see the API reference
-        # for the full field list.
+        # The request body is a partial {CampaignOptions} object. To see the full object
+        # with every field and its current value, `GET` this resource, then `PATCH` back
+        # only the fields you want to change.
         #
         # @overload update(id, body, request_options: {})
         #

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: {})
         #
@@ -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, referred_value: nil, title: nil, value: 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,15 +51,15 @@ 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
         #
@@ -92,7 +90,7 @@ module GrowsurfRuby
         # Updates an existing campaign reward. Only the fields you send are changed;
         # `type` is immutable and must not be supplied.
         #
-        # @overload update(campaign_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, 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, 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.
         #
@@ -102,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
+        # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
         #
-        # @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
         #
@@ -120,15 +116,15 @@ 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
         #