Class: GrowsurfRuby::Models::RewardTaxValuation

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

Defined Under Namespace

Modules: TaxCharacter

Instance Attribute 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(fair_market_value_usd: nil, tax_character: nil) ⇒ Object

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

Tax valuation settings for a reward. Only relevant when the program collects tax documentation.

Parameters:

  • fair_market_value_usd (Float, nil) (defaults to: nil) —

    Manual fair-market value in USD (major units) used as the fallback when the rewa

  • tax_character (Symbol, GrowsurfRuby::Models::RewardTaxValuation::TaxCharacter, nil) (defaults to: nil) —

    The reason the recipient earns this reward. null inherits the program's




# File 'lib/growsurf_ruby/models/reward_tax_valuation.rb', line 24

Instance Attribute Details

#fair_market_value_usd ⇒ Float?

Manual fair-market value in USD (major units) used as the fallback when the reward value cannot be resolved automatically. null = no manual value.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


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

optional :fair_market_value_usd, Float, api_name: :fairMarketValueUSD, nil?: true

#tax_character ⇒ Symbol, ...

The reason the recipient earns this reward. null inherits the program's confirmed tax treatment for configurable non-commission rewards. Commission rewards always use NONEMPLOYEE_SERVICES.

Parameters:

  • value (GrowsurfRuby::Models::RewardTaxValuation::tax_character, nil)

Returns:



19
20
21
22
 
# File 'lib/growsurf_ruby/models/reward_tax_valuation.rb', line 19

optional :tax_character,
enum: -> { GrowsurfRuby::RewardTaxValuation::TaxCharacter },
api_name: :taxCharacter,
nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


19
 
# File 'sig/growsurf_ruby/models/reward_tax_valuation.rbs', line 19

def to_hash: -> {