Class: DocuSign_WebForms::WebFormMetadata

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

Overview

Form metadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebFormMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
195
196
197
198
199
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_webforms/models/web_form_metadata.rb', line 141

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived_date_time ⇒ Object

The last time the web form was archived



51
52
53
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 51

def archived_date_time
  @archived_date_time
end

#created_date_time ⇒ Object

Track the time the web form was created



54
55
56
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 54

def created_date_time
  @created_date_time
end

#form_content_modified_by ⇒ Object

Track the user that last modified the form content



36
37
38
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 36

def form_content_modified_by
  @form_content_modified_by
end

#form_content_modified_date_time ⇒ Object

Track the last time web form content changed.



60
61
62
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 60

def form_content_modified_date_time
  @form_content_modified_date_time
end

#form_properties_modified_by ⇒ Object

Track the user that last modified the form properties



39
40
41
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 39

def form_properties_modified_by
  @form_properties_modified_by
end

#form_properties_modified_date_time ⇒ Object

Track the last time the form properties changed.



63
64
65
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 63

def form_properties_modified_date_time
  @form_properties_modified_date_time
end

#last_disabled_by ⇒ Object

Track the user that last unpublished an active version



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

def last_disabled_by
  @last_disabled_by
end

#last_disabled_date_time ⇒ Object

Track the last time the form was disabled



72
73
74
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 72

def last_disabled_date_time
  @last_disabled_date_time
end

#last_enabled_by ⇒ Object

Track the user that last unpublished an active version



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

def last_enabled_by
  @last_enabled_by
end

#last_enabled_date_time ⇒ Object

Track the last time the form was enabled



69
70
71
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 69

def last_enabled_date_time
  @last_enabled_date_time
end

#last_modified_by ⇒ Object

Track the user that last modified anything related to the form



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

def last_modified_by
  @last_modified_by
end

#last_modified_date_time ⇒ Object

The last time anything was modified on the form



57
58
59
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 57

def last_modified_date_time
  @last_modified_date_time
end

#last_published_by ⇒ Object

Track the user that last published a draft version to active



42
43
44
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 42

def last_published_by
  @last_published_by
end

#last_published_date_time ⇒ Object

Track the last time a draft version was published to active



66
67
68
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 66

def last_published_date_time
  @last_published_date_time
end

#last_sender_consent_date_time ⇒ Object

Track the last time a user added their consent for the form.



75
76
77
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 75

def last_sender_consent_date_time
  @last_sender_consent_date_time
end

#owner ⇒ Object

The user that created the form or has been transferred ownership



27
28
29
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 27

def owner
  @owner
end

#published_component_names ⇒ Object

A dictionary containing the mapping of component names to their respective component types for all the published components.



81
82
83
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 81

def published_component_names
  @published_component_names
end

#published_slug ⇒ Object

The public friendly slug that is used to access the form from the player



78
79
80
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 78

def published_slug
  @published_slug
end

#sender ⇒ Object

The user that has added their consent to the form for sending actions



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

def sender
  @sender
end

#source ⇒ Object

The source from which the webform is created. Accepted values are [templates, blank, form]



18
19
20
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 18

def source
  @source
end

#source_form_id ⇒ Object

The source form id from which the webform is created.



24
25
26
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 24

def source_form_id
  @source_form_id
end

#type ⇒ Object

Represents webform type. Possible values are [standalone, hasEsignTemplate]



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 84

def self.attribute_map
  {
    :'source' => :'source',
    :'type' => :'type',
    :'source_form_id' => :'sourceFormId',
    :'owner' => :'owner',
    :'sender' => :'sender',
    :'last_modified_by' => :'lastModifiedBy',
    :'form_content_modified_by' => :'formContentModifiedBy',
    :'form_properties_modified_by' => :'formPropertiesModifiedBy',
    :'last_published_by' => :'lastPublishedBy',
    :'last_enabled_by' => :'lastEnabledBy',
    :'last_disabled_by' => :'lastDisabledBy',
    :'archived_date_time' => :'archivedDateTime',
    :'created_date_time' => :'createdDateTime',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'form_content_modified_date_time' => :'formContentModifiedDateTime',
    :'form_properties_modified_date_time' => :'formPropertiesModifiedDateTime',
    :'last_published_date_time' => :'lastPublishedDateTime',
    :'last_enabled_date_time' => :'lastEnabledDateTime',
    :'last_disabled_date_time' => :'lastDisabledDateTime',
    :'last_sender_consent_date_time' => :'lastSenderConsentDateTime',
    :'published_slug' => :'publishedSlug',
    :'published_component_names' => :'publishedComponentNames'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 112

def self.swagger_types
  {
    :'source' => :'WebFormSource',
    :'type' => :'WebFormType',
    :'source_form_id' => :'String',
    :'owner' => :'WebFormUserInfo',
    :'sender' => :'WebFormUserInfo',
    :'last_modified_by' => :'WebFormUserInfo',
    :'form_content_modified_by' => :'WebFormUserInfo',
    :'form_properties_modified_by' => :'WebFormUserInfo',
    :'last_published_by' => :'WebFormUserInfo',
    :'last_enabled_by' => :'WebFormUserInfo',
    :'last_disabled_by' => :'WebFormUserInfo',
    :'archived_date_time' => :'DateTime',
    :'created_date_time' => :'DateTime',
    :'last_modified_date_time' => :'DateTime',
    :'form_content_modified_date_time' => :'DateTime',
    :'form_properties_modified_date_time' => :'DateTime',
    :'last_published_date_time' => :'DateTime',
    :'last_enabled_date_time' => :'DateTime',
    :'last_disabled_date_time' => :'DateTime',
    :'last_sender_consent_date_time' => :'DateTime',
    :'published_slug' => :'String',
    :'published_component_names' => :'Hash<String, WebFormComponentType>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source == o.source &&
      type == o.type &&
      source_form_id == o.source_form_id &&
      owner == o.owner &&
      sender == o.sender &&
      last_modified_by == o.last_modified_by &&
      form_content_modified_by == o.form_content_modified_by &&
      form_properties_modified_by == o.form_properties_modified_by &&
      last_published_by == o.last_published_by &&
      last_enabled_by == o.last_enabled_by &&
      last_disabled_by == o.last_disabled_by &&
      archived_date_time == o.archived_date_time &&
      created_date_time == o.created_date_time &&
      last_modified_date_time == o.last_modified_date_time &&
      form_content_modified_date_time == o.form_content_modified_date_time &&
      form_properties_modified_date_time == o.form_properties_modified_date_time &&
      last_published_date_time == o.last_published_date_time &&
      last_enabled_date_time == o.last_enabled_date_time &&
      last_disabled_date_time == o.last_disabled_date_time &&
      last_sender_consent_date_time == o.last_sender_consent_date_time &&
      published_slug == o.published_slug &&
      published_component_names == o.published_component_names
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 316

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 382

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 295

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


282
283
284
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 288

def hash
  [source, type, source_form_id, owner, sender, last_modified_by, form_content_modified_by, form_properties_modified_by, last_published_by, last_enabled_by, last_disabled_by, archived_date_time, created_date_time, last_modified_date_time, form_content_modified_date_time, form_properties_modified_date_time, last_published_date_time, last_enabled_date_time, last_disabled_date_time, last_sender_consent_date_time, published_slug, published_component_names].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



240
241
242
243
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 240

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



362
363
364
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 362

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



368
369
370
371
372
373
374
375
376
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 368

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



356
357
358
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 356

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



247
248
249
 
# File 'lib/docusign_webforms/models/web_form_metadata.rb', line 247

def valid?
  true
end