Class: GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralParams

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

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Participant#trigger_referral

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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:, delay_in_days: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (String)
  • participant_id_or_email (String)
  • delay_in_days (Integer) (defaults to: nil) —

    Number of whole days to hold referral credit before it is awarded. Useful for

  • request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb', line 31

Instance Attribute Details

#delay_in_days ⇒ Integer?

Number of whole days to hold referral credit before it is awarded. Useful for honoring a refund window before crediting a referrer. Omit this field to award credit immediately. The credit is awarded automatically once the delay elapses, and can be cancelled before then with the Cancel delayed referral trigger request.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :delay_in_days, Integer, api_name: :delayInDays

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#participant_id_or_email ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :participant_id_or_email, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs', line 27

def to_hash: -> {