Class: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric

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

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(approved: nil, paid: nil, pending: nil, reversed: nil) ⇒ Object

Affiliate only. Commission counts and amounts by status.

Parameters:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 661

class CommissionStatusMetric < GrowsurfRuby::Internal::Type::BaseModel
  # @!attribute count
  #
  #   @return [Integer, nil]
  optional :count, Integer

  # @!attribute total_amount
  #   Total commission amount in minor currency units.
  #
  #   @return [Integer, nil]
  optional :total_amount, Integer, api_name: :totalAmount

  # @!attribute total_revenue
  #   Total attributed revenue in minor currency units.
  #
  #   @return [Integer, nil]
  optional :total_revenue, Integer, api_name: :totalRevenue

  # @!method initialize(count: nil, total_amount: nil, total_revenue: nil)
  #   @param count [Integer]
  #
  #   @param total_amount [Integer] Total commission amount in minor currency units.
  #
  #   @param total_revenue [Integer] Total attributed revenue in minor currency units.
end

Instance Attribute Details

#count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


665
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 665

optional :count, Integer

#total_amount ⇒ Integer?

Total commission amount in minor currency units.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


671
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 671

optional :total_amount, Integer, api_name: :totalAmount

#total_revenue ⇒ Integer?

Total attributed revenue in minor currency units.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


677
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 677

optional :total_revenue, Integer, api_name: :totalRevenue

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


675
 
# File 'sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs', line 675

def to_hash: -> {