Class: DocuSign_eSign::PowerForm

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PowerForm

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
237
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
# File 'lib/docusign_esign/models/power_form.rb', line 155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_byObject

Returns the value of attribute created_by


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

def created_by
  @created_by
end

#created_date_timeObject

Indicates the date and time the item was created.


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

def created_date_time
  @created_date_time
end

#email_bodyObject

Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.


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

def email_body
  @email_body
end

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


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

def email_subject
  @email_subject
end

#envelopesObject

Returns the value of attribute envelopes


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

def envelopes
  @envelopes
end

#error_detailsObject

Returns the value of attribute error_details


32
33
34
# File 'lib/docusign_esign/models/power_form.rb', line 32

def error_details
  @error_details
end

#instructionsObject

Returns the value of attribute instructions


35
36
37
# File 'lib/docusign_esign/models/power_form.rb', line 35

def instructions
  @instructions
end

#is_activeObject

Returns the value of attribute is_active


38
39
40
# File 'lib/docusign_esign/models/power_form.rb', line 38

def is_active
  @is_active
end

#last_usedObject

Returns the value of attribute last_used


41
42
43
# File 'lib/docusign_esign/models/power_form.rb', line 41

def last_used
  @last_used
end

#limit_use_intervalObject

Returns the value of attribute limit_use_interval


44
45
46
# File 'lib/docusign_esign/models/power_form.rb', line 44

def limit_use_interval
  @limit_use_interval
end

#limit_use_interval_enabledObject

Returns the value of attribute limit_use_interval_enabled


47
48
49
# File 'lib/docusign_esign/models/power_form.rb', line 47

def limit_use_interval_enabled
  @limit_use_interval_enabled
end

#limit_use_interval_unitsObject

Returns the value of attribute limit_use_interval_units


50
51
52
# File 'lib/docusign_esign/models/power_form.rb', line 50

def limit_use_interval_units
  @limit_use_interval_units
end

#max_use_enabledObject

Returns the value of attribute max_use_enabled


53
54
55
# File 'lib/docusign_esign/models/power_form.rb', line 53

def max_use_enabled
  @max_use_enabled
end

#nameObject

Returns the value of attribute name


56
57
58
# File 'lib/docusign_esign/models/power_form.rb', line 56

def name
  @name
end

#power_form_idObject

Returns the value of attribute power_form_id


59
60
61
# File 'lib/docusign_esign/models/power_form.rb', line 59

def power_form_id
  @power_form_id
end

#power_form_urlObject

Returns the value of attribute power_form_url


62
63
64
# File 'lib/docusign_esign/models/power_form.rb', line 62

def power_form_url
  @power_form_url
end

#recipientsObject

An array of powerform recipients.


65
66
67
# File 'lib/docusign_esign/models/power_form.rb', line 65

def recipients
  @recipients
end

#sender_nameObject

Returns the value of attribute sender_name


68
69
70
# File 'lib/docusign_esign/models/power_form.rb', line 68

def sender_name
  @sender_name
end

#sender_user_idObject

Returns the value of attribute sender_user_id


71
72
73
# File 'lib/docusign_esign/models/power_form.rb', line 71

def sender_user_id
  @sender_user_id
end

#signing_modeObject

Returns the value of attribute signing_mode


74
75
76
# File 'lib/docusign_esign/models/power_form.rb', line 74

def signing_mode
  @signing_mode
end

#template_idObject

The unique identifier of the template. If this is not provided, DocuSign will generate a value.


77
78
79
# File 'lib/docusign_esign/models/power_form.rb', line 77

def template_id
  @template_id
end

#template_nameObject

Returns the value of attribute template_name


80
81
82
# File 'lib/docusign_esign/models/power_form.rb', line 80

def template_name
  @template_name
end

#times_usedObject

Returns the value of attribute times_used


83
84
85
# File 'lib/docusign_esign/models/power_form.rb', line 83

def times_used
  @times_used
end

#uriObject

Returns the value of attribute uri


86
87
88
# File 'lib/docusign_esign/models/power_form.rb', line 86

def uri
  @uri
end

#uses_remainingObject

Returns the value of attribute uses_remaining


89
90
91
# File 'lib/docusign_esign/models/power_form.rb', line 89

