growsurf-ruby 0.6.1 → 0.8.0

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

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

@@ -0,0 +1,182 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_update_params =
+        {
+          id: String,
+          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,
+          title: String
+        }
+        & 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 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 title: String?
+
+        def title=: (String) -> String
+
+        def initialize: (
+          id: String,
+          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,
+          ?title: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          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,
+          title: String,
+          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_create_params.rbs

@@ -0,0 +1,88 @@
+module GrowsurfRuby
+  module Models
+    type campaign_create_params =
+      {
+        type: GrowsurfRuby::Models::CampaignCreateParams::type_,
+        company_logo_image_url: String,
+        company_name: String,
+        currency_iso: String,
+        goal: String,
+        name: String,
+        options: ::Hash[Symbol, top],
+        rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams]
+      }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class CampaignCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_accessor type: GrowsurfRuby::Models::CampaignCreateParams::type_
+
+      attr_reader company_logo_image_url: String?
+
+      def company_logo_image_url=: (String) -> String
+
+      attr_reader company_name: String?
+
+      def company_name=: (String) -> String
+
+      attr_reader currency_iso: String?
+
+      def currency_iso=: (String) -> String
+
+      attr_reader goal: String?
+
+      def goal=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader options: ::Hash[Symbol, top]?
+
+      def options=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams]?
+
+      def rewards=: (
+        ::Array[GrowsurfRuby::Campaign::RewardCreateParams]
+      ) -> ::Array[GrowsurfRuby::Campaign::RewardCreateParams]
+
+      def initialize: (
+        type: GrowsurfRuby::Models::CampaignCreateParams::type_,
+        ?company_logo_image_url: String,
+        ?company_name: String,
+        ?currency_iso: String,
+        ?goal: String,
+        ?name: String,
+        ?options: ::Hash[Symbol, top],
+        ?rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        type: GrowsurfRuby::Models::CampaignCreateParams::type_,
+        company_logo_image_url: String,
+        company_name: String,
+        currency_iso: String,
+        goal: String,
+        name: String,
+        options: ::Hash[Symbol, top],
+        rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
+        request_options: GrowsurfRuby::RequestOptions
+      }
+
+      type type_ = :REFERRAL | :AFFILIATE
+
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL: :REFERRAL
+        AFFILIATE: :AFFILIATE
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignCreateParams::type_]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign_update_params.rbs

@@ -0,0 +1,119 @@
+module GrowsurfRuby
+  module Models
+    type campaign_update_params =
+      {
+        id: String,
+        company_logo_image_url: String,
+        company_name: String,
+        currency_iso: String,
+        design: ::Hash[Symbol, top],
+        emails: ::Hash[Symbol, top],
+        goal: String,
+        installation: ::Hash[Symbol, top],
+        name: String,
+        notifications: ::Hash[Symbol, top],
+        options: ::Hash[Symbol, top],
+        status: GrowsurfRuby::Models::CampaignUpdateParams::status
+      }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class CampaignUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader company_logo_image_url: String?
+
+      def company_logo_image_url=: (String) -> String
+
+      attr_reader company_name: String?
+
+      def company_name=: (String) -> String
+
+      attr_reader currency_iso: String?
+
+      def currency_iso=: (String) -> String
+
+      attr_reader design: ::Hash[Symbol, top]?
+
+      def design=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader emails: ::Hash[Symbol, top]?
+
+      def emails=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader goal: String?
+
+      def goal=: (String) -> String
+
+      attr_reader installation: ::Hash[Symbol, top]?
+
+      def installation=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader notifications: ::Hash[Symbol, top]?
+
+      def notifications=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader options: ::Hash[Symbol, top]?
+
+      def options=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader status: GrowsurfRuby::Models::CampaignUpdateParams::status?
+
+      def status=: (
+        GrowsurfRuby::Models::CampaignUpdateParams::status
+      ) -> GrowsurfRuby::Models::CampaignUpdateParams::status
+
+      def initialize: (
+        id: String,
+        ?company_logo_image_url: String,
+        ?company_name: String,
+        ?currency_iso: String,
+        ?design: ::Hash[Symbol, top],
+        ?emails: ::Hash[Symbol, top],
+        ?goal: String,
+        ?installation: ::Hash[Symbol, top],
+        ?name: String,
+        ?notifications: ::Hash[Symbol, top],
+        ?options: ::Hash[Symbol, top],
+        ?status: GrowsurfRuby::Models::CampaignUpdateParams::status,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        company_logo_image_url: String,
+        company_name: String,
+        currency_iso: String,
+        design: ::Hash[Symbol, top],
+        emails: ::Hash[Symbol, top],
+        goal: String,
+        installation: ::Hash[Symbol, top],
+        name: String,
+        notifications: ::Hash[Symbol, top],
+        options: ::Hash[Symbol, top],
+        status: GrowsurfRuby::Models::CampaignUpdateParams::status,
+        request_options: GrowsurfRuby::RequestOptions
+      }
+
+      type status = :DRAFT | :PENDING | :IN_PROGRESS | :COMPLETE | :CANCELLED
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DRAFT: :DRAFT
+        PENDING: :PENDING
+        IN_PROGRESS: :IN_PROGRESS
+        COMPLETE: :COMPLETE
+        CANCELLED: :CANCELLED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignUpdateParams::status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models.rbs

@@ -5,6 +5,8 @@ module GrowsurfRuby
 
   class CampaignCreateMobileParticipantTokenParams = GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
+  class CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
+
   class CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
 
   class CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
@@ -21,6 +23,8 @@ module GrowsurfRuby
 
   class CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  class CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
+
   class CommissionStructure = GrowsurfRuby::Models::CommissionStructure
 
   class ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList

data/sig/growsurf_ruby/resources/campaign/participant.rbs

@@ -112,6 +112,27 @@ module GrowsurfRuby
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::participant_record_transaction_response
 
+        def refund_transaction: (
+          String participant_id_or_email,
+          id: String,
+          ?amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
+          ?amount: Integer,
+          ?amount_refunded: Integer,
+          ?charge_id: String,
+          ?currency: String,
+          ?description: String,
+          ?external_id: String,
+          ?invoice_id: String,
+          ?order_id: String,
+          ?payment_id: String,
+          ?payment_intent_id: String,
+          ?refund_amount: Integer,
+          ?refund_id: String,
+          ?refund_status: String,
+          ?transaction_id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
+
         def send_invites: (
           String participant_id_or_email,
           id: String,
@@ -124,9 +145,16 @@ module GrowsurfRuby
         def trigger_referral: (
           String participant_id_or_email,
           id: String,
+          ?delay_in_days: Integer,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse
 
+        def cancel_delayed_referral: (
+          String participant_id_or_email,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse
+
         def initialize: (client: GrowsurfRuby::Client) -> void
       end
     end