Class: UltracartClient::WebhookEventSubscription

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookEventSubscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
142
143
144
145
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 93

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

Comment about the event to provide further clarification to the end user



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

def comments
  @comments
end

#deprecated_flag ⇒ Object

True if the event is deprecated. See the API change log for details on when it will be discontinued.



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

def deprecated_flag
  @deprecated_flag
end

#discontinued_flag ⇒ Object

True if the event is discontinued. See the API change log for details on migration details.



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

def discontinued_flag
  @discontinued_flag
end

#event_description ⇒ Object

Description of the event



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

def event_description
  @event_description
end

#event_name ⇒ Object

Event name



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

def event_name
  @event_name
end

#event_ruler ⇒ Object

Optional - Event ruler expression to filter events to. Only events that match this Ruler expression will be transmitted to the webhook.



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

def event_ruler
  @event_ruler
end

#expansion ⇒ Object

The expand string for the notification object. See the individual resource _expand documentation for valid values.



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

def expansion
  @expansion
end

#subscribed ⇒ Object

True if this is event is subscribed to



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

def subscribed
  @subscribed
end

#supports_reflow ⇒ Object

True if the event can be triggered to reflow existing records



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

def supports_reflow
  @supports_reflow
end

#webhook_event_oid ⇒ Object

The webhook event object identifier



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

def webhook_event_oid
  @webhook_event_oid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 49

def self.attribute_map
  {
    :'comments' => :'comments',
    :'deprecated_flag' => :'deprecated_flag',
    :'discontinued_flag' => :'discontinued_flag',
    :'event_description' => :'event_description',
    :'event_name' => :'event_name',
    :'event_ruler' => :'event_ruler',
    :'expansion' => :'expansion',
    :'subscribed' => :'subscribed',
    :'supports_reflow' => :'supports_reflow',
    :'webhook_event_oid' => :'webhook_event_oid'
  }
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



192
193
194
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 192

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 70

def self.openapi_types
  {
    :'comments' => :'String',
    :'deprecated_flag' => :'Boolean',
    :'discontinued_flag' => :'Boolean',
    :'event_description' => :'String',
    :'event_name' => :'String',
    :'event_ruler' => :'String',
    :'expansion' => :'String',
    :'subscribed' => :'Boolean',
    :'supports_reflow' => :'Boolean',
    :'webhook_event_oid' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comments == o.comments &&
      deprecated_flag == o.deprecated_flag &&
      discontinued_flag == o.discontinued_flag &&
      event_description == o.event_description &&
      event_name == o.event_name &&
      event_ruler == o.event_ruler &&
      expansion == o.expansion &&
      subscribed == o.subscribed &&
      supports_reflow == o.supports_reflow &&
      webhook_event_oid == o.webhook_event_oid
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



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
255
256
257
258
259
260
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 223

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 294

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 199

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


179
180
181
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 185

def hash
  [comments, deprecated_flag, discontinued_flag, event_description, event_name, event_ruler, expansion, subscribed, supports_reflow, webhook_event_oid].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



149
150
151
152
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 149

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



270
271
272
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 270

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 276

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



264
265
266
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 264

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



156
157
158
 
# File 'lib/ultracart_api/models/webhook_event_subscription.rb', line 156

def valid?
  true
end