Class: DocuSign_Maestro::WorkflowInstance
- Inherits:
-
Object
- Object
- DocuSign_Maestro::WorkflowInstance
- Defined in:
- lib/docusign_maestro/models/workflow_instance.rb
Overview
Details of a Workflow Instance triggered for a Workflow Definition
Instance Attribute Summary collapse
-
#account_id ⇒ Object
Returns the value of attribute account_id.
-
#creator_id ⇒ Object
Returns the value of attribute creator_id.
-
#dac_id ⇒ Object
Returns the value of attribute dac_id.
-
#end_date ⇒ Object
Track the End time of the Workflow Instance.
-
#instance_name ⇒ Object
The friendly name of the particular workflow instance.
-
#instance_state ⇒ Object
Returns the value of attribute instance_state.
-
#progress ⇒ Object
Returns the value of attribute progress.
-
#start_date ⇒ Object
Track the Start time of the Workflow Instance.
-
#started_by ⇒ Object
Returns the value of attribute started_by.
-
#template_id ⇒ Object
Returns the value of attribute template_id.
-
#users ⇒ Object
Contains the list of Users and Steps mapping.
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 = {}) ⇒ WorkflowInstance
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 = {}) ⇒ WorkflowInstance
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 129 130 |
# File 'lib/docusign_maestro/models/workflow_instance.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?(:'creatorId') self.creator_id = attributes[:'creatorId'] end if attributes.has_key?(:'dacId') self.dac_id = attributes[:'dacId'] end if attributes.has_key?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'instanceName') self.instance_name = attributes[:'instanceName'] end if attributes.has_key?(:'instanceState') self.instance_state = attributes[:'instanceState'] end if attributes.has_key?(:'progress') self.progress = attributes[:'progress'] end if attributes.has_key?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'startedBy') self.started_by = attributes[:'startedBy'] end if attributes.has_key?(:'templateId') self.template_id = attributes[:'templateId'] end if attributes.has_key?(:'users') if (value = attributes[:'users']).is_a?(Hash) self.users = value end 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_instance.rb', line 17 def account_id @account_id end |
permalink #creator_id ⇒ Object
Returns the value of attribute creator_id.
19 20 21 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 19 def creator_id @creator_id end |
permalink #dac_id ⇒ Object
Returns the value of attribute dac_id.
21 22 23 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 21 def dac_id @dac_id end |
permalink #end_date ⇒ Object
Track the End time of the Workflow Instance
24 25 26 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 24 def end_date @end_date end |
permalink #instance_name ⇒ Object
The friendly name of the particular workflow instance
27 28 29 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 27 def instance_name @instance_name end |
permalink #instance_state ⇒ Object
Returns the value of attribute instance_state.
29 30 31 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 29 def instance_state @instance_state end |
permalink #progress ⇒ Object
Returns the value of attribute progress.
31 32 33 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 31 def progress @progress end |
permalink #start_date ⇒ Object
Track the Start time of the Workflow Instance
34 35 36 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 34 def start_date @start_date end |
permalink #started_by ⇒ Object
Returns the value of attribute started_by.
36 37 38 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 36 def started_by @started_by end |
permalink #template_id ⇒ Object
Returns the value of attribute template_id.
38 39 40 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 38 def template_id @template_id end |
permalink #users ⇒ Object
Contains the list of Users and Steps mapping
41 42 43 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 41 def users @users 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_instance.rb', line 44 def self.attribute_map { :'account_id' => :'accountId', :'creator_id' => :'creatorId', :'dac_id' => :'dacId', :'end_date' => :'endDate', :'instance_name' => :'instanceName', :'instance_state' => :'instanceState', :'progress' => :'progress', :'start_date' => :'startDate', :'started_by' => :'startedBy', :'template_id' => :'templateId', :'users' => :'users' } 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_instance.rb', line 61 def self.swagger_types { :'account_id' => :'String', :'creator_id' => :'String', :'dac_id' => :'String', :'end_date' => :'DateTime', :'instance_name' => :'String', :'instance_state' => :'WorkflowInstanceState', :'progress' => :'ProgressInstance', :'start_date' => :'DateTime', :'started_by' => :'StartedByInstance', :'template_id' => :'String', :'users' => :'Hash<String, String>' } end |
Instance Method Details
permalink #==(o) ⇒ Object
Checks equality by comparing each attribute.
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 172 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && creator_id == o.creator_id && dac_id == o.dac_id && end_date == o.end_date && instance_name == o.instance_name && instance_state == o.instance_state && progress == o.progress && start_date == o.start_date && started_by == o.started_by && template_id == o.template_id && users == o.users end |
permalink #_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 254 255 256 257 258 259 260 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 224 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
290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 290 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
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 203 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
190 191 192 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 190 def eql?(o) self == o end |
permalink #hash ⇒ Fixnum
Calculates hash code according to all attributes.
196 197 198 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 196 def hash [account_id, creator_id, dac_id, end_date, instance_name, instance_state, progress, start_date, started_by, template_id, users].hash end |
permalink #list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 134 def list_invalid_properties invalid_properties = Array.new if @creator_id.nil? invalid_properties.push('invalid value for "creator_id", creator_id cannot be nil.') end if @dac_id.nil? invalid_properties.push('invalid value for "dac_id", dac_id cannot be nil.') end if @instance_state.nil? invalid_properties.push('invalid value for "instance_state", instance_state cannot be nil.') end if @template_id.nil? invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') end if @users.nil? invalid_properties.push('invalid value for "users", users cannot be nil.') end invalid_properties end |
permalink #to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
270 271 272 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 270 def to_body to_hash end |
permalink #to_hash ⇒ Hash
Returns the object in the form of hash
276 277 278 279 280 281 282 283 284 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 276 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
264 265 266 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 264 def to_s to_hash.to_s end |
permalink #valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
161 162 163 164 165 166 167 168 |
# File 'lib/docusign_maestro/models/workflow_instance.rb', line 161 def valid? return false if @creator_id.nil? return false if @dac_id.nil? return false if @instance_state.nil? return false if @template_id.nil? return false if @users.nil? true end |