growsurf-ruby 0.7.0 → 1.0.0

data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi

@@ -0,0 +1,309 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::RewardUpdateParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :campaign_reward_id
+
+        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::RewardUpdateParams::LimitDuration::OrSymbol
+            )
+          )
+        end
+        attr_reader :limit_duration
+
+        sig do
+          params(
+            limit_duration:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::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(
+            id: String,
+            campaign_reward_id: String,
+            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::RewardUpdateParams::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(
+          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,
+          # 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(
+            {
+              id: String,
+              campaign_reward_id: String,
+              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::RewardUpdateParams::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 LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_TOTAL =
+            T.let(
+              :IN_TOTAL,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::TaggedSymbol
+            )
+          PER_MONTH =
+            T.let(
+              :PER_MONTH,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::TaggedSymbol
+            )
+          PER_YEAR =
+            T.let(
+              :PER_YEAR,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -164,6 +164,10 @@ module GrowsurfRuby
         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
 
@@ -173,6 +177,28 @@ module GrowsurfRuby
         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,
@@ -194,8 +220,12 @@ module GrowsurfRuby
             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_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(
@@ -216,8 +246,14 @@ module GrowsurfRuby
           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
+          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
 
@@ -243,8 +279,11 @@ module GrowsurfRuby
               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_reward_upfront: T::Boolean,
+              referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation),
+              value: T.nilable(GrowsurfRuby::RewardTaxValuation)
             }
           )
         end

data/rbi/growsurf_ruby/models/campaign_create_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignCreateParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(GrowsurfRuby::CampaignCreateParams::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_logo_image_url
+
+      sig { params(company_logo_image_url: String).void }
+      attr_writer :company_logo_image_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_name
+
+      sig { params(company_name: String).void }
+      attr_writer :company_name
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :currency_iso
+
+      sig { params(currency_iso: String).void }
+      attr_writer :currency_iso
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig do
+        returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardCreateParams]))
+      end
+      attr_reader :rewards
+
+      sig do
+        params(
+          rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash]
+        ).void
+      end
+      attr_writer :rewards
+
+      sig do
+        params(
+          type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
+          company_logo_image_url: String,
+          company_name: String,
+          currency_iso: String,
+          name: String,
+          rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        type:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        currency_iso: nil,
+        name: nil,
+        rewards: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
+            company_logo_image_url: String,
+            company_name: String,
+            currency_iso: String,
+            name: String,
+            rewards:
+              T::Array[GrowsurfRuby::Campaign::RewardCreateParams::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::CampaignCreateParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REFERRAL =
+          T.let(
+            :REFERRAL,
+            GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol
+          )
+        AFFILIATE =
+          T.let(
+            :AFFILIATE,
+            GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignCreateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_update_params.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignUpdateParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_logo_image_url
+
+      sig { params(company_logo_image_url: String).void }
+      attr_writer :company_logo_image_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_name
+
+      sig { params(company_name: String).void }
+      attr_writer :company_name
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig do
+        returns(T.nilable(GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          company_logo_image_url: String,
+          company_name: String,
+          name: String,
+          status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        name: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            company_logo_image_url: String,
+            company_name: String,
+            name: String,
+            status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignUpdateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :PENDING,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        IN_PROGRESS =
+          T.let(
+            :IN_PROGRESS,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        COMPLETE =
+          T.let(
+            :COMPLETE,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+        CANCELLED =
+          T.let(
+            :CANCELLED,
+            GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignUpdateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    # Tax valuation settings for a reward. Only relevant when the program collects
+    # tax documentation.
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::RewardTaxValuation,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # Manual fair-market value in USD (major units) used as the fallback when the
+      # reward value cannot be resolved automatically. `null` = no manual value.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fair_market_value_usd
+
+      # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+      # the smart default for the reward's source.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_tax_reportable
+
+      # Tax valuation settings for a reward. Only relevant when the program collects
+      # tax documentation.
+      sig do
+        params(
+          fair_market_value_usd: T.nilable(Float),
+          is_tax_reportable: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Manual fair-market value in USD (major units) used as the fallback when the
+        # reward value cannot be resolved automatically. `null` = no manual value.
+        fair_market_value_usd: nil,
+        # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+        # the smart default for the reward's source.
+        is_tax_reportable: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            fair_market_value_usd: T.nilable(Float),
+            is_tax_reportable: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end