Class: ApolloDeploySignalSdk::AdvisorRecommendationDataResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk/types.rb

Overview

Schema type: AdvisorRecommendationDataResponse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bounce_rate: nil, bounced: nil, accepted: nil, complaint_rate: nil, accepted24h: nil, avg_daily_accepted7d: nil, days_since_last_send: nil, reported_open_rate: nil, adjusted_open_rate: nil, proxy_rate: nil, proxy_opens: nil, total_opens: nil, human_open_rate: nil, delivered: nil, unsub_rate: nil, unsubscribed: nil, dmarc_alignment_failure_rate7d: nil, dmarc_domain: nil, dmarc_current_policy: nil, dmarc_recommended_policy: nil, dmarc_observed_messages: nil, dmarc_aligned_messages: nil, dmarc_accounted_rate: nil, dmarc_unknown_messages: nil, dmarc_unknown_sources: nil, dmarc_reporting_days: nil) ⇒ AdvisorRecommendationDataResponse

Returns a new instance of AdvisorRecommendationDataResponse.

Parameters:

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

    , bounced [Integer, nil], accepted [Integer, nil], complaint_rate [Float, nil], accepted24h [Integer, nil], avg_daily_accepted7d [Integer, nil], days_since_last_send [Integer, nil], reported_open_rate [Float, nil], adjusted_open_rate [Float, nil], proxy_rate [Float, nil], proxy_opens [Integer, nil], total_opens [Integer, nil], human_open_rate [Float, nil], delivered [Integer, nil], unsub_rate [Float, nil], unsubscribed [Integer, nil], dmarc_alignment_failure_rate7d [Float, nil], dmarc_domain [String, nil], dmarc_current_policy [String, nil], dmarc_recommended_policy [String, nil], dmarc_observed_messages [Integer, nil], dmarc_aligned_messages [Integer, nil], dmarc_accounted_rate [Float, nil], dmarc_unknown_messages [Integer, nil], dmarc_unknown_sources [Integer, nil], dmarc_reporting_days [Integer, nil]



1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1452

def initialize(bounce_rate: nil, bounced: nil, accepted: nil, complaint_rate: nil, accepted24h: nil, avg_daily_accepted7d: nil, days_since_last_send: nil, reported_open_rate: nil, adjusted_open_rate: nil, proxy_rate: nil, proxy_opens: nil, total_opens: nil, human_open_rate: nil, delivered: nil, unsub_rate: nil, unsubscribed: nil, dmarc_alignment_failure_rate7d: nil, dmarc_domain: nil, dmarc_current_policy: nil, dmarc_recommended_policy: nil, dmarc_observed_messages: nil, dmarc_aligned_messages: nil, dmarc_accounted_rate: nil, dmarc_unknown_messages: nil, dmarc_unknown_sources: nil, dmarc_reporting_days: nil)
  @bounce_rate = bounce_rate
  @bounced = bounced
  @accepted = accepted
  @complaint_rate = complaint_rate
  @accepted24h = accepted24h
  @avg_daily_accepted7d = avg_daily_accepted7d
  @days_since_last_send = days_since_last_send
  @reported_open_rate = reported_open_rate
  @adjusted_open_rate = adjusted_open_rate
  @proxy_rate = proxy_rate
  @proxy_opens = proxy_opens
  @total_opens = total_opens
  @human_open_rate = human_open_rate
  @delivered = delivered
  @unsub_rate = unsub_rate
  @unsubscribed = unsubscribed
  @dmarc_alignment_failure_rate7d = dmarc_alignment_failure_rate7d
  @dmarc_domain = dmarc_domain
  @dmarc_current_policy = dmarc_current_policy
  @dmarc_recommended_policy = dmarc_recommended_policy
  @dmarc_observed_messages = dmarc_observed_messages
  @dmarc_aligned_messages = dmarc_aligned_messages
  @dmarc_accounted_rate = dmarc_accounted_rate
  @dmarc_unknown_messages = dmarc_unknown_messages
  @dmarc_unknown_sources = dmarc_unknown_sources
  @dmarc_reporting_days = dmarc_reporting_days
end

Instance Attribute Details

#accepted ⇒ Integer?

Returns:

  • (Integer, nil) 


1403
1404
1405
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1403

def accepted
  @accepted
end

#accepted24h ⇒ Integer?

Returns:

  • (Integer, nil) 


1407
1408
1409
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1407

def accepted24h
  @accepted24h
end

#adjusted_open_rate ⇒ Float?

Returns:

  • (Float, nil) 


1415
1416
1417
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1415

def adjusted_open_rate
  @adjusted_open_rate
end

#avg_daily_accepted7d ⇒ Integer?

Returns:

  • (Integer, nil) 


1409
1410
1411
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1409

