Class: DocuSign_eSign::EnvelopeFormData

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

Overview

Describes the form data of the envelope.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeFormData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
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
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 66

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

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

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

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

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

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

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

Instance Attribute Details

#email_subject ⇒ Object

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.



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

def email_subject
  @email_subject
end

#envelope_id ⇒ Object

The envelope ID of the envelope status that failed to post.



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

def envelope_id
  @envelope_id
end

#form_data ⇒ Object

Returns the value of attribute form_data.



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

def form_data
  @form_data
end

#prefill_form_data ⇒ Object

An array of ‘formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).



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

def prefill_form_data
  @prefill_form_data
end

#recipient_form_data ⇒ Object

Returns the value of attribute recipient_form_data.



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

def recipient_form_data
  @recipient_form_data
end

#sent_date_time ⇒ Object

The date and time the envelope was sent.



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

def sent_date_time
  @sent_date_time
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 39

def self.attribute_map
  {
    :'email_subject' => :'emailSubject',
    :'envelope_id' => :'envelopeId',
    :'form_data' => :'formData',
    :'prefill_form_data' => :'prefillFormData',
    :'recipient_form_data' => :'recipientFormData',
    :'sent_date_time' => :'sentDateTime',
    :'status' => :'status'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 52

def self.swagger_types
  {
    :'email_subject' => :'String',
    :'envelope_id' => :'String',
    :'form_data' => :'Array<FormDataItem>',
    :'prefill_form_data' => :'PrefillFormData',
    :'recipient_form_data' => :'Array<RecipientFormData>',
    :'sent_date_time' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_subject == o.email_subject &&
      envelope_id == o.envelope_id &&
      form_data == o.form_data &&
      prefill_form_data == o.prefill_form_data &&
      recipient_form_data == o.recipient_form_data &&
      sent_date_time == o.sent_date_time &&
      status == o.status
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



168
169
170
171
172
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
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 168

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 234

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



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

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


134
135
136
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 140

def hash
  [email_subject, envelope_id, form_data, prefill_form_data, recipient_form_data, sent_date_time, status].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



107
108
109
110
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 107

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



214
215
216
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 214

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 220

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



208
209
210
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 208

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



114
115
116
 
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 114

def valid?
  true
end