growsurf-ruby 1.0.0 → 1.1.0

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

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Webhooks
+        # Lists a program's webhooks (secrets are never returned).
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookListResponse]
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/webhooks", id],
+            model: GrowsurfRuby::Models::Campaign::WebhookListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Adds a webhook to the program.
+        #
+        # @overload create(id, payload_url:, events: nil, is_enabled: nil, secret: nil, request_options: {})
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param payload_url [String] Body param: The URL that receives webhook deliveries.
+        #
+        # @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>] Body param: The events this webhook is subscribed to. When omitted, it is subscri
+        #
+        # @param is_enabled [Boolean] Body param
+        #
+        # @param secret [String] Body param: Write-only. Used to sign deliveries (the `GrowSurf-Signature` HMAC hea
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Webhook]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookCreateParams
+        def create(id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/webhooks", id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Webhook,
+            options: options
+          )
+        end
+
+        # Updates a webhook by id.
+        #
+        # @overload update(webhook_id, id:, events: nil, is_enabled: nil, payload_url: nil, secret: nil, request_options: {})
+        #
+        # @param webhook_id [String] Path param: The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param events [Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>] Body param
+        #
+        # @param is_enabled [Boolean] Body param
+        #
+        # @param payload_url [String] Body param
+        #
+        # @param secret [String] Body param: Write-only.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Webhook]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookUpdateParams
+        def update(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/webhooks/%2$s", id, webhook_id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Webhook,
+            options: options
+          )
+        end
+
+        # Removes a webhook by id.
+        #
+        # @overload delete(webhook_id, id:, request_options: {})
+        #
+        # @param webhook_id [String] The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookDeleteResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookDeleteParams
+        def delete(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["campaign/%1$s/webhooks/%2$s", id, webhook_id],
+            model: GrowsurfRuby::Models::Campaign::WebhookDeleteResponse,
+            options: options
+          )
+        end
+
+        # Sends a live test event to a webhook using its stored URL and secret.
+        #
+        # @overload test(webhook_id, id:, event: nil, request_options: {})
+        #
+        # @param webhook_id [String] Path param: The webhook id (`primary` for the program's primary webhook).
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent] Body param: The event to simulate. When omitted, the webhook's first enabled even
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::WebhookTestResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::WebhookTestParams
+        def test(webhook_id, params)
+          parsed, options = GrowsurfRuby::Campaign::WebhookTestParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/webhooks/%2$s/test", id, webhook_id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::WebhookTestResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign.rb

@@ -34,6 +34,10 @@ module GrowsurfRuby
       # @return [GrowsurfRuby::Resources::Campaign::Installation]
       attr_reader :installation
 
+      # Program webhook configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Webhooks]
+      attr_reader :webhooks
+
       # Retrieves a program for the given program ID.
       #
       # @overload retrieve(id, request_options: {})
@@ -123,7 +127,7 @@ module GrowsurfRuby
       #
       # @param name [String] Body param
       #
-      # @param status [Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status] Body param: The program status. Transitions are validated; DELETED is not allowe
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status] Body param: The requested program status. `IN_PROGRESS` publishes or resumes the
       #
       # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -159,6 +163,25 @@ module GrowsurfRuby
         )
       end
 
+      # Captures two preview screenshots for the program: the authenticated referrer
+      # view and the referred-friend view.
+      #
+      # @overload get_referral_flow_screenshots(id, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ReferralFlowScreenshotsResponse]
+      def get_referral_flow_screenshots(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/referral-flow-screenshots", id],
+          model: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams} for more
       # details.
@@ -379,7 +402,7 @@ module GrowsurfRuby
       #
       # Retrieves analytics for a program.
       #
-      # @overload retrieve_analytics(id, days: nil, end_date: nil, start_date: nil, request_options: {})
+      # @overload retrieve_analytics(id, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
       #
       # @param id [String] GrowSurf program ID.
       #
@@ -387,6 +410,10 @@ module GrowsurfRuby
       #
       # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
       #
+      # @param include [String] Comma-separated list of optional enrichments (opt-in to keep the default response
+      #
+      # @param interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
+      #
       # @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
       #
       # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -419,6 +446,7 @@ module GrowsurfRuby
         @emails = GrowsurfRuby::Resources::Campaign::Emails.new(client: client)
         @options = GrowsurfRuby::Resources::Campaign::Options.new(client: client)
         @installation = GrowsurfRuby::Resources::Campaign::Installation.new(client: client)
