growsurf-ruby 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb7132df27f55fa865460e439a8f461ff5d039b0bc3100b052e1075820a7fe1
-  data.tar.gz: 8d7e3c55e11ee1a6963845234ec97e2fb52c622682029a68021a77243ea7625f
+  metadata.gz: d8076462c15a156d463bf26bb5f654d2baf7a6795204be7b8ef79a9dd2ae2053
+  data.tar.gz: da320558ee220ff66aac11869a410cdcb402084b9563985763da99c47cce1755
 SHA512:
-  metadata.gz: 987fef5597c1023a9e38ade57af6eca87941bac68e020218ba5c98de77c37e55d14276b635da9bc5e3db02b301e765d98aa1ccaa27df02bc4112ae035fb56973
-  data.tar.gz: 0cbd34d217187beb4ea216f81c179e8f9c0a670e7965cc17ba95ae197766b603b0143e75c4c8eb4ef07c3e8435165272a81737c03d38c176842e7dc6ae39158d
+  metadata.gz: d5c1d9647d05936815ddae19a40e12a06cf4d1ed469f27c86dc03b543b3abd9895923e494c4bb0f7a28ba50c0c219bafa78276c0feb15d94f08b43d40b59f908
+  data.tar.gz: fe5bcdf5683be8d8dbf038f33ca365d66d5959f5c3d3a5b7e9c8e9717e0970564d8d5ac9b6d625bbf1af24edda057405aacefd9f4a35e6cd7c48f2aac1023a51

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.1.2](https://github.com/growsurf/growsurf-ruby/compare/v1.1.1...v1.1.2) (2026-07-11)
+
+
+### Bug Fixes
+
+* support retry-safe API key rotation ([939cd05](https://github.com/growsurf/growsurf-ruby/commit/939cd054446d85e411652ae77d37d4351c1ad6ab))
+
+## [1.1.1](https://github.com/growsurf/growsurf-ruby/compare/v1.1.0...v1.1.1) (2026-07-09)
+
+
+### Bug Fixes
+
+* remove referral screenshot REST surface ([7d543f7](https://github.com/growsurf/growsurf-ruby/commit/7d543f7a3dfa1db1f3d0ce5c556d897945d844b1))
+
 ## [1.1.0](https://github.com/growsurf/growsurf-ruby/compare/v1.0.0...v1.1.0) (2026-07-08)
 
 

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", "~> 1.1.0"
+gem "growsurf-ruby", "~> 1.1.2"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/client.rb

@@ -84,6 +84,7 @@ module GrowsurfRuby
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
         max_retry_delay: max_retry_delay,
+        idempotency_header: "Idempotency-Key",
         headers: headers
       )
 

data/lib/growsurf_ruby/models/account_rotate_api_key_response.rb

@@ -5,13 +5,13 @@ module GrowsurfRuby
     # @see GrowsurfRuby::Resources::Account#rotate_api_key
     class AccountRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
       # @!attribute api_key
-      #   The new API key. The previous key is revoked immediately.
+      #   The new API key. Store it now; the key used for rotation stops working immediately.
       #
       #   @return [String]
       required :api_key, String, api_name: :apiKey
 
       # @!method initialize(api_key:)
-      #   @param api_key [String] The new API key. The previous key is revoked immediately.
+      #   @param api_key [String] The new API key. Store it now; the key used for rotation stops working immediately.
     end
   end
 end

data/lib/growsurf_ruby/models.rb

@@ -82,7 +82,5 @@ module GrowsurfRuby
 
   ReferralList = GrowsurfRuby::Models::ReferralList
 
-  ReferralFlowScreenshotsResponse = GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
-
   RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/lib/growsurf_ruby/resources/account.rb

@@ -4,9 +4,10 @@ module GrowsurfRuby
   module Resources
     class Account
       # Creates a new GrowSurf account. This is the only endpoint that does not require
-      # an API key. The response includes an API key for the new account, but the key is
-      # locked until the account's email address is verified: authenticated endpoints
-      # outside the `Accounts` group return a `403` with error code
+      # an API key. The response includes an API key for the new account, shown once
+      # in the response. The key is locked until the account's email address is
+      # verified: authenticated endpoints outside the `Accounts` group return a `403`
+      # with error code
       # `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
       # /account/verification-email`, then retry). A welcome email is sent to the
       # address with the verification link and a set-password link for dashboard
@@ -91,10 +92,12 @@ module GrowsurfRuby
         )
       end
 
-      # Generates a new API key and immediately revokes the old one. The key used to make
-      # this request stops working as soon as the response is returned — update every
-      # integration that used the old key with the new one. The account owner is
-      # notified by email whenever the key is rotated.
+      # Generates a new API key and invalidates the key used for the request. The SDK
+      # sends a retry-safe `Idempotency-Key`, so automatic retries return the same
+      # replacement. Store the returned key, then update every integration that used
+      # the old key. The account owner is notified by email whenever the key is rotated.
+      # Requires an API key with `api_key:rotate`. This operation is available only through
+      # the REST API or a GrowSurf API SDK, not through MCP.
       #
       # @overload rotate_api_key(request_options: {})
       #

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

@@ -33,7 +33,8 @@ module GrowsurfRuby
           )
         end
 
-        # Approves a manually approved reward earned by a participant.
+        # Approves a manually approved reward earned by a participant. Requires
+        # `reward:write`. Passing `fulfill: true` also requires `reward:fulfill`.
         #
         # @overload approve(reward_id, id:, fulfill: nil, request_options: {})
         #
@@ -63,7 +64,7 @@ module GrowsurfRuby
           )
         end
 
-        # Marks an approved participant reward as fulfilled.
+        # Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
         #
         # @overload fulfill(reward_id, id:, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign.rb

@@ -163,25 +163,6 @@ module GrowsurfRuby
         )
       end
 
