growsurf-ruby 1.0.0 → 1.1.0

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

data/rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookTestResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::WebhookTestResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # The mock event payload that was sent.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :payload
+
+        sig { params(payload: T::Hash[Symbol, T.anything]).void }
+        attr_writer :payload
+
+        sig do
+          returns(
+            T.nilable(GrowsurfRuby::Campaign::WebhookTestResponse::Response)
+          )
+        end
+        attr_reader :response
+
+        sig do
+          params(
+            response:
+              GrowsurfRuby::Campaign::WebhookTestResponse::Response::OrHash
+          ).void
+        end
+        attr_writer :response
+
+        sig do
+          params(
+            success: T::Boolean,
+            payload: T::Hash[Symbol, T.anything],
+            response:
+              GrowsurfRuby::Campaign::WebhookTestResponse::Response::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          success:,
+          # The mock event payload that was sent.
+          payload: nil,
+          response: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              success: T::Boolean,
+              payload: T::Hash[Symbol, T.anything],
+              response: GrowsurfRuby::Campaign::WebhookTestResponse::Response
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Response < GrowsurfRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                GrowsurfRuby::Campaign::WebhookTestResponse::Response,
+                GrowsurfRuby::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :msg
+
+          sig { params(msg: String).void }
+          attr_writer :msg
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :status_code
+
+          sig { params(status_code: Integer).void }
+          attr_writer :status_code
+
+          sig do
+            params(msg: String, status_code: Integer).returns(T.attached_class)
+          end
+          def self.new(msg: nil, status_code: nil)
+          end
+
+          sig { override.returns({ msg: String, status_code: Integer }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/webhook_update_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class WebhookUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::WebhookUpdateParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :webhook_id
+
+        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
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payload_url
+
+        sig { params(payload_url: String).void }
+        attr_writer :payload_url
+
+        # Write-only.
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret
+
+        sig { params(secret: String).void }
+        attr_writer :secret
+
+        sig do
+          params(
+            id: String,
+            webhook_id: String,
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+            is_enabled: T::Boolean,
+            payload_url: String,
+            secret: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          webhook_id:,
+          events: nil,
+          is_enabled: nil,
+          payload_url: nil,
+          # Write-only.
+          secret: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              webhook_id: String,
+              events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+              is_enabled: T::Boolean,
+              payload_url: String,
+              secret: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -130,6 +130,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
 
@@ -152,19 +155,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
 
@@ -223,8 +234,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
@@ -236,17 +246,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,