Class: ConnectWise::DocumentSetup

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/document_setup.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentSetup

Initializes the object

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/document_setup.rb', line 68

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::DocumentSetup` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::DocumentSetup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.id = attributes[:id] if attributes.key?(:id)

  self.upload_as_link_flag = attributes[:upload_as_link_flag] if attributes.key?(:upload_as_link_flag)

  self.is_public_flag = attributes[:is_public_flag] if attributes.key?(:is_public_flag)

  self.doc_path = attributes[:doc_path] if attributes.key?(:doc_path)

  self.template_path = attributes[:template_path] if attributes.key?(:template_path)

  self.template_output_path = attributes[:template_output_path] if attributes.key?(:template_output_path)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/document_setup.rb', line 16

def _info
  @_info
end

#doc_path ⇒ Object

Max length: 100;



19
20
21
 
# File 'lib/connect_wise/models/document_setup.rb', line 19

def doc_path
  @doc_path
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/document_setup.rb', line 16

def id
  @id
end

#is_public_flag ⇒ Object

Returns the value of attribute is_public_flag.



16
17
18
 
# File 'lib/connect_wise/models/document_setup.rb', line 16

def is_public_flag
  @is_public_flag
end

#template_output_path ⇒ Object

Max length: 200;



25
26
27
 
# File 'lib/connect_wise/models/document_setup.rb', line 25

def template_output_path
  @template_output_path
end

#template_path ⇒ Object

Max length: 200;



22
23
24
 
# File 'lib/connect_wise/models/document_setup.rb', line 22

def template_path
  @template_path
end

#upload_as_link_flag ⇒ Object

Returns the value of attribute upload_as_link_flag.



16
17
18
 
# File 'lib/connect_wise/models/document_setup.rb', line 16

def upload_as_link_flag
  @upload_as_link_flag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/connect_wise/models/document_setup.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/connect_wise/models/document_setup.rb', line 28

def self.attribute_map
  {
    id: :id,
    upload_as_link_flag: :uploadAsLinkFlag,
    is_public_flag: :isPublicFlag,
    doc_path: :docPath,
    template_path: :templatePath,
    template_output_path: :templateOutputPath,
    _info: :_info
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



138
139
140
 
# File 'lib/connect_wise/models/document_setup.rb', line 138

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
63
64
 
# File 'lib/connect_wise/models/document_setup.rb', line 59

def self.openapi_nullable
  Set.new(i[
            upload_as_link_flag
            is_public_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/connect_wise/models/document_setup.rb', line 46

def self.openapi_types
  {
    id: :Integer,
    upload_as_link_flag: :Boolean,
    is_public_flag: :Boolean,
    doc_path: :String,
    template_path: :String,
    template_output_path: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/connect_wise/models/document_setup.rb', line 110

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    upload_as_link_flag == other.upload_as_link_flag &&
    is_public_flag == other.is_public_flag &&
    doc_path == other.doc_path &&
    template_path == other.template_path &&
    template_output_path == other.template_output_path &&
    _info == other._info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/connect_wise/models/document_setup.rb', line 168

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/connect_wise/models/document_setup.rb', line 239

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/connect_wise/models/document_setup.rb', line 145

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif 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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


125
126
127
 
# File 'lib/connect_wise/models/document_setup.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



131
132
133
 
# File 'lib/connect_wise/models/document_setup.rb', line 131

def hash
  [id, upload_as_link_flag, is_public_flag, doc_path, template_path, template_output_path, _info].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



98
99
100
 
# File 'lib/connect_wise/models/document_setup.rb', line 98

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



215
216
217
 
# File 'lib/connect_wise/models/document_setup.rb', line 215

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/connect_wise/models/document_setup.rb', line 221

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



209
210
211
 
# File 'lib/connect_wise/models/document_setup.rb', line 209

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



104
105
106
 
# File 'lib/connect_wise/models/document_setup.rb', line 104

def valid?
  true
end