growsurf-ruby 0.8.0 → 1.1.0

data/lib/growsurf_ruby/models/campaign/webhook.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#create
+      class Webhook < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute auto_disabled_due_to_failures
+        #   Read-only. Whether GrowSurf auto-disabled this webhook after repeated delivery
+        #   failures.
+        #
+        #   @return [Boolean]
+        required :auto_disabled_due_to_failures,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :autoDisabledDueToFailures
+
+        # @!attribute events
+        #
+        #   @return [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>]
+        required :events, -> { GrowsurfRuby::Internal::Type::ArrayOf[enum: GrowsurfRuby::Campaign::WebhookEvent] }
+
+        # @!attribute failure_count
+        #   Read-only. Consecutive delivery failures.
+        #
+        #   @return [Integer]
+        required :failure_count, Integer, api_name: :failureCount
+
+        # @!attribute id
+        #   The webhook id (`primary` for the program's primary webhook).
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute is_enabled
+        #
+        #   @return [Boolean]
+        required :is_enabled, GrowsurfRuby::Internal::Type::Boolean, api_name: :isEnabled
+
+        # @!attribute last_failure_at
+        #   Read-only. When the last delivery failure occurred, as a Unix timestamp in
+        #   milliseconds.
+        #
+        #   @return [Integer, nil]
+        optional :last_failure_at, Integer, api_name: :lastFailureAt, nil?: true
+
+        # @!attribute payload_url
+        #   The URL that receives webhook deliveries.
+        #
+        #   @return [String, nil]
+        optional :payload_url, String, api_name: :payloadUrl, nil?: true
+
+        # @!method initialize(auto_disabled_due_to_failures:, events:, failure_count:, id:, is_enabled:, last_failure_at: nil, payload_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::Webhook} for more details.
+        #
+        #   @param auto_disabled_due_to_failures [Boolean] Read-only. Whether GrowSurf auto-disabled this webhook after repeated delivery fai
+        #
+        #   @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>]
+        #
+        #   @param failure_count [Integer] Read-only. Consecutive delivery failures.
+        #
+        #   @param id [String] The webhook id (`primary` for the program's primary webhook).
+        #
+        #   @param is_enabled [Boolean]
+        #
+        #   @param last_failure_at [Integer, nil] Read-only. When the last delivery failure occurred, as a Unix timestamp in millise
+        #
+        #   @param payload_url [String, nil] The URL that receives webhook deliveries.
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_create_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#create
+      class WebhookCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute payload_url
+        #   The URL that receives webhook deliveries.
+        #
+        #   @return [String]
+        required :payload_url, String, api_name: :payloadUrl
+
+        # @!attribute events
+        #   The events this webhook is subscribed to. When omitted, it is subscribed to no
+        #   events.
+        #
+        #   @return [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>, nil]
+        optional :events, -> { GrowsurfRuby::Internal::Type::ArrayOf[enum: GrowsurfRuby::Campaign::WebhookEvent] }
+
+        # @!attribute is_enabled
+        #
+        #   @return [Boolean, nil]
+        optional :is_enabled, GrowsurfRuby::Internal::Type::Boolean, api_name: :isEnabled
+
+        # @!attribute secret
+        #   Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC header). Never
+        #   returned.
+        #
+        #   @return [String, nil]
+        optional :secret, String
+
+        # @!method initialize(payload_url:, events: nil, is_enabled: nil, secret: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::WebhookCreateParams} for more details.
+        #
+        #   @param payload_url [String] The URL that receives webhook deliveries.
+        #
+        #   @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>] The events this webhook is subscribed to. When omitted, it is subscribed to no e
+        #
+        #   @param is_enabled [Boolean]
+        #
+        #   @param secret [String] Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC header). Never
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#delete
+      class WebhookDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute webhook_id
+        #
+        #   @return [String]
+        required :webhook_id, String
+
+        # @!method initialize(id:, webhook_id:, request_options: {})
+        #   @param id [String]
+        #   @param webhook_id [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_delete_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#delete
+      class WebhookDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(id:, success:)
+        #   @param id [String]
+        #   @param success [Boolean]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_event.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # A webhook event name.
+      module WebhookEvent
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PARTICIPANT_REACHED_A_GOAL = :PARTICIPANT_REACHED_A_GOAL
+        NEW_PARTICIPANT_ADDED = :NEW_PARTICIPANT_ADDED
+        CAMPAIGN_ENDED = :CAMPAIGN_ENDED
+        PARTICIPANT_FRAUD_STATUS_UPDATED = :PARTICIPANT_FRAUD_STATUS_UPDATED
+        NEW_COMMISSION_ADDED = :NEW_COMMISSION_ADDED
+        COMMISSION_ADJUSTED = :COMMISSION_ADJUSTED
+        NEW_PAYOUT_ISSUED = :NEW_PAYOUT_ISSUED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#list
+      class WebhookListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute webhooks
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::Webhook>]
+        required :webhooks, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::Webhook] }
+
+        # @!method initialize(webhooks:)
+        #   @param webhooks [Array<GrowsurfRuby::Models::Campaign::Webhook>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_test_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#test
+      class WebhookTestParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute webhook_id
+        #
+        #   @return [String]
+        required :webhook_id, String
+
+        # @!attribute event
+        #   The event to simulate. When omitted, the webhook's first enabled event is used
+        #   (returns `400` if it has no enabled events).
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::WebhookEvent }
+
+        # @!method initialize(id:, webhook_id:, event: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::WebhookTestParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param webhook_id [String]
+        #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent] The event to simulate. When omitted, the webhook's first enabled event is used (
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_test_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#test
+      class WebhookTestResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute payload
+        #   The mock event payload that was sent.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :payload, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute response
+        #
+        #   @return [GrowsurfRuby::Models::Campaign::WebhookTestResponse::Response, nil]
+        optional :response, -> { GrowsurfRuby::Campaign::WebhookTestResponse::Response }
+
+        # @!method initialize(success:, payload: nil, response: nil)
+        #   @param success [Boolean]
+        #
+        #   @param payload [Hash{Symbol=>Object}] The mock event payload that was sent.
+        #
+        #   @param response [GrowsurfRuby::Models::Campaign::WebhookTestResponse::Response]
+
+        # @see GrowsurfRuby::Models::Campaign::WebhookTestResponse#response
+        class Response < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute msg
+          #
+          #   @return [String, nil]
+          optional :msg, String
+
+          # @!attribute status_code
+          #
+          #   @return [Integer, nil]
+          optional :status_code, Integer, api_name: :statusCode
+
+          # @!method initialize(msg: nil, status_code: nil)
+          #   @param msg [String]
+          #   @param status_code [Integer]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/webhook_update_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Webhooks#update
+      class WebhookUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute webhook_id
+        #
+        #   @return [String]
+        required :webhook_id, String
+
+        # @!attribute events
+        #
+        #   @return [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>, nil]
+        optional :events, -> { GrowsurfRuby::Internal::Type::ArrayOf[enum: GrowsurfRuby::Campaign::WebhookEvent] }
+
+        # @!attribute is_enabled
+        #
+        #   @return [Boolean, nil]
+        optional :is_enabled, GrowsurfRuby::Internal::Type::Boolean, api_name: :isEnabled
+
+        # @!attribute payload_url
+        #
+        #   @return [String, nil]
+        optional :payload_url, String, api_name: :payloadUrl
+
+        # @!attribute secret
+        #   Write-only.
+        #
+        #   @return [String, nil]
+        optional :secret, String
+
+        # @!method initialize(id:, webhook_id:, events: nil, is_enabled: nil, payload_url: nil, secret: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param webhook_id [String]
+        #
+        #   @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>]
+        #
+        #   @param is_enabled [Boolean]
+        #
+        #   @param payload_url [String]
+        #
+        #   @param secret [String] Write-only.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign.rb