+        @webhooks = GrowsurfRuby::Resources::Campaign::Webhooks.new(client: client)
       end
     end
   end

data/lib/growsurf_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrowsurfRuby
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/growsurf_ruby.rb

@@ -61,11 +61,18 @@ require_relative "growsurf_ruby/models/campaign/commission_delete_params"
 require_relative "growsurf_ruby/models/campaign/commission_delete_response"
 require_relative "growsurf_ruby/models/campaign/delete_reward_response"
 require_relative "growsurf_ruby/models/campaign/fraud_risk_level"
+require_relative "growsurf_ruby/models/campaign/participant_activity_logs_response"
 require_relative "growsurf_ruby/models/campaign/participant_add_params"
+require_relative "growsurf_ruby/models/campaign/participant_analytics_response"
+require_relative "growsurf_ruby/models/campaign/participant_bulk_delete_params"
+require_relative "growsurf_ruby/models/campaign/participant_bulk_delete_response"
 require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params"
 require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response"
 require_relative "growsurf_ruby/models/campaign/participant_delete_params"
 require_relative "growsurf_ruby/models/campaign/participant_delete_response"
+require_relative "growsurf_ruby/models/campaign/participant_email_params"
+require_relative "growsurf_ruby/models/campaign/participant_email_response"
+require_relative "growsurf_ruby/models/campaign/participant_list_activity_logs_params"
 require_relative "growsurf_ruby/models/campaign/participant_list_commissions_params"
 require_relative "growsurf_ruby/models/campaign/participant_list_payouts_params"
 require_relative "growsurf_ruby/models/campaign/participant_list_referrals_params"
@@ -75,6 +82,7 @@ require_relative "growsurf_ruby/models/campaign/participant_record_transaction_p
 require_relative "growsurf_ruby/models/campaign/participant_record_transaction_response"
 require_relative "growsurf_ruby/models/campaign/participant_refund_transaction_params"
 require_relative "growsurf_ruby/models/campaign/participant_refund_transaction_response"
+require_relative "growsurf_ruby/models/campaign/participant_retrieve_analytics_params"
 require_relative "growsurf_ruby/models/campaign/participant_retrieve_params"
 require_relative "growsurf_ruby/models/campaign/participant_reward"
 require_relative "growsurf_ruby/models/campaign/participant_send_invites_params"
@@ -93,6 +101,21 @@ require_relative "growsurf_ruby/models/campaign/reward_delete_response"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_params"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_response"
 require_relative "growsurf_ruby/models/campaign/reward_update_params"
+require_relative "growsurf_ruby/models/campaign/webhook"
+require_relative "growsurf_ruby/models/campaign/webhook_create_params"
+require_relative "growsurf_ruby/models/campaign/webhook_delete_params"
+require_relative "growsurf_ruby/models/campaign/webhook_delete_response"
+require_relative "growsurf_ruby/models/campaign/webhook_event"
+require_relative "growsurf_ruby/models/campaign/webhook_list_response"
+require_relative "growsurf_ruby/models/campaign/webhook_test_params"
+require_relative "growsurf_ruby/models/campaign/webhook_test_response"
+require_relative "growsurf_ruby/models/campaign/webhook_update_params"
+require_relative "growsurf_ruby/models/account"
+require_relative "growsurf_ruby/models/account_create_params"
+require_relative "growsurf_ruby/models/account_create_response"
+require_relative "growsurf_ruby/models/account_resend_verification_email_response"
+require_relative "growsurf_ruby/models/account_rotate_api_key_response"
+require_relative "growsurf_ruby/models/account_update_params"
 require_relative "growsurf_ruby/models/campaign"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_params"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_response"
@@ -113,8 +136,10 @@ require_relative "growsurf_ruby/models/participant_commission_list"
 require_relative "growsurf_ruby/models/participant_list"
 require_relative "growsurf_ruby/models/participant_payout_list"
 require_relative "growsurf_ruby/models/referral_list"
+require_relative "growsurf_ruby/models/referral_flow_screenshots_response"
 require_relative "growsurf_ruby/models/reward_tax_valuation"
 require_relative "growsurf_ruby/models"
+require_relative "growsurf_ruby/resources/account"
 require_relative "growsurf_ruby/resources/campaign"
 require_relative "growsurf_ruby/resources/campaign/commission"
 require_relative "growsurf_ruby/resources/campaign/design"
