Class: GrowsurfRuby::Models::CommissionStructure

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::CommissionStructure

Defined in:

lib/growsurf_ruby/models/commission_structure.rb,
sig/growsurf_ruby/models/commission_structure.rbs

Defined Under Namespace

Modules: Event, Type

Instance Attribute Summary

• #amount ⇒ Integer^?
• #amount_iso ⇒ String^?
• #approval_required ⇒ Boolean^?
• #duration ⇒ String^?
• #duration_in_months ⇒ Integer^?
• #event ⇒ Symbol, ...

  The event that generates a commission.

• #has_intro ⇒ Boolean^?
• #has_max_amount ⇒ Boolean^?
• #hold_duration ⇒ Integer^?
• #intro_amount ⇒ Integer^?
• #intro_amount_iso ⇒ String^?
• #intro_duration ⇒ String^?
• #intro_duration_in_months ⇒ Integer^?
• #intro_percent ⇒ Float^?
• #intro_type ⇒ String^?
• #max_amount ⇒ Integer^?
• #max_amount_iso ⇒ String^?
• #min_paid_referrals ⇒ Integer^?
• #percent ⇒ Float^?
• #type ⇒ Symbol, ...

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount: nil, amount_iso: nil, approval_required: nil, duration: nil, duration_in_months: nil, event: nil, has_intro: nil, has_max_amount: nil, hold_duration: nil, intro_amount: nil, intro_amount_iso: nil, intro_duration: nil, intro_duration_in_months: nil, intro_percent: nil, intro_type: nil, max_amount: nil, max_amount_iso: nil, min_paid_referrals: nil, percent: nil, type: nil) ⇒ Object constructor
• #to_hash ⇒ {

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(amount: nil, amount_iso: nil, approval_required: nil, duration: nil, duration_in_months: nil, event: nil, has_intro: nil, has_max_amount: nil, hold_duration: nil, intro_amount: nil, intro_amount_iso: nil, intro_duration: nil, intro_duration_in_months: nil, intro_percent: nil, intro_type: nil, max_amount: nil, max_amount_iso: nil, min_paid_referrals: nil, percent: nil, type: nil) ⇒ Object

Parameters:

• amount (Integer, nil) (defaults to: nil)
• amount_iso (String, nil) (defaults to: nil)
• approval_required (Boolean, nil) (defaults to: nil)
• duration (String, nil) (defaults to: nil)
• duration_in_months (Integer, nil) (defaults to: nil)
• event (Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil) (defaults to: nil)
• has_intro (Boolean, nil) (defaults to: nil)
• has_max_amount (Boolean, nil) (defaults to: nil)
• hold_duration (Integer, nil) (defaults to: nil)
• intro_amount (Integer, nil) (defaults to: nil)
• intro_amount_iso (String, nil) (defaults to: nil)
• intro_duration (String, nil) (defaults to: nil)
• intro_duration_in_months (Integer, nil) (defaults to: nil)
• intro_percent (Float, nil) (defaults to: nil)
• intro_type (String, nil) (defaults to: nil)
• max_amount (Integer, nil) (defaults to: nil)
• max_amount_iso (String, nil) (defaults to: nil)
• min_paid_referrals (Integer, nil) (defaults to: nil)
• percent (Float, nil) (defaults to: nil)
• type (Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil) (defaults to: nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 110

Instance Attribute Details

#amount ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 9

optional :amount, Integer, nil?: true

#amount_iso ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :amount_iso, String, api_name: :amountISO, nil?: true

#approval_required ⇒ Boolean^?

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

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

optional :approval_required,
GrowsurfRuby::Internal::Type::Boolean,
api_name: :approvalRequired,
nil?: true

#duration ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 27

optional :duration, String, nil?: true

#duration_in_months ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 32

optional :duration_in_months, Integer, api_name: :durationInMonths, nil?: true

#event ⇒ Symbol, ...

The event that generates a commission. Missing legacy values read as SALE.

Parameters:

• value (GrowsurfRuby::Models::CommissionStructure::event, nil)

Returns:

• (Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 38

optional :event, enum: -> { GrowsurfRuby::CommissionStructure::Event }, nil?: true

#has_intro ⇒ Boolean^?

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

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

optional :has_intro, GrowsurfRuby::Internal::Type::Boolean, api_name: :hasIntro, nil?: true

#has_max_amount ⇒ Boolean^?

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 48

optional :has_max_amount, GrowsurfRuby::Internal::Type::Boolean, api_name: :hasMaxAmount, nil?: true

#hold_duration ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 53

optional :hold_duration, Integer, api_name: :holdDuration, nil?: true

#intro_amount ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

optional :intro_amount, Integer, api_name: :introAmount, nil?: true

#intro_amount_iso ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 63

optional :intro_amount_iso, String, api_name: :introAmountISO, nil?: true

#intro_duration ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 68

optional :intro_duration, String, api_name: :introDuration, nil?: true

#intro_duration_in_months ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 73

optional :intro_duration_in_months, Integer, api_name: :introDurationInMonths, nil?: true

#intro_percent ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 78

optional :intro_percent, Float, api_name: :introPercent, nil?: true

#intro_type ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 83

optional :intro_type, String, api_name: :introType, nil?: true

#max_amount ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 88

optional :max_amount, Integer, api_name: :maxAmount, nil?: true

#max_amount_iso ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :max_amount_iso, String, api_name: :maxAmountISO, nil?: true

#min_paid_referrals ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 98

optional :min_paid_referrals, Integer, api_name: :minPaidReferrals, nil?: true

#percent ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 103

optional :percent, Float, nil?: true

#type ⇒ Symbol, ...

Parameters:

• value (GrowsurfRuby::Models::CommissionStructure::type_, nil)

Returns:

• (Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 108

optional :type, enum: -> { GrowsurfRuby::CommissionStructure::Type }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/growsurf_ruby/models/commission_structure.rb', line 140

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/commission_structure.rbs', line 91

def to_hash: -> {