growsurf-ruby 0.8.0 → 1.1.0

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

@@ -19,7 +19,7 @@ module GrowsurfRuby
         attr_accessor :id
 
         sig { returns(String) }
-        attr_accessor :reward_id
+        attr_accessor :campaign_reward_id
 
         sig { returns(T.nilable(GrowsurfRuby::CommissionStructure)) }
         attr_reader :commission_structure
@@ -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
 
@@ -145,22 +156,39 @@ module GrowsurfRuby
         sig { params(referred_reward_upfront: T::Boolean).void }
         attr_writer :referred_reward_upfront
 
+        # Tax valuation for the referred friend's side of a double-sided reward.
+        # Defaults to not tax-reportable (a purchase rebate).
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :referred_value
+
+        sig do
+          params(referred_value: GrowsurfRuby::RewardTaxValuation::OrHash).void
+        end
+        attr_writer :referred_value
+
         sig { returns(T.nilable(String)) }
         attr_reader :title
 
         sig { params(title: String).void }
         attr_writer :title
 
+        # Tax valuation for the reward (the referrer's side of a double-sided reward).
+        # Used by tax documentation / 1099 reporting.
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :value
+
+        sig { params(value: GrowsurfRuby::RewardTaxValuation::OrHash).void }
+        attr_writer :value
+
         sig do
           params(
             id: String,
-            reward_id: String,
+            campaign_reward_id: String,
             commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
             conversions_required: Integer,
             coupon_code: String,
             description: String,
             image_url: String,
-            is_active: T::Boolean,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -174,33 +202,57 @@ module GrowsurfRuby
             referral_coupon_code: String,
             referral_description: String,
             referred_reward_upfront: T::Boolean,
+            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
             title: String,
+            value: GrowsurfRuby::RewardTaxValuation::OrHash,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
-          reward_id:,
+          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,
+          # Tax valuation for the referred friend's side of a double-sided reward.
+          # Defaults to not tax-reportable (a purchase rebate).
+          referred_value: nil,
           title: nil,
+          # Tax valuation for the reward (the referrer's side of a double-sided reward).
+          # Used by tax documentation / 1099 reporting.
+          value: nil,
           request_options: {}
         )
         end
@@ -209,13 +261,12 @@ module GrowsurfRuby
           override.returns(
             {
               id: String,
-              reward_id: String,
+              campaign_reward_id: String,
               commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
               conversions_required: Integer,
               coupon_code: String,
               description: String,
               image_url: String,
-              is_active: T::Boolean,
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,
@@ -229,7 +280,9 @@ module GrowsurfRuby
               referral_coupon_code: String,
               referral_description: String,
               referred_reward_upfront: T::Boolean,
+              referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
               title: String,
+              value: GrowsurfRuby::RewardTaxValuation::OrHash,
               request_options: GrowsurfRuby::RequestOptions
             }
           )

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

data/rbi/growsurf_ruby/models/campaign/webhook_create_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::WebhookCreateParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # The URL that receives webhook deliveries.
+        sig { returns(String) }
+        attr_accessor :payload_url
+
+        # The events this webhook is subscribed to. When omitted, it is subscribed to no
+        # events.
+        sig do
+          returns(
+            T.nilable(T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol])
+          )
+        end
+        attr_reader :events
+
+        sig do
+          params(
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol]
+          ).void
+        end
+        attr_writer :events
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_enabled
+
+        sig { params(is_enabled: T::Boolean).void }
+        attr_writer :is_enabled
+
+        # Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC header). Never
+        # returned.
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret
+
+        sig { params(secret: String).void }
+        attr_writer :secret
+
+        sig do
+          params(
+            payload_url: String,
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+            is_enabled: T::Boolean,
+            secret: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The URL that receives webhook deliveries.
+          payload_url:,
+          # The events this webhook is subscribed to. When omitted, it is subscribed to no
+          # events.
+          events: nil,
+          is_enabled: nil,
+          # Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC header). Never
+          # returned.
+          secret: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              payload_url: String,
+              events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+              is_enabled: T::Boolean,
+              secret: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_delete_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::WebhookDeleteParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :webhook_id
+
+        sig do
+          params(
+            id: String,
+            webhook_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, webhook_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              webhook_id: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_delete_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::WebhookDeleteResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig do
+          params(id: String, success: T::Boolean).returns(T.attached_class)
+        end
+        def self.new(id:, success:)
+        end
+
+        sig { override.returns({ id: String, success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_event.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # A webhook event name.
+      module WebhookEvent
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, GrowsurfRuby::Campaign::WebhookEvent) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PARTICIPANT_REACHED_A_GOAL =
+          T.let(
+            :PARTICIPANT_REACHED_A_GOAL,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        NEW_PARTICIPANT_ADDED =
+          T.let(
+            :NEW_PARTICIPANT_ADDED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        CAMPAIGN_ENDED =
+          T.let(
+            :CAMPAIGN_ENDED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        PARTICIPANT_FRAUD_STATUS_UPDATED =
+          T.let(
+            :PARTICIPANT_FRAUD_STATUS_UPDATED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        NEW_COMMISSION_ADDED =
+          T.let(
+            :NEW_COMMISSION_ADDED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        COMMISSION_ADJUSTED =
+          T.let(
+            :COMMISSION_ADJUSTED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+        NEW_PAYOUT_ISSUED =
+          T.let(
+            :NEW_PAYOUT_ISSUED,
+            GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::Campaign::WebhookEvent::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_list_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::WebhookListResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[GrowsurfRuby::Models::Campaign::Webhook]) }
+        attr_accessor :webhooks
+
+        sig do
+          params(
+            webhooks: T::Array[GrowsurfRuby::Models::Campaign::Webhook::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(webhooks:)
+        end
+
+        sig do
+          override.returns(
+            { webhooks: T::Array[GrowsurfRuby::Models::Campaign::Webhook] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_test_params.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookTestParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::WebhookTestParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :webhook_id
+
+        # The event to simulate. When omitted, the webhook's first enabled event is used
+        # (returns `400` if it has no enabled events).
+        sig do
+          returns(T.nilable(GrowsurfRuby::Campaign::WebhookEvent::OrSymbol))
+        end
+        attr_reader :event
+
+        sig do
+          params(event: GrowsurfRuby::Campaign::WebhookEvent::OrSymbol).void
+        end
+        attr_writer :event
+
+        sig do
+          params(
+            id: String,
+            webhook_id: String,
+            event: GrowsurfRuby::Campaign::WebhookEvent::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          webhook_id:,
+          # The event to simulate. When omitted, the webhook's first enabled event is used
+          # (returns `400` if it has no enabled events).
+          event: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              webhook_id: String,
+              event: GrowsurfRuby::Campaign::WebhookEvent::OrSymbol,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end