def avg_daily_accepted7d
  @avg_daily_accepted7d
end

#bounce_rate ⇒ Float?

Returns:

  • (Float, nil) 


1399
1400
1401
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1399

def bounce_rate
  @bounce_rate
end

#bounced ⇒ Integer?

Returns:

  • (Integer, nil) 


1401
1402
1403
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1401

def bounced
  @bounced
end

#complaint_rate ⇒ Float?

Returns:

  • (Float, nil) 


1405
1406
1407
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1405

def complaint_rate
  @complaint_rate
end

#days_since_last_send ⇒ Integer?

Returns:

  • (Integer, nil) 


1411
1412
1413
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1411

def days_since_last_send
  @days_since_last_send
end

#delivered ⇒ Integer?

Returns:

  • (Integer, nil) 


1425
1426
1427
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1425

def delivered
  @delivered
end

#dmarc_accounted_rate ⇒ Float?

Returns:

  • (Float, nil) 


1443
1444
1445
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1443

def dmarc_accounted_rate
  @dmarc_accounted_rate
end

#dmarc_aligned_messages ⇒ Integer?

Returns:

  • (Integer, nil) 


1441
1442
1443
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1441

def dmarc_aligned_messages
  @dmarc_aligned_messages
end

#dmarc_alignment_failure_rate7d ⇒ Float?

Returns:

  • (Float, nil) 


1431
1432
1433
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1431

def dmarc_alignment_failure_rate7d
  @dmarc_alignment_failure_rate7d
end

#dmarc_current_policy ⇒ String?

Returns:

  • (String, nil) 


1435
1436
1437
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1435

def dmarc_current_policy
  @dmarc_current_policy
end

#dmarc_domain ⇒ String?

Returns:

  • (String, nil) 


1433
1434
1435
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1433

def dmarc_domain
  @dmarc_domain
end

#dmarc_observed_messages ⇒ Integer?

Returns:

  • (Integer, nil) 


1439
1440
1441
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1439

def dmarc_observed_messages
  @dmarc_observed_messages
end

#dmarc_recommended_policy ⇒ String?

Returns:

  • (String, nil) 


1437
1438
1439
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1437

def dmarc_recommended_policy
  @dmarc_recommended_policy
end

#dmarc_reporting_days ⇒ Integer?

Returns:

  • (Integer, nil) 


1449
1450
1451
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1449

def dmarc_reporting_days
  @dmarc_reporting_days
end

#dmarc_unknown_messages ⇒ Integer?

Returns:

  • (Integer, nil) 


1445
1446
1447
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1445

def dmarc_unknown_messages
  @dmarc_unknown_messages
end

#dmarc_unknown_sources ⇒ Integer?

Returns:

  • (Integer, nil) 


1447
1448
1449
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1447

def dmarc_unknown_sources
  @dmarc_unknown_sources
end

#human_open_rate ⇒ Float?

Returns:

  • (Float, nil) 


1423
1424
1425
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1423

def human_open_rate
  @human_open_rate
end

#proxy_opens ⇒ Integer?

Returns:

  • (Integer, nil) 


1419
1420
1421
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1419

def proxy_opens
  @proxy_opens
end

#proxy_rate ⇒ Float?

Returns:

  • (Float, nil) 


1417
1418
1419
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1417

def proxy_rate
  @proxy_rate
end

#reported_open_rate ⇒ Float?

Returns:

  • (Float, nil) 


1413
1414
1415
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1413

def reported_open_rate
  @reported_open_rate
end

#total_opens ⇒ Integer?

Returns:

  • (Integer, nil) 


1421
1422
1423
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1421

def total_opens
  @total_opens
end

#unsub_rate ⇒ Float?

Returns:

  • (Float, nil) 


1427
1428
1429
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1427

def unsub_rate
  @unsub_rate
end

#unsubscribed ⇒ Integer?

Returns:

  • (Integer, nil) 


1429
1430
1431
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1429

def unsubscribed
  @unsubscribed
end

Class Method Details

.from_json(attributes) ⇒ AdvisorRecommendationDataResponse

Create an instance from a parsed JSON hash.

Parameters:

  • attributes (Hash)

Returns:



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1516