def uses_remaining
  @uses_remaining
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'created_by' => :'createdBy',
    :'created_date_time' => :'createdDateTime',
    :'email_body' => :'emailBody',
    :'email_subject' => :'emailSubject',
    :'envelopes' => :'envelopes',
    :'error_details' => :'errorDetails',
    :'instructions' => :'instructions',
    :'is_active' => :'isActive',
    :'last_used' => :'lastUsed',
    :'limit_use_interval' => :'limitUseInterval',
    :'limit_use_interval_enabled' => :'limitUseIntervalEnabled',
    :'limit_use_interval_units' => :'limitUseIntervalUnits',
    :'max_use_enabled' => :'maxUseEnabled',
    :'name' => :'name',
    :'power_form_id' => :'powerFormId',
    :'power_form_url' => :'powerFormUrl',
    :'recipients' => :'recipients',
    :'sender_name' => :'senderName',
    :'sender_user_id' => :'senderUserId',
    :'signing_mode' => :'signingMode',
    :'template_id' => :'templateId',
    :'template_name' => :'templateName',
    :'times_used' => :'timesUsed',
    :'uri' => :'uri',
    :'uses_remaining' => :'usesRemaining'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'created_by' => :'String',
    :'created_date_time' => :'String',
    :'email_body' => :'String',
    :'email_subject' => :'String',
    :'envelopes' => :'Array<Envelope>',
    :'error_details' => :'ErrorDetails',
    :'instructions' => :'String',
    :'is_active' => :'String',
    :'last_used' => :'String',
    :'limit_use_interval' => :'String',
    :'limit_use_interval_enabled' => :'String',
    :'limit_use_interval_units' => :'String',
    :'max_use_enabled' => :'String',
    :'name' => :'String',
    :'power_form_id' => :'String',
    :'power_form_url' => :'String',
    :'recipients' => :'Array<PowerFormRecipient>',
    :'sender_name' => :'String',
    :'sender_user_id' => :'String',
    :'signing_mode' => :'String',
    :'template_id' => :'String',
    :'template_name' => :'String',
    :'times_used' => :'String',
    :'uri' => :'String',
    :'uses_remaining' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/docusign_esign/models/power_form.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_by == o.created_by &&
      created_date_time == o.created_date_time &&
      email_body == o.email_body &&
      email_subject == o.email_subject &&
      envelopes == o.envelopes &&
      error_details == o.error_details &&
      instructions == o.instructions &&
      is_active == o.is_active &&
      last_used == o.last_used &&
      limit_use_interval == o.limit_use_interval &&
      limit_use_interval_enabled == o.limit_use_interval_enabled &&
      limit_use_interval_units == o.limit_use_interval_units &&
      max_use_enabled == o.max_use_enabled &&
      name == o.name &&
      power_form_id == o.power_form_id &&
      power_form_url == o.power_form_url &&
      recipients == o.recipients &&
      sender_name == o.sender_name &&
      sender_user_id == o.sender_user_id &&
      signing_mode == o.signing_mode &&
      template_id == o.template_id &&
      template_name == o.template_name &&
      times_used == o.times_used &&
      uri == o.uri &&
      uses_remaining == o.uses_remaining
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


347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/docusign_esign/models/power_form.rb', line 347

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


413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/docusign_esign/models/power_form.rb', line 413

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


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/docusign_esign/models/power_form.rb', line 326

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

313
314
315
# File 'lib/docusign_esign/models/power_form.rb', line 313

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


319
320
321
# File 'lib/docusign_esign/models/power_form.rb', line 319

def hash
  [created_by, created_date_time, email_body, email_subject, envelopes, error_details, instructions, is_active, last_used, limit_use_interval, limit_use_interval_enabled, limit_use_interval_units, max_use_enabled, name, power_form_id, power_form_url, recipients, sender_name, sender_user_id, signing_mode, template_id, template_name, times_used, uri, uses_remaining].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


268
269
270
271
# File 'lib/docusign_esign/models/power_form.rb', line 268

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


393
394
395
# File 'lib/docusign_esign/models/power_form.rb', line 393

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


399
400
401
402
403
404
405
406
407
# File 'lib/docusign_esign/models/power_form.rb', line 399

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


387
388
389
# File 'lib/docusign_esign/models/power_form.rb', line 387

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


275
276
277
# File 'lib/docusign_esign/models/power_form.rb', line 275

def valid?
  true
end