Class: DocuSign_eSign::LockRequest

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

Overview

This request object contains information about the lock that you want to create or update.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LockRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/docusign_esign/models/lock_request.rb', line 56

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

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

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

Instance Attribute Details

#lock_duration_in_seconds ⇒ Object

The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.



18
19
20
 
# File 'lib/docusign_esign/models/lock_request.rb', line 18

def lock_duration_in_seconds
  @lock_duration_in_seconds
end

#lock_type ⇒ Object

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



24
25
26
 
# File 'lib/docusign_esign/models/lock_request.rb', line 24

def lock_type
  @lock_type
end

#locked_by_app ⇒ Object

A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.



21
22
23
 
# File 'lib/docusign_esign/models/lock_request.rb', line 21

def locked_by_app
  @locked_by_app
end

#template_password ⇒ Object

Returns the value of attribute template_password.



27
28
29
 
# File 'lib/docusign_esign/models/lock_request.rb', line 27

def template_password
  @template_password
end

#use_scratch_pad ⇒ Object

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



30
31
32
 
# File 'lib/docusign_esign/models/lock_request.rb', line 30

def use_scratch_pad
  @use_scratch_pad
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/docusign_esign/models/lock_request.rb', line 33

def self.attribute_map
  {
    :'lock_duration_in_seconds' => :'lockDurationInSeconds',
    :'locked_by_app' => :'lockedByApp',
    :'lock_type' => :'lockType',
    :'template_password' => :'templatePassword',
    :'use_scratch_pad' => :'useScratchPad'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'lock_duration_in_seconds' => :'String',
    :'locked_by_app' => :'String',
    :'lock_type' => :'String',
    :'template_password' => :'String',
    :'use_scratch_pad' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



98
99
100
101
102
103
104
105
106
 
# File 'lib/docusign_esign/models/lock_request.rb', line 98

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



144
145
146
147
148
149
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
 
# File 'lib/docusign_esign/models/lock_request.rb', line 144

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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/docusign_esign/models/lock_request.rb', line 210

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/docusign_esign/models/lock_request.rb', line 123

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


110
111
112
 
# File 'lib/docusign_esign/models/lock_request.rb', line 110

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/docusign_esign/models/lock_request.rb', line 116

def hash
  [lock_duration_in_seconds, locked_by_app, lock_type, template_password, 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



85
86
87
88
 
# File 'lib/docusign_esign/models/lock_request.rb', line 85

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



190
191
192
 
# File 'lib/docusign_esign/models/lock_request.rb', line 190

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



196
197
198
199
200
201
202
203
204
 
# File 'lib/docusign_esign/models/lock_request.rb', line 196

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



184
185
186
 
# File 'lib/docusign_esign/models/lock_request.rb', line 184

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



92
93
94
 
# File 'lib/docusign_esign/models/lock_request.rb', line 92

def valid?
  true
end