def self.from_json(attributes)
  return nil unless attributes.is_a?(Hash)

  new(
    bounce_rate: attributes.key?("bounceRate") ? attributes["bounceRate"] : attributes[:bounce_rate],
    bounced: attributes.key?("bounced") ? attributes["bounced"] : attributes[:bounced],
    accepted: attributes.key?("accepted") ? attributes["accepted"] : attributes[:accepted],
    complaint_rate: attributes.key?("complaintRate") ? attributes["complaintRate"] : attributes[:complaint_rate],
    accepted24h: attributes.key?("accepted24h") ? attributes["accepted24h"] : attributes[:accepted24h],
    avg_daily_accepted7d: attributes.key?("avgDailyAccepted7d") ? attributes["avgDailyAccepted7d"] : attributes[:avg_daily_accepted7d],
    days_since_last_send: attributes.key?("daysSinceLastSend") ? attributes["daysSinceLastSend"] : attributes[:days_since_last_send],
    reported_open_rate: attributes.key?("reportedOpenRate") ? attributes["reportedOpenRate"] : attributes[:reported_open_rate],
    adjusted_open_rate: attributes.key?("adjustedOpenRate") ? attributes["adjustedOpenRate"] : attributes[:adjusted_open_rate],
    proxy_rate: attributes.key?("proxyRate") ? attributes["proxyRate"] : attributes[:proxy_rate],
    proxy_opens: attributes.key?("proxyOpens") ? attributes["proxyOpens"] : attributes[:proxy_opens],
    total_opens: attributes.key?("totalOpens") ? attributes["totalOpens"] : attributes[:total_opens],
    human_open_rate: attributes.key?("humanOpenRate") ? attributes["humanOpenRate"] : attributes[:human_open_rate],
    delivered: attributes.key?("delivered") ? attributes["delivered"] : attributes[:delivered],
    unsub_rate: attributes.key?("unsubRate") ? attributes["unsubRate"] : attributes[:unsub_rate],
    unsubscribed: attributes.key?("unsubscribed") ? attributes["unsubscribed"] : attributes[:unsubscribed],
    dmarc_alignment_failure_rate7d: attributes.key?("dmarcAlignmentFailureRate7d") ? attributes["dmarcAlignmentFailureRate7d"] : attributes[:dmarc_alignment_failure_rate7d],
    dmarc_domain: attributes.key?("dmarcDomain") ? attributes["dmarcDomain"] : attributes[:dmarc_domain],
    dmarc_current_policy: attributes.key?("dmarcCurrentPolicy") ? attributes["dmarcCurrentPolicy"] : attributes[:dmarc_current_policy],
    dmarc_recommended_policy: attributes.key?("dmarcRecommendedPolicy") ? attributes["dmarcRecommendedPolicy"] : attributes[:dmarc_recommended_policy],
    dmarc_observed_messages: attributes.key?("dmarcObservedMessages") ? attributes["dmarcObservedMessages"] : attributes[:dmarc_observed_messages],
    dmarc_aligned_messages: attributes.key?("dmarcAlignedMessages") ? attributes["dmarcAlignedMessages"] : attributes[:dmarc_aligned_messages],
    dmarc_accounted_rate: attributes.key?("dmarcAccountedRate") ? attributes["dmarcAccountedRate"] : attributes[:dmarc_accounted_rate],
    dmarc_unknown_messages: attributes.key?("dmarcUnknownMessages") ? attributes["dmarcUnknownMessages"] : attributes[:dmarc_unknown_messages],
    dmarc_unknown_sources: attributes.key?("dmarcUnknownSources") ? attributes["dmarcUnknownSources"] : attributes[:dmarc_unknown_sources],
    dmarc_reporting_days: attributes.key?("dmarcReportingDays") ? attributes["dmarcReportingDays"] : attributes[:dmarc_reporting_days],
  )
end

Instance Method Details

#to_h ⇒ Hash

Returns a hash representation of this object.

Returns:

  • (Hash) —

    a hash representation of this object



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 1482

def to_h
  {
    bounce_rate: @bounce_rate,
    bounced: @bounced,
    accepted: @accepted,
    complaint_rate: @complaint_rate,
    accepted24h: @accepted24h,
    avg_daily_accepted7d: @avg_daily_accepted7d,
    days_since_last_send: @days_since_last_send,
    reported_open_rate: @reported_open_rate,
    adjusted_open_rate: @adjusted_open_rate,
    proxy_rate: @proxy_rate,
    proxy_opens: @proxy_opens,
    total_opens: @total_opens,
    human_open_rate: @human_open_rate,
    delivered: @delivered,
    unsub_rate: @unsub_rate,
    unsubscribed: @unsubscribed,
    dmarc_alignment_failure_rate7d: @dmarc_alignment_failure_rate7d,
    dmarc_domain: @dmarc_domain,
    dmarc_current_policy: @dmarc_current_policy,
    dmarc_recommended_policy: @dmarc_recommended_policy,
    dmarc_observed_messages: @dmarc_observed_messages,
    dmarc_aligned_messages: @dmarc_aligned_messages,
    dmarc_accounted_rate: @dmarc_accounted_rate,
    dmarc_unknown_messages: @dmarc_unknown_messages,
    dmarc_unknown_sources: @dmarc_unknown_sources,
    dmarc_reporting_days: @dmarc_reporting_days,
  }.compact
end