growsurf-ruby 0.8.0 → 1.1.0

data/rbi/growsurf_ruby/models/campaign_update_params.rbi

@@ -29,54 +29,12 @@ module GrowsurfRuby
       sig { params(company_name: String).void }
       attr_writer :company_name
 
-      sig { returns(T.nilable(String)) }
-      attr_reader :currency_iso
-
-      sig { params(currency_iso: String).void }
-      attr_writer :currency_iso
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :design
-
-      sig { params(design: T::Hash[Symbol, T.anything]).void }
-      attr_writer :design
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :emails
-
-      sig { params(emails: T::Hash[Symbol, T.anything]).void }
-      attr_writer :emails
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :goal
-
-      sig { params(goal: String).void }
-      attr_writer :goal
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :installation
-
-      sig { params(installation: T::Hash[Symbol, T.anything]).void }
-      attr_writer :installation
-
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
       sig { params(name: String).void }
       attr_writer :name
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :notifications
-
-      sig { params(notifications: T::Hash[Symbol, T.anything]).void }
-      attr_writer :notifications
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :options
-
-      sig { params(options: T::Hash[Symbol, T.anything]).void }
-      attr_writer :options
-
       sig do
         returns(T.nilable(GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol))
       end
@@ -94,14 +52,7 @@ module GrowsurfRuby
           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(T.attached_class)
@@ -110,14 +61,7 @@ module GrowsurfRuby
         id:,
         company_logo_image_url: nil,
         company_name: nil,
-        currency_iso: nil,
-        design: nil,
-        emails: nil,
-        goal: nil,
-        installation: nil,
         name: nil,
-        notifications: nil,
-        options: nil,
         status: nil,
         request_options: {}
       )
@@ -129,14 +73,7 @@ module GrowsurfRuby
             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
           }
@@ -154,16 +91,6 @@ module GrowsurfRuby
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        DRAFT =
-          T.let(
-            :DRAFT,
-            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
-          )
-        PENDING =
-          T.let(
-            :PENDING,
-            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
-          )
         IN_PROGRESS =
           T.let(
             :IN_PROGRESS,
@@ -174,11 +101,6 @@ module GrowsurfRuby
             :COMPLETE,
             GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
           )