@@ -124,3 +149,4 @@ require_relative "growsurf_ruby/resources/campaign/options"
 require_relative "growsurf_ruby/resources/campaign/participant"
 require_relative "growsurf_ruby/resources/campaign/reward"
 require_relative "growsurf_ruby/resources/campaign/rewards"
+require_relative "growsurf_ruby/resources/campaign/webhooks"

data/rbi/growsurf_ruby/client.rbi

@@ -14,6 +14,9 @@ module GrowsurfRuby
     sig { returns(String) }
     attr_reader :api_key
 
+    sig { returns(GrowsurfRuby::Resources::Account) }
+    attr_reader :account
+
     sig { returns(GrowsurfRuby::Resources::Campaign) }
     attr_reader :campaign
 

data/rbi/growsurf_ruby/models/account.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class Account < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(GrowsurfRuby::Account, GrowsurfRuby::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :email
+
+      # The account's unique identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # GrowSurf-team verification state. `VERIFIED` is required before a program can
+      # send participant emails.
+      sig { returns(GrowsurfRuby::Account::VerificationStatus::OrSymbol) }
+      attr_accessor :verification_status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company
+
+      # When the account was created, as a Unix timestamp in milliseconds.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :first_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :last_name
+
+      # When team verification was last requested, as a Unix timestamp in milliseconds.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :verification_requested_at
+
+      sig do
+        params(
+          email: String,
+          id: String,
+          verification_status:
+            GrowsurfRuby::Account::VerificationStatus::OrSymbol,
+          company: T.nilable(String),
+          created_at: T.nilable(Integer),
+          first_name: T.nilable(String),
+          last_name: T.nilable(String),
+          verification_requested_at: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        email:,
+        # The account's unique identifier.
+        id:,
+        # GrowSurf-team verification state. `VERIFIED` is required before a program can
+        # send participant emails.
+        verification_status:,
+        company: nil,
+        # When the account was created, as a Unix timestamp in milliseconds.
+        created_at: nil,
+        first_name: nil,
+        last_name: nil,
+        # When team verification was last requested, as a Unix timestamp in milliseconds.
+        verification_requested_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            id: String,
+            verification_status:
+              GrowsurfRuby::Account::VerificationStatus::TaggedSymbol,
+            company: T.nilable(String),
+            created_at: T.nilable(Integer),
+            first_name: T.nilable(String),
+            last_name: T.nilable(String),
+            verification_requested_at: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # GrowSurf-team verification state. `VERIFIED` is required before a program can
+      # send participant emails.
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::Account::VerificationStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NOT_REQUESTED =
+          T.let(
+            :NOT_REQUESTED,
+            GrowsurfRuby::Account::VerificationStatus::TaggedSymbol
+          )
+        REQUESTED =
+          T.let(
+            :REQUESTED,
+            GrowsurfRuby::Account::VerificationStatus::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(
+            :VERIFIED,
+            GrowsurfRuby::Account::VerificationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::Account::VerificationStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/account_create_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class AccountCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::AccountCreateParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # The email address for the new account. Personal emails and disposable email addresses are not accepted.
+      sig { returns(String) }
+      attr_accessor :email
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company
+
+      sig { params(company: String).void }
+      attr_writer :company
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :first_name
+
+      sig { params(first_name: String).void }
+      attr_writer :first_name
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      sig do
+        params(
+          email: String,
+          company: String,
+          first_name: String,
+          last_name: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            company: String,
+            first_name: String,
+            last_name: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/account_create_response.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class AccountCreateResponse < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::AccountCreateResponse,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :api_key
+
+      sig { returns(String) }
+      attr_accessor :email
+
+      # The new account's unique identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # GrowSurf account verification state. `VERIFIED` is required before a program
+      # can send participant emails.
+      sig do
+        returns(
+          GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+        )
+      end
+      attr_accessor :verification_status
+
+      sig do
+        params(
+          api_key: String,
+          email: String,
+          id: String,
+          verification_status:
+            GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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.
+        api_key:,
+        email:,
+        # The new account's unique identifier.
+        id:,
+        # GrowSurf account verification state. `VERIFIED` is required before a program
+        # can send participant emails.
+        verification_status:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            api_key: String,
+            email: String,
+            id: String,
+            verification_status:
+              GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NOT_REQUESTED =
+          T.let(
+            :NOT_REQUESTED,
+            GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+          )
+        REQUESTED =
+          T.let(
+            :REQUESTED,
+            GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(
+            :VERIFIED,
+            GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end