growsurf-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605534d947eac522a949503f9572694007413ef9040a32a96bea535a2584be47
-  data.tar.gz: aef15c880bbfa43c46f5c29f5299179909325b12d7211e1320a03cab1d28a6fe
+  metadata.gz: 90493bdc8baea2e327326d29aa004fe7a57766653641f6ad80ac4cef4057b0b4
+  data.tar.gz: 18f679b7fc93472b3be00394c42cc31e2df266f0c2e0b7222cabc654c88025aa
 SHA512:
-  metadata.gz: 06c6a1595b1d6778efd78c9d01237364471f023f2163d8f3b663aaa27cdf684d1d0ea714023b03b2398d65a07b971fd5902712640016166dee9e116c35f40580
-  data.tar.gz: 3761201606953175d138cbed0e948d6e2b069183e9584faefe841f9dfe7a0a9c5d9f0e190c69776bb1cf424f872e95a23122d1ed77c55721967c73202a569160
+  metadata.gz: c80ae52984154a91eb9887e9da0305fc03cc7c3877437bb034b27d7e7b2f5ac05b124f67808eeeadd51e7c148ace51fa2c7a4b653a2fd1d6ecb054d4854fe492
+  data.tar.gz: acfce9a0ef800f4627bd6dddccdc7c1ad3dcf0ef12b49ff0f3e4561de1dd2ee256ba40dcc92800f82286f958fc6284e7a864a92c882faac304a99c7e004335b5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.0 (2026-05-20)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/growsurf/growsurf-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** Add Participant.mobileInstanceId ([c5ca7c3](https://github.com/growsurf/growsurf-ruby/commit/c5ca7c3334d28caf6d28afa9baf71cd9cfbfee11))
+
 ## 0.3.0 (2026-05-19)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/growsurf/growsurf-ruby/compare/v0.2.0...v0.3.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "growsurf-ruby", "~> 0.3.0"
+gem "growsurf-ruby", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/models/campaign/create.rb

@@ -35,6 +35,13 @@ module GrowsurfRuby
         #   @return [Hash{Symbol=>Object}, nil]
         optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
 
+        # @!attribute mobile_instance_id
+        #   Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+        #   for mobile participant creation and mobile participant token flows.
+        #
+        #   @return [String, nil]
+        optional :mobile_instance_id, String, api_name: :mobileInstanceId
+
         # @!attribute referral_status
         #
         #   @return [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus, nil]
@@ -48,7 +55,10 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :referred_by, String, api_name: :referredBy
 
-        # @!method initialize(email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil)
+        # @!method initialize(email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::Create} for more details.
+        #
         #   @param email [String]
         #
         #   @param fingerprint [String]
@@ -61,6 +71,8 @@ module GrowsurfRuby
         #
         #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
+        #   @param mobile_instance_id [String] Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+        #
         #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
         #
         #   @param referred_by [String] Referrer participant ID or email address.

data/lib/growsurf_ruby/models/campaign/participant.rb

@@ -117,6 +117,13 @@ module GrowsurfRuby
         #   @return [Hash{Symbol=>Object}, nil]
         optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
 
+        # @!attribute mobile_instance_id
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :mobile_instance_id, String, api_name: :mobileInstanceId, nil?: true
+
         # @!attribute monthly_referrals
         #
         #   @return [Array<String>, nil]
@@ -207,7 +214,10 @@ module GrowsurfRuby
         #   @return [Array<String>, nil]
         optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
 
-        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url:, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, monthly_referrals: nil, notes: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
+        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url:, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::CampaignParticipant} for more details.
+        #
         #   @param id [String]
         #
         #   @param email [String]
@@ -250,6 +260,8 @@ module GrowsurfRuby
         #
         #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
+        #   @param mobile_instance_id [String, nil] App-install scoped mobile identifier used for anti-fraud matching when provided
+        #
         #   @param monthly_referrals [Array<String>]
         #
         #   @param notes [String, nil]

data/lib/growsurf_ruby/resources/campaign/participant.rb

@@ -102,10 +102,13 @@ module GrowsurfRuby
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {GrowsurfRuby::Models::Campaign::ParticipantAddParams} for more details.
+        #
         # Adds a new participant to the program. If the email already exists, the existing
         # participant is returned.
         #
-        # @overload add(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, request_options: {})
+        # @overload add(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil, request_options: {})
         #
         # @param id [String] GrowSurf program ID.
         #
@@ -121,6 +124,8 @@ module GrowsurfRuby
         #
         # @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
+        # @param mobile_instance_id [String] Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+        #
         # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
         #
         # @param referred_by [String] Referrer participant ID or email address.

data/lib/growsurf_ruby/resources/campaign.rb

@@ -52,12 +52,16 @@ module GrowsurfRuby
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams} for more
+      # details.
+      #
       # 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.
       #
-      # @overload create_mobile_participant_token(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, request_options: {})
+      # @overload create_mobile_participant_token(id, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil, request_options: {})
       #
       # @param id [String] GrowSurf program ID.
       #
@@ -73,6 +77,8 @@ module GrowsurfRuby
       #
       # @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
       #
+      # @param mobile_instance_id [String] Optional app-install scoped identifier for native mobile anti-fraud. Recommended
+      #
       # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
       #
       # @param referred_by [String] Referrer participant ID or email address.

data/lib/growsurf_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrowsurfRuby
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

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

@@ -46,6 +46,14 @@ module GrowsurfRuby
         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)
@@ -76,6 +84,7 @@ module GrowsurfRuby
             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
@@ -89,6 +98,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
@@ -104,6 +116,7 @@ module GrowsurfRuby
               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

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/resources/campaign/participant.rbi

@@ -91,6 +91,7 @@ module GrowsurfRuby
             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,
@@ -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,

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -50,6 +50,7 @@ module GrowsurfRuby
           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,
@@ -68,6 +69,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,

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

@@ -9,6 +9,7 @@ module GrowsurfRuby
           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
         }
@@ -36,6 +37,10 @@ module GrowsurfRuby
 
         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=: (
@@ -53,6 +58,7 @@ module GrowsurfRuby
           ?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
@@ -64,6 +70,7 @@ module GrowsurfRuby
           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
         }

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,

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

@@ -36,6 +36,7 @@ module GrowsurfRuby
           ?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,
           ?request_options: GrowsurfRuby::request_opts

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -24,6 +24,7 @@ module GrowsurfRuby
         ?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,
         ?request_options: GrowsurfRuby::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growsurf-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Growsurf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi