Class: GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Instance Attribute Summary

• #android_native_shares ⇒ Integer^?
• #bluesky_shares ⇒ Integer^?
• #copy_ref_link_shares ⇒ Integer^?
• #email_shares ⇒ Integer^?
• #facebook_shares ⇒ Integer^?
• #impressions ⇒ Integer^?
• #invites ⇒ Integer^?
• #ios_native_shares ⇒ Integer^?
• #linked_in_shares ⇒ Integer^?
• #messenger_shares ⇒ Integer^?
• #participants ⇒ Integer^?
• #period_start ⇒ Integer^?

  Start of the period, as a Unix timestamp in milliseconds (UTC).

• #pinterest_shares ⇒ Integer^?
• #qrcode_shares ⇒ Integer^?
• #reddit_shares ⇒ Integer^?
• #referral_credit_expireds ⇒ Integer^?
• #referral_credit_pendings ⇒ Integer^?
• #referrals ⇒ Integer^?
• #sms_shares ⇒ Integer^?
• #telegram_shares ⇒ Integer^?
• #threads_shares ⇒ Integer^?
• #total_commission_count ⇒ Integer^?

  Affiliate programs only.

• #total_commissions ⇒ Integer^?

  Affiliate programs only.

• #total_revenue ⇒ Integer^?

  Affiliate programs only.

• #tumblr_shares ⇒ Integer^?
• #twitter_shares ⇒ Integer^?
• #unique_commission_referrals ⇒ Integer^?

  Affiliate programs only.

• #unique_impressions ⇒ Integer^?
• #wechat_shares ⇒ Integer^?
• #whats_app_shares ⇒ Integer^?

Instance Method Summary

• #initialize(android_native_shares: nil, bluesky_shares: nil, copy_ref_link_shares: nil, email_shares: nil, facebook_shares: nil, impressions: nil, invites: nil, ios_native_shares: nil, linked_in_shares: nil, messenger_shares: nil, participants: nil, period_start: nil, pinterest_shares: nil, qrcode_shares: nil, reddit_shares: nil, referral_credit_expireds: nil, referral_credit_pendings: nil, referrals: nil, sms_shares: nil, telegram_shares: nil, threads_shares: nil, total_commission_count: nil, total_commissions: nil, total_revenue: nil, tumblr_shares: nil, twitter_shares: nil, unique_commission_referrals: nil, unique_impressions: nil, wechat_shares: nil, whats_app_shares: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Series for more details.

• #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(android_native_shares: nil, bluesky_shares: nil, copy_ref_link_shares: nil, email_shares: nil, facebook_shares: nil, impressions: nil, invites: nil, ios_native_shares: nil, linked_in_shares: nil, messenger_shares: nil, participants: nil, period_start: nil, pinterest_shares: nil, qrcode_shares: nil, reddit_shares: nil, referral_credit_expireds: nil, referral_credit_pendings: nil, referrals: nil, sms_shares: nil, telegram_shares: nil, threads_shares: nil, total_commission_count: nil, total_commissions: nil, total_revenue: nil, tumblr_shares: nil, twitter_shares: nil, unique_commission_referrals: nil, unique_impressions: nil, wechat_shares: nil, whats_app_shares: nil) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series for more details.

Parameters:

• android_native_shares (Integer) (defaults to: nil)
• bluesky_shares (Integer) (defaults to: nil)
• copy_ref_link_shares (Integer) (defaults to: nil)
• email_shares (Integer) (defaults to: nil)
• facebook_shares (Integer) (defaults to: nil)
• impressions (Integer) (defaults to: nil)
• invites (Integer) (defaults to: nil)
• ios_native_shares (Integer) (defaults to: nil)
• linked_in_shares (Integer) (defaults to: nil)
• messenger_shares (Integer) (defaults to: nil)
• participants (Integer) (defaults to: nil)
• period_start (Integer) (defaults to: nil) —

  Start of the period, as a Unix timestamp in milliseconds (UTC).

