Module: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus

Extended by:
Internal::Type::Enum
Defined in:
lib/growsurf_ruby/models/campaign/participant_update_params.rb,
sig/growsurf_ruby/models/campaign/participant_update_params.rbs

Constant Summary collapse

CREDIT_PENDING =

Returns:

  • (:CREDIT_PENDING) 
:CREDIT_PENDING
CREDIT_AWARDED =

Returns:

  • (:CREDIT_AWARDED) 
:CREDIT_AWARDED
CREDIT_EXPIRED =

Returns:

  • (:CREDIT_EXPIRED) 
:CREDIT_EXPIRED

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/growsurf_ruby/models/campaign/participant_update_params.rb', line 114

Instance Method Details

#initialize(id:, participant_id_or_email:, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, paypal_email: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::Campaign::ParticipantUpdateParams for more details.

Parameters:

  • id (String)
  • participant_id_or_email (String)
  • email (String) (defaults to: nil)
  • first_name (String) (defaults to: nil)
  • last_name (String) (defaults to: nil)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    Shallow custom metadata object.

  • notes (String) (defaults to: nil) —

    Freeform internal notes about the participant (internal only, never exposed to pa

  • paypal_email (String) (defaults to: nil) —

    The participant's PayPal email address, used for affiliate payouts.

  • referral_status (Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus) (defaults to: nil)
  • referred_by (String) (defaults to: nil)
  • unsubscribed (Boolean) (defaults to: nil)
  • vanity_keys (Array<String>) (defaults to: nil)
  • request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


107
108
109
110
111
112
113
114
115
116
 
# File 'lib/growsurf_ruby/models/campaign/participant_update_params.rb', line 107

module ReferralStatus
  extend GrowsurfRuby::Internal::Type::Enum

  CREDIT_PENDING = :CREDIT_PENDING
  CREDIT_AWARDED = :CREDIT_AWARDED
  CREDIT_EXPIRED = :CREDIT_EXPIRED

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status]

Returns:

  • (::Array[GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status]) 


113
 
# File 'sig/growsurf_ruby/models/campaign/participant_update_params.rbs', line 113

def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status]