Class: YousignClient::ProcedureOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/models/procedure_output.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcedureOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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
 
# File 'lib/yousign_client/models/procedure_output.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'archive')
    self.archive = attributes[:'archive']
  else
    self.archive = false
  end
end

Instance Attribute Details

#archive ⇒ Object

Defines if the files of the procedure must be archived (Workspace should be allowed)



72
73
74
 
# File 'lib/yousign_client/models/procedure_output.rb', line 72

def archive
  @archive
end

#config ⇒ Object

Returns the value of attribute config.



61
62
63
 
# File 'lib/yousign_client/models/procedure_output.rb', line 61

def config
  @config
end

#created_at ⇒ Object

Created date of the object



27
28
29
 
# File 'lib/yousign_client/models/procedure_output.rb', line 27

def created_at
  @created_at
end

#creator ⇒ Object

Id of creator of the object



39
40
41
 
# File 'lib/yousign_client/models/procedure_output.rb', line 39

def creator
  @creator
end

#creator_first_name ⇒ Object

The creator’s first name



42
43
44
 
# File 'lib/yousign_client/models/procedure_output.rb', line 42

def creator_first_name
  @creator_first_name
end

#creator_last_name ⇒ Object

The creator’s last name



45
46
47
 
# File 'lib/yousign_client/models/procedure_output.rb', line 45

def creator_last_name
  @creator_last_name
end

#description ⇒ Object

Description of procedure



24
25
26
 
# File 'lib/yousign_client/models/procedure_output.rb', line 24

def description
  @description
end

#expires_at ⇒ Object

Expiration date. The procedure will be out of usage after this date.



33
34
35
 
# File 'lib/yousign_client/models/procedure_output.rb', line 33

def expires_at
  @expires_at
end

#files ⇒ Object

List of files used in the procedure.



66
67
68
 
# File 'lib/yousign_client/models/procedure_output.rb', line 66

def files
  @files
end

#id ⇒ Object

Id of the object



18
19
20
 
# File 'lib/yousign_client/models/procedure_output.rb', line 18

def id
  @id
end

#members ⇒ Object

Returns the value of attribute members.



63
64
65
 
# File 'lib/yousign_client/models/procedure_output.rb', line 63

def members
  @members
end

#metadata ⇒ Object

Returns the value of attribute metadata.



59
60
61
 
# File 'lib/yousign_client/models/procedure_output.rb', line 59

def metadata
  @metadata
end

#name ⇒ Object

Name of procedure



21
22
23
 
# File 'lib/yousign_client/models/procedure_output.rb', line 21

def name
  @name
end

#ordered ⇒ Object

Defines an order for the procedure process. If true, position of each member will be used to define the validation workflow.



54
55
56
 
# File 'lib/yousign_client/models/procedure_output.rb', line 54

def ordered
  @ordered
end

#parent ⇒ Object

Id of a procedure template used to get all properties of the template in the new procedure. If you set other properties, they will be replaced. If you don’t set other properties, all properties will be cloned.



57
58
59
 
# File 'lib/yousign_client/models/procedure_output.rb', line 57

def parent
  @parent
end

#related_files_enable ⇒ Object

Defines if related files are available.



69
70
71
 
# File 'lib/yousign_client/models/procedure_output.rb', line 69

def related_files_enable
  @related_files_enable
end

#status ⇒ Object

Status of the procedure



36
37
38
 
# File 'lib/yousign_client/models/procedure_output.rb', line 36

def status
  @status
end

#template ⇒ Object

Defines if the procedure is a template (if true). A template could be used by a procedure to get all properties of the template. Check parent parameter for more information.



51
52
53
 
# File 'lib/yousign_client/models/procedure_output.rb', line 51

def template
  @template
end

#updated_at ⇒ Object

Updated date of the object



30
31
32
 
# File 'lib/yousign_client/models/procedure_output.rb', line 30

def updated_at
  @updated_at
end

#workspace ⇒ Object

Id of workspace creator of the object



48
49
50
 
# File 'lib/yousign_client/models/procedure_output.rb', line 48

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/yousign_client/models/procedure_output.rb', line 97

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'expires_at' => :'expiresAt',
    :'status' => :'status',
    :'creator' => :'creator',
    :'creator_first_name' => :'creatorFirstName',
    :'creator_last_name' => :'creatorLastName',
    :'workspace' => :'workspace',
    :'template' => :'template',
    :'ordered' => :'ordered',
    :'parent' => :'parent',
    :'metadata' => :'metadata',
    :'config' => :'config',
    :'members' => :'members',
    :'files' => :'files',
    :'related_files_enable' => :'relatedFilesEnable',
    :'archive' => :'archive'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/yousign_client/models/procedure_output.rb', line 123

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'expires_at' => :'DateTime',
    :'status' => :'String',
    :'creator' => :'String',
    :'creator_first_name' => :'String',
    :'creator_last_name' => :'String',
    :'workspace' => :'String',
    :'template' => :'BOOLEAN',
    :'ordered' => :'BOOLEAN',
    :'parent' => :'String',
    :'metadata' => :'ProcedureOutputMetadata',
    :'config' => :'ProcedureConfig',
    :'members' => :'Array<MemberOutput>',
    :'files' => :'Array<FileOutput>',
    :'related_files_enable' => :'BOOLEAN',
    :'archive' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/yousign_client/models/procedure_output.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      expires_at == o.expires_at &&
      status == o.status &&
      creator == o.creator &&
      creator_first_name == o.creator_first_name &&
      creator_last_name == o.creator_last_name &&
      workspace == o.workspace &&
      template == o.template &&
      ordered == o.ordered &&
      parent == o.parent &&
      metadata == o.metadata &&
      config == o.config &&
      members == o.members &&
      files == o.files &&
      related_files_enable == o.related_files_enable &&
      archive == o.archive
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/yousign_client/models/procedure_output.rb', line 331

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 = YousignClient.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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/yousign_client/models/procedure_output.rb', line 397

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/yousign_client/models/procedure_output.rb', line 310

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


297
298
299
 
# File 'lib/yousign_client/models/procedure_output.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/yousign_client/models/procedure_output.rb', line 303

def hash
  [id, name, description, created_at, updated_at, expires_at, status, creator, creator_first_name, creator_last_name, workspace, template, ordered, parent, metadata, config, members, files, related_files_enable, archive].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



245
246
247
248
 
# File 'lib/yousign_client/models/procedure_output.rb', line 245

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



377
378
379
 
# File 'lib/yousign_client/models/procedure_output.rb', line 377

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/yousign_client/models/procedure_output.rb', line 383

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



371
372
373
 
# File 'lib/yousign_client/models/procedure_output.rb', line 371

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



252
253
254
255
256
 
# File 'lib/yousign_client/models/procedure_output.rb', line 252

def valid?
  status_validator = EnumAttributeValidator.new('String', ['draft', 'active', 'finished', 'expired', 'refused'])
  return false unless status_validator.valid?(@status)
  true
end