Class: AmznSpApi::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

Raises:

  • (ArgumentError) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 45

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::NotificationsApiModel::EventFilter` initialize method' unless attributes.is_a?(Hash)

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

    h[k.to_sym] = v
  end

  # call parent's initialize
  super(attributes)

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

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

  return unless attributes.key?(:event_filter_type)

  self.event_filter_type = attributes[:event_filter_type]
end

Instance Attribute Details

#aggregation_settings ⇒ Object

Returns the value of attribute aggregation_settings.



15
16
17
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 15

def aggregation_settings
  @aggregation_settings
end

#event_filter_type ⇒ Object

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.



18
19
20
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 18

def event_filter_type
  @event_filter_type
end

#marketplace_ids ⇒ Object

Returns the value of attribute marketplace_ids.



15
16
17
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 15

def marketplace_ids
  @marketplace_ids
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 21

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



110
111
112
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 110

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



39
40
41
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 39

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

.openapi_types ⇒ Object

Attribute type mapping.



30
31
32
33
34
35
36
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 30

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



86
87
88
89
90
91
92
93
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 86

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    marketplace_ids == other.marketplace_ids &&
    aggregation_settings == other.aggregation_settings &&
    event_filter_type == other.event_filter_type && super(other)
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



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
171
172
173
174
175
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 140

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
    AmznSpApi::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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 209

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 117

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



103
104
105
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 103

def hash
  [marketplace_ids, aggregation_settings, event_filter_type].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



69
70
71
72
73
74
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 69

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

  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



185
186
187
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 185

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



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 191

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



179
180
181
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 179

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



78
79
80
81
82
 
# File 'lib/notifications_api_model/models/event_filter.rb', line 78

def valid?
  return false if @event_filter_type.nil?

  true
end