Class: GrowsurfRuby::Models::Campaign::ParticipantAddParams

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

Overview

See Also:

Defined Under Namespace

Modules: ReferralStatus

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from GrowsurfRuby::Internal::Type::BaseModel

Instance Attribute Details

#email ⇒ String

Returns:

  • (String) 


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

required :email, String

#fingerprint ⇒ String?

Returns:

  • (String, nil) 


24
 
# File 'lib/growsurf_ruby/models/campaign/participant_add_params.rb', line 24

optional :fingerprint, String

#first_name ⇒ String?

Returns:

  • (String, nil) 


29
 
# File 'lib/growsurf_ruby/models/campaign/participant_add_params.rb', line 29

optional :first_name, String, api_name: :firstName

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#ip_address ⇒ String?

Returns:

  • (String, nil) 


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

optional :ip_address, String, api_name: :ipAddress

#last_name ⇒ String?

Returns:

  • (String, nil) 


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

optional :last_name, String, api_name: :lastName

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Returns:

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


45
 
# File 'lib/growsurf_ruby/models/campaign/participant_add_params.rb', line 45

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

#referral_status ⇒ Symbol, ...

Returns:



50
51
52
 
# File 'lib/growsurf_ruby/models/campaign/participant_add_params.rb', line 50

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

#referred_by ⇒ String?

Referrer participant ID or email address.

Returns:

  • (String, nil) 


58
 
# File 'lib/growsurf_ruby/models/campaign/participant_add_params.rb', line 58

optional :referred_by, String, api_name: :referredBy