growsurf-ruby 1.2.1 → 1.4.0

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

@@ -52,6 +52,27 @@ module GrowsurfRuby
         sig { params(description: String).void }
         attr_writer :description
 
+        # The referral event that earns this Campaign Reward. Use `LEAD` or
+        # `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+        # be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+        # `MILESTONE` rewards. When omitted, the stored event is preserved.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol
+            )
+          )
+        end
+        attr_reader :event
+
+        sig do
+          params(
+            event:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol
+          ).void
+        end
+        attr_writer :event
+
         sig { returns(T.nilable(String)) }
         attr_reader :image_url
 
@@ -156,8 +177,8 @@ 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).
+        # Tax treatment override for the referred friend's side of a double-sided reward.
+        # Defaults to the program's confirmed default.
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :referred_value
 
@@ -188,6 +209,8 @@ module GrowsurfRuby
             conversions_required: Integer,
             coupon_code: String,
             description: String,
+            event:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
             image_url: String,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
@@ -218,6 +241,11 @@ module GrowsurfRuby
           # issued coupon when one exists.
           coupon_code: nil,
           description: nil,
+          # The referral event that earns this Campaign Reward. Use `LEAD` or
+          # `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+          # be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+          # `MILESTONE` rewards. When omitted, the stored event is preserved.
+          event: nil,
           image_url: nil,
           # Whether the reward can be earned an unlimited number of times. Defaults to
           # `true`, except `MILESTONE` rewards, which can only be earned once.
@@ -246,8 +274,8 @@ module GrowsurfRuby
           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).
+          # Tax treatment override for the referred friend's side of a double-sided reward.
+          # Defaults to the program's confirmed default.
           referred_value: nil,
           title: nil,
           # Tax valuation for the reward (the referrer's side of a double-sided reward).
@@ -266,6 +294,8 @@ module GrowsurfRuby
               conversions_required: Integer,
               coupon_code: String,
               description: String,
+              event:
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
               image_url: String,
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
@@ -290,6 +320,40 @@ module GrowsurfRuby
         def to_hash
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(
+              :LEAD,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+            )
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum
 

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -139,6 +139,16 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
+        # The referral event that earns this Campaign Reward. Present only for
+        # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        # Rewards return `CONVERSION`.
+        sig do
+          returns(
+            T.nilable(GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol)
+          )
+        end
+        attr_accessor :event
+
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
@@ -188,7 +198,7 @@ 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.
+        # Tax treatment override for the referred friend's side of a double-sided reward.
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :referred_value
 
@@ -221,6 +231,8 @@ module GrowsurfRuby
             conversions_required: T.nilable(Integer),
             coupon_code: T.nilable(String),
             description: T.nilable(String),
+            event:
+              T.nilable(GrowsurfRuby::CampaignAPI::Reward::Event::OrSymbol),
             image_url: T.nilable(String),
             limit: T.nilable(Integer),
             limit_duration:
@@ -251,6 +263,10 @@ module GrowsurfRuby
           # issued coupon when one exists.
           coupon_code: nil,
           description: nil,
+          # The referral event that earns this Campaign Reward. Present only for
+          # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+          # Rewards return `CONVERSION`.
+          event: nil,
           image_url: nil,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
@@ -271,7 +287,7 @@ module GrowsurfRuby
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,
-          # Tax valuation for the referred friend's side of a double-sided reward.
+          # Tax treatment override 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
@@ -290,6 +306,10 @@ module GrowsurfRuby
               conversions_required: T.nilable(Integer),
               coupon_code: T.nilable(String),
               description: T.nilable(String),
+              event:
+                T.nilable(
+                  GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol
+                ),
               image_url: T.nilable(String),
               limit: T.nilable(Integer),
               limit_duration:
@@ -355,6 +375,32 @@ module GrowsurfRuby
           end
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::CampaignAPI::Reward::Event)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(:LEAD, GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol)
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum
 

data/rbi/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignCreateAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignCreateAffiliateInviteParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Valid email address to invite. Maximum 255 characters.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Invitee first name, used in the invite email. Maximum 255 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :first_name
+
+      sig { params(first_name: String).void }
+      attr_writer :first_name
+
+      # Invitee last name. Maximum 255 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      sig do
+        params(
+          id: String,
+          email: String,
+          first_name: String,
+          last_name: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Valid email address to invite. Maximum 255 characters.
+        email:,
+        # Invitee first name, used in the invite email. Maximum 255 characters.
+        first_name: nil,
+        # Invitee last name. Maximum 255 characters.
+        last_name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            email: String,
+            first_name: String,
+            last_name: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_affiliate_applications_params.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListAffiliateApplicationsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # How many applications to return per page (1-100).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Offset number used to skip through a result set.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :offset
+
+      sig { params(offset: Integer).void }
+      attr_writer :offset
+
+      # Only return applications with this status.
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          offset: Integer,
+          status:
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # How many applications to return per page (1-100).
+        limit: nil,
+        # Offset number used to skip through a result set.
+        offset: nil,
+        # Only return applications with this status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            limit: Integer,
+            offset: Integer,
+            status:
+              GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Only return applications with this status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :PENDING,
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::TaggedSymbol
+          )
+        APPROVED =
+          T.let(
+            :APPROVED,
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::TaggedSymbol
+          )
+        DENIED =
+          T.let(
+            :DENIED,
+            GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_affiliate_invites_params.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListAffiliateInvitesParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListAffiliateInvitesParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # How many invites to return per page (1-100).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Offset number used to skip through a result set.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :offset
+
+      sig { params(offset: Integer).void }
+      attr_writer :offset
+
+      # Only return invites with this status.
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          offset: Integer,
+          status:
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # How many invites to return per page (1-100).
+        limit: nil,
+        # Offset number used to skip through a result set.
+        offset: nil,
+        # Only return invites with this status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            limit: Integer,
+            offset: Integer,
+            status:
+              GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Only return invites with this status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignListAffiliateInvitesParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :PENDING,
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::TaggedSymbol
+          )
+        ACCEPTED =
+          T.let(
+            :ACCEPTED,
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::TaggedSymbol
+          )
+        EXPIRED =
+          T.let(
+            :EXPIRED,
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::TaggedSymbol
+          )
+        REVOKED =
+          T.let(
+            :REVOKED,
+            GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListAffiliateInvitesParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_payouts_params.rbi

@@ -111,6 +111,11 @@ module GrowsurfRuby
             :FAILED,
             GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
           )
+        REVERSED =
+          T.let(
+            :REVERSED,
+            GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rbi

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

data/rbi/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbi

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

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -32,11 +32,13 @@ 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.
+      # Comma-separated list of optional data to include: `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; `email` adds `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+      # `spamComplaints`, and per-email-type metrics. When `email` and an interval are both
+      # requested, each `series` item also contains counts for emails sent during that period.
+      # Combine `email` with `previousPeriod` to include the same email metrics in both windows.
       sig { returns(T.nilable(String)) }
       attr_reader :include
 
@@ -89,11 +91,14 @@ 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.
+        # Comma-separated list of optional data to include: `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; `email` adds `sent`, `delivered`, `opened`, `clicked`,
+        # `bounced`, `spamComplaints`, and per-email-type metrics. When `email` and an interval
+        # are both requested, each `series` item also contains counts for emails sent during that
+        # period. Combine `email` with `previousPeriod` to include the same email metrics in both
+        # windows.
         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).