Class: DocuSign_eSign::EnvelopeFormData

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

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


61
62
63
64
65
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
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 61

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?(:'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_subjectObject

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_idObject

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_dataObject

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

#recipient_form_dataObject

Returns the value of attribute recipient_form_data


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

def recipient_form_data
  @recipient_form_data
end

#sent_date_timeObject

The date and time the envelope was sent.


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

def sent_date_time
  @sent_date_time
end

#statusObject

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.


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

def status
  @status
end

Class Method Details

.attribute_mapObject

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


36
37
38
39
40
41
42
43
44
45
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 36

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

.swagger_typesObject

Attribute type mapping.


48
49
50
51
52
53
54
55
56
57
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 48

def self.swagger_types
  {
    :'email_subject' => :'String',
    :'envelope_id' => :'String',
    :'form_data' => :'Array<FormDataItem>',
    :'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


111
112
113
114
115
116
117
118
119
120
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 111

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 &&
      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


158
159
160
161
162
163
164
165
166
167
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
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 158

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


224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 224

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


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 137

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

124
125
126
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 124

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


130
131
132
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 130

def hash
  [email_subject, envelope_id, form_data, recipient_form_data, sent_date_time, status].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


98
99
100
101
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 98

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


204
205
206
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 204

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


210
211
212
213
214
215
216
217
218
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 210

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


198
199
200
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 198

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


105
106
107
# File 'lib/docusign_esign/models/envelope_form_data.rb', line 105

def valid?
  true
end