Class: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams

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

Overview

Either decide a pending application with status, or move a denied application's reapplication window with reapply_allowed_at. Provide exactly one of those fields.

See Also:

  • GrowsurfRuby::Resources::Campaign#review_affiliate_application

Defined Under Namespace

Modules: Status

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:, application_id:, allow_immediate_reapply: nil, reapply_allowed_at: nil, rejection_reason: nil, review_note: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (String)
  • application_id (String)
  • allow_immediate_reapply (Boolean) (defaults to: nil) —

    When denying, let the applicant reapply right away instead of waiting out the

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

    For an already-denied application, move the reapplication window to this earlier

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

    Short reason recorded with a denial. Only valid when status is DENIED.

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

    Private note recorded with a denial. Only valid when status is DENIED;

  • status (Symbol, GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::Status) (defaults to: nil) —

    The decision. APPROVED enrolls the applicant as an affiliate; DENIED closes

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



# File 'lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb', line 60

Instance Attribute Details

#allow_immediate_reapply ⇒ Boolean?

When denying, let the applicant reapply right away instead of waiting out the program's reapplication cooldown. Only valid when status is DENIED.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


28
29
30
 
# File 'lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb', line 28

optional :allow_immediate_reapply,
GrowsurfRuby::Internal::Type::Boolean,
api_name: :allowImmediateReapply

#application_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb', line 21

required :application_id, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb', line 16

required :id, String

#reapply_allowed_at ⇒ Integer?

For an already-denied application, move the reapplication window to this earlier time, in Unix milliseconds. Send without status.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :reapply_allowed_at, Integer, api_name: :reapplyAllowedAt

#rejection_reason ⇒ String?

Short reason recorded with a denial. Only valid when status is DENIED. Maximum 255 characters.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :rejection_reason, String, api_name: :rejectionReason

#review_note ⇒ String?

Private note recorded with a denial. Only valid when status is DENIED; never shown to the applicant. Maximum 500 characters.

Parameters:

  • (String)

Returns:

  • (String, nil) 


51
 
# File 'lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb', line 51

optional :review_note, String, api_name: :reviewNote

#status ⇒ Symbol, ...

The decision. APPROVED enrolls the applicant as an affiliate; DENIED closes the application.

Returns:



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

optional :status, enum: -> { GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


56
 
# File 'sig/growsurf_ruby/models/campaign_review_affiliate_application_params.rbs', line 56

def to_hash: -> {