growsurf-ruby 0.7.0 → 1.0.0

data/rbi/growsurf_ruby/models/campaign/reward.rbi

@@ -0,0 +1,291 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::Reward,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_unlimited
+
+        # Shallow custom metadata object.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :metadata
+
+        sig do
+          returns(GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol)
+        end
+        attr_accessor :type
+
+        sig { returns(T.nilable(GrowsurfRuby::CommissionStructure)) }
+        attr_reader :commission_structure
+
+        sig do
+          params(
+            commission_structure:
+              T.nilable(GrowsurfRuby::CommissionStructure::OrHash)
+          ).void
+        end
+        attr_writer :commission_structure
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :conversions_required
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :coupon_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :image_url
+
+        # `-1` represents an unlimited reward in REST responses.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :limit
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :limit_duration
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_milestone_prefix
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_milestone_suffix
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :number_of_winners
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :order
+
+        # The coupon code delivered to the referred friend (double-sided rewards).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :referral_coupon_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :referral_description
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :referred_reward_upfront
+
+        sig { params(referred_reward_upfront: T::Boolean).void }
+        attr_writer :referred_reward_upfront
+
+        # Tax valuation for the referred friend's side of a double-sided reward.
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :referred_value
+
+        sig do
+          params(
+            referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
+        attr_writer :referred_value
+
+        # Tax valuation for the reward (the referrer's side of a double-sided reward).
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :value
+
+        sig do
+          params(
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
+        attr_writer :value
+
+        sig do
+          params(
+            id: String,
+            is_unlimited: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            type: GrowsurfRuby::Models::Campaign::Reward::Type::OrSymbol,
+            commission_structure:
+              T.nilable(GrowsurfRuby::CommissionStructure::OrHash),
+            conversions_required: T.nilable(Integer),
+            coupon_code: T.nilable(String),
+            description: T.nilable(String),
+            image_url: T.nilable(String),
+            limit: T.nilable(Integer),
+            limit_duration:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::Reward::LimitDuration::OrSymbol
+              ),
+            next_milestone_prefix: T.nilable(String),
+            next_milestone_suffix: T.nilable(String),
+            number_of_winners: T.nilable(Integer),
+            order: T.nilable(Integer),
+            referral_coupon_code: T.nilable(String),
+            referral_description: T.nilable(String),
+            referred_reward_upfront: T::Boolean,
+            referred_value:
+              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          is_unlimited:,
+          # Shallow custom metadata object.
+          metadata:,
+          type:,
+          commission_structure: nil,
+          conversions_required: nil,
+          coupon_code: nil,
+          description: nil,
+          image_url: nil,
+          # `-1` represents an unlimited reward in REST responses.
+          limit: nil,
+          limit_duration: nil,
+          next_milestone_prefix: nil,
+          next_milestone_suffix: nil,
+          number_of_winners: nil,
+          order: nil,
+          # The coupon code delivered to the referred friend (double-sided rewards).
+          referral_coupon_code: nil,
+          referral_description: nil,
+          referred_reward_upfront: nil,
+          # Tax valuation for the referred friend's side of a double-sided reward.
+          referred_value: nil,
+          # Tax valuation for the reward (the referrer's side of a double-sided reward).
+          value: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              is_unlimited: T::Boolean,
+              metadata: T::Hash[Symbol, T.anything],
+              type: GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol,
+              commission_structure:
+                T.nilable(GrowsurfRuby::CommissionStructure),
+              conversions_required: T.nilable(Integer),
+              coupon_code: T.nilable(String),
+              description: T.nilable(String),
+              image_url: T.nilable(String),
+              limit: T.nilable(Integer),
+              limit_duration:
+                T.nilable(
+                  GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+                ),
+              next_milestone_prefix: T.nilable(String),
+              next_milestone_suffix: T.nilable(String),
+              number_of_winners: T.nilable(Integer),
+              order: T.nilable(Integer),
+              referral_coupon_code: T.nilable(String),
+              referral_description: T.nilable(String),
+              referred_reward_upfront: T::Boolean,
+              referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation),
+              value: T.nilable(GrowsurfRuby::RewardTaxValuation)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::Models::Campaign::Reward::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SINGLE_SIDED =
+            T.let(
+              :SINGLE_SIDED,
+              GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+            )
+          DOUBLE_SIDED =
+            T.let(
+              :DOUBLE_SIDED,
+              GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+            )
+          MILESTONE =
+            T.let(
+              :MILESTONE,
+              GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+            )
+          LEADERBOARD =
+            T.let(
+              :LEADERBOARD,
+              GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+            )
+          AFFILIATE =
+            T.let(
+              :AFFILIATE,
+              GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::Reward::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::Reward::LimitDuration
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_TOTAL =
+            T.let(
+              :IN_TOTAL,
+              GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+            )
+          PER_MONTH =
+            T.let(
+              :PER_MONTH,
+              GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+            )
+          PER_YEAR =
+            T.let(
+              :PER_YEAR,
+              GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::Reward::LimitDuration::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi

@@ -0,0 +1,358 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::RewardCreateParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::OrSymbol
+          )
+        end
+        attr_accessor :type
+
+        sig { returns(T.nilable(GrowsurfRuby::CommissionStructure)) }
+        attr_reader :commission_structure
+
+        sig do
+          params(
+            commission_structure: GrowsurfRuby::CommissionStructure::OrHash
+          ).void
+        end
+        attr_writer :commission_structure
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :conversions_required
+
+        sig { params(conversions_required: Integer).void }
+        attr_writer :conversions_required
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :coupon_code
+
+        sig { params(coupon_code: String).void }
+        attr_writer :coupon_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :image_url
+
+        sig { params(image_url: String).void }
+        attr_writer :image_url
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_active
+
+        sig { params(is_active: T::Boolean).void }
+        attr_writer :is_active
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_unlimited
+
+        sig { params(is_unlimited: T::Boolean).void }
+        attr_writer :is_unlimited
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_visible
+
+        sig { params(is_visible: T::Boolean).void }
+        attr_writer :is_visible
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::OrSymbol
+            )
+          )
+        end
+        attr_reader :limit_duration
+
+        sig do
+          params(
+            limit_duration:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::OrSymbol
+          ).void
+        end
+        attr_writer :limit_duration
+
+        # Custom key/value metadata (single-level; values are stored as strings).
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_milestone_prefix
+
+        sig { params(next_milestone_prefix: String).void }
+        attr_writer :next_milestone_prefix
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_milestone_suffix
+
+        sig { params(next_milestone_suffix: String).void }
+        attr_writer :next_milestone_suffix
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :number_of_winners
+
+        sig { params(number_of_winners: Integer).void }
+        attr_writer :number_of_winners
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :order
+
+        sig { params(order: Integer).void }
+        attr_writer :order
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :referral_coupon_code
+
+        sig { params(referral_coupon_code: String).void }
+        attr_writer :referral_coupon_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :referral_description
+
+        sig { params(referral_description: String).void }
+        attr_writer :referral_description
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :referred_reward_upfront
+
+        sig { params(referred_reward_upfront: T::Boolean).void }
+        attr_writer :referred_reward_upfront
+
+        # Tax valuation for the referred friend's side of a double-sided reward.
+        # Defaults to not tax-reportable (a purchase rebate).
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :referred_value
+
+        sig do
+          params(referred_value: GrowsurfRuby::RewardTaxValuation::OrHash).void
+        end
+        attr_writer :referred_value
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :title
+
+        sig { params(title: String).void }
+        attr_writer :title
+
+        # Tax valuation for the reward (the referrer's side of a double-sided reward).
+        # Used by tax documentation / 1099 reporting.
+        sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
+        attr_reader :value
+
+        sig { params(value: GrowsurfRuby::RewardTaxValuation::OrHash).void }
+        attr_writer :value
+
+        sig do
+          params(
+            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,
+            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            title: String,
+            value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          type:,
+          commission_structure: nil,
+          conversions_required: nil,
+          coupon_code: nil,
+          description: nil,
+          image_url: nil,
+          is_active: nil,
+          is_unlimited: nil,
+          is_visible: nil,
+          limit: nil,
+          limit_duration: nil,
+          # Custom key/value metadata (single-level; values are stored as strings).
+          metadata: nil,
+          next_milestone_prefix: nil,
+          next_milestone_suffix: nil,
+          number_of_winners: nil,
+          order: nil,
+          referral_coupon_code: nil,
+          referral_description: nil,
+          referred_reward_upfront: nil,
+          # Tax valuation for the referred friend's side of a double-sided reward.
+          # Defaults to not tax-reportable (a purchase rebate).
+          referred_value: nil,
+          title: nil,
+          # Tax valuation for the reward (the referrer's side of a double-sided reward).
+          # Used by tax documentation / 1099 reporting.
+          value: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              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,
+              referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+              title: String,
+              value: GrowsurfRuby::RewardTaxValuation::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::Models::Campaign::RewardCreateParams::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SINGLE_SIDED =
+            T.let(
+              :SINGLE_SIDED,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+            )
+          DOUBLE_SIDED =
+            T.let(
+              :DOUBLE_SIDED,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+            )
+          MILESTONE =
+            T.let(
+              :MILESTONE,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+            )
+          LEADERBOARD =
+            T.let(
+              :LEADERBOARD,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+            )
+          AFFILIATE =
+            T.let(
+              :AFFILIATE,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_TOTAL =
+            T.let(
+              :IN_TOTAL,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::TaggedSymbol
+            )
+          PER_MONTH =
+            T.let(
+              :PER_MONTH,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::TaggedSymbol
+            )
+          PER_YEAR =
+            T.let(
+              :PER_YEAR,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_delete_params.rbi

@@ -19,23 +19,23 @@ module GrowsurfRuby
         attr_accessor :id
 
         sig { returns(String) }
-        attr_accessor :reward_id
+        attr_accessor :campaign_reward_id
 
         sig do
           params(
             id: String,
-            reward_id: String,
+            campaign_reward_id: String,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(id:, reward_id:, request_options: {})
+        def self.new(id:, campaign_reward_id:, request_options: {})
         end
 
         sig do
           override.returns(
             {
               id: String,
-              reward_id: String,
+              campaign_reward_id: String,
               request_options: GrowsurfRuby::RequestOptions
             }
           )