Class: DocuSign_eSign::BulkRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_codeObject

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/bulk_recipient.rb', line 18

def access_code
  @access_code
end

#emailObject

Specifies the recipient's email address. Maximum length: 100 characters.


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

def email
  @email
end

#error_detailsObject

Array or errors.


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

def error_details
  @error_details
end

#identificationObject

Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.


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

def identification
  @identification
end

#nameObject

Specifies the recipient's name. Maximum length: 50 characters.


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

def name
  @name
end

#noteObject

Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.


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

def note
  @note
end

#phone_numberObject

This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If `usersupplied` is used, the signer supplies his or her own telephone number.


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

def phone_number
  @phone_number
end

#recipient_signature_provider_infoObject

Returns the value of attribute recipient_signature_provider_info


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

def recipient_signature_provider_info
  @recipient_signature_provider_info
end

#row_numberObject

Returns the value of attribute row_number


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

def row_number
  @row_number
end

#tab_labelsObject

Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.


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

def tab_labels
  @tab_labels
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 48

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'email' => :'email',
    :'error_details' => :'errorDetails',
    :'identification' => :'identification',
    :'name' => :'name',
    :'note' => :'note',
    :'phone_number' => :'phoneNumber',
    :'recipient_signature_provider_info' => :'recipientSignatureProviderInfo',
    :'row_number' => :'rowNumber',
    :'tab_labels' => :'tabLabels'
  }
end

.swagger_typesObject

Attribute type mapping.


64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 64

def self.swagger_types
  {
    :'access_code' => :'String',
    :'email' => :'String',
    :'error_details' => :'Array<ErrorDetails>',
    :'identification' => :'String',
    :'name' => :'String',
    :'note' => :'String',
    :'phone_number' => :'String',
    :'recipient_signature_provider_info' => :'Array<BulkRecipientSignatureProvider>',
    :'row_number' => :'String',
    :'tab_labels' => :'Array<BulkRecipientTabLabel>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      email == o.email &&
      error_details == o.error_details &&
      identification == o.identification &&
      name == o.name &&
      note == o.note &&
      phone_number == o.phone_number &&
      recipient_signature_provider_info == o.recipient_signature_provider_info &&
      row_number == o.row_number &&
      tab_labels == o.tab_labels
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


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

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


266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 266

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


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 179

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

166
167
168
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 166

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


172
173
174
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 172

def hash
  [access_code, email, error_details, identification, name, note, phone_number, recipient_signature_provider_info, row_number, tab_labels].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


136
137
138
139
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


246
247
248
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 246

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


252
253
254
255
256
257
258
259
260
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 252

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


240
241
242
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 240

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


143
144
145
# File 'lib/docusign_esign/models/bulk_recipient.rb', line 143

def valid?
  true
end