growsurf-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f01d0f2cb2534783b61dc721b1fde1d8f4465951558a08e474a2c0816b55785
-  data.tar.gz: bc309ac0246f6ee795ccb48487c37f366c3e04293cdc9f3fea0ef55c8a8576e0
+  metadata.gz: fcb7132df27f55fa865460e439a8f461ff5d039b0bc3100b052e1075820a7fe1
+  data.tar.gz: 8d7e3c55e11ee1a6963845234ec97e2fb52c622682029a68021a77243ea7625f
 SHA512:
-  metadata.gz: bf7d990bbf244492889bdb83c07478bee329598a80eaf4bb48a9445fb322fcdd10fa1a7854a19c8f5dee29f4277d7a3a13c557f5329ebada1309ba7f7a299461
-  data.tar.gz: 4157fc3ebf661d9a92f4713b9f10d91f1f31f6d298449684c5f01946c85909eb3fbf02aefff7399282d7d9c81f124878543806cc307629752105c7156355c1cc
+  metadata.gz: 987fef5597c1023a9e38ade57af6eca87941bac68e020218ba5c98de77c37e55d14276b635da9bc5e3db02b301e765d98aa1ccaa27df02bc4112ae035fb56973
+  data.tar.gz: 0cbd34d217187beb4ea216f81c179e8f9c0a670e7965cc17ba95ae197766b603b0143e75c4c8eb4ef07c3e8435165272a81737c03d38c176842e7dc6ae39158d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.0](https://github.com/growsurf/growsurf-ruby/compare/v1.0.0...v1.1.0) (2026-07-08)
+
+
+### Features
+
+* add account webhook and participant APIs ([11738ff](https://github.com/growsurf/growsurf-ruby/commit/11738ffa7138ff8468c4b6c1b4d355c9ae8706b7))
+
 ## [1.0.0](https://github.com/growsurf/growsurf-ruby/compare/v0.8.0...v1.0.0) (2026-07-03)
 
 

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

data/lib/growsurf_ruby/client.rb

@@ -19,6 +19,9 @@ module GrowsurfRuby
     # @return [String]
     attr_reader :api_key
 
+    # @return [GrowsurfRuby::Resources::Account]
+    attr_reader :account
+
     # @return [GrowsurfRuby::Resources::Campaign]
     attr_reader :campaign
 
@@ -84,6 +87,7 @@ module GrowsurfRuby
         headers: headers
       )
 
+      @account = GrowsurfRuby::Resources::Account.new(client: self)
       @campaign = GrowsurfRuby::Resources::Campaign.new(client: self)
     end
   end

data/lib/growsurf_ruby/models/account.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Account#retrieve
+    class Account < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute id
+      #   The account's unique identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute verification_status
+      #   GrowSurf-team verification state. `VERIFIED` is required before a program can
+      #   send participant emails.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::Account::VerificationStatus]
+      required :verification_status,
+               enum: -> { GrowsurfRuby::Account::VerificationStatus },
+               api_name: :verificationStatus
+
+      # @!attribute company
+      #
+      #   @return [String, nil]
+      optional :company, String, nil?: true
+
+      # @!attribute created_at
+      #   When the account was created, as a Unix timestamp in milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :created_at, Integer, api_name: :createdAt, nil?: true
+
+      # @!attribute first_name
+      #
+      #   @return [String, nil]
+      optional :first_name, String, api_name: :firstName, nil?: true
+
+      # @!attribute last_name
+      #
+      #   @return [String, nil]
+      optional :last_name, String, api_name: :lastName, nil?: true
+
+      # @!attribute verification_requested_at
+      #   When team verification was last requested, as a Unix timestamp in milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :verification_requested_at, Integer, api_name: :verificationRequestedAt, nil?: true
+
+      # @!method initialize(email:, id:, verification_status:, company: nil, created_at: nil, first_name: nil, last_name: nil, verification_requested_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::Account} for more details.
+      #
+      #   @param email [String]
+      #
+      #   @param id [String] The account's unique identifier.
+      #
+      #   @param verification_status [Symbol, GrowsurfRuby::Models::Account::VerificationStatus] GrowSurf-team verification state. `VERIFIED` is required before a program can send
+      #
+      #   @param company [String, nil]
+      #
+      #   @param created_at [Integer, nil] When the account was created, as a Unix timestamp in milliseconds.
+      #
+      #   @param first_name [String, nil]
+      #
+      #   @param last_name [String, nil]
+      #
+      #   @param verification_requested_at [Integer, nil] When team verification was last requested, as a Unix timestamp in milliseconds.
+
+      # GrowSurf-team verification state. `VERIFIED` is required before a program can
+      # send participant emails.
+      #
+      # @see GrowsurfRuby::Models::Account#verification_status
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NOT_REQUESTED = :NOT_REQUESTED
+        REQUESTED = :REQUESTED
+        VERIFIED = :VERIFIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/account_create_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Account#create
+    class AccountCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   The email address for the new account. Personal emails and disposable email addresses are not accepted.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute company
+      #
+      #   @return [String, nil]
+      optional :company, String
+
+      # @!attribute first_name
+      #
+      #   @return [String, nil]
+      optional :first_name, String, api_name: :firstName
+
+      # @!attribute last_name
+      #
+      #   @return [String, nil]
+      optional :last_name, String, api_name: :lastName
+
+      # @!method initialize(email:, company: nil, first_name: nil, last_name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::AccountCreateParams} for more details.
+      #
+      #   @param email [String] The email address for the new account. Personal emails and disposable email addresses are not accepted.
+      #
+      #   @param company [String]
+      #
+      #   @param first_name [String]
+      #
+      #   @param last_name [String]
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/account_create_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Account#create
+    class AccountCreateResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute api_key
+      #   An API key for the new account. Use it as the `Bearer` token on subsequent
+      #   requests. Locked (`403` `EMAIL_NOT_VERIFIED_ERROR`) until the account's email
+      #   is verified, and rotated when the account owner first signs in to the GrowSurf
+      #   dashboard.
+      #
+      #   @return [String]
+      required :api_key, String, api_name: :apiKey
+
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute id
+      #   The new account's unique identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute verification_status
+      #   GrowSurf account verification state. `VERIFIED` is required before a program
+      #   can send participant emails.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus]
+      required :verification_status,
+               enum: -> { GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus },
+               api_name: :verificationStatus
+
+      # @!method initialize(api_key:, email:, id:, verification_status:)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::AccountCreateResponse} for more details.
+      #
+      #   @param api_key [String] An API key for the new account. Use it as the `Bearer` token on subsequent
+      #
+      #   @param email [String]
+      #
+      #   @param id [String] The new account's unique identifier.
+      #
+      #   @param verification_status [Symbol, GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus] GrowSurf account verification state. `VERIFIED` is required before a program can
+
+      # GrowSurf account verification state. `VERIFIED` is required before a program
+      # can send participant emails.
+      #
+      # @see GrowsurfRuby::Models::AccountCreateResponse#verification_status
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NOT_REQUESTED = :NOT_REQUESTED
+        REQUESTED = :REQUESTED
+        VERIFIED = :VERIFIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/account_resend_verification_email_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Account#resend_verification_email
+    class AccountResendVerificationEmailResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute status
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::AccountResendVerificationEmailResponse::Status]
+      required :status, enum: -> { GrowsurfRuby::Models::AccountResendVerificationEmailResponse::Status }
+
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, GrowsurfRuby::Internal::Type::Boolean
+
+      # @!method initialize(status:, success:)
+      #   @param status [Symbol, GrowsurfRuby::Models::AccountResendVerificationEmailResponse::Status]
+      #
+      #   @param success [Boolean]
+
+      # @see GrowsurfRuby::Models::AccountResendVerificationEmailResponse#status
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        SENT = :SENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/account_rotate_api_key_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @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.
+      #
+      #   @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.
+    end
+  end
+end

data/lib/growsurf_ruby/models/account_update_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Account#update
+    class AccountUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute company
+      #
+      #   @return [String, nil]
+      optional :company, String
+
+      # @!attribute first_name
+      #
+      #   @return [String, nil]
+      optional :first_name, String, api_name: :firstName
+
+      # @!attribute last_name
+      #
+      #   @return [String, nil]
+      optional :last_name, String, api_name: :lastName
+
+      # @!method initialize(company: nil, first_name: nil, last_name: nil, request_options: {})
+      #   @param company [String]
+      #
+      #   @param first_name [String]
+      #
+      #   @param last_name [String]
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module GrowsurfRuby
       # @see GrowsurfRuby::Resources::Campaign::Rewards#list
       class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
         # @!attribute rewards
-        #   The program's active, visible, and enabled rewards.
+        #   The program's configured rewards.
         #
         #   @return [Array<GrowsurfRuby::Models::Campaign::Reward>]
         required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::Reward] }