• pinterest_shares (Integer) (defaults to: nil)
• qrcode_shares (Integer) (defaults to: nil)
• reddit_shares (Integer) (defaults to: nil)
• referral_credit_expireds (Integer) (defaults to: nil)
• referral_credit_pendings (Integer) (defaults to: nil)
• referrals (Integer) (defaults to: nil)
• sms_shares (Integer) (defaults to: nil)
• telegram_shares (Integer) (defaults to: nil)
• threads_shares (Integer) (defaults to: nil)
• total_commission_count (Integer) (defaults to: nil) —

  Affiliate programs only. Number of commission records.

• total_commissions (Integer) (defaults to: nil) —

  Affiliate programs only. Commissions in the smallest unit of the program currenc

• total_revenue (Integer) (defaults to: nil) —

  Affiliate programs only. Revenue in the smallest unit of the program currency.

• tumblr_shares (Integer) (defaults to: nil)
• twitter_shares (Integer) (defaults to: nil)
• unique_commission_referrals (Integer) (defaults to: nil) —

  Affiliate programs only. Number of unique referred participants represented by commissions in the requested timeframe.

• unique_impressions (Integer) (defaults to: nil)
• wechat_shares (Integer) (defaults to: nil)
• whats_app_shares (Integer) (defaults to: nil)

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

Instance Attribute Details

#android_native_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :android_native_shares, Integer, api_name: :androidNativeShares

#bluesky_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :bluesky_shares, Integer, api_name: :blueskyShares

#copy_ref_link_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :copy_ref_link_shares, Integer, api_name: :copyRefLinkShares

#email_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :email_shares, Integer, api_name: :emailShares

#facebook_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :facebook_shares, Integer, api_name: :facebookShares

#impressions ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :impressions, Integer

#invites ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :invites, Integer

#ios_native_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :ios_native_shares, Integer, api_name: :iosNativeShares

#linked_in_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :linked_in_shares, Integer, api_name: :linkedInShares

#messenger_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :messenger_shares, Integer, api_name: :messengerShares

#participants ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :participants, Integer

#period_start ⇒ Integer^?

Start of the period, as a Unix timestamp in milliseconds (UTC).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :period_start, Integer, api_name: :periodStart

#pinterest_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :pinterest_shares, Integer, api_name: :pinterestShares

#qrcode_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :qrcode_shares, Integer, api_name: :qrcodeShares

#reddit_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :reddit_shares, Integer, api_name: :redditShares

#referral_credit_expireds ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :referral_credit_expireds, Integer, api_name: :referralCreditExpireds

#referral_credit_pendings ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :referral_credit_pendings, Integer, api_name: :referralCreditPendings

#referrals ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :referrals, Integer

#sms_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :sms_shares, Integer, api_name: :smsShares

#telegram_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :telegram_shares, Integer, api_name: :telegramShares

#threads_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :threads_shares, Integer, api_name: :threadsShares

#total_commission_count ⇒ Integer^?

Affiliate programs only. Number of commission records.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :total_commission_count, Integer, api_name: :totalCommissionCount

#total_commissions ⇒ Integer^?

Affiliate programs only. Commissions in the smallest unit of the program currency.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :total_commissions, Integer, api_name: :totalCommissions

#total_revenue ⇒ Integer^?

Affiliate programs only. Revenue in the smallest unit of the program currency.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :total_revenue, Integer, api_name: :totalRevenue

#tumblr_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :tumblr_shares, Integer, api_name: :tumblrShares

#twitter_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :twitter_shares, Integer, api_name: :twitterShares

#unique_commission_referrals ⇒ Integer^?

Affiliate programs only. Number of unique referred participants represented by commissions in the requested timeframe.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :unique_commission_referrals, Integer, api_name: :uniqueCommissionReferrals

#unique_impressions ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :unique_impressions, Integer, api_name: :uniqueImpressions

#wechat_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :wechat_shares, Integer, api_name: :wechatShares

#whats_app_shares ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :whats_app_shares, Integer, api_name: :whatsAppShares

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {