Class: YousignClient::ProcedureInput

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcedureInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
 
# File 'lib/yousign_client/models/procedure_input.rb', line 84

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

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

  if attributes.has_key?(:'expiresAt')
    self.expires_at = attributes[:'expiresAt']
  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?(:'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?(:'start')
    self.start = attributes[:'start']
  else
    self.start = true
  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 (Organization should be allowed)



46
47
48
 
# File 'lib/yousign_client/models/procedure_input.rb', line 46

def archive
  @archive
end

#config ⇒ Object

Returns the value of attribute config.



34
35
36
 
# File 'lib/yousign_client/models/procedure_input.rb', line 34

def config
  @config
end

#description ⇒ Object

Description of procedure



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

def description
  @description
end

#expires_at ⇒ Object

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



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

def expires_at
  @expires_at
end

#members ⇒ Object

List of members, REQUIRED if start field is true.



37
38
39
 
# File 'lib/yousign_client/models/procedure_input.rb', line 37

def members
  @members
end

#metadata ⇒ Object

Returns the value of attribute metadata.



32
33
34
 
# File 'lib/yousign_client/models/procedure_input.rb', line 32

def metadata
  @metadata
end

#name ⇒ Object

Name of procedure



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

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.



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

def ordered
  @ordered
end

#related_files_enable ⇒ Object

Defines if related files are available. Used only for organization that have this option.



43
44
45
 
# File 'lib/yousign_client/models/procedure_input.rb', line 43

def related_files_enable
  @related_files_enable
end

#start ⇒ Object

Defines if the procedure has been started. If false, the procedure status will be draft.



40
41
42
 
# File 'lib/yousign_client/models/procedure_input.rb', line 40

def start
  @start
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.



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

def template
  @template
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/yousign_client/models/procedure_input.rb', line 49

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'expires_at' => :'expiresAt',
    :'template' => :'template',
    :'ordered' => :'ordered',
    :'metadata' => :'metadata',
    :'config' => :'config',
    :'members' => :'members',
    :'start' => :'start',
    :'related_files_enable' => :'relatedFilesEnable',
    :'archive' => :'archive'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/yousign_client/models/procedure_input.rb', line 66

def self.swagger_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'expires_at' => :'Date',
    :'template' => :'BOOLEAN',
    :'ordered' => :'BOOLEAN',
    :'metadata' => :'ProcedureInputMetadata',
    :'config' => :'ProcedureConfig',
    :'members' => :'Array<MemberInput>',
    :'start' => :'BOOLEAN',
    :'related_files_enable' => :'BOOLEAN',
    :'archive' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/yousign_client/models/procedure_input.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      expires_at == o.expires_at &&
      template == o.template &&
      ordered == o.ordered &&
      metadata == o.metadata &&
      config == o.config &&
      members == o.members &&
      start == o.start &&
      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



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
242
243
244
 
# File 'lib/yousign_client/models/procedure_input.rb', line 208

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/yousign_client/models/procedure_input.rb', line 274

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/yousign_client/models/procedure_input.rb', line 187

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


174
175
176
 
# File 'lib/yousign_client/models/procedure_input.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/yousign_client/models/procedure_input.rb', line 180

def hash
  [name, description, expires_at, template, ordered, metadata, config, members, start, 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



143
144
145
146
 
# File 'lib/yousign_client/models/procedure_input.rb', line 143

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



254
255
256
 
# File 'lib/yousign_client/models/procedure_input.rb', line 254

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



260
261
262
263
264
265
266
267
268
 
# File 'lib/yousign_client/models/procedure_input.rb', line 260

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



248
249
250
 
# File 'lib/yousign_client/models/procedure_input.rb', line 248

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



150
151
152
 
# File 'lib/yousign_client/models/procedure_input.rb', line 150

def valid?
  true
end