Class: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts

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

Overview

See Also:

  • GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse#status_counts

Defined Under Namespace

Classes: CommissionStatus, PayoutStatus, RewardStatus

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(count: nil, total_amount: nil) ⇒ Object

Parameters:

  • count (Integer) (defaults to: nil)
  • total_amount (Integer) (defaults to: nil) —

    Total payout amount in minor currency units.




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

Instance Attribute Details

#affiliate_status ⇒ Hash{Symbol=>Integer}?

Affiliate only. Participant counts keyed by affiliate status.

Returns:

  • (Hash{Symbol=>Integer}, nil) 


558
559
560
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 558

optional :affiliate_status,
GrowsurfRuby::Internal::Type::HashOf[Integer],
api_name: :affiliateStatus

#commission_status ⇒ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus?

Affiliate only. Commission counts and amounts by status.

Returns:



566
567
568
569
570
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 566

optional :commission_status,
-> {
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus
},
api_name: :commissionStatus

#currency_iso ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :currency_iso, String, api_name: :currencyISO

#payout_status ⇒ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus?

Affiliate only. Payout counts and amounts by status.

Returns:



581
582
583
584
585
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 581

optional :payout_status,
-> {
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus
},
api_name: :payoutStatus

#reward_status ⇒ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus?

Present for every program.

Returns:



591
592
593
594
595
 
# File 'lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb', line 591

optional :reward_status,
-> {
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
},
api_name: :rewardStatus

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {