Class: SignRequestClient::DocumentAttachment

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/models/document_attachment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentAttachment

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 68

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

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

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

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

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

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

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

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

Instance Attribute Details

#document ⇒ Object

Returns the value of attribute document.



36
37
38
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 36

def document
  @document
end

#file ⇒ Object

Temporary URL to document attachment, expires in five minutes



25
26
27
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 25

def file
  @file
end

#file_from_content ⇒ Object

Base64 encoded document content



28
29
30
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 28

def file_from_content
  @file_from_content
end

#file_from_content_name ⇒ Object

Filename, including extension. Required when using file_from_content.



31
32
33
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 31

def file_from_content_name
  @file_from_content_name
end

#file_from_url ⇒ Object

Publicly accessible URL of document to be downloaded by SignRequest



34
35
36
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 34

def file_from_url
  @file_from_url
end

#name ⇒ Object

Defaults to filename, including extension



22
23
24
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 22

def name
  @name
end

#url ⇒ Object

Returns the value of attribute url.



17
18
19
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 17

def url
  @url
end

#uuid ⇒ Object

Returns the value of attribute uuid.



19
20
21
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 19

def uuid
  @uuid
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 39

def self.attribute_map
  {
    :'url' => :'url',
    :'uuid' => :'uuid',
    :'name' => :'name',
    :'file' => :'file',
    :'file_from_content' => :'file_from_content',
    :'file_from_content_name' => :'file_from_content_name',
    :'file_from_url' => :'file_from_url',
    :'document' => :'document'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 53

def self.swagger_types
  {
    :'url' => :'String',
    :'uuid' => :'String',
    :'name' => :'String',
    :'file' => :'String',
    :'file_from_content' => :'String',
    :'file_from_content_name' => :'String',
    :'file_from_url' => :'String',
    :'document' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      uuid == o.uuid &&
      name == o.name &&
      file == o.file &&
      file_from_content == o.file_from_content &&
      file_from_content_name == o.file_from_content_name &&
      file_from_url == o.file_from_url &&
      document == o.document
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 221

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 = SignRequestClient.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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 287

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 200

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:

  • to be compared

Returns:

See Also:

  • `==` method


187
188
189
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • Hash code



193
194
195
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 193

def hash
  [url, uuid, name, file, file_from_content, file_from_content_name, file_from_url, document].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  if !@uuid.nil? && @uuid.to_s.length < 1
    invalid_properties.push('invalid value for "uuid", the character length must be great than or equal to 1.')
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if !@file_from_url.nil? && @file_from_url.to_s.length > 2100
    invalid_properties.push('invalid value for "file_from_url", the character length must be smaller than or equal to 2100.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



267
268
269
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 273

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 presentation of the object



261
262
263
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 261

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



132
133
134
135
136
137
138
 
# File 'lib/signrequest_client/models/document_attachment.rb', line 132

def valid?
  return false if !@uuid.nil? && @uuid.to_s.length < 1
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@file_from_url.nil? && @file_from_url.to_s.length > 2100
  return false if @document.nil?
  true
end