Class: DocuSign_Maestro::ESignDocumentFromESignTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ESignDocumentFromESignTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 47

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

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

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

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

Instance Attribute Details

#e_sign_template_id ⇒ Object

Returns the value of attribute e_sign_template_id.


16
17
18
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 16

def e_sign_template_id
  @e_sign_template_id
end

#file_extension ⇒ Object

Returns the value of attribute file_extension.


18
19
20
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 18

def file_extension
  @file_extension
end

#name ⇒ Object

Reference of #/definitions/StringOrVariableOrTransformation. Object stands for a String or a Variable or a Transformation. This object should be any of the following object models or types: [string, #/definitions/DSWorkflowVariable, #/definitions/DSWorkflowTransformationExpression]


21
22
23
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 21

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.


23
24
25
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 23

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

26
27
28
29
30
31
32
33
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 26

def self.attribute_map
  {
    :'e_sign_template_id' => :'eSignTemplateId',
    :'file_extension' => :'fileExtension',
    :'name' => :'name',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

36
37
38
39
40
41
42
43
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 36

def self.swagger_types
  {
    :'e_sign_template_id' => :'String',
    :'file_extension' => :'DSWorkflowDocGenDocOutputFormat',
    :'name' => :'Object',
    :'type' => :'ESignDocumentTypesFromDSTemplate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

105
106
107
108
109
110
111
112
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 105

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      e_sign_template_id == o.e_sign_template_id &&
      file_extension == o.file_extension &&
      name == o.name &&
      type == o.type
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

[View source]

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
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 150

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

[View source]

216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 216

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

[View source]

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 129

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
[View source]

116
117
118
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 116

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

122
123
124
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 122

def hash
  [e_sign_template_id, file_extension, name, type].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

[View source]

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 72

def list_invalid_properties
  invalid_properties = Array.new
  if @e_sign_template_id.nil?
    invalid_properties.push('invalid value for "e_sign_template_id", e_sign_template_id cannot be nil.')
  end

  if @file_extension.nil?
    invalid_properties.push('invalid value for "file_extension", file_extension cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  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

[View source]

196
197
198
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 196

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

[View source]

202
203
204
205
206
207
208
209
210
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 202

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

[View source]

190
191
192
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 190

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

[View source]

95
96
97
98
99
100
101
 
# File 'lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb', line 95

def valid?
  return false if @e_sign_template_id.nil?
  return false if @file_extension.nil?
  return false if @name.nil?
  return false if @type.nil?
  true
end