growsurf-ruby 0.8.0 → 1.1.0

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,18 +155,30 @@ 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
 
+        # 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
+
         sig { returns(T.nilable(String)) }
         attr_accessor :referral_description
 
@@ -173,6 +188,28 @@ 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.
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :referred_value
+
+        sig do
+          params(
+            referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
+        attr_writer :referred_value
+
+        # Tax valuation for the reward (the referrer's side of a double-sided reward).
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :value
+
+        sig do
+          params(
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
+        attr_writer :value
+
         sig do
           params(
             id: String,
@@ -194,8 +231,11 @@ module GrowsurfRuby
             next_milestone_suffix: T.nilable(String),
             number_of_winners: T.nilable(Integer),
             order: T.nilable(Integer),
+            referral_coupon_code: T.nilable(String),
             referral_description: T.nilable(String),
-            referred_reward_upfront: T::Boolean
+            referred_reward_upfront: T::Boolean,
+            referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -206,18 +246,35 @@ 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,
+          # 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
+          referred_reward_upfront: nil,
+          # Tax valuation for the referred friend's side of a double-sided reward.
+          referred_value: nil,
+          # Tax valuation for the reward (the referrer's side of a double-sided reward).
+          value: nil
         )
         end
 
@@ -243,8 +300,11 @@ module GrowsurfRuby
               next_milestone_suffix: T.nilable(String),
               number_of_winners: T.nilable(Integer),
               order: T.nilable(Integer),
+              referral_coupon_code: T.nilable(String),
               referral_description: T.nilable(String),
-              referred_reward_upfront: T::Boolean
+              referred_reward_upfront: T::Boolean,
+              referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation),
+              value: T.nilable(GrowsurfRuby::RewardTaxValuation)
             }
           )
         end

data/rbi/growsurf_ruby/models/campaign_create_params.rbi

@@ -35,24 +35,12 @@ module GrowsurfRuby
       sig { params(currency_iso: String).void }
       attr_writer :currency_iso
 
-      sig { returns(T.nilable(String)) }
-      attr_reader :goal
-
-      sig { params(goal: String).void }
-      attr_writer :goal
-
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
       sig { params(name: String).void }
       attr_writer :name
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :options
-
-      sig { params(options: T::Hash[Symbol, T.anything]).void }
-      attr_writer :options
-
       sig do
         returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardCreateParams]))
       end
@@ -71,9 +59,7 @@ module GrowsurfRuby
           company_logo_image_url: String,
           company_name: String,
           currency_iso: String,
-          goal: String,
           name: String,
-          options: T::Hash[Symbol, T.anything],
           rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -83,9 +69,7 @@ module GrowsurfRuby
         company_logo_image_url: nil,
         company_name: nil,
         currency_iso: nil,
-        goal: nil,
         name: nil,
-        options: nil,
         rewards: nil,
         request_options: {}
       )
@@ -98,9 +82,7 @@ module GrowsurfRuby
             company_logo_image_url: String,
             company_name: String,
             currency_iso: String,
-            goal: String,
             name: String,
-            options: T::Hash[Symbol, T.anything],
             rewards:
               T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
             request_options: GrowsurfRuby::RequestOptions

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -32,6 +32,36 @@ module GrowsurfRuby
       sig { params(end_date: Integer).void }
       attr_writer :end_date
 
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :include
+
+      sig { params(include: String).void }
+      attr_writer :include
+
+      # When set to `day`, `week`, or `month`, the response also includes a `series` array
+      # with per-period totals. Defaults to `total` (no series).
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol
+          )
+        )
+      end
+      attr_reader :interval
+
+      sig do
+        params(
+          interval:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::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)) }
@@ -45,6 +75,9 @@ module GrowsurfRuby
           id: String,
           days: Integer,
           end_date: Integer,
+          include: String,
+          interval:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
           start_date: Integer,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -56,6 +89,15 @@ module GrowsurfRuby
         # End date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         end_date: nil,
+        # 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.
+        include: nil,
+        # When set to `day`, `week`, or `month`, the response also includes a `series` array
+        # with per-period totals. Defaults to `total` (no series).
+        interval: nil,
         # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         start_date: nil,
@@ -69,6 +111,9 @@ module GrowsurfRuby
             id: String,
             days: Integer,
             end_date: Integer,
+            include: String,
+            interval:
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
             start_date: Integer,
             request_options: GrowsurfRuby::RequestOptions
           }
@@ -76,6 +121,52 @@ module GrowsurfRuby
       end
       def to_hash
       end
+
+      # 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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAY =
+          T.let(
+            :day,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :week,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :month,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        TOTAL =
+          T.let(
+            :total,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end