-      # Captures two preview screenshots for the program: the authenticated referrer
-      # view and the referred-friend view.
-      #
-      # @overload get_referral_flow_screenshots(id, request_options: {})
-      #
-      # @param id [String] GrowSurf program ID.
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse]
-      def get_referral_flow_screenshots(id, params = {})
-        @client.request(
-          method: :get,
-          path: ["campaign/%1$s/referral-flow-screenshots", id],
-          model: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse,
-          options: params[:request_options]
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams} for more
       # details.

data/lib/growsurf_ruby/version.rb

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

data/lib/growsurf_ruby.rb

@@ -136,7 +136,6 @@ require_relative "growsurf_ruby/models/participant_commission_list"
 require_relative "growsurf_ruby/models/participant_list"
 require_relative "growsurf_ruby/models/participant_payout_list"
 require_relative "growsurf_ruby/models/referral_list"
-require_relative "growsurf_ruby/models/referral_flow_screenshots_response"
 require_relative "growsurf_ruby/models/reward_tax_valuation"
 require_relative "growsurf_ruby/models"
 require_relative "growsurf_ruby/resources/account"

data/rbi/growsurf_ruby/models/account_rotate_api_key_response.rbi

@@ -11,13 +11,13 @@ module GrowsurfRuby
           )
         end
 
-      # The new API key. The previous key is revoked immediately.
+      # The new API key. Store it now; the key used for rotation stops working immediately.
       sig { returns(String) }
       attr_accessor :api_key
 
       sig { params(api_key: String).returns(T.attached_class) }
       def self.new(
-        # The new API key. The previous key is revoked immediately.
+        # The new API key. Store it now; the key used for rotation stops working immediately.
         api_key:
       )
       end

data/rbi/growsurf_ruby/models.rbi

@@ -49,8 +49,5 @@ module GrowsurfRuby
 
   ReferralList = GrowsurfRuby::Models::ReferralList
 
-  ReferralFlowScreenshotsResponse =
-    GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
-
   RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/rbi/growsurf_ruby/resources/account.rbi

@@ -4,9 +4,10 @@ module GrowsurfRuby
   module Resources
     class Account
       # Creates a new GrowSurf account. This is the only endpoint that does not require
-      # an API key. The response includes an API key for the new account, but the key is
-      # locked until the account's email address is verified: authenticated endpoints
-      # outside the `Accounts` group return a `403` with error code
+      # an API key. The response includes an API key for the new account, shown once
+      # in the response. The key is locked until the account's email address is
+      # verified: authenticated endpoints outside the `Accounts` group return a `403`
+      # with error code
       # `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
       # /account/verification-email`, then retry). A welcome email is sent to the
       # address with the verification link and a set-password link for dashboard
@@ -67,10 +68,12 @@ module GrowsurfRuby
       )
       end
 
