Class: DocuSign_Maestro::WorkflowStepHistory
- Inherits:
-
Object
- Object
- DocuSign_Maestro::WorkflowStepHistory
- Defined in:
- lib/docusign_maestro/models/workflow_step_history.rb
Overview
Details (history) of a Workflow Instance Step
Instance Attribute Summary collapse
-
#account_id ⇒ Object
Returns the value of attribute account_id.
-
#dac_id ⇒ Object
Returns the value of attribute dac_id.
-
#ds_step_id ⇒ Object
Returns the value of attribute ds_step_id.
-
#end_date ⇒ Object
Track the End time of the Workflow Step.
-
#error ⇒ Object
Returns the value of attribute error.
-
#output_module_properties ⇒ Object
Returns the value of attribute output_module_properties.
-
#start_date ⇒ Object
Track the Start time of the Workflow Step.
-
#step_id ⇒ Object
The Step Id of the workflow step in the workflow instance.
-
#step_name ⇒ Object
Name of the workflow step (DS Scope).
-
#step_state ⇒ Object
Returns the value of attribute step_state.
-
#user_id ⇒ Object
Returns the value of attribute user_id.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ WorkflowStepHistory
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
permalink #initialize(attributes = {}) ⇒ WorkflowStepHistory
Initializes the object
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 79 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?(:'accountId') self.account_id = attributes[:'accountId'] end if attributes.has_key?(:'dacId') self.dac_id = attributes[:'dacId'] end if attributes.has_key?(:'dsStepId') self.ds_step_id = attributes[:'dsStepId'] end if attributes.has_key?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'error') self.error = attributes[:'error'] end if attributes.has_key?(:'outputModuleProperties') self.output_module_properties = attributes[:'outputModuleProperties'] end if attributes.has_key?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'stepId') self.step_id = attributes[:'stepId'] end if attributes.has_key?(:'stepName') self.step_name = attributes[:'stepName'] end if attributes.has_key?(:'stepState') self.step_state = attributes[:'stepState'] end if attributes.has_key?(:'userId') self.user_id = attributes[:'userId'] end end |
Instance Attribute Details
permalink #account_id ⇒ Object
Returns the value of attribute account_id.
17 18 19 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 17 def account_id @account_id end |
permalink #dac_id ⇒ Object
Returns the value of attribute dac_id.
19 20 21 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 19 def dac_id @dac_id end |
permalink #ds_step_id ⇒ Object
Returns the value of attribute ds_step_id.
21 22 23 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 21 def ds_step_id @ds_step_id end |
permalink #end_date ⇒ Object
Track the End time of the Workflow Step
24 25 26 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 24 def end_date @end_date end |
permalink #error ⇒ Object
Returns the value of attribute error.
26 27 28 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 26 def error @error end |
permalink #output_module_properties ⇒ Object
Returns the value of attribute output_module_properties.
28 29 30 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 28 def output_module_properties @output_module_properties end |
permalink #start_date ⇒ Object
Track the Start time of the Workflow Step
31 32 33 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 31 def start_date @start_date end |
permalink #step_id ⇒ Object
The Step Id of the workflow step in the workflow instance
34 35 36 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 34 def step_id @step_id end |
permalink #step_name ⇒ Object
Name of the workflow step (DS Scope)
37 38 39 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 37 def step_name @step_name end |
permalink #step_state ⇒ Object
Returns the value of attribute step_state.
39 40 41 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 39 def step_state @step_state end |
permalink #user_id ⇒ Object
Returns the value of attribute user_id.
41 42 43 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 41 def user_id @user_id end |
Class Method Details
permalink .attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 44 def self.attribute_map { :'account_id' => :'accountId', :'dac_id' => :'dacId', :'ds_step_id' => :'dsStepId', :'end_date' => :'endDate', :'error' => :'error', :'output_module_properties' => :'outputModuleProperties', :'start_date' => :'startDate', :'step_id' => :'stepId', :'step_name' => :'stepName', :'step_state' => :'stepState', :'user_id' => :'userId' } end |
permalink .swagger_types ⇒ Object
Attribute type mapping.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 61 def self.swagger_types { :'account_id' => :'String', :'dac_id' => :'String', :'ds_step_id' => :'String', :'end_date' => :'DateTime', :'error' => :'WorkflowStepError', :'output_module_properties' => :'Object', :'start_date' => :'DateTime', :'step_id' => :'String', :'step_name' => :'String', :'step_state' => :'WorkflowStepHistoryState', :'user_id' => :'String' } end |
Instance Method Details
permalink #==(o) ⇒ Object
Checks equality by comparing each attribute.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 165 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && dac_id == o.dac_id && ds_step_id == o.ds_step_id && end_date == o.end_date && error == o.error && output_module_properties == o.output_module_properties && start_date == o.start_date && step_id == o.step_id && step_name == o.step_name && step_state == o.step_state && user_id == o.user_id end |
permalink #_deserialize(type, value) ⇒ Object
Deserializes the data based on type
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 217 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 |
permalink #_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 283 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 |
permalink #build_from_hash(attributes) ⇒ Object
Builds the object from hash
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 196 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 |
permalink #eql?(o) ⇒ Boolean
183 184 185 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 183 def eql?(o) self == o end |
permalink #hash ⇒ Fixnum
Calculates hash code according to all attributes.
189 190 191 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 189 def hash [account_id, dac_id, ds_step_id, end_date, error, output_module_properties, start_date, step_id, step_name, step_state, user_id].hash end |
permalink #list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 132 def list_invalid_properties invalid_properties = Array.new if @dac_id.nil? invalid_properties.push('invalid value for "dac_id", dac_id cannot be nil.') end if @step_name.nil? invalid_properties.push('invalid value for "step_name", step_name cannot be nil.') end if @step_state.nil? invalid_properties.push('invalid value for "step_state", step_state cannot be nil.') end if @user_id.nil? invalid_properties.push('invalid value for "user_id", user_id cannot be nil.') end invalid_properties end |
permalink #to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
263 264 265 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 263 def to_body to_hash end |
permalink #to_hash ⇒ Hash
Returns the object in the form of hash
269 270 271 272 273 274 275 276 277 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 269 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 |
permalink #to_s ⇒ String
Returns the string representation of the object
257 258 259 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 257 def to_s to_hash.to_s end |
permalink #valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
155 156 157 158 159 160 161 |
# File 'lib/docusign_maestro/models/workflow_step_history.rb', line 155 def valid? return false if @dac_id.nil? return false if @step_name.nil? return false if @step_state.nil? return false if @user_id.nil? true end |