@@ -14,7 +14,7 @@ module GrowsurfRuby
         # @!method initialize(rewards:)
         #   The list of a program's configured rewards.
         #
-        #   @param rewards [Array<GrowsurfRuby::Models::Campaign::Reward>] The program's active, visible, and enabled rewards.
+        #   @param rewards [Array<GrowsurfRuby::Models::Campaign::Reward>] The program's configured rewards.
       end
     end
   end

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

@@ -44,6 +44,10 @@ module GrowsurfRuby
         optional :mobile_instance_id, String, api_name: :mobileInstanceId
 
         # @!attribute referral_status
+        #   The referral credit status; only meaningful when `referred_by` resolves to a
+        #   referrer. When omitted it is derived from the program's referral trigger
+        #   (`CREDIT_AWARDED`, `CREDIT_PENDING`, or `CREDIT_EXPIRED`); left unset when no
+        #   referrer resolves.
         #
         #   @return [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus, nil]
         optional :referral_status,
@@ -74,7 +78,7 @@ module GrowsurfRuby
         #
         #   @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 referral_status [Symbol, GrowsurfRuby::Models::Campaign::Create::ReferralStatus] The referral credit status; only meaningful when `referred_by` resolves to a ref
         #
         #   @param referred_by [String] Referrer participant ID or email address.
 

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_activity_logs
+      class ParticipantActivityLogsResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute activity_logs
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog>]
+        required :activity_logs,
+                 -> {
+                   GrowsurfRuby::Internal::Type::ArrayOf[
+                     GrowsurfRuby::Campaign::ParticipantActivityLogsResponse::ActivityLog
+                   ]
+                 },
+                 api_name: :activityLogs
+
+        # @!attribute limit
+        #
+        #   @return [Integer]
+        required :limit, Integer
+
+        # @!attribute offset
+        #   The offset for the next page, or null when there are no more logs.
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer, nil?: true
+
+        # @!method initialize(activity_logs:, limit:, offset: nil)
+        #   @param activity_logs [Array<GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog>]
+        #
+        #   @param limit [Integer]
+        #
+        #   @param offset [Integer, nil] The offset for the next page, or null when there are no more logs.
+
+        class ActivityLog < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute created_at
+          #   When the activity occurred, as a Unix timestamp in milliseconds.
+          #
+          #   @return [Integer]
+          required :created_at, Integer, api_name: :createdAt
+
+          # @!attribute text
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The activity family (e.g. `REFERRAL`, `SHARE`, `REWARD`, `EMAIL`, `COMMON`).
+          #
+          #   @return [String]
+          required :type, String
+
+          # @!method initialize(created_at:, text:, type:)
+          #   @param created_at [Integer] When the activity occurred, as a Unix timestamp in milliseconds.
+          #
+          #   @param text [String]
+          #
+          #   @param type [String] The activity family (e.g. `REFERRAL`, `SHARE`, `REWARD`, `EMAIL`, `COMMON`).
+        end
+      end
+    end
+  end
+end