growsurf-ruby 0.6.1 → 0.8.0

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -14,6 +14,10 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
       attr_reader :commission
 
+      # Program reward configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Rewards) }
+      attr_reader :rewards
+
       # Retrieves a program for the given program ID.
       sig do
         params(
@@ -37,6 +41,101 @@ module GrowsurfRuby
       def list(request_options: {})
       end
 
+      # Creates a program. Only `type` is required; everything else is server-defaulted.
+      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)
+      end
+      def create(
+        # The program type. Immutable after creation.
+        type:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        # ISO 4217 currency code. Defaults to USD.
+        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.
+      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)
+      end
+      def update(
+        # Path param: GrowSurf program ID.
+        id,
+        # Body param
+        company_logo_image_url: nil,
+        # 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.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Clones an existing program, returning the newly created program.
+      sig do
+        params(
+          id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def clone(
+        # 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

data/sig/growsurf_ruby/models/campaign/campaign_reward_list_response.rbs

@@ -0,0 +1,18 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type campaign_reward_list_response =
+        { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+
+      class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+
+        def initialize: (
+          rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+        ) -> void
+
+        def to_hash: -> { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/delete_reward_response.rbs

@@ -0,0 +1,17 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type delete_reward_response = { id: String, success: bool }
+
+      class DeleteRewardResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor success: bool
+
+        def initialize: (id: String, success: bool) -> void
+
+        def to_hash: -> { id: String, success: bool }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_cancel_delayed_referral_params =
+        { id: String, participant_id_or_email: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantCancelDelayedReferralParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbs

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_cancel_delayed_referral_response =
+        { success: bool, message: String }
+
+      class ParticipantCancelDelayedReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        attr_reader message: String?
+
+        def message=: (String) -> String
+
+        def initialize: (success: bool, ?message: String) -> void
+
+        def to_hash: -> { success: bool, message: String }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbs

@@ -0,0 +1,151 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_refund_transaction_params =
+        {
+          id: String,
+          participant_id_or_email: String,
+          amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
+          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
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantRefundTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        attr_reader amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type?
+
+        def amendment_type=: (
+          GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type
+
+        attr_reader amount: Integer?
+
+        def amount=: (Integer) -> Integer
+
+        attr_reader amount_refunded: Integer?
+
+        def amount_refunded=: (Integer) -> Integer
+
+        attr_reader charge_id: String?
+
+        def charge_id=: (String) -> String
+
+        attr_reader currency: String?
+
+        def currency=: (String) -> String
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_reader external_id: String?
+
+        def external_id=: (String) -> String
+
+        attr_reader invoice_id: String?
+
+        def invoice_id=: (String) -> String
+
+        attr_reader order_id: String?
+
+        def order_id=: (String) -> String
+
+        attr_reader payment_id: String?
+
+        def payment_id=: (String) -> String
+
+        attr_reader payment_intent_id: String?
+
+        def payment_intent_id=: (String) -> String
+
+        attr_reader refund_amount: Integer?
+
+        def refund_amount=: (Integer) -> Integer
+
+        attr_reader refund_id: String?
+
+        def refund_id=: (String) -> String
+
+        attr_reader refund_status: String?
+
+        def refund_status=: (String) -> String
+
+        attr_reader transaction_id: String?
+
+        def transaction_id=: (String) -> String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
+          ?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::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
+          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
+        }
+
+        type amendment_type = :REFUND | :CHARGEBACK
+
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFUND: :REFUND
+          CHARGEBACK: :CHARGEBACK
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbs

@@ -0,0 +1,75 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_refund_transaction_response =
+        {
+          adjusted: Integer,
+          amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
+          deleted: Integer,
+          matched: Integer,
+          matching_commission_ids: ::Array[String],
+          message: String,
+          reversed: Integer,
+          success: bool,
+          not_found: bool
+        }
+
+      class ParticipantRefundTransactionResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor adjusted: Integer
+
+        attr_accessor amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type
+
+        attr_accessor deleted: Integer
+
+        attr_accessor matched: Integer
+
+        attr_accessor matching_commission_ids: ::Array[String]
+
+        attr_accessor message: String
+
+        attr_accessor reversed: Integer
+
+        attr_accessor success: bool
+
+        attr_reader not_found: bool?
+
+        def not_found=: (bool) -> bool
+
+        def initialize: (
+          adjusted: Integer,
+          amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
+          deleted: Integer,
+          matched: Integer,
+          matching_commission_ids: ::Array[String],
+          message: String,
+          reversed: Integer,
+          success: bool,
+          ?not_found: bool
+        ) -> void
+
+        def to_hash: -> {
+          adjusted: Integer,
+          amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
+          deleted: Integer,
+          matched: Integer,
+          matching_commission_ids: ::Array[String],
+          message: String,
+          reversed: Integer,
+          success: bool,
+          not_found: bool
+        }
+
+        type amendment_type = :REFUND | :CHARGEBACK
+
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFUND: :REFUND
+          CHARGEBACK: :CHARGEBACK
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs

@@ -2,7 +2,7 @@ module GrowsurfRuby
   module Models
     module Campaign
       type participant_trigger_referral_params =
-        { id: String, participant_id_or_email: String }
+        { id: String, participant_id_or_email: String, delay_in_days: Integer }
         & GrowsurfRuby::Internal::Type::request_parameters
 
       class ParticipantTriggerReferralParams < GrowsurfRuby::Internal::Type::BaseModel
@@ -13,15 +13,21 @@ module GrowsurfRuby
 
         attr_accessor participant_id_or_email: String
 
+        attr_reader delay_in_days: Integer?
+
+        def delay_in_days=: (Integer) -> Integer
+
         def initialize: (
           id: String,
           participant_id_or_email: String,
+          ?delay_in_days: Integer,
           ?request_options: GrowsurfRuby::request_opts
         ) -> void
 
         def to_hash: -> {
           id: String,
           participant_id_or_email: String,
+          delay_in_days: Integer,
           request_options: GrowsurfRuby::RequestOptions
         }
       end

data/sig/growsurf_ruby/models/campaign/reward.rbs

@@ -0,0 +1,131 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward =
+        {
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::Campaign::Reward::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure?,
+          conversions_required: Integer?,
+          coupon_code: String?,
+          description: String?,
+          image_url: String?,
+          limit: Integer?,
+          limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
+          next_milestone_prefix: String?,
+          next_milestone_suffix: String?,
+          number_of_winners: Integer?,
+          order: Integer?,
+          referral_description: String?,
+          referred_reward_upfront: bool
+        }
+
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor is_unlimited: bool
+
+        attr_accessor metadata: ::Hash[Symbol, top]
+
+        attr_accessor type: GrowsurfRuby::Models::Campaign::Reward::type_
+
+        attr_accessor commission_structure: GrowsurfRuby::CommissionStructure?
+
+        attr_accessor conversions_required: Integer?
+
+        attr_accessor coupon_code: String?
+
+        attr_accessor description: String?
+
+        attr_accessor image_url: String?
+
+        attr_accessor limit: Integer?
+
+        attr_accessor limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?
+
+        attr_accessor next_milestone_prefix: String?
+
+        attr_accessor next_milestone_suffix: String?
+
+        attr_accessor number_of_winners: Integer?
+
+        attr_accessor order: Integer?
+
+        attr_accessor referral_description: String?
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        def initialize: (
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::Campaign::Reward::type_,
+          ?commission_structure: GrowsurfRuby::CommissionStructure?,
+          ?conversions_required: Integer?,
+          ?coupon_code: String?,
+          ?description: String?,
+          ?image_url: String?,
+          ?limit: Integer?,
+          ?limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
+          ?next_milestone_prefix: String?,
+          ?next_milestone_suffix: String?,
+          ?number_of_winners: Integer?,
+          ?order: Integer?,
+          ?referral_description: String?,
+          ?referred_reward_upfront: bool
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::Campaign::Reward::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure?,
+          conversions_required: Integer?,
+          coupon_code: String?,
+          description: String?,
+          image_url: String?,
+          limit: Integer?,
+          limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
+          next_milestone_prefix: String?,
+          next_milestone_suffix: String?,
+          number_of_winners: Integer?,
+          order: Integer?,
+          referral_description: String?,
+          referred_reward_upfront: bool
+        }
+
+        type type_ =
+          :SINGLE_SIDED | :DOUBLE_SIDED | :MILESTONE | :LEADERBOARD | :AFFILIATE
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED: :SINGLE_SIDED
+          DOUBLE_SIDED: :DOUBLE_SIDED
+          MILESTONE: :MILESTONE
+          LEADERBOARD: :LEADERBOARD
+          AFFILIATE: :AFFILIATE
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::Reward::type_]
+        end
+
+        type limit_duration = :IN_TOTAL | :PER_MONTH | :PER_YEAR
+
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL: :IN_TOTAL
+          PER_MONTH: :PER_MONTH
+          PER_YEAR: :PER_YEAR
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::Reward::limit_duration]
+        end
+      end
+    end
+  end
+end