Class: ConnectWise::DocumentInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/document_info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 71

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity


30
31
32
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 30

def _info
  @_info
end

#file_name ⇒ Object

Returns the value of attribute file_name.


11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 11

def file_name
  @file_name
end

#html_template_flag ⇒ Object

Returns the value of attribute html_template_flag.


23
24
25
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 23

def html_template_flag
  @html_template_flag
end

#id ⇒ Object

Returns the value of attribute id.


7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 7

def id
  @id
end

#image_flag ⇒ Object

Returns the value of attribute image_flag.


19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 19

def image_flag
  @image_flag
end

#link_flag ⇒ Object

Returns the value of attribute link_flag.


17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 17

def link_flag
  @link_flag
end

#owner ⇒ Object

Returns the value of attribute owner.


15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 15

def owner
  @owner
end

#public_flag ⇒ Object

Returns the value of attribute public_flag.


21
22
23
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 21

def public_flag
  @public_flag
end

#read_only_flag ⇒ Object

Returns the value of attribute read_only_flag.


25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 25

def read_only_flag
  @read_only_flag
end

#server_file_name ⇒ Object

Returns the value of attribute server_file_name.


13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 13

def server_file_name
  @server_file_name
end

#size ⇒ Object

Returns the value of attribute size.


27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 27

def size
  @size
end

#title ⇒ Object

Returns the value of attribute title.


9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 9

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 34

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'file_name' => :'fileName',
    :'server_file_name' => :'serverFileName',
    :'owner' => :'owner',
    :'link_flag' => :'linkFlag',
    :'image_flag' => :'imageFlag',
    :'public_flag' => :'publicFlag',
    :'html_template_flag' => :'htmlTemplateFlag',
    :'read_only_flag' => :'readOnlyFlag',
    :'size' => :'size',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 52

def self.swagger_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'file_name' => :'String',
    :'server_file_name' => :'String',
    :'owner' => :'String',
    :'link_flag' => :'BOOLEAN',
    :'image_flag' => :'BOOLEAN',
    :'public_flag' => :'BOOLEAN',
    :'html_template_flag' => :'BOOLEAN',
    :'read_only_flag' => :'BOOLEAN',
    :'size' => :'Integer',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      file_name == o.file_name &&
      server_file_name == o.server_file_name &&
      owner == o.owner &&
      link_flag == o.link_flag &&
      image_flag == o.image_flag &&
      public_flag == o.public_flag &&
      html_template_flag == o.html_template_flag &&
      read_only_flag == o.read_only_flag &&
      size == o.size &&
      _info == o._info
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]

195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 195

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 = ConnectWise.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]

261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 261

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]

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 174

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

161
162
163
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

167
168
169
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 167

def hash
  [id, title, file_name, server_file_name, owner, link_flag, image_flag, public_flag, html_template_flag, read_only_flag, size, _info].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

[View source]

129
130
131
132
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 129

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

[View source]

241
242
243
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 241

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]

247
248
249
250
251
252
253
254
255
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 247

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]

235
236
237
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 235

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]

136
137
138
 
# File 'lib/connectwise-ruby-sdk/models/document_info.rb', line 136

def valid?
  return true
end