class DocuSign_eSign::WorkflowStep

Describes a single step in a workflow.

Attributes

action[RW]
completed_date[RW]
delayed_routing[RW]

A complex element that specifies the delayed routing settings for the workflow step.

item_id[RW]
recipient_routing[RW]

The rules for recipient routing.

status[RW]

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

trigger_on_item[RW]
triggered_date[RW]
workflow_step_id[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/workflow_step.rb, line 45
def self.attribute_map
  {
    :'action' => :'action',
    :'completed_date' => :'completedDate',
    :'delayed_routing' => :'delayedRouting',
    :'item_id' => :'itemId',
    :'recipient_routing' => :'recipientRouting',
    :'status' => :'status',
    :'triggered_date' => :'triggeredDate',
    :'trigger_on_item' => :'triggerOnItem',
    :'workflow_step_id' => :'workflowStepId'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_esign/models/workflow_step.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?(:'action')
    self.action = attributes[:'action']
  end

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/docusign_esign/models/workflow_step.rb, line 60
def self.swagger_types
  {
    :'action' => :'String',
    :'completed_date' => :'String',
    :'delayed_routing' => :'DelayedRouting',
    :'item_id' => :'String',
    :'recipient_routing' => :'RecipientRouting',
    :'status' => :'String',
    :'triggered_date' => :'String',
    :'trigger_on_item' => :'String',
    :'workflow_step_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/docusign_esign/models/workflow_step.rb, line 134
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      completed_date == o.completed_date &&
      delayed_routing == o.delayed_routing &&
      item_id == o.item_id &&
      recipient_routing == o.recipient_routing &&
      status == o.status &&
      triggered_date == o.triggered_date &&
      trigger_on_item == o.trigger_on_item &&
      workflow_step_id == o.workflow_step_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/docusign_esign/models/workflow_step.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 = DocuSign_eSign.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.rb, line 156
def hash
  [action, completed_date, delayed_routing, item_id, recipient_routing, status, triggered_date, trigger_on_item, workflow_step_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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.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/docusign_esign/models/workflow_step.rb, line 128
def valid?
  true
end