growsurf-ruby 0.8.0 → 1.1.0

data/lib/growsurf_ruby/models/referral_flow_screenshots_response.rb

@@ -0,0 +1,72 @@
+# 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/lib/growsurf_ruby/models/reward_tax_valuation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute fair_market_value_usd
+      #   Manual fair-market value in USD (major units) used as the fallback when the
+      #   reward value cannot be resolved automatically. `null` = no manual value.
+      #
+      #   @return [Float, nil]
+      optional :fair_market_value_usd, Float, api_name: :fairMarketValueUSD, nil?: true
+
+      # @!attribute is_tax_reportable
+      #   Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+      #   the smart default for the reward's source.
+      #
+      #   @return [Boolean, nil]
+      optional :is_tax_reportable,
+               GrowsurfRuby::Internal::Type::Boolean,
+               api_name: :isTaxReportable,
+               nil?: true
+
+      # @!method initialize(fair_market_value_usd: nil, is_tax_reportable: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::RewardTaxValuation} for more details.
+      #
+      #   Tax valuation settings for a reward. Only relevant when the program collects
+      #   tax documentation.
+      #
+      #   @param fair_market_value_usd [Float, nil] Manual fair-market value in USD (major units) used as the fallback when the rewa
+      #
+      #   @param is_tax_reportable [Boolean, nil] Whether the reward's value counts toward 1099 thresholds/totals. `null` = use th
+    end
+  end
+end

data/lib/growsurf_ruby/models.rb

@@ -39,6 +39,12 @@ module GrowsurfRuby
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  Account = GrowsurfRuby::Models::Account
+
+  AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
+
+  AccountUpdateParams = GrowsurfRuby::Models::AccountUpdateParams
+
   Campaign = GrowsurfRuby::Models::Campaign
 
   CampaignAPI = GrowsurfRuby::Models::CampaignAPI
@@ -75,4 +81,8 @@ module GrowsurfRuby
   ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
 
   ReferralList = GrowsurfRuby::Models::ReferralList
+
+  ReferralFlowScreenshotsResponse = GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
+
+  RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/lib/growsurf_ruby/resources/account.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+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).
+      #
+      # @overload create(email:, company: nil, first_name: nil, last_name: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountCreateResponse]
+      #
+      # @see GrowsurfRuby::Models::AccountCreateParams
+      def create(params)
+        parsed, options = GrowsurfRuby::AccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "accounts",
+          body: parsed,
+          model: GrowsurfRuby::Models::AccountCreateResponse,
+          options: 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.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "account",
+          model: GrowsurfRuby::Account,
+          options: params[: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.
+      #
+      # @overload update(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}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      #
+      # @see GrowsurfRuby::Models::AccountUpdateParams
+      def update(params = {})
+        parsed, options = GrowsurfRuby::AccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: "account",
+          body: parsed,
+          model: GrowsurfRuby::Account,
+          options: 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.
+      #
+      # @overload rotate_api_key(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountRotateAPIKeyResponse]
+      def rotate_api_key(params = {})
+        @client.request(
+          method: :post,
+          path: "account/api-key",
+          model: GrowsurfRuby::Models::AccountRotateAPIKeyResponse,
+          options: params[: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`.
+      #
+      # @overload request_verification(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::Account]
+      def request_verification(params = {})
+        @client.request(
+          method: :post,
+          path: "account/verification-request",
+          model: GrowsurfRuby::Account,
+          options: params[: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.
+      #
+      # @overload resend_verification_email(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::AccountResendVerificationEmailResponse]
+      def resend_verification_email(params = {})
+        @client.request(
+          method: :post,
+          path: "account/verification-email",
+          model: GrowsurfRuby::Models::AccountResendVerificationEmailResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [GrowsurfRuby::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+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 (window layout, header, share channels, signup
+        # form, portal/landing pages, theme styling, and summary/status sections).
+        #
+        # 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.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/design", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[: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). Unknown fields, fields not available for the program type, and
+        # invalid values return a `400`.
+        #
+        # The request body is a partial {CampaignDesign} 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.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/design", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+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 (per-email templates plus sender, contact, and
+        # design settings).
+        #
+        # 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.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/emails", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's email configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. Unknown fields and invalid values return a
+        # `400`.
+        #
+        # The request body is a partial {CampaignEmails} 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.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial email configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/emails", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+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 (signup and mobile SDK
+        # installation settings).
+        #
+        # 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.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/installation", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's installation configuration. Only the fields you send are
+        # changed; anything you leave out is untouched. Unknown fields, fields not
+        # available for the program type, and invalid values return a `400`.
+        #
+        # The request body is a partial {CampaignInstallation} 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.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial installation configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/installation", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+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 (fraud/reCAPTCHA, tax documentation,
+        # notification emails, and other program settings).
+        #
+        # 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.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/options", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's options configuration. Only the fields you send are changed;
+        # anything you leave out is untouched. Unknown fields and invalid values return a
+        # `400`.
+        #
+        # The request body is a partial {CampaignOptions} 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.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial options configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/options", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end