Class: Zippendo::UpdateOrgBrandRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zippendo/models/update_org_brand_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOrgBrandRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zippendo::UpdateOrgBrandRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::UpdateOrgBrandRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'company_name')
    self.company_name = attributes[:'company_name']
  end

  if attributes.key?(:'vat_number')
    self.vat_number = attributes[:'vat_number']
  end

  if attributes.key?(:'customs')
    if (value = attributes[:'customs']).is_a?(Hash)
      self.customs = value
    end
  end

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

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

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

  if attributes.key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  end

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

  if attributes.key?(:'primary_color')
    self.primary_color = attributes[:'primary_color']
  end

  if attributes.key?(:'secondary_color')
    self.secondary_color = attributes[:'secondary_color']
  end

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

  if attributes.key?(:'slug')
    self.slug = attributes[:'slug']
  end

  if attributes.key?(:'use_org_customs')
    self.use_org_customs = attributes[:'use_org_customs']
  end
end

Instance Attribute Details

#address_line1 ⇒ Object

Street address line 1



28
29
30
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 28

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Street address line 2



31
32
33
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 31

def address_line2
  @address_line2
end

#city ⇒ Object

City



34
35
36
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 34

def city
  @city
end

#company_name ⇒ Object

Legal entity name printed on this brand's documents



19
20
21
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 19

def company_name
  @company_name
end

#country ⇒ Object

Country (ISO 3166-1 alpha-2)



40
41
42
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 40

def country
  @country
end

#customs ⇒ Object

Customs identifiers keyed by type



25
26
27
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 25

def customs
  @customs
end

#name ⇒ Object

Brand display name



49
50
51
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 49

def name
  @name
end

#postal_code ⇒ Object

Postal code



37
38
39
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 37

def postal_code
  @postal_code
end

#primary_color ⇒ Object

Primary brand colour — document title and table headers



43
44
45
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 43

def primary_color
  @primary_color
end

#secondary_color ⇒ Object

Secondary brand colour — subtitle, section headings, totals accent



46
47
48
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 46

def secondary_color
  @secondary_color
end

#slug ⇒ Object

URL-safe identifier, unique within the org



52
53
54
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 52

def slug
  @slug
end

#use_org_customs ⇒ Object

Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all.



55
56
57
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 55

def use_org_customs
  @use_org_customs
end

#vat_number ⇒ Object

VAT/tax ID for this brand's shipments and documents



22
23
24
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 22

def vat_number
  @vat_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 58

def self.attribute_map
  {
    :'company_name' => :'companyName',
    :'vat_number' => :'vatNumber',
    :'customs' => :'customs',
    :'address_line1' => :'addressLine1',
    :'address_line2' => :'addressLine2',
    :'city' => :'city',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'primary_color' => :'primaryColor',
    :'secondary_color' => :'secondaryColor',
    :'name' => :'name',
    :'slug' => :'slug',
    :'use_org_customs' => :'useOrgCustoms'
  }
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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 457

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 106

def self.openapi_nullable
  Set.new([
    :'company_name',
    :'vat_number',
    :'customs',
    :'address_line1',
    :'address_line2',
    :'city',
    :'postal_code',
    :'country',
    :'primary_color',
    :'secondary_color',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 87

def self.openapi_types
  {
    :'company_name' => :'String',
    :'vat_number' => :'String',
    :'customs' => :'Hash<String, String>',
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'city' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'primary_color' => :'String',
    :'secondary_color' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'use_org_customs' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 424

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company_name == o.company_name &&
      vat_number == o.vat_number &&
      customs == o.customs &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      city == o.city &&
      postal_code == o.postal_code &&
      country == o.country &&
      primary_color == o.primary_color &&
      secondary_color == o.secondary_color &&
      name == o.name &&
      slug == o.slug &&
      use_org_customs == o.use_org_customs
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


444
445
446
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 444

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



450
451
452
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 450

def hash
  [company_name, vat_number, customs, address_line1, address_line2, city, postal_code, country, primary_color, secondary_color, name, slug, use_org_customs].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



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
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
258
259
260
261
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 194

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@company_name.nil? && @company_name.to_s.length > 200
    invalid_properties.push('invalid value for "company_name", the character length must be smaller than or equal to 200.')
  end

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

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

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

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

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

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

  if !@country.nil? && @country.to_s.length < 2
    invalid_properties.push('invalid value for "country", the character length must be greater than or equal to 2.')
  end

  pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
  if !@primary_color.nil? && @primary_color !~ pattern
    invalid_properties.push("invalid value for \"primary_color\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
  if !@secondary_color.nil? && @secondary_color !~ pattern
    invalid_properties.push("invalid value for \"secondary_color\", must conform to the pattern #{pattern}.")
  end

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

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

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

  if !@slug.nil? && @slug.to_s.length < 2
    invalid_properties.push('invalid value for "slug", the character length must be greater than or equal to 2.')
  end

  pattern = Regexp.new(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
  if !@slug.nil? && @slug !~ pattern
    invalid_properties.push("invalid value for \"slug\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 479

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/zippendo/models/update_org_brand_request.rb', line 265

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@company_name.nil? && @company_name.to_s.length > 200
  return false if !@vat_number.nil? && @vat_number.to_s.length > 40
  return false if !@address_line1.nil? && @address_line1.to_s.length > 200
  return false if !@address_line2.nil? && @address_line2.to_s.length > 200
  return false if !@city.nil? && @city.to_s.length > 100
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@country.nil? && @country.to_s.length < 2
  return false if !@primary_color.nil? && @primary_color !~ Regexp.new(/^#[0-9a-fA-F]{6}$/)
  return false if !@secondary_color.nil? && @secondary_color !~ Regexp.new(/^#[0-9a-fA-F]{6}$/)
  return false if !@name.nil? && @name.to_s.length > 120
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@slug.nil? && @slug.to_s.length > 60
  return false if !@slug.nil? && @slug.to_s.length < 2
  return false if !@slug.nil? && @slug !~ Regexp.new(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
  true
end