class ApproveAPISwagger::CreatePromptRequest

Attributes

approve_text[RW]

The approve action text. Defaults to 'Approve'.

body[RW]

The body of the approval request to show the user.

long_poll[RW]

If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.

metadata[RW]
reject_text[RW]

The reject action text. Defaults to 'Reject'.

title[RW]

The title of an approval request. Defaults to an empty string.

user[RW]

The user to send the approval request to. Can be either an email address or a phone number.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/approveapi_swagger/models/create_prompt_request.rb, line 38
def self.attribute_map
  {
    :'body' => :'body',
    :'user' => :'user',
    :'title' => :'title',
    :'reject_text' => :'reject_text',
    :'approve_text' => :'approve_text',
    :'metadata' => :'metadata',
    :'long_poll' => :'long_poll'
  }
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/approveapi_swagger/models/create_prompt_request.rb, line 152
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/approveapi_swagger/models/create_prompt_request.rb, line 65
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?(:'body')
    self.body = attributes[:'body']
  end

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

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

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

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

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

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

Attribute type mapping.

# File lib/approveapi_swagger/models/create_prompt_request.rb, line 51
def self.openapi_types
  {
    :'body' => :'String',
    :'user' => :'String',
    :'title' => :'String',
    :'reject_text' => :'String',
    :'approve_text' => :'String',
    :'metadata' => :'PromptMetadata',
    :'long_poll' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/approveapi_swagger/models/create_prompt_request.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      user == o.user &&
      title == o.title &&
      reject_text == o.reject_text &&
      approve_text == o.approve_text &&
      metadata == o.metadata &&
      long_poll == o.long_poll
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/approveapi_swagger/models/create_prompt_request.rb, line 180
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
    ApproveAPISwagger.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/approveapi_swagger/models/create_prompt_request.rb, line 245
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/approveapi_swagger/models/create_prompt_request.rb, line 159
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/approveapi_swagger/models/create_prompt_request.rb, line 139
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/approveapi_swagger/models/create_prompt_request.rb, line 145
def hash
  [body, user, title, reject_text, approve_text, metadata, long_poll].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/approveapi_swagger/models/create_prompt_request.rb, line 102
def list_invalid_properties
  invalid_properties = Array.new
  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

  if @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

  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/approveapi_swagger/models/create_prompt_request.rb, line 225
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/approveapi_swagger/models/create_prompt_request.rb, line 231
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/approveapi_swagger/models/create_prompt_request.rb, line 219
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/approveapi_swagger/models/create_prompt_request.rb, line 117
def valid?
  return false if @body.nil?
  return false if @user.nil?
  true
end