growsurf-ruby 1.0.0 → 1.1.0

data/rbi/growsurf_ruby/resources/campaign/rewards.rbi

@@ -4,7 +4,7 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # Retrieves the active, visible, and enabled rewards configured for a program.
+        # Retrieves the rewards configured for a program.
         sig do
           params(
             id: String,
@@ -30,7 +30,6 @@ module GrowsurfRuby
             coupon_code: String,
             description: String,
             image_url: String,
-            is_active: T::Boolean,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -59,17 +58,20 @@ module GrowsurfRuby
           commission_structure: nil,
           # Body param
           conversions_required: nil,
-          # Body param
+          # Body param: Legacy static coupon code shown to the referrer in the reward-won
+          # email and webhook. Display text only; superseded by a connected billing
+          # integration's issued coupon when one exists.
           coupon_code: nil,
           # Body param
           description: nil,
           # Body param
           image_url: nil,
-          # Body param
-          is_active: nil,
-          # Body param
+          # Body param: Whether the reward can be earned an unlimited number of times.
+          # Defaults to `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
-          # Body param
+          # Body param: Whether the reward is enabled. When `false` the reward is disabled:
+          # hidden from participants and no longer awarded, including those who already
+          # earned it.
           is_visible: nil,
           # Body param
           limit: nil,
@@ -78,15 +80,21 @@ module GrowsurfRuby
           # Body param: Custom key/value metadata (single-level; values are stored as
           # strings).
           metadata: nil,
-          # Body param
+          # Body param: Text shown before a participant's referral count in
+          # milestone-progress copy. Applies to `MILESTONE` rewards.
           next_milestone_prefix: nil,
-          # Body param
+          # Body param: Text shown after a participant's referral count in
+          # milestone-progress copy. Applies to `MILESTONE` rewards.
           next_milestone_suffix: nil,
-          # Body param
+          # Body param: The number of winners (`LEADERBOARD` rewards only). With
+          # `limitDuration` `PER_MONTH` this many win each month, otherwise this many win
+          # in total; omitting it defaults to `3`.
           number_of_winners: nil,
           # Body param
           order: nil,
-          # Body param
+          # Body param: Legacy static coupon code shown to the referred friend
+          # (double-sided rewards) in the reward-won email and webhook. Display text only;
+          # superseded by a connected billing integration's issued coupon when one exists.
           referral_coupon_code: nil,
           # Body param
           referral_description: nil,
@@ -115,7 +123,6 @@ module GrowsurfRuby
             coupon_code: String,
             description: String,
             image_url: String,
-            is_active: T::Boolean,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -144,17 +151,20 @@ module GrowsurfRuby
           commission_structure: nil,
           # Body param
           conversions_required: nil,
-          # Body param
+          # Body param: Legacy static coupon code shown to the referrer in the reward-won
+          # email and webhook. Display text only; superseded by a connected billing
+          # integration's issued coupon when one exists.
           coupon_code: nil,
           # Body param
           description: nil,
           # Body param
           image_url: nil,
-          # Body param
-          is_active: nil,
-          # Body param
+          # Body param: Whether the reward can be earned an unlimited number of times.
+          # Defaults to `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
-          # Body param
+          # Body param: Whether the reward is enabled. When `false` the reward is disabled:
+          # hidden from participants and no longer awarded, including those who already
+          # earned it.
           is_visible: nil,
           # Body param
           limit: nil,
@@ -163,15 +173,21 @@ module GrowsurfRuby
           # Body param: Custom key/value metadata (single-level; values are stored as
           # strings).
           metadata: nil,
-          # Body param
+          # Body param: Text shown before a participant's referral count in
+          # milestone-progress copy. Applies to `MILESTONE` rewards.
           next_milestone_prefix: nil,
-          # Body param
+          # Body param: Text shown after a participant's referral count in
+          # milestone-progress copy. Applies to `MILESTONE` rewards.
           next_milestone_suffix: nil,
-          # Body param
+          # Body param: The number of winners (`LEADERBOARD` rewards only). With
+          # `limitDuration` `PER_MONTH` this many win each month, otherwise this many win
+          # in total; omitting it defaults to `3`.
           number_of_winners: nil,
           # Body param
           order: nil,
-          # Body param
+          # Body param: Legacy static coupon code shown to the referred friend
+          # (double-sided rewards) in the reward-won email and webhook. Display text only;
+          # superseded by a connected billing integration's issued coupon when one exists.
           referral_coupon_code: nil,
           # Body param
           referral_description: nil,

data/rbi/growsurf_ruby/resources/campaign/webhooks.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Webhooks
+        # Lists a program's webhooks (secrets are never returned).
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::WebhookListResponse)
+        end
+        def list(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Adds a webhook to the program.
+        sig do
+          params(
+            id: String,
+            payload_url: String,
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+            is_enabled: T::Boolean,
+            secret: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Webhook)
+        end
+        def create(
+          # Path param: GrowSurf program ID.
+          id,
+          # Body param: The URL that receives webhook deliveries.
+          payload_url:,
+          # Body param: The events this webhook is subscribed to. When omitted, it is
+          # subscribed to no events.
+          events: nil,
+          # Body param
+          is_enabled: nil,
+          # Body param: Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC
+          # header). Never returned.
+          secret: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates a webhook by id.
+        sig do
+          params(
+            webhook_id: String,
+            id: String,
+            events: T::Array[GrowsurfRuby::Campaign::WebhookEvent::OrSymbol],
+            is_enabled: T::Boolean,
+            payload_url: String,
+            secret: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Webhook)
+        end
+        def update(
+          # Path param: The webhook id (`primary` for the program's primary webhook).
+          webhook_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          events: nil,
+          # Body param
+          is_enabled: nil,
+          # Body param
+          payload_url: nil,
+          # Body param: Write-only.
+          secret: nil,
+          request_options: {}
+        )
+        end
+
+        # Removes a webhook by id.
+        sig do
+          params(
+            webhook_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::WebhookDeleteResponse)
+        end
+        def delete(
+          # The webhook id (`primary` for the program's primary webhook).
+          webhook_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Sends a live test event to a webhook using its stored URL and secret.
+        sig do
+          params(
+            webhook_id: String,
+            id: String,
+            event: GrowsurfRuby::Campaign::WebhookEvent::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::WebhookTestResponse)
+        end
+        def test(
+          # Path param: The webhook id (`primary` for the program's primary webhook).
+          webhook_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param: The event to simulate. When omitted, the webhook's first enabled
+          # event is used (returns `400` if it has no enabled events).
+          event: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -34,6 +34,10 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Installation) }
       attr_reader :installation
 
+      # Program webhook configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Webhooks) }
+      attr_reader :webhooks
+
       # Retrieves a program for the given program ID.
       sig do
         params(
@@ -110,8 +114,8 @@ module GrowsurfRuby
         company_name: nil,
         # Body param
         name: nil,
-        # Body param: The program status. Transitions are validated; DELETED is not
-        # allowed.
+        # Body param: The requested program status. `IN_PROGRESS` publishes or resumes
+        # the program; `COMPLETE` ends it. Any other value returns a `400`.
         status: nil,
         request_options: {}
       )
@@ -131,6 +135,21 @@ 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
@@ -314,6 +333,9 @@ module GrowsurfRuby
           id: String,
           days: Integer,
           end_date: Integer,
+          include: String,
+          interval:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
           start_date: Integer,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse)
@@ -326,6 +348,15 @@ module GrowsurfRuby
         # End date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         end_date: nil,
+        # Comma-separated list of optional enrichments (opt-in to keep the default response
+        # lean): `previousPeriod` adds totals for the equal-length window immediately before
+        # the requested one; `statusCounts` adds reward (and, for affiliate programs,
+        # affiliate/commission/payout) status breakdowns; `rates` adds derived referral
+        # rates.
+        include: nil,
+        # When set to `day`, `week`, or `month`, the response also includes a `series` array
+        # with per-period totals. Defaults to `total` (no series).
+        interval: nil,
         # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         start_date: nil,

data/sig/growsurf_ruby/client.rbs

@@ -10,6 +10,8 @@ module GrowsurfRuby
 
     attr_reader api_key: String
 
+    attr_reader account: GrowsurfRuby::Resources::Account
+
     attr_reader campaign: GrowsurfRuby::Resources::Campaign
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/growsurf_ruby/models/account.rbs

@@ -0,0 +1,67 @@
+module GrowsurfRuby
+  module Models
+    type account =
+      {
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::Account::verification_status,
+        company: String?,
+        created_at: Integer?,
+        first_name: String?,
+        last_name: String?,
+        verification_requested_at: Integer?
+      }
+
+    class Account < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor email: String
+
+      attr_accessor id: String
+
+      attr_accessor verification_status: GrowsurfRuby::Models::Account::verification_status
+
+      attr_accessor company: String?
+
+      attr_accessor created_at: Integer?
+
+      attr_accessor first_name: String?
+
+      attr_accessor last_name: String?
+
+      attr_accessor verification_requested_at: Integer?
+
+      def initialize: (
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::Account::verification_status,
+        ?company: String?,
+        ?created_at: Integer?,
+        ?first_name: String?,
+        ?last_name: String?,
+        ?verification_requested_at: Integer?
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::Account::verification_status,
+        company: String?,
+        created_at: Integer?,
+        first_name: String?,
+        last_name: String?,
+        verification_requested_at: Integer?
+      }
+
+      type verification_status = :NOT_REQUESTED | :REQUESTED | :VERIFIED
+
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NOT_REQUESTED: :NOT_REQUESTED
+        REQUESTED: :REQUESTED
+        VERIFIED: :VERIFIED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::Account::verification_status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/account_create_params.rbs

@@ -0,0 +1,42 @@
+module GrowsurfRuby
+  module Models
+    type account_create_params =
+      { email: String, company: String, first_name: String, last_name: String }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class AccountCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_accessor email: String
+
+      attr_reader company: String?
+
+      def company=: (String) -> String
+
+      attr_reader first_name: String?
+
+      def first_name=: (String) -> String
+
+      attr_reader last_name: String?
+
+      def last_name=: (String) -> String
+
+      def initialize: (
+        email: String,
+        ?company: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        company: String,
+        first_name: String,
+        last_name: String,
+        request_options: GrowsurfRuby::RequestOptions
+      }
+    end
+  end
+end

data/sig/growsurf_ruby/models/account_create_response.rbs

@@ -0,0 +1,47 @@
+module GrowsurfRuby
+  module Models
+    type account_create_response =
+      {
+        api_key: String,
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::AccountCreateResponse::verification_status
+      }
+
+    class AccountCreateResponse < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor api_key: String
+
+      attr_accessor email: String
+
+      attr_accessor id: String
+
+      attr_accessor verification_status: GrowsurfRuby::Models::AccountCreateResponse::verification_status
+
+      def initialize: (
+        api_key: String,
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::AccountCreateResponse::verification_status
+      ) -> void
+
+      def to_hash: -> {
+        api_key: String,
+        email: String,
+        id: String,
+        verification_status: GrowsurfRuby::Models::AccountCreateResponse::verification_status
+      }
+
+      type verification_status = :NOT_REQUESTED | :REQUESTED | :VERIFIED
+
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NOT_REQUESTED: :NOT_REQUESTED
+        REQUESTED: :REQUESTED
+        VERIFIED: :VERIFIED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::AccountCreateResponse::verification_status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/account_resend_verification_email_response.rbs

@@ -0,0 +1,35 @@
+module GrowsurfRuby
+  module Models
+    type account_resend_verification_email_response =
+      {
+        status: GrowsurfRuby::Models::AccountResendVerificationEmailResponse::status,
+        success: bool
+      }
+
+    class AccountResendVerificationEmailResponse < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor status: GrowsurfRuby::Models::AccountResendVerificationEmailResponse::status
+
+      attr_accessor success: bool
+
+      def initialize: (
+        status: GrowsurfRuby::Models::AccountResendVerificationEmailResponse::status,
+        success: bool
+      ) -> void
+
+      def to_hash: -> {
+        status: GrowsurfRuby::Models::AccountResendVerificationEmailResponse::status,
+        success: bool
+      }
+
+      type status = :SENT
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        SENT: :SENT
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::AccountResendVerificationEmailResponse::status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/account_rotate_api_key_response.rbs

@@ -0,0 +1,13 @@
+module GrowsurfRuby
+  module Models
+    type account_rotate_api_key_response = { api_key: String }
+
+    class AccountRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor api_key: String
+
+      def initialize: (api_key: String) -> void
+
+      def to_hash: -> { api_key: String }
+    end
+  end
+end

data/sig/growsurf_ruby/models/account_update_params.rbs

@@ -0,0 +1,42 @@
+module GrowsurfRuby
+  module Models
+    type account_update_params =
+      {
+        company: String,
+        first_name: String,
+        last_name: String
+      }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class AccountUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_reader company: String?
+
+      def company=: (String) -> String
+
+      attr_reader first_name: String?
+
+      def first_name=: (String) -> String
+
+      attr_reader last_name: String?
+
+      def last_name=: (String) -> String
+
+      def initialize: (
+        ?company: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        company: String,
+        first_name: String,
+        last_name: String,
+        request_options: GrowsurfRuby::RequestOptions
+      }
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_activity_logs_response =
+        {
+          activity_logs: ::Array[GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog],
+          limit: Integer,
+          offset: Integer?
+        }
+
+      class ParticipantActivityLogsResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor activity_logs: ::Array[GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog]
+
+        attr_accessor limit: Integer
+
+        attr_accessor offset: Integer?
+
+        def initialize: (
+          activity_logs: ::Array[GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog],
+          limit: Integer,
+          ?offset: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          activity_logs: ::Array[GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse::ActivityLog],
+          limit: Integer,
+          offset: Integer?
+        }
+
+        type activity_log =
+          {
+            created_at: Integer,
+            text: String,
+            type: String
+          }
+
+        class ActivityLog < GrowsurfRuby::Internal::Type::BaseModel
+          attr_accessor created_at: Integer
+
+          attr_accessor text: String
+
+          attr_accessor type: String
+
+          def initialize: (
+            created_at: Integer,
+            text: String,
+            type: String
+          ) -> void
+
+          def to_hash: -> {
+            created_at: Integer,
+            text: String,
+            type: String
+          }
+        end
+      end
+    end
+  end
+end