Class: UltracartClient::Notification

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/notification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Notification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/ultracart_api/models/notification.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#can_filter_by_distribution_centers ⇒ Object

True if this notification can be filtered to only send for one or more distribution centers.



19
20
21
 
# File 'lib/ultracart_api/models/notification.rb', line 19

def can_filter_by_distribution_centers
  @can_filter_by_distribution_centers
end

#can_include_affiliate ⇒ Object

True if this notification can include an affiliate information.



22
23
24
 
# File 'lib/ultracart_api/models/notification.rb', line 22

def can_include_affiliate
  @can_include_affiliate
end

#can_include_order ⇒ Object

True if this notification can include an order attachment.



25
26
27
 
# File 'lib/ultracart_api/models/notification.rb', line 25

def can_include_order
  @can_include_order
end

#can_include_order_plain_text ⇒ Object

True if this notification can include a plain text rendering of an order directly within an email. Some desire this over an attachment



28
29
30
 
# File 'lib/ultracart_api/models/notification.rb', line 28

def can_include_order_plain_text
  @can_include_order_plain_text
end

#distribution_center_filters ⇒ Object

If this notification supports it, this list of distribution center CODES will filter the notification to just those distribution centers.



31
32
33
 
# File 'lib/ultracart_api/models/notification.rb', line 31

def distribution_center_filters
  @distribution_center_filters
end

#include_affiliate ⇒ Object

If true, and this notification supports it, affiliate information will be attached to all notifications of this type



34
35
36
 
# File 'lib/ultracart_api/models/notification.rb', line 34

def include_affiliate
  @include_affiliate
end

#include_order ⇒ Object

If true, and this notification supports it, the order will be attached to all notifications of this type



37
38
39
 
# File 'lib/ultracart_api/models/notification.rb', line 37

def include_order
  @include_order
end

#include_order_plain_text ⇒ Object

If true, and this notification supports it, a plain text order will be directly inserted into all notifications of this type



40
41
42
 
# File 'lib/ultracart_api/models/notification.rb', line 40

def include_order_plain_text
  @include_order_plain_text
end

#name ⇒ Object

The name of this notification.



43
44
45
 
# File 'lib/ultracart_api/models/notification.rb', line 43

def name
  @name
end

#notification_group ⇒ Object

A group for this notification. This name is only used for visual grouping within interfaces.



46
47
48
 
# File 'lib/ultracart_api/models/notification.rb', line 46

def notification_group
  @notification_group
end

#selected ⇒ Object

True if this user wishes to receive this email notification.



49
50
51
 
# File 'lib/ultracart_api/models/notification.rb', line 49

def selected
  @selected
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/ultracart_api/models/notification.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ultracart_api/models/notification.rb', line 52

def self.attribute_map
  {
    :'can_filter_by_distribution_centers' => :'can_filter_by_distribution_centers',
    :'can_include_affiliate' => :'can_include_affiliate',
    :'can_include_order' => :'can_include_order',
    :'can_include_order_plain_text' => :'can_include_order_plain_text',
    :'distribution_center_filters' => :'distribution_center_filters',
    :'include_affiliate' => :'include_affiliate',
    :'include_order' => :'include_order',
    :'include_order_plain_text' => :'include_order_plain_text',
    :'name' => :'name',
    :'notification_group' => :'notification_group',
    :'selected' => :'selected'
  }
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



204
205
206
 
# File 'lib/ultracart_api/models/notification.rb', line 204

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/ultracart_api/models/notification.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/notification.rb', line 74

def self.openapi_types
  {
    :'can_filter_by_distribution_centers' => :'Boolean',
    :'can_include_affiliate' => :'Boolean',
    :'can_include_order' => :'Boolean',
    :'can_include_order_plain_text' => :'Boolean',
    :'distribution_center_filters' => :'Array<String>',
    :'include_affiliate' => :'Boolean',
    :'include_order' => :'Boolean',
    :'include_order_plain_text' => :'Boolean',
    :'name' => :'String',
    :'notification_group' => :'String',
    :'selected' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ultracart_api/models/notification.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      can_filter_by_distribution_centers == o.can_filter_by_distribution_centers &&
      can_include_affiliate == o.can_include_affiliate &&
      can_include_order == o.can_include_order &&
      can_include_order_plain_text == o.can_include_order_plain_text &&
      distribution_center_filters == o.distribution_center_filters &&
      include_affiliate == o.include_affiliate &&
      include_order == o.include_order &&
      include_order_plain_text == o.include_order_plain_text &&
      name == o.name &&
      notification_group == o.notification_group &&
      selected == o.selected
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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/notification.rb', line 235

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/ultracart_api/models/notification.rb', line 306

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ultracart_api/models/notification.rb', line 211

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/ultracart_api/models/notification.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/ultracart_api/models/notification.rb', line 197

def hash
  [can_filter_by_distribution_centers, can_include_affiliate, can_include_order, can_include_order_plain_text, distribution_center_filters, include_affiliate, include_order, include_order_plain_text, name, notification_group, selected].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



160
161
162
163
 
# File 'lib/ultracart_api/models/notification.rb', line 160

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



282
283
284
 
# File 'lib/ultracart_api/models/notification.rb', line 282

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



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

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



276
277
278
 
# File 'lib/ultracart_api/models/notification.rb', line 276

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



167
168
169
 
# File 'lib/ultracart_api/models/notification.rb', line 167

def valid?
  true
end