-      # Generates a new API key and immediately revokes the old one. The key used to make
-      # this request stops working as soon as the response is returned — update every
-      # integration that used the old key with the new one. The account owner is
-      # notified by email whenever the key is rotated.
+      # Generates a new API key and invalidates the key used for the request. The SDK
+      # sends a retry-safe `Idempotency-Key`, so automatic retries return the same
+      # replacement. Store the returned key, then update every integration that used
+      # the old key. The account owner is notified by email whenever the key is rotated.
+      # Requires an API key with `api_key:rotate`. This operation is available only through
+      # the REST API or a GrowSurf API SDK, not through MCP.
       sig do
         params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
           GrowsurfRuby::Models::AccountRotateAPIKeyResponse

data/rbi/growsurf_ruby/resources/campaign/reward.rbi

@@ -23,7 +23,8 @@ module GrowsurfRuby
         )
         end
 
-        # Approves a manually approved reward earned by a participant.
+        # Approves a manually approved reward earned by a participant. Requires
+        # `reward:write`. Passing `fulfill: true` also requires `reward:fulfill`.
         sig do
           params(
             reward_id: String,
@@ -43,7 +44,7 @@ module GrowsurfRuby
         )
         end
 
-        # Marks an approved participant reward as fulfilled.
+        # Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
         sig do
           params(
             reward_id: String,

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -135,21 +135,6 @@ module GrowsurfRuby
       )
       end
 
