Class: GrowsurfRuby::Models::AffiliateApplication

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/affiliate_application.rb,
sig/growsurf_ruby/models/affiliate_application.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign#retrieve_affiliate_application

Defined Under Namespace

Modules: RiskLevel, Status Classes: Answer

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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 ⇒ Object 



64
 
# File 'sig/growsurf_ruby/models/affiliate_application.rbs', line 64

def initialize: (

Instance Attribute Details

#answers ⇒ Array<GrowsurfRuby::Models::AffiliateApplication::Answer>

The applicant's answers to the saved application form.

Returns:



11
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 11

required :answers, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::AffiliateApplication::Answer] }

#created_at ⇒ Integer

When the application was submitted, in Unix milliseconds.

Parameters:

  • (Integer)

Returns:

  • (Integer) 


17
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 17

required :created_at, Integer, api_name: :createdAt

#decided_at ⇒ Integer?

When the decision was made, in Unix milliseconds. null while pending.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


23
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 23

required :decided_at, Integer, api_name: :decidedAt, nil?: true

#email ⇒ String?

Required applicant email address, or null after applicant data is removed under the Program's retention policy.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


30
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 30

required :email, String, nil?: true

#first_name ⇒ String?

Required applicant first name, or null after applicant data is removed under the Program's retention policy.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :first_name, String, api_name: :firstName, nil?: true

#id ⇒ String

Application ID.

Parameters:

  • (String)

Returns:

  • (String) 


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

required :id, String

#last_name ⇒ String?

Required applicant last name, or null after applicant data is removed under the Program's retention policy.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :last_name, String, api_name: :lastName, nil?: true

#participant_id ⇒ String?

ID of the participant created or upgraded by approval. null until the application is approved.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :participant_id, String, api_name: :participantId, nil?: true

#reapply_allowed_at ⇒ Integer?

When a denied applicant may apply again, in Unix milliseconds. null when not applicable.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


64
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 64

required :reapply_allowed_at, Integer, api_name: :reapplyAllowedAt, nil?: true

#rejection_reason ⇒ String?

The structured reason recorded when the application was denied. null until then.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


71
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 71

required :rejection_reason, String, api_name: :rejectionReason, nil?: true

#reviewed_at ⇒ Integer?

When the application was reviewed, in Unix milliseconds. null while pending.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


77
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 77

required :reviewed_at, Integer, api_name: :reviewedAt, nil?: true

#risk_level ⇒ Symbol, ...

GrowSurf risk assessment. Applications that are not LOW risk are held for manual review; null means no assessment was recorded.

Parameters:

  • value (GrowsurfRuby::Models::AffiliateApplication::risk_level, nil)

Returns:



84
85
86
87
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 84

required :risk_level,
enum: -> { GrowsurfRuby::AffiliateApplication::RiskLevel },
api_name: :riskLevel,
nil?: true

#status ⇒ Symbol, GrowsurfRuby::Models::AffiliateApplication::Status

Where the application is in review. Only PENDING applications can be decided.

Returns:



93
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 93

required :status, enum: -> { GrowsurfRuby::AffiliateApplication::Status }

#terms_accepted_at ⇒ Integer?

When the applicant accepted the Program Terms, in Unix milliseconds, or null when acceptance was not required.

Parameters:

  • (Integer, nil)

Returns:

  • (Integer, nil) 


100
 
# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 100

required :terms_accepted_at, Integer, api_name: :termsAcceptedAt, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/growsurf_ruby/models/affiliate_application.rb', line 214

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


81
 
# File 'sig/growsurf_ruby/models/affiliate_application.rbs', line 81

def to_hash: -> {