growsurf-ruby 1.2.1 → 1.3.0

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

@@ -21,6 +21,26 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :participant_id_or_email
 
+        # Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a
+        # participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected
+        # for non-affiliates.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol
+            )
+          )
+        end
+        attr_reader :affiliate_status
+
+        sig do
+          params(
+            affiliate_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol
+          ).void
+        end
+        attr_writer :affiliate_status
+
         sig { returns(T.nilable(String)) }
         attr_reader :email
 
@@ -54,13 +74,6 @@ module GrowsurfRuby
         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(
@@ -100,12 +113,13 @@ module GrowsurfRuby
           params(
             id: String,
             participant_id_or_email: String,
+            affiliate_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
             email: String,
             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,
@@ -117,6 +131,10 @@ module GrowsurfRuby
         def self.new(
           id:,
           participant_id_or_email:,
+          # Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a
+          # participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected
+          # for non-affiliates.
+          affiliate_status: nil,
           email: nil,
           first_name: nil,
           last_name: nil,
@@ -125,8 +143,6 @@ module GrowsurfRuby
           # 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,
@@ -140,12 +156,13 @@ module GrowsurfRuby
             {
               id: String,
               participant_id_or_email: String,
+              affiliate_status:
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
               email: String,
               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,
@@ -158,6 +175,45 @@ module GrowsurfRuby
         def to_hash
         end
 
+        module AffiliateStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APPROVED =
+            T.let(
+              :APPROVED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :SUSPENDED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+          BANNED =
+            T.let(
+              :BANNED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module ReferralStatus
           extend GrowsurfRuby::Internal::Type::Enum
 

data/rbi/growsurf_ruby/models/campaign/referral_source.rbi

@@ -17,6 +17,15 @@ module GrowsurfRuby
             :PARTICIPANT,
             GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol
           )
+        DELETED_PARTICIPANT =
+          T.let(
+            :DELETED_PARTICIPANT,
+            GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol
+          )
+        IMPORT =
+          T.let(:IMPORT, GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
+        MANUAL =
+          T.let(:MANUAL, GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
 
         sig do
           override.returns(

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

@@ -53,6 +53,14 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
+        # 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
+
+        sig { params(is_visible: T::Boolean).void }
+        attr_writer :is_visible
+
         # `-1` represents an unlimited reward in REST responses.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :limit
@@ -99,7 +107,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
 
@@ -110,6 +118,10 @@ module GrowsurfRuby
         end
         attr_writer :referred_value
 
+        # The reward title (internal label).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :title
+
         # Tax valuation for the reward (the referrer's side of a double-sided reward).
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :value
@@ -133,6 +145,7 @@ module GrowsurfRuby
             coupon_code: T.nilable(String),
             description: T.nilable(String),
             image_url: T.nilable(String),
+            is_visible: T::Boolean,
             limit: T.nilable(Integer),
             limit_duration:
               T.nilable(
@@ -146,6 +159,7 @@ module GrowsurfRuby
             referral_description: T.nilable(String),
             referred_reward_upfront: T::Boolean,
             referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
+            title: T.nilable(String),
             value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
           ).returns(T.attached_class)
         end
@@ -163,6 +177,9 @@ module GrowsurfRuby
           coupon_code: nil,
           description: nil,
           image_url: 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,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
           limit_duration: nil,
@@ -182,8 +199,10 @@ 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,
+          # The reward title (internal label).
+          title: nil,
           # Tax valuation for the reward (the referrer's side of a double-sided reward).
           value: nil
         )
@@ -202,6 +221,7 @@ module GrowsurfRuby
               coupon_code: T.nilable(String),
               description: T.nilable(String),
               image_url: T.nilable(String),
+              is_visible: T::Boolean,
               limit: T.nilable(Integer),
               limit_duration:
                 T.nilable(
@@ -215,6 +235,7 @@ module GrowsurfRuby
               referral_description: T.nilable(String),
               referred_reward_upfront: T::Boolean,
               referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation),
+              title: T.nilable(String),
               value: T.nilable(GrowsurfRuby::RewardTaxValuation)
             }
           )

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

@@ -157,8 +157,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
 
@@ -246,8 +246,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).

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

@@ -156,8 +156,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
 
@@ -246,8 +246,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).

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -188,7 +188,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
 
@@ -271,7 +271,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

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