growsurf-ruby 0.8.0 → 1.1.0

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -14,10 +14,30 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
       attr_reader :commission
 
-      # Program reward configuration operations.
+      # Campaign reward configuration operations.
       sig { returns(GrowsurfRuby::Resources::Campaign::Rewards) }
       attr_reader :rewards
 
+      # Program Editor "Design" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Design) }
+      attr_reader :design
+
+      # Program Editor "Emails" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Emails) }
+      attr_reader :emails
+
+      # Program Editor "Options" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Options) }
+      attr_reader :options
+
+      # Program Editor "Installation" tab configuration operations.
+      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(
@@ -42,15 +62,15 @@ module GrowsurfRuby
       end
 
       # Creates a program. Only `type` is required; everything else is server-defaulted.
+      # Editor-tab configuration (design, emails, options, installation) is not accepted
+      # here — configure it via the config sub-resources after the program is created.
       sig do
         params(
           type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
           company_logo_image_url: String,
           company_name: String,
           currency_iso: String,
-          goal: String,
           name: String,
-          options: T::Hash[Symbol, T.anything],
           rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(GrowsurfRuby::CampaignAPI)
@@ -60,34 +80,27 @@ module GrowsurfRuby
         type:,
         company_logo_image_url: nil,
         company_name: nil,
-        # ISO 4217 currency code. Defaults to USD.
+        # ISO 4217 currency code. Defaults to USD. Chosen when the program is created and
+        # immutable afterward — it cannot be changed on update.
         currency_iso: nil,
-        goal: nil,
         # The program name. Defaults to "Untitled Program".
         name: nil,
-        # A curated subset of program options to shallow-merge onto the defaults.
-        options: nil,
         # Optional inline rewards to create with the program.
         rewards: nil,
         request_options: {}
       )
       end
 
-      # Updates a program. Only the fields you send are changed. `type` and `urlId` are
-      # immutable.
+      # Updates a program's identity and lifecycle. Only the fields you send are changed.
+      # `type`, `urlId`, and `currencyISO` are immutable. Editor-tab configuration (design, emails,
+      # options, installation) is edited via the dedicated config sub-resources, not
+      # here.
       sig do
         params(
           id: String,
           company_logo_image_url: String,
           company_name: String,
-          currency_iso: String,
-          design: T::Hash[Symbol, T.anything],
-          emails: T::Hash[Symbol, T.anything],
-          goal: String,
-          installation: T::Hash[Symbol, T.anything],
           name: String,
-          notifications: T::Hash[Symbol, T.anything],
-          options: T::Hash[Symbol, T.anything],
           status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(GrowsurfRuby::CampaignAPI)
@@ -100,23 +113,9 @@ module GrowsurfRuby
         # Body param
         company_name: nil,
         # Body param
-        currency_iso: nil,
-        # Body param
-        design: nil,
-        # Body param
-        emails: nil,
-        # Body param
-        goal: nil,
-        # Body param
-        installation: nil,
-        # Body param
         name: nil,
-        # Body param
-        notifications: nil,
-        # Body param
-        options: 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: {}
       )
@@ -136,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
@@ -319,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)
@@ -331,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