Class: DocuSign_Maestro::ProgressInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_maestro/models/progress_instance.rb

Overview

The progress information for a workflow instance

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProgressInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 46

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?(:'completedSteps')
    self.completed_steps = attributes[:'completedSteps']
  end

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

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

Instance Attribute Details

#completed_steps ⇒ Object

The number of completed steps for this workflow instance


18
19
20
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 18

def completed_steps
  @completed_steps
end

#current_completed_step_name ⇒ Object

The last completed step name


21
22
23
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 21

def current_completed_step_name
  @current_completed_step_name
end

#total_steps ⇒ Object

The total number of steps for this workflow instance


24
25
26
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 24

def total_steps
  @total_steps
end

Class Method Details

.attribute_map ⇒ Object

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


27
28
29
30
31
32
33
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 27

def self.attribute_map
  {
    :'completed_steps' => :'completedSteps',
    :'current_completed_step_name' => :'currentCompletedStepName',
    :'total_steps' => :'totalSteps'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.


36
37
38
39
40
41
42
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 36

def self.swagger_types
  {
    :'completed_steps' => :'Float',
    :'current_completed_step_name' => :'String',
    :'total_steps' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared


80
81
82
83
84
85
86
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 80

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completed_steps == o.completed_steps &&
      current_completed_step_name == o.current_completed_step_name &&
      total_steps == o.total_steps
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


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 124

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_Maestro.const_get(type).new
    temp_model.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


190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 190

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


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 103

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

90
91
92
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 90

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code


96
97
98
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 96

def hash
  [completed_steps, current_completed_step_name, total_steps].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


67
68
69
70
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 67

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


170
171
172
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 170

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


176
177
178
179
180
181
182
183
184
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 176

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object


164
165
166
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 164

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


74
75
76
 
# File 'lib/docusign_maestro/models/progress_instance.rb', line 74

def valid?
  true
end