Class: DocuSign_Maestro::WorkflowDefinition

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

Overview

A DS workflow definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

75
76
77
78
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
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 75

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. = attributes[:'accountId']
  end

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

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

  if attributes.has_key?(:'participants')
    if (value = attributes[:'participants']).is_a?(Hash)
      self.participants = value
    end
  end

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

  if attributes.has_key?(:'steps')
    if (value = attributes[:'steps']).is_a?(Array)
      self.steps = value
    end
  end

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

  if attributes.has_key?(:'variables')
    if (value = attributes[:'variables']).is_a?(Hash)
      self.variables = value
    end
  end

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.


17
18
19
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 17

def 
  @account_id
end

#created_by_name ⇒ Object

The name of the user who created this workflow definition


20
21
22
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 20

def created_by_name
  @created_by_name
end

#document_version ⇒ Object

Returns the value of attribute document_version.


22
23
24
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 22

def document_version
  @document_version
end

#participants ⇒ Object

A DS Workflow participant record


25
26
27
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 25

def participants
  @participants
end

#schema_version ⇒ Object

Returns the value of attribute schema_version.


27
28
29
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 27

def schema_version
  @schema_version
end

#steps ⇒ Object

A list of #/definitions/DSWorkflowStep. Each element is: A DS Workflow Step. This object should be any of the following object models: [#/definitions/DSServiceStep, #/definitions/DSTransformationStep, #/definitions/DSDocGenStep, #/definitions/DSSignStep]


30
31
32
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 30

def steps
  @steps
end

#trigger ⇒ Object

Returns the value of attribute trigger.


32
33
34
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 32

def trigger
  @trigger
end

#variables ⇒ Object

A DS Workflow variable record


35
36
37
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 35

def variables
  @variables
end

#workflow_description ⇒ Object

Returns the value of attribute workflow_description.


37
38
39
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 37

def workflow_description
  @workflow_description
end

#workflow_name ⇒ Object

Returns the value of attribute workflow_name.


39
40
41
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 39

def workflow_name
  @workflow_name
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 42

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'created_by_name' => :'createdByName',
    :'document_version' => :'documentVersion',
    :'participants' => :'participants',
    :'schema_version' => :'schemaVersion',
    :'steps' => :'steps',
    :'trigger' => :'trigger',
    :'variables' => :'variables',
    :'workflow_description' => :'workflowDescription',
    :'workflow_name' => :'workflowName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 58

def self.swagger_types
  {
    :'account_id' => :'String',
    :'created_by_name' => :'String',
    :'document_version' => :'String',
    :'participants' => :'Hash<String, Participant>',
    :'schema_version' => :'String',
    :'steps' => :'Array<Object>',
    :'trigger' => :'DSWorkflowTrigger',
    :'variables' => :'Hash<String, Object>',
    :'workflow_description' => :'String',
    :'workflow_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      created_by_name == o.created_by_name &&
      document_version == o.document_version &&
      participants == o.participants &&
      schema_version == o.schema_version &&
      steps == o.steps &&
      trigger == o.trigger &&
      variables == o.variables &&
      workflow_description == o.workflow_description &&
      workflow_name == o.workflow_name
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

[View source]

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
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 234

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

[View source]

300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 300

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

[View source]

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 213

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
[View source]

200
201
202
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

206
207
208
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 206

def hash
  [, created_by_name, document_version, participants, schema_version, steps, trigger, variables, workflow_description, workflow_name].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

[View source]

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
161
162
163
164
165
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

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

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

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

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

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

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

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

  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

[View source]

280
281
282
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 280

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

[View source]

286
287
288
289
290
291
292
293
294
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 286

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

[View source]

274
275
276
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 274

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

[View source]

169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/docusign_maestro/models/workflow_definition.rb', line 169

def valid?
  return false if @account_id.nil?
  return false if @document_version.nil?
  return false if @schema_version.nil?
  return false if @steps.nil?
  return false if @trigger.nil?
  return false if @variables.nil?
  return false if @workflow_description.nil?
  return false if @workflow_name.nil?
  true
end