Class: GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb

Overview

See Also:

• Resources::Campaign::Participant#list_referrals

Defined Under Namespace

Modules: SortBy

Instance Attribute Summary

• #desc ⇒ Boolean^?

  Return results in descending order when true.

• #email ⇒ String^?

  URL-encoded email value to filter referral results.

• #first_name ⇒ String^?

  First name value to filter results.

• #id ⇒ String
• #last_name ⇒ String^?

  Last name value to filter results.

• #limit ⇒ Integer^?

  Number of results to return.

• #next_id ⇒ String^?

  ID to start the next paged result set with.

• #offset ⇒ Integer^?

  Offset number used to skip through a result set.

• #participant_id_or_email ⇒ String
• #referral_status ⇒ Symbol, ...
• #sort_by ⇒ Symbol, ...

  Field used to sort referral results.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, participant_id_or_email:, desc: nil, email: nil, first_name: nil, last_name: nil, limit: nil, next_id: nil, offset: nil, referral_status: nil, sort_by: nil, request_options: {}) ⇒ Object constructor

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:, desc: nil, email: nil, first_name: nil, last_name: nil, limit: nil, next_id: nil, offset: nil, referral_status: nil, sort_by: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• participant_id_or_email (String)
• desc (Boolean) (defaults to: nil) —

  Return results in descending order when true.

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

  URL-encoded email value to filter referral results.

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

  First name value to filter results.

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

  Last name value to filter results.

• limit (Integer) (defaults to: nil) —

  Number of results to return. Maximum 100.

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

  ID to start the next paged result set with.

• offset (Integer) (defaults to: nil) —

  Offset number used to skip through a result set.

• referral_status (Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus) (defaults to: nil)
• sort_by (Symbol, GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::SortBy) (defaults to: nil) —

  Field used to sort referral results.

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

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

Instance Attribute Details

#desc ⇒ Boolean^?

Return results in descending order when true.

Returns:

• (Boolean, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 25

optional :desc, GrowsurfRuby::Internal::Type::Boolean

#email ⇒ String^?

URL-encoded email value to filter referral results.

Returns:

• (String, nil)

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

optional :email, String

#first_name ⇒ String^?

First name value to filter results.

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 37

optional :first_name, String

#id ⇒ String

Returns:

• (String)

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

required :id, String

#last_name ⇒ String^?

Last name value to filter results.

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 43

optional :last_name, String

#limit ⇒ Integer^?

Number of results to return. Maximum 100.

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 49

optional :limit, Integer

#next_id ⇒ String^?

ID to start the next paged result set with.

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 55

optional :next_id, String

#offset ⇒ Integer^?

Offset number used to skip through a result set.

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 61

optional :offset, Integer

#participant_id_or_email ⇒ String

Returns:

• (String)

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

required :participant_id_or_email, String

#referral_status ⇒ Symbol, ...

Returns:

• (Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 66

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

#sort_by ⇒ Symbol, ...

Field used to sort referral results.

Returns:

• (Symbol, GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::SortBy, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb', line 72

optional :sort_by, enum: -> { GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy }