Class: GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics

Defined in:

lib/growsurf_ruby/models/campaign/participant_analytics_response.rb,
sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs

Overview

See Also:

• GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse#analytics

Instance Attribute Summary

• #currency_iso ⇒ String^?
• #expired_referrals ⇒ Integer^?
• #impressions ⇒ Integer^?
• #invites_sent ⇒ Integer^?
• #leads ⇒ Integer^?
• #monthly_referrals ⇒ Integer^?
• #referral_revenue ⇒ Integer^?

  Affiliate only.

• #referrals ⇒ Integer^?
• #reward_status ⇒ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus^?

  This participant's reward counts grouped by review and fulfillment status.

• #total_commissions ⇒ Integer^?

  Affiliate only.

• #total_paid_out ⇒ Integer^?

  Affiliate only.

• #unique_impressions ⇒ Integer^?
• #upcoming_payout ⇒ Integer^?

  Affiliate only.

Instance Method Summary

• #initialize ⇒ 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 ⇒ Object

# File 'sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs', line 123

def initialize: (

Instance Attribute Details

#currency_iso ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 75

optional :currency_iso, String, api_name: :currencyISO

#expired_referrals ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 80

optional :expired_referrals, Integer, api_name: :expiredReferrals

#impressions ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 85

optional :impressions, Integer

#invites_sent ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 90

optional :invites_sent, Integer, api_name: :invitesSent

#leads ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 95

optional :leads, Integer

#monthly_referrals ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 100

optional :monthly_referrals, Integer, api_name: :monthlyReferrals

#referral_revenue ⇒ Integer^?

Affiliate only. Revenue attributed to this participant's referrals, in minor currency units.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 115

optional :referral_revenue, Integer, api_name: :referralRevenue

#referrals ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 120

optional :referrals, Integer

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

This participant's reward counts grouped by review and fulfillment status.

Parameters:

• (GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus)

Returns:

• (GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 106

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

#total_commissions ⇒ Integer^?

Affiliate only. Total commissions earned, in minor currency units.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 126

optional :total_commissions, Integer, api_name: :totalCommissions

#total_paid_out ⇒ Integer^?

Affiliate only. Total paid out, in minor currency units.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 132

optional :total_paid_out, Integer, api_name: :totalPaidOut

#unique_impressions ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 137

optional :unique_impressions, Integer, api_name: :uniqueImpressions

#upcoming_payout ⇒ Integer^?

Affiliate only. Approved commissions ready to pay, in minor currency units.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/campaign/participant_analytics_response.rb', line 143

optional :upcoming_payout, Integer, api_name: :upcomingPayout

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs', line 139

def to_hash: -> {