-        CANCELLED =
-          T.let(
-            :CANCELLED,
-            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
-          )
 
         sig do
           override.returns(

data/rbi/growsurf_ruby/models/commission_structure.rbi

@@ -14,6 +14,9 @@ module GrowsurfRuby
       sig { returns(T.nilable(Integer)) }
       attr_accessor :amount
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount_iso
+
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :approval_required
 
@@ -75,6 +78,7 @@ module GrowsurfRuby
       sig do
         params(
           amount: T.nilable(Integer),
+          amount_iso: T.nilable(String),
           approval_required: T.nilable(T::Boolean),
           duration: T.nilable(String),
           duration_in_months: T.nilable(Integer),
@@ -97,6 +101,7 @@ module GrowsurfRuby
       end
       def self.new(
         amount: nil,
+        amount_iso: nil,
         approval_required: nil,
         duration: nil,
         duration_in_months: nil,
@@ -122,6 +127,7 @@ module GrowsurfRuby
         override.returns(
           {
             amount: T.nilable(Integer),
+            amount_iso: T.nilable(String),
             approval_required: T.nilable(T::Boolean),
             duration: T.nilable(String),
             duration_in_months: T.nilable(Integer),
@@ -158,8 +164,8 @@ module GrowsurfRuby
 
         PERCENT =
           T.let(:PERCENT, GrowsurfRuby::CommissionStructure::Type::TaggedSymbol)
-        AMOUNT =
-          T.let(:AMOUNT, GrowsurfRuby::CommissionStructure::Type::TaggedSymbol)
+        FIXED =
+          T.let(:FIXED, GrowsurfRuby::CommissionStructure::Type::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/growsurf_ruby/models/referral_flow_screenshots_response.rbi

@@ -0,0 +1,94 @@
+# 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/rbi/growsurf_ruby/models/reward_tax_valuation.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    # Tax valuation settings for a reward. Only relevant when the program collects
+    # tax documentation.
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::RewardTaxValuation,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # Manual fair-market value in USD (major units) used as the fallback when the
+      # reward value cannot be resolved automatically. `null` = no manual value.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fair_market_value_usd
+
+      # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+      # the smart default for the reward's source.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_tax_reportable
+
+      # Tax valuation settings for a reward. Only relevant when the program collects
+      # tax documentation.
+      sig do
+        params(
+          fair_market_value_usd: T.nilable(Float),
+          is_tax_reportable: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Manual fair-market value in USD (major units) used as the fallback when the
+        # reward value cannot be resolved automatically. `null` = no manual value.
+        fair_market_value_usd: nil,
+        # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+        # the smart default for the reward's source.
+        is_tax_reportable: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            fair_market_value_usd: T.nilable(Float),
+            is_tax_reportable: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -1,6 +1,12 @@
 # typed: strong
 
 module GrowsurfRuby
+  Account = GrowsurfRuby::Models::Account
+
+  AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
+
+  AccountUpdateParams = GrowsurfRuby::Models::AccountUpdateParams
+
   Campaign = GrowsurfRuby::Models::Campaign
 
   CampaignAPI = GrowsurfRuby::Models::CampaignAPI
@@ -42,4 +48,9 @@ module GrowsurfRuby
   ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
 
   ReferralList = GrowsurfRuby::Models::ReferralList
+
+  ReferralFlowScreenshotsResponse =
+    GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
+
+  RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/rbi/growsurf_ruby/resources/account.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+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
+      # `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
+      # access. Accounts whose email is never verified are deleted automatically after
+      # 7 days. For security, the API key is rotated the first time the account owner
+      # signs in to the GrowSurf dashboard. Some actions (such as emailing
+      # participants) additionally require the GrowSurf team to verify the account
+      # first. By creating an account you agree, on behalf of the account holder, to
+      # GrowSurf's [Terms of Service](https://growsurf.com/terms) and
+      # [Privacy Policy](https://growsurf.com/privacy).
+      sig do
+        params(
+          email: String,
+          company: String,
+          first_name: String,
+          last_name: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::Models::AccountCreateResponse)
+      end
+      def create(
+        # The email address for the new account. Personal emails and disposable email addresses are not accepted.
+        email:,
+        company: nil,
+        first_name: nil,
+        last_name: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the account that owns the API key: profile and GrowSurf-team
+      # verification state.
+      # `verificationStatus` is `VERIFIED` once the GrowSurf team has verified the account
+      # — this is required before you can send participant emails from a program.
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          GrowsurfRuby::Account
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # Updates your own account profile (`firstName`, `lastName`, `company`). Any other
+      # property is rejected with a `400` — in particular, the account `email` cannot be
+      # changed via the API, and billing/subscription is not editable here.
+      sig do
+        params(
+          company: String,
+          first_name: String,
+          last_name: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::Account)
+      end
+      def update(
+        company: nil,
+        first_name: nil,
+        last_name: nil,
+        request_options: {}
+      )
+      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.
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          GrowsurfRuby::Models::AccountRotateAPIKeyResponse
+        )
+      end
+      def rotate_api_key(request_options: {})
+      end
+
+      # Requests GrowSurf-team verification of your account (required before a program can
+      # email its participants). Idempotent — calling it again while a request is pending
+      # does not create a duplicate. Returns the account with its updated
+      # `verificationStatus`.
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          GrowsurfRuby::Account
+        )
+      end
+      def request_verification(request_options: {})
+      end
+
+      # Resends the email-verification email to the account's email address. A `200`
+      # with `status: SENT` is only returned when an email was actually dispatched.
+      # Returns a `400` if the email is already verified, or a `429` if a verification
+      # email was sent too recently — wait a moment, then retry.
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          GrowsurfRuby::Models::AccountResendVerificationEmailResponse
+        )
+      end
+      def resend_verification_email(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/design.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Design
+        # Retrieves a program's design configuration — the same surface as the dashboard
+        # Program Editor's **Design** tab. This is a large, deeply nested object whose
+        # available fields depend on the program type; the response includes every field
+        # and its current value, which is the same shape you send back on update.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's design configuration. Only the fields you send are changed;
+        # anything you leave out is untouched (arrays such as `signup.fields` replace
+        # wholesale). The request body is a partial design object. To see the full object
+        # with every field and its current value, `GET` this resource, then `PATCH` back
+        # only the fields you want to change.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial design configuration to merge.
+          body,
+          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/emails.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Emails
+        # Retrieves a program's email configuration — the same surface as the dashboard
+        # Program Editor's **Emails** tab. To see the full object with every field and its
+        # current value, `GET` this resource, then `PATCH` back only the fields you want to
+        # change.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's email configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. The request body is a partial email
+        # configuration object. To see the full object with every field and its current
+        # value, `GET` this resource, then `PATCH` back only the fields you want to change.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial email configuration to merge.
+          body,
+          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/installation.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Installation
+        # Retrieves a program's installation configuration — the same surface as the
+        # dashboard Program Editor's **Installation** tab. This is a nested object whose
+        # available fields depend on the program type. To see the full object with every
+        # field and its current value, `GET` this resource, then `PATCH` back only the
+        # fields you want to change.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's installation configuration. Only the fields you send are
+        # changed; anything you leave out is untouched. The request body is a partial
+        # installation configuration object. To see the full object with every field and
+        # its current value, `GET` this resource, then `PATCH` back only the fields you
+        # want to change.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial installation configuration to merge.
+          body,
+          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/options.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Options
+        # Retrieves a program's options configuration — the same surface as the dashboard
+        # Program Editor's **Options** tab. To see the full object with every field and its
+        # current value, `GET` this resource, then `PATCH` back only the fields you want to
+        # change.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's options configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. The request body is a partial options
+        # configuration object. To see the full object with every field and its current
+        # value, `GET` this resource, then `PATCH` back only the fields you want to change.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial options configuration to merge.
+          body,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end