Class: Notifo::PublishDto

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/models/publish_dto.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublishDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
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
 
# File 'lib/notifo/models/publish_dto.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::PublishDto` 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 `Notifo::PublishDto`. 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?(:'topic')
    self.topic = attributes[:'topic']
  end

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

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

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

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

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

  if attributes.key?(:'settings')
    if (value = attributes[:'settings']).is_a?(Hash)
      self.settings = value
    end
  end

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

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

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

Instance Attribute Details

#creator_id ⇒ Object

A custom id to identity the creator.



20
21
22
 
# File 'lib/notifo/models/publish_dto.rb', line 20

def creator_id
  @creator_id
end

#data ⇒ Object

Additional user defined data.



26
27
28
 
# File 'lib/notifo/models/publish_dto.rb', line 26

def data
  @data
end

#preformatted ⇒ Object

Returns the value of attribute preformatted.



31
32
33
 
# File 'lib/notifo/models/publish_dto.rb', line 31

def preformatted
  @preformatted
end

#properties ⇒ Object

Returns the value of attribute properties.



36
37
38
 
# File 'lib/notifo/models/publish_dto.rb', line 36

def properties
  @properties
end

#scheduling ⇒ Object

Returns the value of attribute scheduling.



38
39
40
 
# File 'lib/notifo/models/publish_dto.rb', line 38

def scheduling
  @scheduling
end

#settings ⇒ Object

The notification settings.



34
35
36
 
# File 'lib/notifo/models/publish_dto.rb', line 34

def settings
  @settings
end

#silent ⇒ Object

True when silent.



41
42
43
 
# File 'lib/notifo/models/publish_dto.rb', line 41

def silent
  @silent
end

#template_code ⇒ Object

The template code.



23
24
25
 
# File 'lib/notifo/models/publish_dto.rb', line 23

def template_code
  @template_code
end

#timestamp ⇒ Object

A custom timestamp.



29
30
31
 
# File 'lib/notifo/models/publish_dto.rb', line 29

def timestamp
  @timestamp
end

#topic ⇒ Object

The topic path.



17
18
19
 
# File 'lib/notifo/models/publish_dto.rb', line 17

def topic
  @topic
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/notifo/models/publish_dto.rb', line 44

def self.attribute_map
  {
    :'topic' => :'topic',
    :'creator_id' => :'creatorId',
    :'template_code' => :'templateCode',
    :'data' => :'data',
    :'timestamp' => :'timestamp',
    :'preformatted' => :'preformatted',
    :'settings' => :'settings',
    :'properties' => :'properties',
    :'scheduling' => :'scheduling',
    :'silent' => :'silent'
  }
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



189
190
191
 
# File 'lib/notifo/models/publish_dto.rb', line 189

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/notifo/models/publish_dto.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/notifo/models/publish_dto.rb', line 60

def self.openapi_types
  {
    :'topic' => :'Object',
    :'creator_id' => :'Object',
    :'template_code' => :'Object',
    :'data' => :'Object',
    :'timestamp' => :'Object',
    :'preformatted' => :'Object',
    :'settings' => :'Object',
    :'properties' => :'Object',
    :'scheduling' => :'Object',
    :'silent' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/notifo/models/publish_dto.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      topic == o.topic &&
      creator_id == o.creator_id &&
      template_code == o.template_code &&
      data == o.data &&
      timestamp == o.timestamp &&
      preformatted == o.preformatted &&
      settings == o.settings &&
      properties == o.properties &&
      scheduling == o.scheduling &&
      silent == o.silent
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/notifo/models/publish_dto.rb', line 219

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
    Notifo.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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/notifo/models/publish_dto.rb', line 288

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/notifo/models/publish_dto.rb', line 196

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/notifo/models/publish_dto.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/notifo/models/publish_dto.rb', line 182

def hash
  [topic, creator_id, template_code, data, timestamp, preformatted, settings, properties, scheduling, silent].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



141
142
143
144
145
146
147
148
 
# File 'lib/notifo/models/publish_dto.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  if @topic.nil?
    invalid_properties.push('invalid value for "topic", topic cannot be nil.')
  end

  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



264
265
266
 
# File 'lib/notifo/models/publish_dto.rb', line 264

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/notifo/models/publish_dto.rb', line 270

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



258
259
260
 
# File 'lib/notifo/models/publish_dto.rb', line 258

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



152
153
154
155
 
# File 'lib/notifo/models/publish_dto.rb', line 152

def valid?
  return false if @topic.nil?
  true
end