growsurf-ruby 0.7.0 → 1.0.0

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

@@ -0,0 +1,146 @@
+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_coupon_code: String?,
+          referral_description: String?,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
+        }
+
+      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_coupon_code: String?
+
+        attr_accessor referral_description: String?
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        attr_accessor referred_value: GrowsurfRuby::RewardTaxValuation?
+
+        attr_accessor value: GrowsurfRuby::RewardTaxValuation?
+
+        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_coupon_code: String?,
+          ?referral_description: String?,
+          ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation?,
+          ?value: GrowsurfRuby::RewardTaxValuation?
+        ) -> 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_coupon_code: String?,
+          referral_description: String?,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
+        }
+
+        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

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

@@ -0,0 +1,210 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_create_params =
+        {
+          type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure,
+          conversions_required: Integer,
+          coupon_code: String,
+          description: String,
+          image_url: String,
+          is_active: bool,
+          is_unlimited: bool,
+          is_visible: bool,
+          limit: Integer,
+          limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
+          metadata: ::Hash[Symbol, top],
+          next_milestone_prefix: String,
+          next_milestone_suffix: String,
+          number_of_winners: Integer,
+          order: Integer,
+          referral_coupon_code: String,
+          referral_description: String,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation,
+          title: String,
+          value: GrowsurfRuby::RewardTaxValuation
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class RewardCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_
+
+        attr_reader commission_structure: GrowsurfRuby::CommissionStructure?
+
+        def commission_structure=: (
+          GrowsurfRuby::CommissionStructure
+        ) -> GrowsurfRuby::CommissionStructure
+
+        attr_reader conversions_required: Integer?
+
+        def conversions_required=: (Integer) -> Integer
+
+        attr_reader coupon_code: String?
+
+        def coupon_code=: (String) -> String
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_reader image_url: String?
+
+        def image_url=: (String) -> String
+
+        attr_reader is_active: bool?
+
+        def is_active=: (bool) -> bool
+
+        attr_reader is_unlimited: bool?
+
+        def is_unlimited=: (bool) -> bool
+
+        attr_reader is_visible: bool?
+
+        def is_visible=: (bool) -> bool
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration?
+
+        def limit_duration=: (
+          GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration
+        ) -> GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader next_milestone_prefix: String?
+
+        def next_milestone_prefix=: (String) -> String
+
+        attr_reader next_milestone_suffix: String?
+
+        def next_milestone_suffix=: (String) -> String
+
+        attr_reader number_of_winners: Integer?
+
+        def number_of_winners=: (Integer) -> Integer
+
+        attr_reader order: Integer?
+
+        def order=: (Integer) -> Integer
+
+        attr_reader referral_coupon_code: String?
+
+        def referral_coupon_code=: (String) -> String
+
+        attr_reader referral_description: String?
+
+        def referral_description=: (String) -> String
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
+
+        def referred_value=: (
+          GrowsurfRuby::RewardTaxValuation
+        ) -> GrowsurfRuby::RewardTaxValuation
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        attr_reader value: GrowsurfRuby::RewardTaxValuation?
+
+        def value=: (
+          GrowsurfRuby::RewardTaxValuation
+        ) -> GrowsurfRuby::RewardTaxValuation
+
+        def initialize: (
+          type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
+          ?commission_structure: GrowsurfRuby::CommissionStructure,
+          ?conversions_required: Integer,
+          ?coupon_code: String,
+          ?description: String,
+          ?image_url: String,
+          ?is_active: bool,
+          ?is_unlimited: bool,
+          ?is_visible: bool,
+          ?limit: Integer,
+          ?limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
+          ?metadata: ::Hash[Symbol, top],
+          ?next_milestone_prefix: String,
+          ?next_milestone_suffix: String,
+          ?number_of_winners: Integer,
+          ?order: Integer,
+          ?referral_coupon_code: String,
+          ?referral_description: String,
+          ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation,
+          ?title: String,
+          ?value: GrowsurfRuby::RewardTaxValuation,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure,
+          conversions_required: Integer,
+          coupon_code: String,
+          description: String,
+          image_url: String,
+          is_active: bool,
+          is_unlimited: bool,
+          is_visible: bool,
+          limit: Integer,
+          limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
+          metadata: ::Hash[Symbol, top],
+          next_milestone_prefix: String,
+          next_milestone_suffix: String,
+          number_of_winners: Integer,
+          order: Integer,
+          referral_coupon_code: String,
+          referral_description: String,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation,
+          title: String,
+          value: GrowsurfRuby::RewardTaxValuation,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+
+        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::RewardCreateParams::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::RewardCreateParams::limit_duration]
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module GrowsurfRuby
   module Models
     module Campaign
       type reward_delete_params =
-        { id: String, reward_id: String }
+        { id: String, campaign_reward_id: String }
         & GrowsurfRuby::Internal::Type::request_parameters
 
       class RewardDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
@@ -11,17 +11,17 @@ module GrowsurfRuby
 
         attr_accessor id: String
 
-        attr_accessor reward_id: String
+        attr_accessor campaign_reward_id: String
 
         def initialize: (
           id: String,
-          reward_id: String,
+          campaign_reward_id: String,
           ?request_options: GrowsurfRuby::request_opts
         ) -> void
 
         def to_hash: -> {
           id: String,
-          reward_id: String,
+          campaign_reward_id: String,
           request_options: GrowsurfRuby::RequestOptions
         }
       end

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

@@ -0,0 +1,200 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_update_params =
+        {
+          id: String,
+          campaign_reward_id: String,
+          commission_structure: GrowsurfRuby::CommissionStructure,
+          conversions_required: Integer,
+          coupon_code: String,
+          description: String,
+          image_url: String,
+          is_active: bool,
+          is_unlimited: bool,
+          is_visible: bool,
+          limit: Integer,
+          limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
+          metadata: ::Hash[Symbol, top],
+          next_milestone_prefix: String,
+          next_milestone_suffix: String,
+          number_of_winners: Integer,
+          order: Integer,
+          referral_coupon_code: String,
+          referral_description: String,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation,
+          title: String,
+          value: GrowsurfRuby::RewardTaxValuation
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class RewardUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor campaign_reward_id: String
+
+        attr_reader commission_structure: GrowsurfRuby::CommissionStructure?
+
+        def commission_structure=: (
+          GrowsurfRuby::CommissionStructure
+        ) -> GrowsurfRuby::CommissionStructure
+
+        attr_reader conversions_required: Integer?
+
+        def conversions_required=: (Integer) -> Integer
+
+        attr_reader coupon_code: String?
+
+        def coupon_code=: (String) -> String
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_reader image_url: String?
+
+        def image_url=: (String) -> String
+
+        attr_reader is_active: bool?
+
+        def is_active=: (bool) -> bool
+
+        attr_reader is_unlimited: bool?
+
+        def is_unlimited=: (bool) -> bool
+
+        attr_reader is_visible: bool?
+
+        def is_visible=: (bool) -> bool
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration?
+
+        def limit_duration=: (
+          GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration
+        ) -> GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader next_milestone_prefix: String?
+
+        def next_milestone_prefix=: (String) -> String
+
+        attr_reader next_milestone_suffix: String?
+
+        def next_milestone_suffix=: (String) -> String
+
+        attr_reader number_of_winners: Integer?
+
+        def number_of_winners=: (Integer) -> Integer
+
+        attr_reader order: Integer?
+
+        def order=: (Integer) -> Integer
+
+        attr_reader referral_coupon_code: String?
+
+        def referral_coupon_code=: (String) -> String
+
+        attr_reader referral_description: String?
+
+        def referral_description=: (String) -> String
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
+
+        def referred_value=: (
+          GrowsurfRuby::RewardTaxValuation
+        ) -> GrowsurfRuby::RewardTaxValuation
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        attr_reader value: GrowsurfRuby::RewardTaxValuation?
+
+        def value=: (
+          GrowsurfRuby::RewardTaxValuation
+        ) -> GrowsurfRuby::RewardTaxValuation
+
+        def initialize: (
+          id: String,
+          campaign_reward_id: String,
+          ?commission_structure: GrowsurfRuby::CommissionStructure,
+          ?conversions_required: Integer,
+          ?coupon_code: String,
+          ?description: String,
+          ?image_url: String,
+          ?is_active: bool,
+          ?is_unlimited: bool,
+          ?is_visible: bool,
+          ?limit: Integer,
+          ?limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
+          ?metadata: ::Hash[Symbol, top],
+          ?next_milestone_prefix: String,
+          ?next_milestone_suffix: String,
+          ?number_of_winners: Integer,
+          ?order: Integer,
+          ?referral_coupon_code: String,
+          ?referral_description: String,
+          ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation,
+          ?title: String,
+          ?value: GrowsurfRuby::RewardTaxValuation,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          campaign_reward_id: String,
+          commission_structure: GrowsurfRuby::CommissionStructure,
+          conversions_required: Integer,
+          coupon_code: String,
+          description: String,
+          image_url: String,
+          is_active: bool,
+          is_unlimited: bool,
+          is_visible: bool,
+          limit: Integer,
+          limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
+          metadata: ::Hash[Symbol, top],
+          next_milestone_prefix: String,
+          next_milestone_suffix: String,
+          number_of_winners: Integer,
+          order: Integer,
+          referral_coupon_code: String,
+          referral_description: String,
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation,
+          title: String,
+          value: GrowsurfRuby::RewardTaxValuation,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+
+        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::RewardUpdateParams::limit_duration]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign.rbs

@@ -85,8 +85,11 @@ module GrowsurfRuby
           next_milestone_suffix: String?,
           number_of_winners: Integer?,
           order: Integer?,
+          referral_coupon_code: String?,
           referral_description: String?,
-          referred_reward_upfront: bool
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
         }
 
       class Reward < GrowsurfRuby::Internal::Type::BaseModel
@@ -120,12 +123,18 @@ module GrowsurfRuby
 
         attr_accessor order: Integer?
 
+        attr_accessor referral_coupon_code: String?
+
         attr_accessor referral_description: String?
 
         attr_reader referred_reward_upfront: bool?
 
         def referred_reward_upfront=: (bool) -> bool
 
+        attr_accessor referred_value: GrowsurfRuby::RewardTaxValuation?
+
+        attr_accessor value: GrowsurfRuby::RewardTaxValuation?
+
         def initialize: (
           id: String,
           is_unlimited: bool,
@@ -142,8 +151,11 @@ module GrowsurfRuby
           ?next_milestone_suffix: String?,
           ?number_of_winners: Integer?,
           ?order: Integer?,
+          ?referral_coupon_code: String?,
           ?referral_description: String?,
-          ?referred_reward_upfront: bool
+          ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation?,
+          ?value: GrowsurfRuby::RewardTaxValuation?
         ) -> void
 
         def to_hash: -> {
@@ -162,8 +174,11 @@ module GrowsurfRuby
           next_milestone_suffix: String?,
           number_of_winners: Integer?,
           order: Integer?,
+          referral_coupon_code: String?,
           referral_description: String?,
-          referred_reward_upfront: bool
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
         }
 
         type type_ =