growsurf-ruby 0.2.0 → 0.4.0

data/rbi/growsurf_ruby/models/campaign/create.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class Create < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::Create,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :email
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :fingerprint
+
+        sig { params(fingerprint: String).void }
+        attr_writer :fingerprint
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :ip_address
+
+        sig { params(ip_address: String).void }
+        attr_writer :ip_address
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        # Shallow custom metadata object.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        # Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+        # for mobile participant creation and mobile participant token flows.
+        sig { returns(T.nilable(String)) }
+        attr_reader :mobile_instance_id
+
+        sig { params(mobile_instance_id: String).void }
+        attr_writer :mobile_instance_id
+
+        sig do
+          returns(
+            T.nilable(GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol)
+          )
+        end
+        attr_reader :referral_status
+
+        sig do
+          params(
+            referral_status:
+              GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol
+          ).void
+        end
+        attr_writer :referral_status
+
+        # Referrer participant ID or email address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :referred_by
+
+        sig { params(referred_by: String).void }
+        attr_writer :referred_by
+
+        sig do
+          params(
+            email: String,
+            fingerprint: String,
+            first_name: String,
+            ip_address: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, T.anything],
+            mobile_instance_id: String,
+            referral_status:
+              GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
+            referred_by: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          email:,
+          fingerprint: nil,
+          first_name: nil,
+          ip_address: nil,
+          last_name: nil,
+          # Shallow custom metadata object.
+          metadata: nil,
+          # Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+          # for mobile participant creation and mobile participant token flows.
+          mobile_instance_id: nil,
+          referral_status: nil,
+          # Referrer participant ID or email address.
+          referred_by: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              email: String,
+              fingerprint: String,
+              first_name: String,
+              ip_address: String,
+              last_name: String,
+              metadata: T::Hash[Symbol, T.anything],
+              mobile_instance_id: String,
+              referral_status:
+                GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
+              referred_by: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::Campaign::Create::ReferralStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREDIT_PENDING =
+            T.let(
+              :CREDIT_PENDING,
+              GrowsurfRuby::Campaign::Create::ReferralStatus::TaggedSymbol
+            )
+          CREDIT_AWARDED =
+            T.let(
+              :CREDIT_AWARDED,
+              GrowsurfRuby::Campaign::Create::ReferralStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::Create::ReferralStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant.rbi

@@ -115,6 +115,11 @@ module GrowsurfRuby
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # App-install scoped mobile identifier used for anti-fraud matching when provided
+        # by native mobile apps. Not stored when strict GDPR/CCPA mode is enabled.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mobile_instance_id
+
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :monthly_referrals
 
@@ -259,6 +264,7 @@ module GrowsurfRuby
             is_winner: T::Boolean,
             last_name: T.nilable(String),
             metadata: T::Hash[Symbol, T.anything],
+            mobile_instance_id: T.nilable(String),
             monthly_referrals: T::Array[String],
             notes: T.nilable(String),
             paypal_email_address: String,
@@ -303,6 +309,9 @@ module GrowsurfRuby
           last_name: nil,
           # Shallow custom metadata object.
           metadata: nil,
+          # App-install scoped mobile identifier used for anti-fraud matching when provided
+          # by native mobile apps. Not stored when strict GDPR/CCPA mode is enabled.
+          mobile_instance_id: nil,
           monthly_referrals: nil,
           notes: nil,
           paypal_email_address: nil,
@@ -347,6 +356,7 @@ module GrowsurfRuby
               is_winner: T::Boolean,
               last_name: T.nilable(String),
               metadata: T::Hash[Symbol, T.anything],
+              mobile_instance_id: T.nilable(String),
               monthly_referrals: T::Array[String],
               notes: T.nilable(String),
               paypal_email_address: String,

data/rbi/growsurf_ruby/models/campaign/participant_add_params.rbi

@@ -3,7 +3,7 @@
 module GrowsurfRuby
   module Models
     module Campaign
-      class ParticipantAddParams < GrowsurfRuby::Internal::Type::BaseModel
+      class ParticipantAddParams < GrowsurfRuby::Models::Campaign::Create
         extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
         include GrowsurfRuby::Internal::Type::RequestParameters
 
@@ -18,148 +18,22 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :id
 
-        sig { returns(String) }
-        attr_accessor :email
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :fingerprint
-
-        sig { params(fingerprint: String).void }
-        attr_writer :fingerprint
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :first_name
-
-        sig { params(first_name: String).void }
-        attr_writer :first_name
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :ip_address
-
-        sig { params(ip_address: String).void }
-        attr_writer :ip_address
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :last_name
-
-        sig { params(last_name: String).void }
-        attr_writer :last_name
-
-        # Shallow custom metadata object.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :metadata
-
-        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
-        attr_writer :metadata
-
-        sig do
-          returns(
-            T.nilable(
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol
-            )
-          )
-        end
-        attr_reader :referral_status
-
-        sig do
-          params(
-            referral_status:
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol
-          ).void
-        end
-        attr_writer :referral_status
-
-        # Referrer participant ID or email address.
-        sig { returns(T.nilable(String)) }
-        attr_reader :referred_by
-
-        sig { params(referred_by: String).void }
-        attr_writer :referred_by
-
         sig do
           params(
             id: String,
-            email: String,
-            fingerprint: String,
-            first_name: String,
-            ip_address: String,
-            last_name: String,
-            metadata: T::Hash[Symbol, T.anything],
-            referral_status:
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol,
-            referred_by: String,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(
-          id:,
-          email:,
-          fingerprint: nil,
-          first_name: nil,
-          ip_address: nil,
-          last_name: nil,
-          # Shallow custom metadata object.
-          metadata: nil,
-          referral_status: nil,
-          # Referrer participant ID or email address.
-          referred_by: nil,
-          request_options: {}
-        )
+        def self.new(id:, request_options: {})
         end
 
         sig do
           override.returns(
-            {
-              id: String,
-              email: String,
-              fingerprint: String,
-              first_name: String,
-              ip_address: String,
-              last_name: String,
-              metadata: T::Hash[Symbol, T.anything],
-              referral_status:
-                GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol,
-              referred_by: String,
-              request_options: GrowsurfRuby::RequestOptions
-            }
+            { id: String, request_options: GrowsurfRuby::RequestOptions }
           )
         end
         def to_hash
         end
-
-        module ReferralStatus
-          extend GrowsurfRuby::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          CREDIT_PENDING =
-            T.let(
-              :CREDIT_PENDING,
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::TaggedSymbol
-            )
-          CREDIT_AWARDED =
-            T.let(
-              :CREDIT_AWARDED,
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
       end
     end
   end

data/rbi/growsurf_ruby/models/campaign_create_mobile_participant_token_params.rbi

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

data/rbi/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignCreateMobileParticipantTokenResponse < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # Token lifetime in seconds.
+      sig { returns(Integer) }
+      attr_accessor :expires_in
+
+      # Whether this request created a new participant. Returns false when the
+      # participant already existed.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_new
+
+      sig { returns(GrowsurfRuby::Campaign::CampaignParticipant) }
+      attr_reader :participant
+
+      sig do
+        params(
+          participant: GrowsurfRuby::Campaign::CampaignParticipant::OrHash
+        ).void
+      end
+      attr_writer :participant
+
+      # Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.
+      sig { returns(String) }
+      attr_accessor :participant_token
+
+      sig do
+        params(
+          expires_in: Integer,
+          is_new: T::Boolean,
+          participant: GrowsurfRuby::Campaign::CampaignParticipant::OrHash,
+          participant_token: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Token lifetime in seconds.
+        expires_in:,
+        # Whether this request created a new participant. Returns false when the
+        # participant already existed.
+        is_new:,
+        participant:,
+        # Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.
+        participant_token:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            expires_in: Integer,
+            is_new: T::Boolean,
+            participant: GrowsurfRuby::Campaign::CampaignParticipant,
+            participant_token: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -5,6 +5,9 @@ module GrowsurfRuby
 
   CampaignAPI = GrowsurfRuby::Models::CampaignAPI
 
+  CampaignCreateMobileParticipantTokenParams =
+    GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
+
   CampaignListCommissionsParams =
     GrowsurfRuby::Models::CampaignListCommissionsParams
 

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -91,8 +91,9 @@ module GrowsurfRuby
             ip_address: String,
             last_name: String,
             metadata: T::Hash[Symbol, T.anything],
+            mobile_instance_id: String,
             referral_status:
-              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol,
+              GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
             referred_by: String,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
@@ -107,6 +108,9 @@ module GrowsurfRuby
           last_name: nil,
           # Shallow custom metadata object.
           metadata: nil,
+          # Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+          # for mobile participant creation and mobile participant token flows.
+          mobile_instance_id: nil,
           referral_status: nil,
           # Referrer participant ID or email address.
           referred_by: nil,
@@ -114,26 +118,6 @@ module GrowsurfRuby
         )
         end
 
-        # Creates a participant-scoped token for GrowSurf mobile SDK participant
-        # endpoints. The program must have mobile SDK access enabled.
-        sig do
-          params(
-            participant_id_or_email: String,
-            id: String,
-            request_options: GrowsurfRuby::RequestOptions::OrHash
-          ).returns(
-            GrowsurfRuby::Models::Campaign::ParticipantCreateMobileTokenResponse
-          )
-        end
-        def create_mobile_token(
-          # GrowSurf participant ID or URL-encoded participant email address.
-          participant_id_or_email,
-          # GrowSurf program ID.
-          id:,
-          request_options: {}
-        )
-        end
-
         # Retrieves a paged list of commissions earned by a participant.
         sig do
           params(

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -37,6 +37,48 @@ module GrowsurfRuby
       def list(request_options: {})
       end
 
+      # Creates or returns a participant using the same input behavior as Add
+      # Participant, then returns a participant-scoped token for GrowSurf mobile SDK
+      # participant endpoints. Use this endpoint from your backend after your mobile app
+      # authenticates a signed-in user. The program must have mobile SDK access enabled.
+      sig do
+        params(
+          id: String,
+          email: String,
+          fingerprint: String,
+          first_name: String,
+          ip_address: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, T.anything],
+          mobile_instance_id: String,
+          referral_status:
+            GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
+          referred_by: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(
+          GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse
+        )
+      end
+      def create_mobile_participant_token(
+        # GrowSurf program ID.
+        id,
+        email:,
+        fingerprint: nil,
+        first_name: nil,
+        ip_address: nil,
+        last_name: nil,
+        # Shallow custom metadata object.
+        metadata: nil,
+        # Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+        # for mobile participant creation and mobile participant token flows.
+        mobile_instance_id: nil,
+        referral_status: nil,
+        # Referrer participant ID or email address.
+        referred_by: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieves a paged list of all participant commissions in an affiliate program.
       sig do
         params(

data/sig/growsurf_ruby/models/campaign/create.rbs

@@ -0,0 +1,91 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type create =
+        {
+          email: String,
+          fingerprint: String,
+          first_name: String,
+          ip_address: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          mobile_instance_id: String,
+          referral_status: GrowsurfRuby::Models::Campaign::Create::referral_status,
+          referred_by: String
+        }
+
+      class Create < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor email: String
+
+        attr_reader fingerprint: String?
+
+        def fingerprint=: (String) -> String
+
+        attr_reader first_name: String?
+
+        def first_name=: (String) -> String
+
+        attr_reader ip_address: String?
+
+        def ip_address=: (String) -> String
+
+        attr_reader last_name: String?
+
+        def last_name=: (String) -> String
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader mobile_instance_id: String?
+
+        def mobile_instance_id=: (String) -> String
+
+        attr_reader referral_status: GrowsurfRuby::Models::Campaign::Create::referral_status?
+
+        def referral_status=: (
+          GrowsurfRuby::Models::Campaign::Create::referral_status
+        ) -> GrowsurfRuby::Models::Campaign::Create::referral_status
+
+        attr_reader referred_by: String?
+
+        def referred_by=: (String) -> String
+
+        def initialize: (
+          email: String,
+          ?fingerprint: String,
+          ?first_name: String,
+          ?ip_address: String,
+          ?last_name: String,
+          ?metadata: ::Hash[Symbol, top],
+          ?mobile_instance_id: String,
+          ?referral_status: GrowsurfRuby::Models::Campaign::Create::referral_status,
+          ?referred_by: String
+        ) -> void
+
+        def to_hash: -> {
+          email: String,
+          fingerprint: String,
+          first_name: String,
+          ip_address: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          mobile_instance_id: String,
+          referral_status: GrowsurfRuby::Models::Campaign::Create::referral_status,
+          referred_by: String
+        }
+
+        type referral_status = :CREDIT_PENDING | :CREDIT_AWARDED
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING: :CREDIT_PENDING
+          CREDIT_AWARDED: :CREDIT_AWARDED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::Create::referral_status]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant.rbs

@@ -24,6 +24,7 @@ module GrowsurfRuby
           is_winner: bool,
           last_name: String?,
           metadata: ::Hash[Symbol, top],
+          mobile_instance_id: String?,
           monthly_referrals: ::Array[String],
           notes: String?,
           paypal_email_address: String,
@@ -107,6 +108,8 @@ module GrowsurfRuby
 
         def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
+        attr_accessor mobile_instance_id: String?
+
         attr_reader monthly_referrals: ::Array[String]?
 
         def monthly_referrals=: (::Array[String]) -> ::Array[String]
@@ -193,6 +196,7 @@ module GrowsurfRuby
           ?is_winner: bool,
           ?last_name: String?,
           ?metadata: ::Hash[Symbol, top],
+          ?mobile_instance_id: String?,
           ?monthly_referrals: ::Array[String],
           ?notes: String?,
           ?paypal_email_address: String,
@@ -233,6 +237,7 @@ module GrowsurfRuby
           is_winner: bool,
           last_name: String?,
           metadata: ::Hash[Symbol, top],
+          mobile_instance_id: String?,
           monthly_referrals: ::Array[String],
           notes: String?,
           paypal_email_address: String,