Class: DocuSign_eSign::EnvelopeTemplateDefinition

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

Overview

A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeTemplateDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 105

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#folder_id ⇒ Object

The ID for the folder.



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

def folder_id
  @folder_id
end

#folder_name ⇒ Object

The name of the folder in which the template is located.



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

def folder_name
  @folder_name
end

#folder_uri ⇒ Object

The URI of the folder.



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

def folder_uri
  @folder_uri
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#last_modified_by ⇒ Object

Returns the value of attribute last_modified_by.



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

def last_modified_by
  @last_modified_by
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#new_password ⇒ Object

Returns the value of attribute new_password.



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

def new_password
  @new_password
end

#owner ⇒ Object

Returns the value of attribute owner.



40
41
42
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 40

def owner
  @owner
end

#page_count ⇒ Object

An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.



43
44
45
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 43

def page_count
  @page_count
end

#parent_folder_uri ⇒ Object

Returns the value of attribute parent_folder_uri.



46
47
48
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 46

def parent_folder_uri
  @parent_folder_uri
end

#password ⇒ Object

Returns the value of attribute password.



49
50
51
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 49

def password
  @password
end

#shared ⇒ Object

When set to true, this custom tab is shared.



52
53
54
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 52

def shared
  @shared
end

#template_id ⇒ Object

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



55
56
57
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 55

def template_id
  @template_id
end

#uri ⇒ Object

Returns the value of attribute uri.



58
59
60
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 58

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 62

def self.attribute_map
  {
    :'description' => :'description',
    :'folder_id' => :'folderId',
    :'folder_name' => :'folderName',
    :'folder_uri' => :'folderUri',
    :'last_modified' => :'lastModified',
    :'last_modified_by' => :'lastModifiedBy',
    :'name' => :'name',
    :'new_password' => :'newPassword',
    :'owner' => :'owner',
    :'page_count' => :'pageCount',
    :'parent_folder_uri' => :'parentFolderUri',
    :'password' => :'password',
    :'shared' => :'shared',
    :'template_id' => :'templateId',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 83

def self.swagger_types
  {
    :'description' => :'String',
    :'folder_id' => :'String',
    :'folder_name' => :'String',
    :'folder_uri' => :'String',
    :'last_modified' => :'String',
    :'last_modified_by' => :'UserInfo',
    :'name' => :'String',
    :'new_password' => :'String',
    :'owner' => :'UserInfo',
    :'page_count' => :'Integer',
    :'parent_folder_uri' => :'String',
    :'password' => :'String',
    :'shared' => :'String',
    :'template_id' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      folder_id == o.folder_id &&
      folder_name == o.folder_name &&
      folder_uri == o.folder_uri &&
      last_modified == o.last_modified &&
      last_modified_by == o.last_modified_by &&
      name == o.name &&
      new_password == o.new_password &&
      owner == o.owner &&
      page_count == o.page_count &&
      parent_folder_uri == o.parent_folder_uri &&
      password == o.password &&
      shared == o.shared &&
      template_id == o.template_id &&
      uri == o.uri
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



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
275
276
277
278
279
280
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 244

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 310

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



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

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


210
211
212
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 216

def hash
  [description, folder_id, folder_name, folder_uri, last_modified, last_modified_by, name, new_password, owner, page_count, parent_folder_uri, password, shared, template_id, uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



175
176
177
178
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  return 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



290
291
292
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 290

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



296
297
298
299
300
301
302
303
304
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 296

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



284
285
286
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 284

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



182
183
184
 
# File 'lib/docusign_esign/models/envelope_template_definition.rb', line 182

def valid?
  return true
end