growsurf-ruby 0.6.1 → 0.8.0

data/lib/growsurf_ruby/models/campaign/reward_create_params.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#create
+      class RewardCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type]
+        required :type, enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::Type }
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure
+
+        # @!attribute conversions_required
+        #
+        #   @return [Integer, nil]
+        optional :conversions_required, Integer, api_name: :conversionsRequired
+
+        # @!attribute coupon_code
+        #
+        #   @return [String, nil]
+        optional :coupon_code, String, api_name: :couponCode
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        optional :image_url, String, api_name: :imageUrl
+
+        # @!attribute is_active
+        #
+        #   @return [Boolean, nil]
+        optional :is_active, GrowsurfRuby::Internal::Type::Boolean, api_name: :isActive
+
+        # @!attribute is_unlimited
+        #
+        #   @return [Boolean, nil]
+        optional :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
+
+        # @!attribute is_visible
+        #
+        #   @return [Boolean, nil]
+        optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute limit_duration
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration, nil]
+        optional :limit_duration,
+                 enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::LimitDuration },
+                 api_name: :limitDuration
+
+        # @!attribute metadata
+        #   Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute next_milestone_prefix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
+
+        # @!attribute next_milestone_suffix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
+
+        # @!attribute number_of_winners
+        #
+        #   @return [Integer, nil]
+        optional :number_of_winners, Integer, api_name: :numberOfWinners
+
+        # @!attribute order
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer
+
+        # @!attribute referral_coupon_code
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode
+
+        # @!attribute referral_description
+        #
+        #   @return [String, nil]
+        optional :referral_description, String, api_name: :referralDescription
+
+        # @!attribute referred_reward_upfront
+        #
+        #   @return [Boolean, nil]
+        optional :referred_reward_upfront,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :referredRewardUpfront
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(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, 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, title: nil, request_options: {})
+        #   @param type [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type]
+        #
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure]
+        #
+        #   @param conversions_required [Integer]
+        #
+        #   @param coupon_code [String]
+        #
+        #   @param description [String]
+        #
+        #   @param image_url [String]
+        #
+        #   @param is_active [Boolean]
+        #
+        #   @param is_unlimited [Boolean]
+        #
+        #   @param is_visible [Boolean]
+        #
+        #   @param limit [Integer]
+        #
+        #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @param next_milestone_prefix [String]
+        #
+        #   @param next_milestone_suffix [String]
+        #
+        #   @param number_of_winners [Integer]
+        #
+        #   @param order [Integer]
+        #
+        #   @param referral_coupon_code [String]
+        #
+        #   @param referral_description [String]
+        #
+        #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param title [String]
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#type
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED = :SINGLE_SIDED
+          DOUBLE_SIDED = :DOUBLE_SIDED
+          MILESTONE = :MILESTONE
+          LEADERBOARD = :LEADERBOARD
+          AFFILIATE = :AFFILIATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#limit_duration
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL = :IN_TOTAL
+          PER_MONTH = :PER_MONTH
+          PER_YEAR = :PER_YEAR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/reward_update_params.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#update
+      class RewardUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute reward_id
+        #
+        #   @return [String]
+        required :reward_id, String
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure
+
+        # @!attribute conversions_required
+        #
+        #   @return [Integer, nil]
+        optional :conversions_required, Integer, api_name: :conversionsRequired
+
+        # @!attribute coupon_code
+        #
+        #   @return [String, nil]
+        optional :coupon_code, String, api_name: :couponCode
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        optional :image_url, String, api_name: :imageUrl
+
+        # @!attribute is_active
+        #
+        #   @return [Boolean, nil]
+        optional :is_active, GrowsurfRuby::Internal::Type::Boolean, api_name: :isActive
+
+        # @!attribute is_unlimited
+        #
+        #   @return [Boolean, nil]
+        optional :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
+
+        # @!attribute is_visible
+        #
+        #   @return [Boolean, nil]
+        optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute limit_duration
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration, nil]
+        optional :limit_duration,
+                 enum: -> { GrowsurfRuby::Campaign::RewardUpdateParams::LimitDuration },
+                 api_name: :limitDuration
+
+        # @!attribute metadata
+        #   Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute next_milestone_prefix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
+
+        # @!attribute next_milestone_suffix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
+
+        # @!attribute number_of_winners
+        #
+        #   @return [Integer, nil]
+        optional :number_of_winners, Integer, api_name: :numberOfWinners
+
+        # @!attribute order
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer
+
+        # @!attribute referral_coupon_code
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode
+
+        # @!attribute referral_description
+        #
+        #   @return [String, nil]
+        optional :referral_description, String, api_name: :referralDescription
+
+        # @!attribute referred_reward_upfront
+        #
+        #   @return [Boolean, nil]
+        optional :referred_reward_upfront,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :referredRewardUpfront
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(id:, reward_id:, 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, 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, title: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param reward_id [String]
+        #
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure]
+        #
+        #   @param conversions_required [Integer]
+        #
+        #   @param coupon_code [String]
+        #
+        #   @param description [String]
+        #
+        #   @param image_url [String]
+        #
+        #   @param is_active [Boolean]
+        #
+        #   @param is_unlimited [Boolean]
+        #
+        #   @param is_visible [Boolean]
+        #
+        #   @param limit [Integer]
+        #
+        #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @param next_milestone_prefix [String]
+        #
+        #   @param next_milestone_suffix [String]
+        #
+        #   @param number_of_winners [Integer]
+        #
+        #   @param order [Integer]
+        #
+        #   @param referral_coupon_code [String]
+        #
+        #   @param referral_description [String]
+        #
+        #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param title [String]
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#limit_duration
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL = :IN_TOTAL
+          PER_MONTH = :PER_MONTH
+          PER_YEAR = :PER_YEAR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_create_params.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#create
+    class CampaignCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute type
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type]
+      required :type, enum: -> { GrowsurfRuby::CampaignCreateParams::Type }
+
+      # @!attribute company_logo_image_url
+      #
+      #   @return [String, nil]
+      optional :company_logo_image_url, String, api_name: :companyLogoImageUrl
+
+      # @!attribute company_name
+      #
+      #   @return [String, nil]
+      optional :company_name, String, api_name: :companyName
+
+      # @!attribute currency_iso
+      #
+      #   @return [String, nil]
+      optional :currency_iso, String, api_name: :currencyISO
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute options
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :options, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute rewards
+      #
+      #   @return [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>, nil]
+      optional :rewards,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::RewardCreateParams] }
+
+      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, goal: nil, name: nil, options: nil, rewards: nil, request_options: {})
+      #   @param type [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type]
+      #
+      #   @param company_logo_image_url [String]
+      #
+      #   @param company_name [String]
+      #
+      #   @param currency_iso [String]
+      #
+      #   @param goal [String]
+      #
+      #   @param name [String]
+      #
+      #   @param options [Hash{Symbol=>Object}]
+      #
+      #   @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>]
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # @see GrowsurfRuby::Models::CampaignCreateParams#type
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :REFERRAL
+        AFFILIATE = :AFFILIATE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_update_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#update
+    class CampaignUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_logo_image_url
+      #
+      #   @return [String, nil]
+      optional :company_logo_image_url, String, api_name: :companyLogoImageUrl
+
+      # @!attribute company_name
+      #
+      #   @return [String, nil]
+      optional :company_name, String, api_name: :companyName
+
+      # @!attribute currency_iso
+      #
+      #   @return [String, nil]
+      optional :currency_iso, String, api_name: :currencyISO
+
+      # @!attribute design
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :design, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute emails
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :emails, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute installation
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :installation, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute notifications
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :notifications, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute options
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :options, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+      # @!attribute status
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignUpdateParams::Status }
+
+      # @!method initialize(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: {})
+      #   @param id [String]
+      #
+      #   @param company_logo_image_url [String]
+      #
+      #   @param company_name [String]
+      #
+      #   @param currency_iso [String]
+      #
+      #   @param design [Hash{Symbol=>Object}]
+      #
+      #   @param emails [Hash{Symbol=>Object}]
+      #
+      #   @param goal [String]
+      #
+      #   @param installation [Hash{Symbol=>Object}]
+      #
+      #   @param name [String]
+      #
+      #   @param notifications [Hash{Symbol=>Object}]
+      #
+      #   @param options [Hash{Symbol=>Object}]
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status]
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # @see GrowsurfRuby::Models::CampaignUpdateParams#status
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PENDING = :PENDING
+        IN_PROGRESS = :IN_PROGRESS
+        COMPLETE = :COMPLETE
+        CANCELLED = :CANCELLED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models.rb

@@ -46,6 +46,8 @@ module GrowsurfRuby
   CampaignCreateMobileParticipantTokenParams =
     GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
+  CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
+
   CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
 
   CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
@@ -62,6 +64,8 @@ module GrowsurfRuby
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
+
   CommissionStructure = GrowsurfRuby::Models::CommissionStructure
 
   ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList