Class: ConnectWise::CompanySite

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompanySite

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
181
182
183
184
 
# File 'lib/connect_wise/models/company_site.rb', line 122

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::CompanySite` 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::CompanySite`. 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.name = attributes[:name] if attributes.key?(:name)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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.



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

def _info
  @_info
end

#address_format ⇒ Object

Returns the value of attribute address_format.



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

def address_format
  @address_format
end

#address_line1 ⇒ Object

Max length: 50;



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

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Max length: 50;



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

def address_line2
  @address_line2
end

#bill_separate_flag ⇒ Object

Returns the value of attribute bill_separate_flag.



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

def bill_separate_flag
  @bill_separate_flag
end

#calendar ⇒ Object

Returns the value of attribute calendar.



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

def calendar
  @calendar
end

#city ⇒ Object

Max length: 50;



28
29
30
 
# File 'lib/connect_wise/models/company_site.rb', line 28

def city
  @city
end

#company ⇒ Object

Returns the value of attribute company.



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

def company
  @company
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#default_billing_flag ⇒ Object

Returns the value of attribute default_billing_flag.



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

def default_billing_flag
  @default_billing_flag
end

#default_mailing_flag ⇒ Object

Returns the value of attribute default_mailing_flag.



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

def default_mailing_flag
  @default_mailing_flag
end

#default_shipping_flag ⇒ Object

Returns the value of attribute default_shipping_flag.



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

def default_shipping_flag
  @default_shipping_flag
end

#entity_type ⇒ Object

Returns the value of attribute entity_type.



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

def entity_type
  @entity_type
end

#expense_reimbursement ⇒ Object

Returns the value of attribute expense_reimbursement.



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

def expense_reimbursement
  @expense_reimbursement
end

#fax_number ⇒ Object

Max length: 30;



37
38
39
 
# File 'lib/connect_wise/models/company_site.rb', line 37

def fax_number
  @fax_number
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



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

def inactive_flag
  @inactive_flag
end

#mobile_guid ⇒ Object

Returns the value of attribute mobile_guid.



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

def mobile_guid
  @mobile_guid
end

#name ⇒ Object

Max length: 50;



17
18
19
 
# File 'lib/connect_wise/models/company_site.rb', line 17

def name
  @name
end

#phone_number ⇒ Object

Max length: 30;



34
35
36
 
# File 'lib/connect_wise/models/company_site.rb', line 34

def phone_number
  @phone_number
end

#primary_address_flag ⇒ Object

Returns the value of attribute primary_address_flag.



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

def primary_address_flag
  @primary_address_flag
end

#state_reference ⇒ Object

Returns the value of attribute state_reference.



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

def state_reference
  @state_reference
end

#tax_code ⇒ Object

Returns the value of attribute tax_code.



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

def tax_code
  @tax_code
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



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

def time_zone
  @time_zone
end

#zip ⇒ Object

Max length: 12;



31
32
33
 
# File 'lib/connect_wise/models/company_site.rb', line 31

def zip
  @zip
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/connect_wise/models/company_site.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/connect_wise/models/company_site.rb', line 40

def self.attribute_map
  {
    name: :name,
    id: :id,
    address_line1: :addressLine1,
    address_line2: :addressLine2,
    city: :city,
    state_reference: :stateReference,
    zip: :zip,
    country: :country,
    address_format: :addressFormat,
    phone_number: :phoneNumber,
    fax_number: :faxNumber,
    tax_code: :taxCode,
    entity_type: :entityType,
    expense_reimbursement: :expenseReimbursement,
    primary_address_flag: :primaryAddressFlag,
    default_shipping_flag: :defaultShippingFlag,
    default_billing_flag: :defaultBillingFlag,
    default_mailing_flag: :defaultMailingFlag,
    inactive_flag: :inactiveFlag,
    bill_separate_flag: :billSeparateFlag,
    mobile_guid: :mobileGuid,
    calendar: :calendar,
    time_zone: :timeZone,
    company: :company,
    _info: :_info
  }
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



251
252
253
 
# File 'lib/connect_wise/models/company_site.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/connect_wise/models/company_site.rb', line 107

def self.openapi_nullable
  Set.new(i[
            expense_reimbursement
            primary_address_flag
            default_shipping_flag
            default_billing_flag
            default_mailing_flag
            inactive_flag
            bill_separate_flag
            mobile_guid
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    name: :String,
    id: :Integer,
    address_line1: :String,
    address_line2: :String,
    city: :String,
    state_reference: :StateReference,
    zip: :String,
    country: :CountryReference,
    address_format: :String,
    phone_number: :String,
    fax_number: :String,
    tax_code: :TaxCodeReference,
    entity_type: :EntityTypeReference,
    expense_reimbursement: :Float,
    primary_address_flag: :Boolean,
    default_shipping_flag: :Boolean,
    default_billing_flag: :Boolean,
    default_mailing_flag: :Boolean,
    inactive_flag: :Boolean,
    bill_separate_flag: :Boolean,
    mobile_guid: :String,
    calendar: :CalendarReference,
    time_zone: :TimeZoneSetupReference,
    company: :CompanyReference,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
232
233
234
 
# File 'lib/connect_wise/models/company_site.rb', line 205

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

  self.class == other.class &&
    name == other.name &&
    id == other.id &&
    address_line1 == other.address_line1 &&
    address_line2 == other.address_line2 &&
    city == other.city &&
    state_reference == other.state_reference &&
    zip == other.zip &&
    country == other.country &&
    address_format == other.address_format &&
    phone_number == other.phone_number &&
    fax_number == other.fax_number &&
    tax_code == other.tax_code &&
    entity_type == other.entity_type &&
    expense_reimbursement == other.expense_reimbursement &&
    primary_address_flag == other.primary_address_flag &&
    default_shipping_flag == other.default_shipping_flag &&
    default_billing_flag == other.default_billing_flag &&
    default_mailing_flag == other.default_mailing_flag &&
    inactive_flag == other.inactive_flag &&
    bill_separate_flag == other.bill_separate_flag &&
    mobile_guid == other.mobile_guid &&
    calendar == other.calendar &&
    time_zone == other.time_zone &&
    company == other.company &&
    _info == other._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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/connect_wise/models/company_site.rb', line 281

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/connect_wise/models/company_site.rb', line 352

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/connect_wise/models/company_site.rb', line 258

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/connect_wise/models/company_site.rb', line 238

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/connect_wise/models/company_site.rb', line 244

def hash
  [name, id, address_line1, address_line2, city, state_reference, zip, country, address_format, phone_number, fax_number, tax_code, entity_type, expense_reimbursement, primary_address_flag, default_shipping_flag, default_billing_flag, default_mailing_flag, inactive_flag, bill_separate_flag, mobile_guid, calendar, time_zone, company, _info].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



188
189
190
191
192
193
 
# File 'lib/connect_wise/models/company_site.rb', line 188

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil?

  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



328
329
330
 
# File 'lib/connect_wise/models/company_site.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/connect_wise/models/company_site.rb', line 334

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

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/connect_wise/models/company_site.rb', line 322

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



197
198
199
200
201
 
# File 'lib/connect_wise/models/company_site.rb', line 197

def valid?
  return false if @name.nil?

  true
end