Class: DocuSign_Maestro::WorkflowDefinitionWithId

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

Overview

A DS workflow definition with metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowDefinitionWithId

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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
131
132
133
134
135
136
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 81

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'workflowDefinition')
    self.workflow_definition = attributes[:'workflowDefinition']
  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_with_id.rb', line 17

def 
  @account_id
end

#created_date ⇒ Object

The date the workflow was created


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

def created_date
  @created_date
end

#id ⇒ Object

Returns the value of attribute id.


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

def id
  @id
end

#is_draft ⇒ Object

Returns the value of attribute is_draft.


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

def is_draft
  @is_draft
end

#last_deployed_id ⇒ Object

Returns the value of attribute last_deployed_id.


26
27
28
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 26

def last_deployed_id
  @last_deployed_id
end

#last_deployed_version ⇒ Object

Returns the value of attribute last_deployed_version.


28
29
30
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 28

def last_deployed_version
  @last_deployed_version
end

#last_deployed_workflow_definition ⇒ Object

Returns the value of attribute last_deployed_workflow_definition.


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

def last_deployed_workflow_definition
  @last_deployed_workflow_definition
end

#last_updated_date ⇒ Object

The date the workflow was last updated


33
34
35
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 33

def last_updated_date
  @last_updated_date
end

#status ⇒ Object

Returns the value of attribute status.


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

def status
  @status
end

#trigger_url ⇒ Object

Returns the value of attribute trigger_url.


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

def trigger_url
  @trigger_url
end

#validation_errors ⇒ Object

Returns the value of attribute validation_errors.


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

def validation_errors
  @validation_errors
end

#workflow_definition ⇒ Object

Returns the value of attribute workflow_definition.


41
42
43
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 41

def workflow_definition
  @workflow_definition
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 44

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'created_date' => :'createdDate',
    :'id' => :'id',
    :'is_draft' => :'isDraft',
    :'last_deployed_id' => :'lastDeployedId',
    :'last_deployed_version' => :'lastDeployedVersion',
    :'last_deployed_workflow_definition' => :'lastDeployedWorkflowDefinition',
    :'last_updated_date' => :'lastUpdatedDate',
    :'status' => :'status',
    :'trigger_url' => :'triggerUrl',
    :'validation_errors' => :'validationErrors',
    :'workflow_definition' => :'workflowDefinition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 62

def self.swagger_types
  {
    :'account_id' => :'String',
    :'created_date' => :'DateTime',
    :'id' => :'String',
    :'is_draft' => :'BOOLEAN',
    :'last_deployed_id' => :'String',
    :'last_deployed_version' => :'String',
    :'last_deployed_workflow_definition' => :'WorkflowDefinition',
    :'last_updated_date' => :'DateTime',
    :'status' => :'WorkflowMetadataStatus',
    :'trigger_url' => :'String',
    :'validation_errors' => :'Array<ValidationErrors>',
    :'workflow_definition' => :'WorkflowDefinition'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      created_date == o.created_date &&
      id == o.id &&
      is_draft == o.is_draft &&
      last_deployed_id == o.last_deployed_id &&
      last_deployed_version == o.last_deployed_version &&
      last_deployed_workflow_definition == o.last_deployed_workflow_definition &&
      last_updated_date == o.last_updated_date &&
      status == o.status &&
      trigger_url == o.trigger_url &&
      validation_errors == o.validation_errors &&
      workflow_definition == o.workflow_definition
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]

211
212
213
214
215
216
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
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 211

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]

277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 277

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]

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

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]

177
178
179
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

183
184
185
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 183

def hash
  [, created_date, id, is_draft, last_deployed_id, last_deployed_version, last_deployed_workflow_definition, last_updated_date, status, trigger_url, validation_errors, workflow_definition].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]

140
141
142
143
144
145
146
147
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id 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]

257
258
259
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 257

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]

263
264
265
266
267
268
269
270
271
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 263

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]

251
252
253
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 251

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]

151
152
153
154
 
# File 'lib/docusign_maestro/models/workflow_definition_with_id.rb', line 151

def valid?
  return false if @id.nil?
  true
end