Class: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/growsurf_ruby/models/campaign/participant_update_params.rb,
sig/growsurf_ruby/models/campaign/participant_update_params.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Participant#update

Defined Under Namespace

Modules: AffiliateStatus, ReferralStatus

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(id:, participant_id_or_email:, affiliate_status: nil, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: 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)
  • affiliate_status (Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::AffiliateStatus) (defaults to: nil) —

    Affiliate programs only. Sets the affiliate status.

  • 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

  • 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: {}) 



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

Instance Attribute Details

#affiliate_status ⇒ Symbol, ...

Affiliate programs only. Sets the affiliate status. APPROVED also enrolls a participant who is not yet an affiliate. SUSPENDED and BANNED are rejected for non-affiliates.

Returns:



27
28
29
 
# File 'lib/growsurf_ruby/models/campaign/participant_update_params.rb', line 27

optional :affiliate_status,
enum: -> { GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus },
api_name: :affiliateStatus

#email ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :email, String

#first_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :first_name, String, api_name: :firstName

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#last_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :last_name, String, api_name: :lastName

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


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

optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#notes ⇒ String?

Freeform internal notes about the participant (internal only, never exposed to participants).

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :notes, String

#participant_id_or_email ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :participant_id_or_email, String

#referral_status ⇒ Symbol, ...

Returns:



62
63
64
 
# File 'lib/growsurf_ruby/models/campaign/participant_update_params.rb', line 62

optional :referral_status,
enum: -> { GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus },
api_name: :referralStatus

#referred_by ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :referred_by, String, api_name: :referredBy

#unsubscribed ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :unsubscribed, GrowsurfRuby::Internal::Type::Boolean

#vanity_keys ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {