growsurf-ruby 0.6.1 → 0.8.0

data/rbi/growsurf_ruby/models/campaign_create_params.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignCreateParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(GrowsurfRuby::CampaignCreateParams::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_logo_image_url
+
+      sig { params(company_logo_image_url: String).void }
+      attr_writer :company_logo_image_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_name
+
+      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(String)) }
+      attr_reader :goal
+
+      sig { params(goal: String).void }
+      attr_writer :goal
+
+      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 :options
+
+      sig { params(options: T::Hash[Symbol, T.anything]).void }
+      attr_writer :options
+
+      sig do
+        returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardCreateParams]))
+      end
+      attr_reader :rewards
+
+      sig do
+        params(
+          rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash]
+        ).void
+      end
+      attr_writer :rewards
+
+      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(T.attached_class)
+      end
+      def self.new(
+        type:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        currency_iso: nil,
+        goal: nil,
+        name: nil,
+        options: nil,
+        rewards: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignCreateParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REFERRAL =
+          T.let(
+            :REFERRAL,
+            GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol
+          )
+        AFFILIATE =
+          T.let(
+            :AFFILIATE,
+            GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_update_params.rbi

@@ -0,0 +1,193 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignUpdateParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_logo_image_url
+
+      sig { params(company_logo_image_url: String).void }
+      attr_writer :company_logo_image_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_name
+
+      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
+      attr_reader :status
+
+      sig do
+        params(
+          status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      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(T.attached_class)
+      end
+      def self.new(
+        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: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignUpdateParams::Status)
+          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,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        COMPLETE =
+          T.let(
+            :COMPLETE,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        CANCELLED =
+          T.let(
+            :CANCELLED,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -8,6 +8,8 @@ module GrowsurfRuby
   CampaignCreateMobileParticipantTokenParams =
     GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
+  CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
+
   CampaignListCommissionsParams =
     GrowsurfRuby::Models::CampaignListCommissionsParams
 
@@ -29,6 +31,8 @@ module GrowsurfRuby
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
+
   CommissionStructure = GrowsurfRuby::Models::CommissionStructure
 
   ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -332,6 +332,73 @@ module GrowsurfRuby
         )
         end
 
+        # Records an amendment (refund, partial refund, refund cancellation, or
+        # chargeback) against a previously recorded transaction and reverses or adjusts
+        # the referrer's commission.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            amendment_type:
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol,
+            amount: Integer,
+            amount_refunded: Integer,
+            charge_id: String,
+            currency: String,
+            description: String,
+            external_id: String,
+            invoice_id: String,
+            order_id: String,
+            payment_id: String,
+            payment_intent_id: String,
+            refund_amount: Integer,
+            refund_id: String,
+            refund_status: String,
+            transaction_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
+          )
+        end
+        def refund_transaction(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          amendment_type: nil,
+          # Body param
+          amount: nil,
+          # Body param
+          amount_refunded: nil,
+          # Body param
+          charge_id: nil,
+          # Body param
+          currency: nil,
+          # Body param
+          description: nil,
+          # Body param
+          external_id: nil,
+          # Body param
+          invoice_id: nil,
+          # Body param
+          order_id: nil,
+          # Body param
+          payment_id: nil,
+          # Body param
+          payment_intent_id: nil,
+          # Body param
+          refund_amount: nil,
+          # Body param
+          refund_id: nil,
+          # Body param
+          refund_status: nil,
+          # Body param
+          transaction_id: nil,
+          request_options: {}
+        )
+        end
+
         # Sends email invites on behalf of a participant to a list of email addresses.
         sig do
           params(
@@ -366,12 +433,39 @@ module GrowsurfRuby
           params(
             participant_id_or_email: String,
             id: String,
+            delay_in_days: Integer,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(
             GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse
           )
         end
         def trigger_referral(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param: Number of whole days to hold referral credit before it is awarded.
+          # Useful for honoring a refund window before crediting a referrer. Omit this field
+          # to award credit immediately. The credit is awarded automatically once the delay
+          # elapses, and can be cancelled before then with the Cancel delayed referral
+          # trigger request.
+          delay_in_days: nil,
+          request_options: {}
+        )
+        end
+
+        # Cancels a pending delayed referral trigger for an existing referred participant
+        # by GrowSurf participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse
+          )
+        end
+        def cancel_delayed_referral(
           # GrowSurf participant ID or URL-encoded participant email address.
           participant_id_or_email,
           # GrowSurf program ID.

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

@@ -0,0 +1,200 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Rewards
+        # Retrieves the active, visible, and enabled rewards configured for a program.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::CampaignRewardListResponse)
+        end
+        def list(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Creates a reward for a program. The reward `type` must be compatible with the
+        # program type.
+        sig do
+          params(
+            id: String,
+            type:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::OrSymbol,
+            commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
+            conversions_required: Integer,
+            coupon_code: String,
+            description: String,
+            image_url: String,
+            is_active: T::Boolean,
+            is_unlimited: T::Boolean,
+            is_visible: T::Boolean,
+            limit: Integer,
+            limit_duration:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::OrSymbol,
+            metadata: T::Hash[Symbol, T.anything],
+            next_milestone_prefix: String,
+            next_milestone_suffix: String,
+            number_of_winners: Integer,
+            order: Integer,
+            referral_coupon_code: String,
+            referral_description: String,
+            referred_reward_upfront: T::Boolean,
+            title: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Reward)
+        end
+        def create(
+          # Path param: GrowSurf program ID.
+          id,
+          # Body param: The reward type. Immutable after creation.
+          type:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          referral_description: nil,
+          # Body param
+          referred_reward_upfront: nil,
+          # Body param
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates an existing program reward. Only the fields you send are changed; `type`
+        # is immutable and must not be supplied.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
+            conversions_required: Integer,
+            coupon_code: String,
+            description: String,
+            image_url: String,
+            is_active: T::Boolean,
+            is_unlimited: T::Boolean,
+            is_visible: T::Boolean,
+            limit: Integer,
+            limit_duration:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::OrSymbol,
+            metadata: T::Hash[Symbol, T.anything],
+            next_milestone_prefix: String,
+            next_milestone_suffix: String,
+            number_of_winners: Integer,
+            order: Integer,
+            referral_coupon_code: String,
+            referral_description: String,
+            referred_reward_upfront: T::Boolean,
+            title: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Reward)
+        end
+        def update(
+          # Path param: Program reward ID.
+          reward_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          referral_description: nil,
+          # Body param
+          referred_reward_upfront: nil,
+          # Body param
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a program reward.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::DeleteRewardResponse)
+        end
+        def delete(
+          # Program reward ID.
+          reward_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end