Class: Zernio::ListCommentAutomations200ResponseAutomationsInnerStats

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ListCommentAutomations200ResponseAutomationsInnerStats

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 89

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ListCommentAutomations200ResponseAutomationsInnerStats` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ListCommentAutomations200ResponseAutomationsInnerStats`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'triggered')
    self.triggered = attributes[:'triggered']
  end

  if attributes.key?(:'dms_sent')
    self.dms_sent = attributes[:'dms_sent']
  end

  if attributes.key?(:'dms_failed')
    self.dms_failed = attributes[:'dms_failed']
  end

  if attributes.key?(:'unique_contacts')
    self.unique_contacts = attributes[:'unique_contacts']
  end

  if attributes.key?(:'tracked_sends')
    self.tracked_sends = attributes[:'tracked_sends']
  end

  if attributes.key?(:'link_clicks')
    self.link_clicks = attributes[:'link_clicks']
  end

  if attributes.key?(:'unique_clicks')
    self.unique_clicks = attributes[:'unique_clicks']
  end

  if attributes.key?(:'delivered')
    self.delivered = attributes[:'delivered']
  end

  if attributes.key?(:'read')
    self.read = attributes[:'read']
  end
end

Instance Attribute Details

#delivered ⇒ Object

DMs confirmed delivered (Messenger; IG emits no delivery receipt).



36
37
38
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 36

def delivered
  @delivered
end

#dms_failed ⇒ Object

Returns the value of attribute dms_failed.



22
23
24
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 22

def dms_failed
  @dms_failed
end

#dms_sent ⇒ Object

Returns the value of attribute dms_sent.



20
21
22
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 20

def dms_sent
  @dms_sent
end

#link_clicks ⇒ Object

Total clicks on tracked links (bots/prefetch excluded).



30
31
32
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 30

def link_clicks
  @link_clicks
end

#read ⇒ Object

DMs confirmed read (IG messaging_seen / Messenger message_reads).



39
40
41
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 39

def read
  @read
end

#tracked_sends ⇒ Object

DMs sent with a trackable (wrapped) link. CTR denominator: divide clicks by this, not dmsSent. Lags dmsSent for campaigns that predate click tracking.



27
28
29
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 27

def tracked_sends
  @tracked_sends
end

#triggered ⇒ Object

Returns the value of attribute triggered.



18
19
20
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 18

def triggered
  @triggered
end

#unique_clicks ⇒ Object

Distinct people who clicked a tracked link.



33
34
35
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 33

def unique_clicks
  @unique_clicks
end

#unique_contacts ⇒ Object

Returns the value of attribute unique_contacts.



24
25
26
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 24

def unique_contacts
  @unique_contacts
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



57
58
59
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 57

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 62

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 42

def self.attribute_map
  {
    :'triggered' => :'triggered',
    :'dms_sent' => :'dmsSent',
    :'dms_failed' => :'dmsFailed',
    :'unique_contacts' => :'uniqueContacts',
    :'tracked_sends' => :'trackedSends',
    :'link_clicks' => :'linkClicks',
    :'unique_clicks' => :'uniqueClicks',
    :'delivered' => :'delivered',
    :'read' => :'read'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 186

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 82

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 67

def self.openapi_types
  {
    :'triggered' => :'Integer',
    :'dms_sent' => :'Integer',
    :'dms_failed' => :'Integer',
    :'unique_contacts' => :'Integer',
    :'tracked_sends' => :'Integer',
    :'link_clicks' => :'Integer',
    :'unique_clicks' => :'Integer',
    :'delivered' => :'Integer',
    :'read' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      triggered == o.triggered &&
      dms_sent == o.dms_sent &&
      dms_failed == o.dms_failed &&
      unique_contacts == o.unique_contacts &&
      tracked_sends == o.tracked_sends &&
      link_clicks == o.link_clicks &&
      unique_clicks == o.unique_clicks &&
      delivered == o.delivered &&
      read == o.read
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 179

def hash
  [triggered, dms_sent, dms_failed, unique_contacts, tracked_sends, link_clicks, unique_clicks, delivered, read].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 208

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



150
151
152
153
 
# File 'lib/zernio-sdk/models/list_comment_automations200_response_automations_inner_stats.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end