Class: MailSlurpClient::CreateTrackingPixelOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/create_tracking_pixel_options.rb

Overview

Options for creating a tracking pixel for email open tracking

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTrackingPixelOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 48

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

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

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

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

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 18

def name
  @name
end

#recipient ⇒ Object

Returns the value of attribute recipient.



20
21
22
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 20

def recipient
  @recipient
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 23

def self.attribute_map
  {
    :'name' => :'name',
    :'recipient' => :'recipient'
  }
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



107
108
109
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 107

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



39
40
41
42
43
44
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 39

def self.openapi_nullable
  Set.new([
    :'name',
    :'recipient'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 31

def self.openapi_types
  {
    :'name' => :'String',
    :'recipient' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



85
86
87
88
89
90
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 85

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      recipient == o.recipient
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 135

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 204

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 114

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


94
95
96
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 94

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



100
101
102
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 100

def hash
  [name, recipient].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



72
73
74
75
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 72

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 180

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 186

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



174
175
176
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 174

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



79
80
81
 
# File 'lib/mailslurp_client/models/create_tracking_pixel_options.rb', line 79

def valid?
  true
end