-      # Captures two preview screenshots for the program: the authenticated referrer
-      # view and the referred-friend view.
-      sig do
-        params(
-          id: String,
-          request_options: GrowsurfRuby::RequestOptions::OrHash
-        ).returns(GrowsurfRuby::Models::ReferralFlowScreenshotsResponse)
-      end
-      def get_referral_flow_screenshots(
-        # GrowSurf program ID.
-        id,
-        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

data/sig/growsurf_ruby/models.rbs

@@ -41,7 +41,5 @@ module GrowsurfRuby
 
   class ReferralList = GrowsurfRuby::Models::ReferralList
 
-  class ReferralFlowScreenshotsResponse = GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
-
   class RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -52,11 +52,6 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
 
-      def get_referral_flow_screenshots: (
-        String id,
-        ?request_options: GrowsurfRuby::request_opts
-      ) -> GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
-
       def create_mobile_participant_token: (
         String id,
         email: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growsurf-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Growsurf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-08 00:00:00.000000000 Z
+date: 2026-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -152,7 +152,6 @@ files:
 - lib/growsurf_ruby/models/participant_commission_list.rb
 - lib/growsurf_ruby/models/participant_list.rb
 - lib/growsurf_ruby/models/participant_payout_list.rb
-- lib/growsurf_ruby/models/referral_flow_screenshots_response.rb
 - lib/growsurf_ruby/models/referral_list.rb
 - lib/growsurf_ruby/models/reward_tax_valuation.rb
 - lib/growsurf_ruby/request_options.rb
@@ -271,7 +270,6 @@ files:
 - rbi/growsurf_ruby/models/participant_commission_list.rbi
 - rbi/growsurf_ruby/models/participant_list.rbi
 - rbi/growsurf_ruby/models/participant_payout_list.rbi
-- rbi/growsurf_ruby/models/referral_flow_screenshots_response.rbi
 - rbi/growsurf_ruby/models/referral_list.rbi
 - rbi/growsurf_ruby/models/reward_tax_valuation.rbi
 - rbi/growsurf_ruby/request_options.rbi
@@ -389,7 +387,6 @@ files:
 - sig/growsurf_ruby/models/participant_commission_list.rbs
 - sig/growsurf_ruby/models/participant_list.rbs
 - sig/growsurf_ruby/models/participant_payout_list.rbs
-- sig/growsurf_ruby/models/referral_flow_screenshots_response.rbs
 - sig/growsurf_ruby/models/referral_list.rbs
 - sig/growsurf_ruby/models/reward_tax_valuation.rbs
 - sig/growsurf_ruby/request_options.rbs

data/lib/growsurf_ruby/models/referral_flow_screenshots_response.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module GrowsurfRuby
-  module Models
-    # @see GrowsurfRuby::Resources::Campaign#get_referral_flow_screenshots
-    class ReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
-      # @!attribute referrer
-      #   Screenshot of the referral flow as a signed-in referrer sees it.
-      #
-      #   @return [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot]
-      required :referrer, -> { GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot }
-
-      # @!attribute referred_friend
-      #   Screenshot of the referral flow as the referred friend sees it.
-      #
-      #   @return [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot]
-      required :referred_friend,
-               -> { GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot },
-               api_name: :referredFriend
-
-      # @!attribute generated_at
-      #   When the screenshots were generated, as a Unix timestamp in milliseconds.
-      #
-      #   @return [Integer]
-      required :generated_at, Integer, api_name: :generatedAt
-
-      # @!method initialize(referrer:, referred_friend:, generated_at:)
-      #
-      #   @param referrer [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot] Screenshot of the referral flow as a signed-in referrer sees it.
-      #
-      #   @param referred_friend [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot] Screenshot of the referral flow as the referred friend sees it.
-      #
-      #   @param generated_at [Integer] When the screenshots were generated, as a Unix timestamp in milliseconds.
-
-      class ReferralFlowScreenshot < GrowsurfRuby::Internal::Type::BaseModel
-        # @!attribute view
-        #   The referral-flow view captured in this screenshot.
-        #
-        #   @return [String]
-        required :view, String
-
-        # @!attribute url
-        #   Image URL for the generated screenshot.
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!attribute width
-        #   Screenshot viewport width in CSS pixels.
-        #
-        #   @return [Integer]
-        required :width, Integer
-
-        # @!attribute height
-        #   Screenshot viewport height in CSS pixels.
-        #
-        #   @return [Integer]
-        required :height, Integer
-
-        # @!method initialize(view:, url:, width:, height:)
-        #
-        #   @param view [String] The referral-flow view captured in this screenshot.
-        #
-        #   @param url [String] Image URL for the generated screenshot.
-        #
-        #   @param width [Integer] Screenshot viewport width in CSS pixels.
-        #
-        #   @param height [Integer] Screenshot viewport height in CSS pixels.
-      end
-    end
-  end
-end

data/rbi/growsurf_ruby/models/referral_flow_screenshots_response.rbi

@@ -1,94 +0,0 @@
-# typed: strong
-
-module GrowsurfRuby
-  module Models
-    class ReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            GrowsurfRuby::Models::ReferralFlowScreenshotsResponse,
-            GrowsurfRuby::Internal::AnyHash
-          )
-        end
-
-      sig { returns(GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot) }
-      attr_reader :referrer
-
-      sig do
-        params(
-          referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot::OrHash
-        ).void
-      end
-      attr_writer :referrer
-
-      sig { returns(GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot) }
-      attr_reader :referred_friend
-
-      sig do
-        params(
-          referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot::OrHash
-        ).void
-      end
-      attr_writer :referred_friend
-
-      sig { returns(Integer) }
-      attr_accessor :generated_at
-
-      sig do
-        params(
-          referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot::OrHash,
-          referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot::OrHash,
-          generated_at: Integer
-        ).returns(T.attached_class)
-      end
-      def self.new(referrer:, referred_friend:, generated_at:)
-      end
-
-      sig do
-        override.returns(
-          {
-            referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-            referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-            generated_at: Integer
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class ReferralFlowScreenshot < GrowsurfRuby::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-              GrowsurfRuby::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :view
-
-        sig { returns(String) }
-        attr_accessor :url
-
-        sig { returns(Integer) }
-        attr_accessor :width
-
-        sig { returns(Integer) }
-        attr_accessor :height
-
-        sig do
-          params(view: String, url: String, width: Integer, height: Integer).returns(T.attached_class)
-        end
-        def self.new(view:, url:, width:, height:)
-        end
-
-        sig do
-          override.returns({view: String, url: String, width: Integer, height: Integer})
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/sig/growsurf_ruby/models/referral_flow_screenshots_response.rbs

@@ -1,54 +0,0 @@
-module GrowsurfRuby
-  module Models
-    type referral_flow_screenshots_response =
-      {
-        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        generated_at: Integer
-      }
-
-    class ReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
-      attr_accessor referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
-
-      attr_accessor referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
-
-      attr_accessor generated_at: Integer
-
-      def initialize: (
-        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        generated_at: Integer
-      ) -> void
-
-      def to_hash: -> {
-        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
-        generated_at: Integer
-      }
-
-      class ReferralFlowScreenshot < GrowsurfRuby::Internal::Type::BaseModel
-        attr_accessor view: String
-
-        attr_accessor url: String
-
-        attr_accessor width: Integer
-
-        attr_accessor height: Integer
-
-        def initialize: (
-          view: String,
-          url: String,
-          width: Integer,
-          height: Integer
-        ) -> void
-
-        def to_hash: -> {
-          view: String,
-          url: String,
-          width: Integer,
-          height: Integer
-        }
-      end
-    end
-  end
-end