class MailSlurpClient::WebhookDto

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See api.mailslurp.com/schemas/webhook-payload for the payload schema.

Attributes

basic_auth[RW]

Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.

created_at[RW]

When the webhook was created

event_name[RW]
id[RW]

ID of the Webhook

inbox_id[RW]

The inbox that the Webhook will be triggered by

method[RW]

HTTP method that your server endpoint must listen for

name[RW]

Name of the webhook

payload_json_schema[RW]

Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method

updated_at[RW]
url[RW]

URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.

user_id[RW]

User ID of the Webhook

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailslurp_client/models/webhook_dto.rb, line 72
def self.attribute_map
  {
    :'basic_auth' => :'basicAuth',
    :'created_at' => :'createdAt',
    :'event_name' => :'eventName',
    :'id' => :'id',
    :'inbox_id' => :'inboxId',
    :'method' => :'method',
    :'name' => :'name',
    :'payload_json_schema' => :'payloadJsonSchema',
    :'updated_at' => :'updatedAt',
    :'url' => :'url',
    :'user_id' => :'userId'
  }
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/mailslurp_client/models/webhook_dto.rb, line 246
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/mailslurp_client/models/webhook_dto.rb, line 113
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookDto` 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 `MailSlurpClient::WebhookDto`. 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?(:'basic_auth')
    self.basic_auth = attributes[:'basic_auth']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/mailslurp_client/models/webhook_dto.rb, line 106
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/mailslurp_client/models/webhook_dto.rb, line 89
def self.openapi_types
  {
    :'basic_auth' => :'Boolean',
    :'created_at' => :'DateTime',
    :'event_name' => :'String',
    :'id' => :'String',
    :'inbox_id' => :'String',
    :'method' => :'String',
    :'name' => :'String',
    :'payload_json_schema' => :'String',
    :'updated_at' => :'DateTime',
    :'url' => :'String',
    :'user_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/mailslurp_client/models/webhook_dto.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      basic_auth == o.basic_auth &&
      created_at == o.created_at &&
      event_name == o.event_name &&
      id == o.id &&
      inbox_id == o.inbox_id &&
      method == o.method &&
      name == o.name &&
      payload_json_schema == o.payload_json_schema &&
      updated_at == o.updated_at &&
      url == o.url &&
      user_id == o.user_id
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/mailslurp_client/models/webhook_dto.rb, line 274
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
    MailSlurpClient.const_get(type).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/mailslurp_client/models/webhook_dto.rb, line 343
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/mailslurp_client/models/webhook_dto.rb, line 253
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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]]))
    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/mailslurp_client/models/webhook_dto.rb, line 233
def eql?(o)
  self == o
end
event_name=(event_name) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] event_name Object to be assigned

# File lib/mailslurp_client/models/webhook_dto.rb, line 195
def event_name=(event_name)
  validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
  unless validator.valid?(event_name)
    fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
  end
  @event_name = event_name
end
hash() click to toggle source

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

# File lib/mailslurp_client/models/webhook_dto.rb, line 239
def hash
  [basic_auth, created_at, event_name, id, inbox_id, method, name, payload_json_schema, updated_at, url, user_id].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/mailslurp_client/models/webhook_dto.rb, line 173
def list_invalid_properties
  invalid_properties = Array.new
  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  invalid_properties
end
method=(method) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] method Object to be assigned

# File lib/mailslurp_client/models/webhook_dto.rb, line 205
def method=(method)
  validator = EnumAttributeValidator.new('String', ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"])
  unless validator.valid?(method)
    fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
  end
  @method = method
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/mailslurp_client/models/webhook_dto.rb, line 319
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/mailslurp_client/models/webhook_dto.rb, line 325
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() click to toggle source

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

# File lib/mailslurp_client/models/webhook_dto.rb, line 313
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/mailslurp_client/models/webhook_dto.rb, line 184
def valid?
  event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
  return false unless event_name_validator.valid?(@event_name)
  method_validator = EnumAttributeValidator.new('String', ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"])
  return false unless method_validator.valid?(@method)
  return false if @updated_at.nil?
  true
end