Class: AmzSpApi::NotificationsApiModel::EventFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/notifications-api-model/models/event_filter.rb

Overview

A notificationType specific filter. This object contains all of the currently available filters and properties that you can use to define a notificationType specific filter.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/notifications-api-model/models/event_filter.rb', line 50

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::NotificationsApiModel::EventFilter` 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 `AmzSpApi::NotificationsApiModel::EventFilter`. 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
  }

  # call parent's initialize
  super(attributes)

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

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

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

Instance Attribute Details

#aggregation_settingsObject

Returns the value of attribute aggregation_settings.



19
20
21
# File 'lib/notifications-api-model/models/event_filter.rb', line 19

def aggregation_settings
  @aggregation_settings
end

#event_filter_typeObject

An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. Refer to the section of the [Notifications Use Case Guide](doc:notifications-api-v1-use-case-guide) that describes the specific notificationType to determine if an eventFilterType is supported.



22
23
24
# File 'lib/notifications-api-model/models/event_filter.rb', line 22

def event_filter_type
  @event_filter_type
end

#marketplace_idsObject

Returns the value of attribute marketplace_ids.



17
18
19
# File 'lib/notifications-api-model/models/event_filter.rb', line 17

def marketplace_ids
  @marketplace_ids
end

Class Method Details

.attribute_mapObject

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



25
26
27
28
29
30
31
# File 'lib/notifications-api-model/models/event_filter.rb', line 25

def self.attribute_map
  {
    :'marketplace_ids' => :'marketplaceIds',
    :'aggregation_settings' => :'aggregationSettings',
    :'event_filter_type' => :'eventFilterType'
  }
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



122
123
124
# File 'lib/notifications-api-model/models/event_filter.rb', line 122

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

.openapi_nullableObject

List of attributes with nullable: true



43
44
45
46
# File 'lib/notifications-api-model/models/event_filter.rb', line 43

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

.openapi_typesObject

Attribute type mapping.



34
35
36
37
38
39
40
# File 'lib/notifications-api-model/models/event_filter.rb', line 34

def self.openapi_types
  {
    :'marketplace_ids' => :'',
    :'aggregation_settings' => :'',
    :'event_filter_type' => :''
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



99
100
101
102
103
104
105
# File 'lib/notifications-api-model/models/event_filter.rb', line 99

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      marketplace_ids == o.marketplace_ids &&
      aggregation_settings == o.aggregation_settings &&
      event_filter_type == o.event_filter_type && super(o)
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/notifications-api-model/models/event_filter.rb', line 153

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
    AmzSpApi::NotificationsApiModel.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



222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/notifications-api-model/models/event_filter.rb', line 222

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/notifications-api-model/models/event_filter.rb', line 129

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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


109
110
111
# File 'lib/notifications-api-model/models/event_filter.rb', line 109

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



115
116
117
# File 'lib/notifications-api-model/models/event_filter.rb', line 115

def hash
  [marketplace_ids, aggregation_settings, event_filter_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



81
82
83
84
85
86
87
88
# File 'lib/notifications-api-model/models/event_filter.rb', line 81

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



198
199
200
# File 'lib/notifications-api-model/models/event_filter.rb', line 198

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/notifications-api-model/models/event_filter.rb', line 204

def to_hash
  hash = super
  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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



192
193
194
# File 'lib/notifications-api-model/models/event_filter.rb', line 192

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



92
93
94
95
# File 'lib/notifications-api-model/models/event_filter.rb', line 92

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