Class: DocuSign_eSign::DocumentTemplate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/docusign_esign/models/document_template.rb', line 55

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

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

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

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

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

Instance Attribute Details

#document_end_page ⇒ Object

Returns the value of attribute document_end_page.



17
18
19
 
# File 'lib/docusign_esign/models/document_template.rb', line 17

def document_end_page
  @document_end_page
end

#document_id ⇒ Object

Specifies the document ID number that the tab is placed on. This must refer to an existing Document’s ID attribute.



20
21
22
 
# File 'lib/docusign_esign/models/document_template.rb', line 20

def document_id
  @document_id
end

#document_start_page ⇒ Object

Returns the value of attribute document_start_page.



23
24
25
 
# File 'lib/docusign_esign/models/document_template.rb', line 23

def document_start_page
  @document_start_page
end

#error_details ⇒ Object

Array or errors.



26
27
28
 
# File 'lib/docusign_esign/models/document_template.rb', line 26

def error_details
  @error_details
end

#template_id ⇒ Object

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



29
30
31
 
# File 'lib/docusign_esign/models/document_template.rb', line 29

def template_id
  @template_id
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/docusign_esign/models/document_template.rb', line 32

def self.attribute_map
  {
    :'document_end_page' => :'documentEndPage',
    :'document_id' => :'documentId',
    :'document_start_page' => :'documentStartPage',
    :'error_details' => :'errorDetails',
    :'template_id' => :'templateId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/docusign_esign/models/document_template.rb', line 43

def self.swagger_types
  {
    :'document_end_page' => :'String',
    :'document_id' => :'String',
    :'document_start_page' => :'String',
    :'error_details' => :'ErrorDetails',
    :'template_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



97
98
99
100
101
102
103
104
105
 
# File 'lib/docusign_esign/models/document_template.rb', line 97

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_end_page == o.document_end_page &&
      document_id == o.document_id &&
      document_start_page == o.document_start_page &&
      error_details == o.error_details &&
      template_id == o.template_id
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



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

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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/docusign_esign/models/document_template.rb', line 209

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/docusign_esign/models/document_template.rb', line 122

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


109
110
111
 
# File 'lib/docusign_esign/models/document_template.rb', line 109

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/docusign_esign/models/document_template.rb', line 115

def hash
  [document_end_page, document_id, document_start_page, error_details, template_id].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



84
85
86
87
 
# File 'lib/docusign_esign/models/document_template.rb', line 84

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



189
190
191
 
# File 'lib/docusign_esign/models/document_template.rb', line 189

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/docusign_esign/models/document_template.rb', line 195

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



183
184
185
 
# File 'lib/docusign_esign/models/document_template.rb', line 183

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



91
92
93
 
# File 'lib/docusign_esign/models/document_template.rb', line 91

def valid?
  true
end