growsurf-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981bbbfa4ff94476ccd32bd8c6c6e3b162f299b595917e4203453b63075c5b49
-  data.tar.gz: b60479fec6ed1cee05057a5fabd06542c1315f47bda95d3aab1eeb4ba24ad6e4
+  metadata.gz: 605534d947eac522a949503f9572694007413ef9040a32a96bea535a2584be47
+  data.tar.gz: aef15c880bbfa43c46f5c29f5299179909325b12d7211e1320a03cab1d28a6fe
 SHA512:
-  metadata.gz: ed43b241c7fbf84392eeb93107946c6456eb26c9014a65660999c0523faa11a701cf6f54c51607a8e788c0c5ec96fc8f5fbbd50515012f3235a31097241da3f3
-  data.tar.gz: 260c56e29c5f066f4e778c9c709007a93a64aba501ec13abc4c77bb29ff77702a388ffb103c444c5600ef02ac9e15dcce3ee2160150b490393479d6bc4d3b185
+  metadata.gz: 06c6a1595b1d6778efd78c9d01237364471f023f2163d8f3b663aaa27cdf684d1d0ea714023b03b2398d65a07b971fd5902712640016166dee9e116c35f40580
+  data.tar.gz: 3761201606953175d138cbed0e948d6e2b069183e9584faefe841f9dfe7a0a9c5d9f0e190c69776bb1cf424f872e95a23122d1ed77c55721967c73202a569160

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** manual updates ([929f439](https://github.com/growsurf/growsurf-ruby/commit/929f4399c265598db298eb96f5ff4ac2db6b12e8))
+
 ## 0.2.0 (2026-05-15)
 
 Full Changelog: [v0.1.1...v0.2.0](https://github.com/growsurf/growsurf-ruby/compare/v0.1.1...v0.2.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.2.0"
+gem "growsurf-ruby", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -196,25 +196,25 @@ growsurf.campaign.list(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :PENDING
-puts(GrowsurfRuby::CampaignListCommissionsParams::Status::PENDING)
+# :CREDIT_PENDING
+puts(GrowsurfRuby::Campaign::Create::ReferralStatus::CREDIT_PENDING)
 
-# Revealed type: `T.all(GrowsurfRuby::CampaignListCommissionsParams::Status, Symbol)`
-T.reveal_type(GrowsurfRuby::CampaignListCommissionsParams::Status::PENDING)
+# Revealed type: `T.all(GrowsurfRuby::Campaign::Create::ReferralStatus, Symbol)`
+T.reveal_type(GrowsurfRuby::Campaign::Create::ReferralStatus::CREDIT_PENDING)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-growsurf.campaign.list_commissions(
-  status: GrowsurfRuby::CampaignListCommissionsParams::Status::PENDING,
+growsurf.campaign.create_mobile_participant_token(
+  referral_status: GrowsurfRuby::Campaign::Create::ReferralStatus::CREDIT_PENDING,
   # …
 )
 
 # Literal values are also permissible:
-growsurf.campaign.list_commissions(
-  status: :PENDING,
+growsurf.campaign.create_mobile_participant_token(
+  referral_status: :CREDIT_PENDING,
   # …
 )
 ```

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class Create < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute fingerprint
+        #
+        #   @return [String, nil]
+        optional :fingerprint, String
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!attribute ip_address
+        #
+        #   @return [String, nil]
+        optional :ip_address, String, api_name: :ipAddress
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName
+
+        # @!attribute metadata
+        #   Shallow custom metadata object.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute referral_status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus, nil]
+        optional :referral_status,
+                 enum: -> { GrowsurfRuby::Campaign::Create::ReferralStatus },
+                 api_name: :referralStatus
+
+        # @!attribute referred_by
+        #   Referrer participant ID or email address.
+        #
+        #   @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)
+        #   @param email [String]
+        #
+        #   @param fingerprint [String]
+        #
+        #   @param first_name [String]
+        #
+        #   @param ip_address [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+        #
+        #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
+        #
+        #   @param referred_by [String] Referrer participant ID or email address.
+
+        # @see GrowsurfRuby::Models::Campaign::Create#referral_status
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING = :CREDIT_PENDING
+          CREDIT_AWARDED = :CREDIT_AWARDED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module GrowsurfRuby
   module Models
     module Campaign
       # @see GrowsurfRuby::Resources::Campaign::Participant#add
-      class ParticipantAddParams < GrowsurfRuby::Internal::Type::BaseModel
+      class ParticipantAddParams < GrowsurfRuby::Models::Campaign::Create
         extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
         include GrowsurfRuby::Internal::Type::RequestParameters
 
@@ -13,80 +13,9 @@ module GrowsurfRuby
         #   @return [String]
         required :id, String
 
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute fingerprint
-        #
-        #   @return [String, nil]
-        optional :fingerprint, String
-
-        # @!attribute first_name
-        #
-        #   @return [String, nil]
-        optional :first_name, String, api_name: :firstName
-
-        # @!attribute ip_address
-        #
-        #   @return [String, nil]
-        optional :ip_address, String, api_name: :ipAddress
-
-        # @!attribute last_name
-        #
-        #   @return [String, nil]
-        optional :last_name, String, api_name: :lastName
-
-        # @!attribute metadata
-        #   Shallow custom metadata object.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
-
-        # @!attribute referral_status
-        #
-        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantAddParams::ReferralStatus, nil]
-        optional :referral_status,
-                 enum: -> { GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus },
-                 api_name: :referralStatus
-
-        # @!attribute referred_by
-        #   Referrer participant ID or email address.
-        #
-        #   @return [String, nil]
-        optional :referred_by, String, api_name: :referredBy
-
-        # @!method initialize(id:, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, request_options: {})
+        # @!method initialize(id:, request_options: {})
         #   @param id [String]
-        #
-        #   @param email [String]
-        #
-        #   @param fingerprint [String]
-        #
-        #   @param first_name [String]
-        #
-        #   @param ip_address [String]
-        #
-        #   @param last_name [String]
-        #
-        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
-        #
-        #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantAddParams::ReferralStatus]
-        #
-        #   @param referred_by [String] Referrer participant ID or email address.
-        #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
-
-        module ReferralStatus
-          extend GrowsurfRuby::Internal::Type::Enum
-
-          CREDIT_PENDING = :CREDIT_PENDING
-          CREDIT_AWARDED = :CREDIT_AWARDED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
     end
   end

data/lib/growsurf_ruby/models/campaign_create_mobile_participant_token_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#create_mobile_participant_token
+    class CampaignCreateMobileParticipantTokenParams < GrowsurfRuby::Models::Campaign::Create
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#create_mobile_participant_token
+    class CampaignCreateMobileParticipantTokenResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute expires_in
+      #   Token lifetime in seconds.
+      #
+      #   @return [Integer]
+      required :expires_in, Integer, api_name: :expiresIn
+
+      # @!attribute is_new
+      #   Whether this request created a new participant. Returns false when the
+      #   participant already existed.
+      #
+      #   @return [Boolean]
+      required :is_new, GrowsurfRuby::Internal::Type::Boolean, api_name: :isNew
+
+      # @!attribute participant
+      #
+      #   @return [GrowsurfRuby::Models::Campaign::CampaignParticipant]
+      required :participant, -> { GrowsurfRuby::Campaign::CampaignParticipant }
+
+      # @!attribute participant_token
+      #   Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.
+      #
+      #   @return [String]
+      required :participant_token, String, api_name: :participantToken
+
+      # @!method initialize(expires_in:, is_new:, participant:, participant_token:)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse} for more
+      #   details.
+      #
+      #   @param expires_in [Integer] Token lifetime in seconds.
+      #
+      #   @param is_new [Boolean] Whether this request created a new participant. Returns false when the participa
+      #
+      #   @param participant [GrowsurfRuby::Models::Campaign::CampaignParticipant]
+      #
+      #   @param participant_token [String] Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.
+    end
+  end
+end

data/lib/growsurf_ruby/models.rb

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

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

@@ -121,7 +121,7 @@ module GrowsurfRuby
         #
         # @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
-        # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantAddParams::ReferralStatus]
+        # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
         #
         # @param referred_by [String] Referrer participant ID or email address.
         #
@@ -141,34 +141,6 @@ module GrowsurfRuby
           )
         end
 
-        # Creates a participant-scoped token for GrowSurf mobile SDK participant
-        # endpoints. The program must have mobile SDK access enabled.
-        #
-        # @overload create_mobile_token(participant_id_or_email, id:, request_options: {})
-        #
-        # @param participant_id_or_email [String] GrowSurf participant ID or URL-encoded participant email address.
-        #
-        # @param id [String] GrowSurf program ID.
-        #
-        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [GrowsurfRuby::Models::Campaign::ParticipantCreateMobileTokenResponse]
-        #
-        # @see GrowsurfRuby::Models::Campaign::ParticipantCreateMobileTokenParams
-        def create_mobile_token(participant_id_or_email, params)
-          parsed, options = GrowsurfRuby::Campaign::ParticipantCreateMobileTokenParams.dump_request(params)
-          id =
-            parsed.delete(:id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
-          @client.request(
-            method: :post,
-            path: ["campaign/%1$s/participant/%2$s/mobile-token", id, participant_id_or_email],
-            model: GrowsurfRuby::Models::Campaign::ParticipantCreateMobileTokenResponse,
-            options: options
-          )
-        end
-
         # Retrieves a paged list of commissions earned by a participant.
         #
         # @overload list_commissions(participant_id_or_email, id:, limit: nil, next_id: nil, status: nil, request_options: {})

data/lib/growsurf_ruby/resources/campaign.rb

@@ -52,6 +52,47 @@ module GrowsurfRuby
         )
       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.
+      #
+      # @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: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param email [String]
+      #
+      # @param fingerprint [String]
+      #
+      # @param first_name [String]
+      #
+      # @param ip_address [String]
+      #
+      # @param last_name [String]
+      #
+      # @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+      #
+      # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus]
+      #
+      # @param referred_by [String] Referrer participant ID or email address.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse]
+      #
+      # @see GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
+      def create_mobile_participant_token(id, params)
+        parsed, options = GrowsurfRuby::CampaignCreateMobileParticipantTokenParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["campaign/%1$s/mobile-participant-token", id],
+          body: parsed,
+          model: GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse,
+          options: options
+        )
+      end
+
       # Retrieves a paged list of all participant commissions in an affiliate program.
       #
       # @overload list_commissions(id, limit: nil, next_id: nil, status: nil, request_options: {})

data/lib/growsurf_ruby/version.rb

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

data/lib/growsurf_ruby.rb

@@ -52,6 +52,7 @@ require_relative "growsurf_ruby/errors"
 require_relative "growsurf_ruby/internal/transport/base_client"
 require_relative "growsurf_ruby/internal/transport/pooled_net_requester"
 require_relative "growsurf_ruby/client"
+require_relative "growsurf_ruby/models/campaign/create"
 require_relative "growsurf_ruby/models/campaign/participant"
 require_relative "growsurf_ruby/models/campaign/commission_approve_params"
 require_relative "growsurf_ruby/models/campaign/commission_approve_response"
@@ -59,8 +60,6 @@ require_relative "growsurf_ruby/models/campaign/commission_delete_params"
 require_relative "growsurf_ruby/models/campaign/commission_delete_response"
 require_relative "growsurf_ruby/models/campaign/fraud_risk_level"
 require_relative "growsurf_ruby/models/campaign/participant_add_params"
-require_relative "growsurf_ruby/models/campaign/participant_create_mobile_token_params"
-require_relative "growsurf_ruby/models/campaign/participant_create_mobile_token_response"
 require_relative "growsurf_ruby/models/campaign/participant_delete_params"
 require_relative "growsurf_ruby/models/campaign/participant_delete_response"
 require_relative "growsurf_ruby/models/campaign/participant_list_commissions_params"
@@ -86,6 +85,8 @@ require_relative "growsurf_ruby/models/campaign/reward_delete_response"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_params"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_response"
 require_relative "growsurf_ruby/models/campaign"
+require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_params"
+require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_response"
 require_relative "growsurf_ruby/models/campaign_list_commissions_params"
 require_relative "growsurf_ruby/models/campaign_list_leaderboard_params"
 require_relative "growsurf_ruby/models/campaign_list_params"

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

@@ -0,0 +1,149 @@
+# 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
+
+        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],
+            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,
+          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],
+              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