class UltracartClient::WebhookEventSubscription

Attributes

comments[RW]

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

deprecated_flag[RW]

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

discontinued_flag[RW]

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

event_description[RW]

Description of the event

event_name[RW]

Event name

expansion[RW]

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

subscribed[RW]

True if this is event is subscribed to

supports_reflow[RW]

True if the event can be triggered to reflow existing records

webhook_event_oid[RW]

The webhook event object identifier

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 45
def self.attribute_map
  {
    :'comments' => :'comments',
    :'deprecated_flag' => :'deprecated_flag',
    :'discontinued_flag' => :'discontinued_flag',
    :'event_description' => :'event_description',
    :'event_name' => :'event_name',
    :'expansion' => :'expansion',
    :'subscribed' => :'subscribed',
    :'supports_reflow' => :'supports_reflow',
    :'webhook_event_oid' => :'webhook_event_oid'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 76
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'comments')
    self.comments = attributes[:'comments']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'webhook_event_oid')
    self.webhook_event_oid = attributes[:'webhook_event_oid']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 60
def self.swagger_types
  {
    :'comments' => :'String',
    :'deprecated_flag' => :'BOOLEAN',
    :'discontinued_flag' => :'BOOLEAN',
    :'event_description' => :'String',
    :'event_name' => :'String',
    :'expansion' => :'String',
    :'subscribed' => :'BOOLEAN',
    :'supports_reflow' => :'BOOLEAN',
    :'webhook_event_oid' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 134
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 &&
      expansion == o.expansion &&
      subscribed == o.subscribed &&
      supports_reflow == o.supports_reflow &&
      webhook_event_oid == o.webhook_event_oid
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 184
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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 250
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 163
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 150
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 156
def hash
  [comments, deprecated_flag, discontinued_flag, event_description, event_name, expansion, subscribed, supports_reflow, webhook_event_oid].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 230
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 236
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 224
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ultracart_api/models/webhook_event_subscription.rb, line 128
def valid?
  true
end