@@ -108,6 +108,9 @@ module GrowsurfRuby
         optional :conversions_required, Integer, api_name: :conversionsRequired, nil?: true
 
         # @!attribute coupon_code
+        #   Legacy static coupon code shown to the referrer in the reward-won email and
+        #   webhook. Display text only; superseded by a connected billing integration's
+        #   issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :coupon_code, String, api_name: :couponCode, nil?: true
@@ -137,16 +140,22 @@ module GrowsurfRuby
                  nil?: true
 
         # @!attribute next_milestone_prefix
+        #   Text shown before a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
 
         # @!attribute next_milestone_suffix
+        #   Text shown after a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
 
         # @!attribute number_of_winners
+        #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        #   `PER_MONTH` this many win each month, otherwise this many win in total.
         #
         #   @return [Integer, nil]
         optional :number_of_winners, Integer, api_name: :numberOfWinners, nil?: true
@@ -156,6 +165,14 @@ module GrowsurfRuby
         #   @return [Integer, nil]
         optional :order, Integer, nil?: true
 
+        # @!attribute referral_coupon_code
+        #   Legacy static coupon code shown to the referred friend (double-sided rewards)
+        #   in the reward-won email and webhook. Display text only; superseded by a
+        #   connected billing integration's issued coupon when one exists.
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
+
         # @!attribute referral_description
         #
         #   @return [String, nil]
