Class: DocuSign_eSign::CompositeTemplate

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

Overview

This object contains information about a [composite template], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompositeTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
81
82
83
84
85
 
# File 'lib/docusign_esign/models/composite_template.rb', line 56

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

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

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

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

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

Instance Attribute Details

#composite_template_id ⇒ Object

The identify of this composite template. It is used as a reference when adding document object information. If used, the document’s ‘content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.



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

def composite_template_id
  @composite_template_id
end

#document ⇒ Object

An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.



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

def document
  @document
end

#inline_templates ⇒ Object

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.



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

def inline_templates
  @inline_templates
end

#pdf_meta_data_template_sequence ⇒ Object

Returns the value of attribute pdf_meta_data_template_sequence.



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

def pdf_meta_data_template_sequence
  @pdf_meta_data_template_sequence
end

#server_templates ⇒ Object

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value



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

def server_templates
  @server_templates
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'composite_template_id' => :'compositeTemplateId',
    :'document' => :'document',
    :'inline_templates' => :'inlineTemplates',
    :'pdf_meta_data_template_sequence' => :'pdfMetaDataTemplateSequence',
    :'server_templates' => :'serverTemplates'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'composite_template_id' => :'String',
    :'document' => :'Document',
    :'inline_templates' => :'Array<InlineTemplate>',
    :'pdf_meta_data_template_sequence' => :'String',
    :'server_templates' => :'Array<ServerTemplate>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
 
# File 'lib/docusign_esign/models/composite_template.rb', line 102

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      composite_template_id == o.composite_template_id &&
      document == o.document &&
      inline_templates == o.inline_templates &&
      pdf_meta_data_template_sequence == o.pdf_meta_data_template_sequence &&
      server_templates == o.server_templates
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



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

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/docusign_esign/models/composite_template.rb', line 214

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/docusign_esign/models/composite_template.rb', line 127

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


114
115
116
 
# File 'lib/docusign_esign/models/composite_template.rb', line 114

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/docusign_esign/models/composite_template.rb', line 120

def hash
  [composite_template_id, document, inline_templates, pdf_meta_data_template_sequence, server_templates].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



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

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



194
195
196
 
# File 'lib/docusign_esign/models/composite_template.rb', line 194

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



200
201
202
203
204
205
206
207
208
 
# File 'lib/docusign_esign/models/composite_template.rb', line 200

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



188
189
190
 
# File 'lib/docusign_esign/models/composite_template.rb', line 188

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



96
97
98
 
# File 'lib/docusign_esign/models/composite_template.rb', line 96

def valid?
  true
end