Class: DocuSign_eSign::LockInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/lock_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LockInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
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
 
# File 'lib/docusign_esign/models/lock_information.rb', line 70

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

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

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

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

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

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

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

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

Instance Attribute Details

#error_details ⇒ Object

Array or errors.



17
18
19
 
# File 'lib/docusign_esign/models/lock_information.rb', line 17

def error_details
  @error_details
end

#lock_duration_in_seconds ⇒ Object

Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.



20
21
22
 
# File 'lib/docusign_esign/models/lock_information.rb', line 20

def lock_duration_in_seconds
  @lock_duration_in_seconds
end

#lock_token ⇒ Object

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.



32
33
34
 
# File 'lib/docusign_esign/models/lock_information.rb', line 32

def lock_token
  @lock_token
end

#lock_type ⇒ Object

The type of envelope lock. Currently "edit" is the only supported type.



35
36
37
 
# File 'lib/docusign_esign/models/lock_information.rb', line 35

def lock_type
  @lock_type
end

#locked_by_app ⇒ Object

Specifies the friendly name of the application that is locking the envelope.



23
24
25
 
# File 'lib/docusign_esign/models/lock_information.rb', line 23

def locked_by_app
  @locked_by_app
end

#locked_by_user ⇒ Object

A complex type containing information about the user that has the envelope or template locked.



26
27
28
 
# File 'lib/docusign_esign/models/lock_information.rb', line 26

def locked_by_user
  @locked_by_user
end

#locked_until_date_time ⇒ Object

The datetime until the envelope lock expires.



29
30
31
 
# File 'lib/docusign_esign/models/lock_information.rb', line 29

def locked_until_date_time
  @locked_until_date_time
end

#use_scratch_pad ⇒ Object

Reserved for future use. Indicates whether a scratchpad is used for editing information.



38
39
40
 
# File 'lib/docusign_esign/models/lock_information.rb', line 38

def use_scratch_pad
  @use_scratch_pad
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/docusign_esign/models/lock_information.rb', line 41

def self.attribute_map
  {
    :'error_details' => :'errorDetails',
    :'lock_duration_in_seconds' => :'lockDurationInSeconds',
    :'locked_by_app' => :'lockedByApp',
    :'locked_by_user' => :'lockedByUser',
    :'locked_until_date_time' => :'lockedUntilDateTime',
    :'lock_token' => :'lockToken',
    :'lock_type' => :'lockType',
    :'use_scratch_pad' => :'useScratchPad'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/docusign_esign/models/lock_information.rb', line 55

def self.swagger_types
  {
    :'error_details' => :'ErrorDetails',
    :'lock_duration_in_seconds' => :'String',
    :'locked_by_app' => :'String',
    :'locked_by_user' => :'UserInfo',
    :'locked_until_date_time' => :'String',
    :'lock_token' => :'String',
    :'lock_type' => :'String',
    :'use_scratch_pad' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/docusign_esign/models/lock_information.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_details == o.error_details &&
      lock_duration_in_seconds == o.lock_duration_in_seconds &&
      locked_by_app == o.locked_by_app &&
      locked_by_user == o.locked_by_user &&
      locked_until_date_time == o.locked_until_date_time &&
      lock_token == o.lock_token &&
      lock_type == o.lock_type &&
      use_scratch_pad == o.use_scratch_pad
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



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
 
# File 'lib/docusign_esign/models/lock_information.rb', line 173

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_eSign.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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/docusign_esign/models/lock_information.rb', line 239

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/docusign_esign/models/lock_information.rb', line 152

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


139
140
141
 
# File 'lib/docusign_esign/models/lock_information.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/docusign_esign/models/lock_information.rb', line 145

def hash
  [error_details, lock_duration_in_seconds, locked_by_app, locked_by_user, locked_until_date_time, lock_token, lock_type, use_scratch_pad].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



111
112
113
114
 
# File 'lib/docusign_esign/models/lock_information.rb', line 111

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



219
220
221
 
# File 'lib/docusign_esign/models/lock_information.rb', line 219

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



225
226
227
228
229
230
231
232
233
 
# File 'lib/docusign_esign/models/lock_information.rb', line 225

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



213
214
215
 
# File 'lib/docusign_esign/models/lock_information.rb', line 213

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



118
119
120
 
# File 'lib/docusign_esign/models/lock_information.rb', line 118

def valid?
  true
end