growsurf-ruby 0.7.0 → 0.8.0

data/rbi/growsurf_ruby/resources/campaign/rewards.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Rewards
+        # Retrieves the active, visible, and enabled rewards configured for a program.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::CampaignRewardListResponse)
+        end
+        def list(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Creates a reward for a program. The reward `type` must be compatible with the
+        # program type.
+        sig do
+          params(
+            id: String,
+            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,
+            title: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Reward)
+        end
+        def create(
+          # Path param: GrowSurf program ID.
+          id,
+          # Body param: The reward type. Immutable after creation.
+          type:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          referral_description: nil,
+          # Body param
+          referred_reward_upfront: nil,
+          # Body param
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates an existing program reward. Only the fields you send are changed; `type`
+        # is immutable and must not be supplied.
+        sig do
+          params(
+            reward_id: String,
+            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,
+            title: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::Reward)
+        end
+        def update(
+          # Path param: Program reward ID.
+          reward_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          referral_description: nil,
+          # Body param
+          referred_reward_upfront: nil,
+          # Body param
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a program reward.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::DeleteRewardResponse)
+        end
+        def delete(
+          # Program reward ID.
+          reward_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -14,6 +14,10 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
       attr_reader :commission
 
+      # Program reward configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Rewards) }
+      attr_reader :rewards
+
       # Retrieves a program for the given program ID.
       sig do
         params(
@@ -37,6 +41,101 @@ module GrowsurfRuby
       def list(request_options: {})
       end
 
+      # Creates a program. Only `type` is required; everything else is server-defaulted.
+      sig do
+        params(
+          type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
+          company_logo_image_url: String,
+          company_name: String,
+          currency_iso: String,
+          goal: String,
+          name: String,
+          options: T::Hash[Symbol, T.anything],
+          rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def create(
+        # The program type. Immutable after creation.
+        type:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        # ISO 4217 currency code. Defaults to USD.
+        currency_iso: nil,
+        goal: nil,
+        # The program name. Defaults to "Untitled Program".
+        name: nil,
+        # A curated subset of program options to shallow-merge onto the defaults.
+        options: nil,
+        # Optional inline rewards to create with the program.
+        rewards: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates a program. Only the fields you send are changed. `type` and `urlId` are
+      # immutable.
+      sig do
+        params(
+          id: String,
+          company_logo_image_url: String,
+          company_name: String,
+          currency_iso: String,
+          design: T::Hash[Symbol, T.anything],
+          emails: T::Hash[Symbol, T.anything],
+          goal: String,
+          installation: T::Hash[Symbol, T.anything],
+          name: String,
+          notifications: T::Hash[Symbol, T.anything],
+          options: T::Hash[Symbol, T.anything],
+          status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def update(
+        # Path param: GrowSurf program ID.
+        id,
+        # Body param
+        company_logo_image_url: nil,
+        # Body param
+        company_name: nil,
+        # Body param
+        currency_iso: nil,
+        # Body param
+        design: nil,
+        # Body param
+        emails: nil,
+        # Body param
+        goal: nil,
+        # Body param
+        installation: nil,
+        # Body param
+        name: nil,
+        # Body param
+        notifications: nil,
+        # Body param
+        options: nil,
+        # Body param: The program status. Transitions are validated; DELETED is not
+        # allowed.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Clones an existing program, returning the newly created program.
+      sig do
+        params(
+          id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def clone(
+        # GrowSurf program ID.
+        id,
+        request_options: {}
+      )
+      end
+
       # Creates or returns a participant using the same input behavior as Add
       # Participant, then returns a participant-scoped token for GrowSurf mobile SDK
       # participant endpoints. Use this endpoint from your backend after your mobile app

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

@@ -0,0 +1,18 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type campaign_reward_list_response =
+        { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+
+      class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+
+        def initialize: (
+          rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+        ) -> void
+
+        def to_hash: -> { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type delete_reward_response = { id: String, success: bool }
+
+      class DeleteRewardResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor success: bool
+
+        def initialize: (id: String, success: bool) -> void
+
+        def to_hash: -> { id: String, success: bool }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+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_description: String?,
+          referred_reward_upfront: bool
+        }
+
+      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_description: String?
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        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_description: String?,
+          ?referred_reward_upfront: bool
+        ) -> 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_description: String?,
+          referred_reward_upfront: bool
+        }
+
+        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,192 @@
+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,
+          title: String
+        }
+        & 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 title: String?
+
+        def title=: (String) -> String
+
+        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,
+          ?title: String,
+          ?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,
+          title: String,
+          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