Class: DocuSign_WebForms::WebFormInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_webforms/models/web_form_instance.rb

Overview

An object that contains the Web Form Instance required to render it and its metadata such as created by, created time

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebFormInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'formValues')
    if (value = attributes[:'formValues']).is_a?(Hash)
      self.form_values = value
    end
  end

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



28
29
30
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 28

def 
  @account_id
end

#brand_id ⇒ Object

Returns the value of attribute brand_id.



45
46
47
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 45

def brand_id
  @brand_id
end

#client_user_id ⇒ Object

Returns the value of attribute client_user_id.



30
31
32
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 30

def client_user_id
  @client_user_id
end

#envelopes ⇒ Object

The associated envelope that is created when the instance is submitted



38
39
40
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 38

def envelopes
  @envelopes
end

#form_id ⇒ Object

Web form from which the instance is created



26
27
28
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 26

def form_id
  @form_id
end

#form_url ⇒ Object

Returns the value of attribute form_url.



17
18
19
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 17

def form_url
  @form_url
end

#form_values ⇒ Object

Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string.



43
44
45
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 43

def form_values
  @form_values
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 23

def id
  @id
end

#instance_metadata ⇒ Object

Returns the value of attribute instance_metadata.



40
41
42
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 40

def instance_metadata
  @instance_metadata
end

#instance_token ⇒ Object

Returns the value of attribute instance_token.



19
20
21
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 19

def instance_token
  @instance_token
end

#recipients ⇒ Object

The associated envelope that is created when the instance is submitted



48
49
50
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 48

def recipients
  @recipients
end

#status ⇒ Object

Returns the value of attribute status.



35
36
37
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 35

def status
  @status
end

#tags ⇒ Object

List of tags provided by the user with each request. This field is optional.



33
34
35
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 33

def tags
  @tags
end

#token_expiration_date_time ⇒ Object

Returns the value of attribute token_expiration_date_time.



21
22
23
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 21

def token_expiration_date_time
  @token_expiration_date_time
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 51

def self.attribute_map
  {
    :'form_url' => :'formUrl',
    :'instance_token' => :'instanceToken',
    :'token_expiration_date_time' => :'tokenExpirationDateTime',
    :'id' => :'id',
    :'form_id' => :'formId',
    :'account_id' => :'accountId',
    :'client_user_id' => :'clientUserId',
    :'tags' => :'tags',
    :'status' => :'status',
    :'envelopes' => :'envelopes',
    :'instance_metadata' => :'instanceMetadata',
    :'form_values' => :'formValues',
    :'brand_id' => :'brandId',
    :'recipients' => :'recipients'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 71

def self.swagger_types
  {
    :'form_url' => :'String',
    :'instance_token' => :'String',
    :'token_expiration_date_time' => :'DateTime',
    :'id' => :'String',
    :'form_id' => :'String',
    :'account_id' => :'String',
    :'client_user_id' => :'String',
    :'tags' => :'Array<String>',
    :'status' => :'InstanceStatus',
    :'envelopes' => :'Array<WebFormInstanceEnvelopes>',
    :'instance_metadata' => :'WebFormInstanceMetadata',
    :'form_values' => :'Hash<String, Object>',
    :'brand_id' => :'String',
    :'recipients' => :'Array<WebFormInstanceRecipients>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      form_url == o.form_url &&
      instance_token == o.instance_token &&
      token_expiration_date_time == o.token_expiration_date_time &&
      id == o.id &&
      form_id == o.form_id &&
       == o. &&
      client_user_id == o.client_user_id &&
      tags == o.tags &&
      status == o.status &&
      envelopes == o.envelopes &&
      instance_metadata == o.instance_metadata &&
      form_values == o.form_values &&
      brand_id == o.brand_id &&
      recipients == o.recipients
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 238

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_WebForms.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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 304

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 217

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


204
205
206
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 210

def hash
  [form_url, instance_token, token_expiration_date_time, id, form_id, , client_user_id, tags, status, envelopes, instance_metadata, form_values, brand_id, recipients].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



165
166
167
168
169
170
171
172
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  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



284
285
286
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 284

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



290
291
292
293
294
295
296
297
298
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 290

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



278
279
280
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 278

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



176
177
178
179
 
# File 'lib/docusign_webforms/models/web_form_instance.rb', line 176

def valid?
  return false if @id.nil?
  true
end