Class: DocuSign_eSign::PowerFormRecipient

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

Overview

Note: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use ‘Member` as the `Name`), and omit personal details such as `email`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PowerFormRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 96

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_code ⇒ Object

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer ‘accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.



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

def access_code
  @access_code
end

#access_code_locked ⇒ Object

Returns the value of attribute access_code_locked.



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

def access_code_locked
  @access_code_locked
end

#access_code_required ⇒ Object

Returns the value of attribute access_code_required.



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

def access_code_required
  @access_code_required
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#email_locked ⇒ Object

Returns the value of attribute email_locked.



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

def email_locked
  @email_locked
end

#id_check_configuration_name ⇒ Object

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ‘ID Check $’ and ‘SMS Auth $’. To use ID check in an envelope, the idCheckConfigurationName should be ‘ID Check ’. If you wanted to use SMS, it would be ‘SMS Auth $’ and you would need to add you would need to add phone number information to the ‘smsAuthentication` node.



33
34
35
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 33

def id_check_configuration_name
  @id_check_configuration_name
end

#id_check_required ⇒ Object

Returns the value of attribute id_check_required.



36
37
38
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 36

def id_check_required
  @id_check_required
end

#name ⇒ Object

Returns the value of attribute name.



39
40
41
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 39

def name
  @name
end

#recipient_type ⇒ Object

Returns the value of attribute recipient_type.



42
43
44
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 42

def recipient_type
  @recipient_type
end

#role_name ⇒ Object

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.



45
46
47
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 45

def role_name
  @role_name
end

#routing_order ⇒ Object

Specifies the routing order of the recipient in the envelope.



48
49
50
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 48

def routing_order
  @routing_order
end

#template_requires_id_lookup ⇒ Object

Returns the value of attribute template_requires_id_lookup.



51
52
53
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 51

def template_requires_id_lookup
  @template_requires_id_lookup
end

#user_name_locked ⇒ Object

Returns the value of attribute user_name_locked.



54
55
56
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 54

def user_name_locked
  @user_name_locked
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 57

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'access_code_locked' => :'accessCodeLocked',
    :'access_code_required' => :'accessCodeRequired',
    :'email' => :'email',
    :'email_locked' => :'emailLocked',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_required' => :'idCheckRequired',
    :'name' => :'name',
    :'recipient_type' => :'recipientType',
    :'role_name' => :'roleName',
    :'routing_order' => :'routingOrder',
    :'template_requires_id_lookup' => :'templateRequiresIdLookup',
    :'user_name_locked' => :'userNameLocked'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 76

def self.swagger_types
  {
    :'access_code' => :'String',
    :'access_code_locked' => :'String',
    :'access_code_required' => :'String',
    :'email' => :'String',
    :'email_locked' => :'String',
    :'id_check_configuration_name' => :'String',
    :'id_check_required' => :'String',
    :'name' => :'String',
    :'recipient_type' => :'String',
    :'role_name' => :'String',
    :'routing_order' => :'String',
    :'template_requires_id_lookup' => :'String',
    :'user_name_locked' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      access_code_locked == o.access_code_locked &&
      access_code_required == o.access_code_required &&
      email == o.email &&
      email_locked == o.email_locked &&
      id_check_configuration_name == o.id_check_configuration_name &&
      id_check_required == o.id_check_required &&
      name == o.name &&
      recipient_type == o.recipient_type &&
      role_name == o.role_name &&
      routing_order == o.routing_order &&
      template_requires_id_lookup == o.template_requires_id_lookup &&
      user_name_locked == o.user_name_locked
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 224

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 290

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 203

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 196

def hash
  [access_code, access_code_locked, access_code_required, email, email_locked, id_check_configuration_name, id_check_required, name, recipient_type, role_name, routing_order, template_requires_id_lookup, user_name_locked].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



157
158
159
160
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 157

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



270
271
272
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 270

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



276
277
278
279
280
281
282
283
284
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 276

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



264
265
266
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 264

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



164
165
166
 
# File 'lib/docusign_esign/models/power_form_recipient.rb', line 164

def valid?
  true
end