@@ -168,7 +185,22 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::Boolean,
                  api_name: :referredRewardUpfront
 
-        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_description: nil, referred_reward_upfront: nil)
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue,
+                 nil?: true
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
+
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: 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, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -181,7 +213,7 @@ module GrowsurfRuby
         #
         #   @param conversions_required [Integer, nil]
         #
-        #   @param coupon_code [String, nil]
+        #   @param coupon_code [String, nil] Legacy static coupon code shown to the referrer in the reward-won email and web
         #
         #   @param description [String, nil]
         #
@@ -191,17 +223,23 @@ module GrowsurfRuby
         #
         #   @param limit_duration [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::LimitDuration, nil]
         #
-        #   @param next_milestone_prefix [String, nil]
+        #   @param next_milestone_prefix [String, nil] Text shown before a participant's referral count in milestone-progress copy. App
         #
-        #   @param next_milestone_suffix [String, nil]
+        #   @param next_milestone_suffix [String, nil] Text shown after a participant's referral count in milestone-progress copy. Appl
         #
-        #   @param number_of_winners [Integer, nil]
+        #   @param number_of_winners [Integer, nil] The number of winners (`LEADERBOARD` rewards only). With `limitDuration` `PER_MO
         #
         #   @param order [Integer, nil]
         #
+        #   @param referral_coupon_code [String, nil] Legacy static coupon code shown to the referred friend (double-sided rewards) in
+        #
         #   @param referral_description [String, nil]
         #
         #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
 
         # @see GrowsurfRuby::Models::CampaignAPI::Reward#type
         module Type

data/lib/growsurf_ruby/models/campaign_create_params.rb

@@ -27,28 +27,18 @@ module GrowsurfRuby
       #   @return [String, nil]
       optional :currency_iso, String, api_name: :currencyISO
 
-      # @!attribute goal
-      #
-      #   @return [String, nil]
-      optional :goal, String
-
       # @!attribute name
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!attribute options
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :options, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
-
       # @!attribute rewards
       #
       #   @return [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>, nil]
       optional :rewards,
                -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::RewardCreateParams] }
 
-      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, goal: nil, name: nil, options: nil, rewards: nil, request_options: {})
+      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {})
       #   @param type [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type]
       #
       #   @param company_logo_image_url [String]
@@ -57,12 +47,8 @@ module GrowsurfRuby
       #
       #   @param currency_iso [String]
       #
-      #   @param goal [String]
-      #
       #   @param name [String]
       #
-      #   @param options [Hash{Symbol=>Object}]
-      #
       #   @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>]
       #
       #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb

@@ -25,6 +25,23 @@ module GrowsurfRuby
       #   @return [Integer, nil]
       optional :end_date, Integer
 
+      # @!attribute include
+      #   Comma-separated list of optional enrichments (opt-in to keep the default response
+      #   lean): `previousPeriod` adds totals for the equal-length window immediately before
+      #   the requested one; `statusCounts` adds reward (and, for affiliate programs,
+      #   affiliate/commission/payout) status breakdowns; `rates` adds derived referral
+      #   rates.
+      #
+      #   @return [String, nil]
+      optional :include, String
+
+      # @!attribute interval
+      #   When set to `day`, `week`, or `month`, the response also includes a `series` array
+      #   with per-period totals. Defaults to `total` (no series).
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval, nil]
+      optional :interval, enum: -> { GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval }
+
       # @!attribute start_date
       #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
       #   Required if `days` is not set.
@@ -32,7 +49,7 @@ module GrowsurfRuby
       #   @return [Integer, nil]
       optional :start_date, Integer
 
-      # @!method initialize(id:, days: nil, end_date: nil, start_date: nil, request_options: {})
+      # @!method initialize(id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
       #
@@ -42,9 +59,27 @@ 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 interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
+      #
       #   @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}]
+
+      # When set to `day`, `week`, or `month`, the response also includes a `series` array
+      # with per-period totals. Defaults to `total` (no series).
+      module Interval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+        TOTAL = :total
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end