Class: ConnectWise::ConnectWiseHostedSetup

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectWiseHostedSetup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



40
41
42
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 40

def _info
  @_info
end

#created_by ⇒ Object

Returns the value of attribute created_by.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 35

def created_by
  @created_by
end

#date_created ⇒ Object

Returns the value of attribute date_created.



37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 37

def date_created
  @date_created
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#disabled_flag ⇒ Object

Returns the value of attribute disabled_flag.



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 33

def disabled_flag
  @disabled_flag
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#origin ⇒ Object

Returns the value of attribute origin.



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

def origin
  @origin
end

#pod_height ⇒ Object

Returns the value of attribute pod_height.



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

def pod_height
  @pod_height
end

#screen_id ⇒ Object

Can be obtained via ConnectWiseHostedApiScreen report



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

def screen_id
  @screen_id
end

#toolbar_button_dialog_height ⇒ Object

Returns the value of attribute toolbar_button_dialog_height.



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

def toolbar_button_dialog_height
  @toolbar_button_dialog_height
end

#toolbar_button_dialog_width ⇒ Object

Returns the value of attribute toolbar_button_dialog_width.



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

def toolbar_button_dialog_width
  @toolbar_button_dialog_width
end

#toolbar_button_icon_document_id ⇒ Object

Returns the value of attribute toolbar_button_icon_document_id.



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

def toolbar_button_icon_document_id
  @toolbar_button_icon_document_id
end

#toolbar_button_text ⇒ Object

Only required for ToolbarButtons



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

def toolbar_button_text
  @toolbar_button_text
end

#toolbar_button_tool_tip ⇒ Object

Returns the value of attribute toolbar_button_tool_tip.



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

def toolbar_button_tool_tip
  @toolbar_button_tool_tip
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'screen_id' => :'screenId',
    :'description' => :'description',
    :'url' => :'url',
    :'type' => :'type',
    :'origin' => :'origin',
    :'pod_height' => :'podHeight',
    :'toolbar_button_dialog_height' => :'toolbarButtonDialogHeight',
    :'toolbar_button_dialog_width' => :'toolbarButtonDialogWidth',
    :'toolbar_button_text' => :'toolbarButtonText',
    :'toolbar_button_tool_tip' => :'toolbarButtonToolTip',
    :'toolbar_button_icon_document_id' => :'toolbarButtonIconDocumentId',
    :'disabled_flag' => :'disabledFlag',
    :'created_by' => :'createdBy',
    :'date_created' => :'dateCreated',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 87

def self.swagger_types
  {
    :'id' => :'Integer',
    :'screen_id' => :'Integer',
    :'description' => :'String',
    :'url' => :'String',
    :'type' => :'String',
    :'origin' => :'String',
    :'pod_height' => :'Integer',
    :'toolbar_button_dialog_height' => :'Integer',
    :'toolbar_button_dialog_width' => :'Integer',
    :'toolbar_button_text' => :'String',
    :'toolbar_button_tool_tip' => :'String',
    :'toolbar_button_icon_document_id' => :'Integer',
    :'disabled_flag' => :'BOOLEAN',
    :'created_by' => :'String',
    :'date_created' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      screen_id == o.screen_id &&
      description == o.description &&
      url == o.url &&
      type == o.type &&
      origin == o.origin &&
      pod_height == o.pod_height &&
      toolbar_button_dialog_height == o.toolbar_button_dialog_height &&
      toolbar_button_dialog_width == o.toolbar_button_dialog_width &&
      toolbar_button_text == o.toolbar_button_text &&
      toolbar_button_tool_tip == o.toolbar_button_tool_tip &&
      toolbar_button_icon_document_id == o.toolbar_button_icon_document_id &&
      disabled_flag == o.disabled_flag &&
      created_by == o.created_by &&
      date_created == o.date_created &&
      _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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 372

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 438

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 351

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


338
339
340
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 344

def hash
  [id, screen_id, description, url, type, origin, pod_height, toolbar_button_dialog_height, toolbar_button_dialog_width, toolbar_button_text, toolbar_button_tool_tip, toolbar_button_icon_document_id, disabled_flag, created_by, date_created, _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



184
185
186
187
188
189
190
191
192
193
194
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
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 184

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

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

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

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

  if @url.to_s.length > 1024
    invalid_properties.push("invalid value for 'url', the character length must be smaller than or equal to 1024.")
  end

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

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

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

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

  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



418
419
420
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 418

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



424
425
426
427
428
429
430
431
432
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 424

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



412
413
414
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 412

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/connectwise-ruby-sdk/models/connect_wise_hosted_setup.rb', line 227

def valid?
  return false if @screen_id.nil?
  return false if @description.nil?
  return false if @description.to_s.length > 255
  return false if @url.nil?
  return false if @url.to_s.length > 1024
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["Tab", "Pod", "ToolbarButton"])
  return false unless type_validator.valid?(@type)
  return false if !@origin.nil? && @origin.to_s.length > 50
  return false if !@toolbar_button_text.nil? && @toolbar_button_text.to_s.length > 50
  return false if !@toolbar_button_tool_tip.nil? && @toolbar_button_tool_tip.to_s.length > 50
  return true
end