growsurf-ruby 0.7.0 → 1.0.0

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

@@ -0,0 +1,205 @@
+# 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 campaign_reward_id
+        #
+        #   @return [String]
+        required :campaign_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 referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Defaults to not tax-reportable (a purchase rebate).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #   Used by tax documentation / 1099 reporting.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+
+        # @!method initialize(id:, campaign_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, referred_value: nil, title: nil, value: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::RewardUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param campaign_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 referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #
+        #   @param title [String]
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the reward (the referrer's side of a double-sided reward). Use
+        #
+        #   @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.rb

@@ -156,6 +156,12 @@ module GrowsurfRuby
         #   @return [Integer, nil]
         optional :order, Integer, nil?: true
 
+        # @!attribute referral_coupon_code
+        #   The coupon code delivered to the referred friend (double-sided rewards).
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
+
         # @!attribute referral_description
         #
         #   @return [String, nil]
@@ -168,7 +174,22 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::Boolean,
                  api_name: :referredRewardUpfront
 
-        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_description: nil, referred_reward_upfront: nil)
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue,
+                 nil?: true
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
+
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: 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, referred_value: nil, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -199,9 +220,15 @@ module GrowsurfRuby
         #
         #   @param order [Integer, nil]
         #
+        #   @param referral_coupon_code [String, nil] The coupon code delivered to the referred friend (double-sided rewards).
+        #
         #   @param referral_description [String, nil]
         #
         #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
 
         # @see GrowsurfRuby::Models::CampaignAPI::Reward#type
         module Type

data/lib/growsurf_ruby/models/campaign_create_params.rb

@@ -0,0 +1,68 @@
+# 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 name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!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, name: 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 name [String]
+      #
+      #   @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,63 @@
+# 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 name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!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, name: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param company_logo_image_url [String]
+      #
+      #   @param company_name [String]
+      #
+      #   @param name [String]
+      #
+      #   @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/reward_tax_valuation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute fair_market_value_usd
+      #   Manual fair-market value in USD (major units) used as the fallback when the
+      #   reward value cannot be resolved automatically. `null` = no manual value.
+      #
+      #   @return [Float, nil]
+      optional :fair_market_value_usd, Float, api_name: :fairMarketValueUSD, nil?: true
+
+      # @!attribute is_tax_reportable
+      #   Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+      #   the smart default for the reward's source.
+      #
+      #   @return [Boolean, nil]
+      optional :is_tax_reportable,
+               GrowsurfRuby::Internal::Type::Boolean,
+               api_name: :isTaxReportable,
+               nil?: true
+
+      # @!method initialize(fair_market_value_usd: nil, is_tax_reportable: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::RewardTaxValuation} for more details.
+      #
+      #   Tax valuation settings for a reward. Only relevant when the program collects
+      #   tax documentation.
+      #
+      #   @param fair_market_value_usd [Float, nil] Manual fair-market value in USD (major units) used as the fallback when the rewa
+      #
+      #   @param is_tax_reportable [Boolean, nil] Whether the reward's value counts toward 1099 thresholds/totals. `null` = use th
+    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
@@ -71,4 +75,6 @@ module GrowsurfRuby
   ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
 
   ReferralList = GrowsurfRuby::Models::ReferralList
+
+  RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/lib/growsurf_ruby/resources/campaign/design.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Design
+        # Retrieves a program's design configuration — the same surface as the dashboard
+        # Program Editor's **Design** tab (window layout, header, share channels, signup
+        # form, portal/landing pages, theme styling, and summary/status sections).
+        #
+        # This is a large, deeply nested object whose available fields depend on the
+        # program type. See the API reference for the full field list.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/design", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's design configuration. Only the fields you send are changed (a
+        # surgical merge; arrays such as `signup.fields` replace wholesale). Unknown
+        # fields, fields not available for the program type, and invalid values return a
+        # `400`.
+        #
+        # The request body is a partial {CampaignDesign} object — see the API reference for
+        # the full field list.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/design", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign/emails.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Emails
+        # Retrieves a program's email configuration — the same surface as the dashboard
+        # Program Editor's **Emails** tab (per-email templates plus sender, contact, and
+        # design settings).
+        #
+        # This is a large, nested object. See the API reference for the full field list.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/emails", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's email configuration. Only the fields you send are changed.
+        # Unknown fields and invalid values return a `400`.
+        #
+        # The request body is a partial {CampaignEmails} object — see the API reference for
+        # the full field list.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial email configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/emails", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign/installation.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Installation
+        # Retrieves a program's installation configuration — the same surface as the
+        # dashboard Program Editor's **Installation** tab (signup and mobile SDK
+        # installation settings).
+        #
+        # This is a nested object whose available fields depend on the program type. See
+        # the API reference for the full field list.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/installation", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's installation configuration. Only the fields you send are
+        # changed. Unknown fields, fields not available for the program type, and invalid
+        # values return a `400`.
+        #
+        # The request body is a partial {CampaignInstallation} object — see the API
+        # reference for the full field list.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial installation configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/installation", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end