growsurf-ruby 1.0.0 → 1.1.0

data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi

@@ -0,0 +1,207 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRetrieveAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :days
+
+        sig { params(days: Integer).void }
+        attr_writer :days
+
+        # End date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :end_date
+
+        sig { params(end_date: Integer).void }
+        attr_writer :end_date
+
+        # Set to `series` to also return this participant's own activity per period.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
+            )
+          )
+        end
+        attr_reader :include
+
+        sig do
+          params(
+            include:
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
+          ).void
+        end
+        attr_writer :include
+
+        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol
+            )
+          )
+        end
+        attr_reader :interval
+
+        sig do
+          params(
+            interval:
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol
+          ).void
+        end
+        attr_writer :interval
+
+        # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :start_date
+
+        sig { params(start_date: Integer).void }
+        attr_writer :start_date
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            days: Integer,
+            end_date: Integer,
+            include:
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+            interval:
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
+            start_date: Integer,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+          days: nil,
+          # End date of the analytics timeframe as a Unix timestamp in milliseconds.
+          # Required if `days` is not set.
+          end_date: nil,
+          # Set to `series` to also return this participant's own activity per period.
+          include: nil,
+          # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+          interval: nil,
+          # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+          # Required if `days` is not set.
+          start_date: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              days: Integer,
+              end_date: Integer,
+              include:
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+              interval:
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
+              start_date: Integer,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Set to `series` to also return this participant's own activity per period.
+        module Include
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SERIES =
+            T.let(
+              :series,
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        module Interval
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DAY =
+            T.let(
+              :day,
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::TaggedSymbol
+            )
+          WEEK =
+            T.let(
+              :week,
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::TaggedSymbol
+            )
+          MONTH =
+            T.let(
+              :month,
+              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi

@@ -46,6 +46,21 @@ module GrowsurfRuby
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # Freeform internal notes about the participant (internal only, never exposed to
+        # participants).
+        sig { returns(T.nilable(String)) }
+        attr_reader :notes
+
+        sig { params(notes: String).void }
+        attr_writer :notes
+
+        # The participant's PayPal email address, used for affiliate payouts.
+        sig { returns(T.nilable(String)) }
+        attr_reader :paypal_email
+
+        sig { params(paypal_email: String).void }
+        attr_writer :paypal_email
+
         sig do
           returns(
             T.nilable(
@@ -89,6 +104,8 @@ module GrowsurfRuby
             first_name: String,
             last_name: String,
             metadata: T::Hash[Symbol, T.anything],
+            notes: String,
+            paypal_email: String,
             referral_status:
               GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
             referred_by: String,
@@ -105,6 +122,11 @@ module GrowsurfRuby
           last_name: nil,
           # Shallow custom metadata object.
           metadata: nil,
+          # Freeform internal notes about the participant (internal only, never exposed to
+          # participants).
+          notes: nil,
+          # The participant's PayPal email address, used for affiliate payouts.
+          paypal_email: nil,
           referral_status: nil,
           referred_by: nil,
           unsubscribed: nil,
@@ -122,6 +144,8 @@ module GrowsurfRuby
               first_name: String,
               last_name: String,
               metadata: T::Hash[Symbol, T.anything],
+              notes: String,
+              paypal_email: String,
               referral_status:
                 GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
               referred_by: String,

data/rbi/growsurf_ruby/models/campaign/reward.rbi

@@ -41,6 +41,9 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_accessor :conversions_required
 
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_accessor :coupon_code
 
@@ -63,19 +66,27 @@ module GrowsurfRuby
         end
         attr_accessor :limit_duration
 
+        # Text shown before a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_accessor :next_milestone_prefix
 
+        # Text shown after a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_accessor :next_milestone_suffix
 
+        # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        # `PER_MONTH` this many win each month, otherwise this many win in total.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :number_of_winners
 
         sig { returns(T.nilable(Integer)) }
         attr_accessor :order
 
-        # The coupon code delivered to the referred friend (double-sided rewards).
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_accessor :referral_coupon_code
 
@@ -134,8 +145,7 @@ module GrowsurfRuby
             referral_coupon_code: T.nilable(String),
             referral_description: T.nilable(String),
             referred_reward_upfront: T::Boolean,
-            referred_value:
-              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
+            referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
             value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
           ).returns(T.attached_class)
         end
@@ -147,17 +157,28 @@ module GrowsurfRuby
           type:,
           commission_structure: nil,
           conversions_required: nil,
+          # 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.
           coupon_code: nil,
           description: nil,
           image_url: nil,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
           limit_duration: nil,
+          # Text shown before a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_prefix: nil,
+          # Text shown after a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_suffix: nil,
+          # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+          # `PER_MONTH` this many win each month, otherwise this many win in total.
           number_of_winners: nil,
           order: nil,
-          # The coupon code delivered to the referred friend (double-sided rewards).
+          # 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.
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,

data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi

@@ -38,6 +38,9 @@ module GrowsurfRuby
         sig { params(conversions_required: Integer).void }
         attr_writer :conversions_required
 
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :coupon_code
 
@@ -56,18 +59,16 @@ module GrowsurfRuby
         sig { params(image_url: String).void }
         attr_writer :image_url
 
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_active
-
-        sig { params(is_active: T::Boolean).void }
-        attr_writer :is_active
-
+        # Whether the reward can be earned an unlimited number of times. Defaults to
+        # `true`, except `MILESTONE` rewards, which can only be earned once.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_unlimited
 
         sig { params(is_unlimited: T::Boolean).void }
         attr_writer :is_unlimited
 
+        # Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        # participants and no longer awarded, including those who already earned it.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_visible
 
@@ -104,18 +105,25 @@ module GrowsurfRuby
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # Text shown before a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_prefix
 
         sig { params(next_milestone_prefix: String).void }
         attr_writer :next_milestone_prefix
 
+        # Text shown after a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_suffix
 
         sig { params(next_milestone_suffix: String).void }
         attr_writer :next_milestone_suffix
 
+        # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        # `PER_MONTH` this many win each month, otherwise this many win in total;
+        # omitting it defaults to `3`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :number_of_winners
 
@@ -128,6 +136,9 @@ module GrowsurfRuby
         sig { params(order: Integer).void }
         attr_writer :order
 
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :referral_coupon_code
 
@@ -179,7 +190,6 @@ module GrowsurfRuby
             coupon_code: String,
             description: String,
             image_url: String,
-            is_active: T::Boolean,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -203,20 +213,36 @@ module GrowsurfRuby
           type:,
           commission_structure: nil,
           conversions_required: nil,
+          # 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.
           coupon_code: nil,
           description: nil,
           image_url: nil,
-          is_active: nil,
+          # Whether the reward can be earned an unlimited number of times. Defaults to
+          # `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
+          # Whether the reward is enabled. When `false` the reward is disabled: hidden from
+          # participants and no longer awarded, including those who already earned it.
           is_visible: nil,
           limit: nil,
           limit_duration: nil,
           # Custom key/value metadata (single-level; values are stored as strings).
           metadata: nil,
+          # Text shown before a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_prefix: nil,
+          # Text shown after a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_suffix: nil,
+          # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+          # `PER_MONTH` this many win each month, otherwise this many win in total;
+          # omitting it defaults to `3`.
           number_of_winners: nil,
           order: nil,
+          # 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.
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,
@@ -241,7 +267,6 @@ module GrowsurfRuby
               coupon_code: String,
               description: String,
               image_url: String,
-              is_active: T::Boolean,
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,

data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi

@@ -37,6 +37,9 @@ module GrowsurfRuby
         sig { params(conversions_required: Integer).void }
         attr_writer :conversions_required
 
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :coupon_code
 
@@ -55,18 +58,16 @@ module GrowsurfRuby
         sig { params(image_url: String).void }
         attr_writer :image_url
 
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_active
-
-        sig { params(is_active: T::Boolean).void }
-        attr_writer :is_active
-
+        # Whether the reward can be earned an unlimited number of times. Defaults to
+        # `true`, except `MILESTONE` rewards, which can only be earned once.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_unlimited
 
         sig { params(is_unlimited: T::Boolean).void }
         attr_writer :is_unlimited
 
+        # Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        # participants and no longer awarded, including those who already earned it.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_visible
 
@@ -103,18 +104,25 @@ module GrowsurfRuby
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # Text shown before a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_prefix
 
         sig { params(next_milestone_prefix: String).void }
         attr_writer :next_milestone_prefix
 
+        # Text shown after a participant's referral count in milestone-progress copy.
+        # Applies to `MILESTONE` rewards.
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_suffix
 
         sig { params(next_milestone_suffix: String).void }
         attr_writer :next_milestone_suffix
 
+        # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        # `PER_MONTH` this many win each month, otherwise this many win in total;
+        # omitting it defaults to `3`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :number_of_winners
 
@@ -127,6 +135,9 @@ module GrowsurfRuby
         sig { params(order: Integer).void }
         attr_writer :order
 
+        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :referral_coupon_code
 
@@ -178,7 +189,6 @@ module GrowsurfRuby
             coupon_code: String,
             description: String,
             image_url: String,
-            is_active: T::Boolean,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -203,20 +213,36 @@ module GrowsurfRuby
           campaign_reward_id:,
           commission_structure: nil,
           conversions_required: nil,
+          # 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.
           coupon_code: nil,
           description: nil,
           image_url: nil,
-          is_active: nil,
+          # Whether the reward can be earned an unlimited number of times. Defaults to
+          # `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
+          # Whether the reward is enabled. When `false` the reward is disabled: hidden from
+          # participants and no longer awarded, including those who already earned it.
           is_visible: nil,
           limit: nil,
           limit_duration: nil,
           # Custom key/value metadata (single-level; values are stored as strings).
           metadata: nil,
+          # Text shown before a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_prefix: nil,
+          # Text shown after a participant's referral count in milestone-progress copy.
+          # Applies to `MILESTONE` rewards.
           next_milestone_suffix: nil,
+          # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+          # `PER_MONTH` this many win each month, otherwise this many win in total;
+          # omitting it defaults to `3`.
           number_of_winners: nil,
           order: nil,
+          # 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.
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,
@@ -241,7 +267,6 @@ module GrowsurfRuby
               coupon_code: String,
               description: String,
               image_url: String,
-              is_active: T::Boolean,
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,

data/rbi/growsurf_ruby/models/campaign/webhook.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class Webhook < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::Webhook,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # Read-only. Whether GrowSurf auto-disabled this webhook after repeated delivery
+        # failures.
+        sig { returns(T::Boolean) }
+        attr_accessor :auto_disabled_due_to_failures
+
+        sig do
+          returns(T::Array[GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol])
+        end
+        attr_accessor :events
+
+        # Read-only. Consecutive delivery failures.
+        sig { returns(Integer) }
+        attr_accessor :failure_count
+
+        # The webhook id (`primary` for the program's primary webhook).
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_enabled
+
+        # Read-only. When the last delivery failure occurred, as a Unix timestamp in
+        # milliseconds.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :last_failure_at
+
+        # The URL that receives webhook deliveries.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payload_url
+
+        sig do
+          params(
+            auto_disabled_due_to_failures: T::Boolean,
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+            failure_count: Integer,
+            id: String,
+            is_enabled: T::Boolean,
+            last_failure_at: T.nilable(Integer),
+            payload_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Read-only. Whether GrowSurf auto-disabled this webhook after repeated delivery
+          # failures.
+          auto_disabled_due_to_failures:,
+          events:,
+          # Read-only. Consecutive delivery failures.
+          failure_count:,
+          # The webhook id (`primary` for the program's primary webhook).
+          id:,
+          is_enabled:,
+          # Read-only. When the last delivery failure occurred, as a Unix timestamp in
+          # milliseconds.
+          last_failure_at: nil,
+          # The URL that receives webhook deliveries.
+          payload_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              auto_disabled_due_to_failures: T::Boolean,
+              events:
+                T::Array[GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol],
+              failure_count: Integer,
+              id: String,
+              is_enabled: T::Boolean,
+              last_failure_at: T.nilable(Integer),
+              payload_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end