Class: OpenapiClient::UpsAccountSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/ups_account_settings.rb

Overview

UPS account settings

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpsAccountSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 96

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_postal_code ⇒ Object

account postal code



47
48
49
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 47

def 
  @account_postal_code
end

#invoice ⇒ Object

The invoice



50
51
52
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 50

def invoice
  @invoice
end

#is_primary_account ⇒ Object

Indicates if this is the primary UPS account



22
23
24
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 22

def 
  @is_primary_account
end

#mail_innovations_cost_center ⇒ Object

mail innovations cost center



41
42
43
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 41

def mail_innovations_cost_center
  @mail_innovations_cost_center
end

#mail_innovations_endorsement ⇒ Object

Returns the value of attribute mail_innovations_endorsement.



38
39
40
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 38

def mail_innovations_endorsement
  @mail_innovations_endorsement
end

#nickname ⇒ Object

nickname



19
20
21
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 19

def nickname
  @nickname
end

#pickup_type ⇒ Object

Returns the value of attribute pickup_type.



24
25
26
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 24

def pickup_type
  @pickup_type
end

#use_carbon_neutral_shipping_program ⇒ Object

The use carbon neutral shipping program



27
28
29
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 27

def use_carbon_neutral_shipping_program
  @use_carbon_neutral_shipping_program
end

#use_consolidation_services ⇒ Object

The use consolidation services



33
34
35
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 33

def use_consolidation_services
  @use_consolidation_services
end

#use_ground_freight_pricing ⇒ Object

The use ground freight pricing



30
31
32
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 30

def use_ground_freight_pricing
  @use_ground_freight_pricing
end

#use_negotiated_rates ⇒ Object

The use negotiated rates



44
45
46
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 44

def use_negotiated_rates
  @use_negotiated_rates
end

#use_order_number_on_mail_innovations_labels ⇒ Object

The use order number on mail innovations labels



36
37
38
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 36

def use_order_number_on_mail_innovations_labels
  @use_order_number_on_mail_innovations_labels
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 53

def self.attribute_map
  {
    :'nickname' => :'nickname',
    :'is_primary_account' => :'is_primary_account',
    :'pickup_type' => :'pickup_type',
    :'use_carbon_neutral_shipping_program' => :'use_carbon_neutral_shipping_program',
    :'use_ground_freight_pricing' => :'use_ground_freight_pricing',
    :'use_consolidation_services' => :'use_consolidation_services',
    :'use_order_number_on_mail_innovations_labels' => :'use_order_number_on_mail_innovations_labels',
    :'mail_innovations_endorsement' => :'mail_innovations_endorsement',
    :'mail_innovations_cost_center' => :'mail_innovations_cost_center',
    :'use_negotiated_rates' => :'use_negotiated_rates',
    :'account_postal_code' => :'account_postal_code',
    :'invoice' => :'invoice'
  }
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



250
251
252
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 250

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 71

def self.openapi_types
  {
    :'nickname' => :'String',
    :'is_primary_account' => :'Boolean',
    :'pickup_type' => :'UpsPickupType',
    :'use_carbon_neutral_shipping_program' => :'Boolean',
    :'use_ground_freight_pricing' => :'Boolean',
    :'use_consolidation_services' => :'Boolean',
    :'use_order_number_on_mail_innovations_labels' => :'Boolean',
    :'mail_innovations_endorsement' => :'AncillaryServiceEndorsement',
    :'mail_innovations_cost_center' => :'String',
    :'use_negotiated_rates' => :'Boolean',
    :'account_postal_code' => :'String',
    :'invoice' => :'UpsInvoice'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nickname == o.nickname &&
       == o. &&
      pickup_type == o.pickup_type &&
      use_carbon_neutral_shipping_program == o.use_carbon_neutral_shipping_program &&
      use_ground_freight_pricing == o.use_ground_freight_pricing &&
      use_consolidation_services == o.use_consolidation_services &&
      use_order_number_on_mail_innovations_labels == o.use_order_number_on_mail_innovations_labels &&
      mail_innovations_endorsement == o.mail_innovations_endorsement &&
      mail_innovations_cost_center == o.mail_innovations_cost_center &&
      use_negotiated_rates == o.use_negotiated_rates &&
       == o. &&
      invoice == o.invoice
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



278
279
280
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
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 278

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
    OpenapiClient.const_get(type).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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 347

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 257

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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


237
238
239
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



243
244
245
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 243

def hash
  [nickname, , pickup_type, use_carbon_neutral_shipping_program, use_ground_freight_pricing, use_consolidation_services, use_order_number_on_mail_innovations_labels, mail_innovations_endorsement, mail_innovations_cost_center, use_negotiated_rates, , invoice].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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 160

def list_invalid_properties
  invalid_properties = Array.new
  if !@nickname.nil? && @nickname.to_s.length < 1
    invalid_properties.push('invalid value for "nickname", the character length must be great than or equal to 1.')
  end

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

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

  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



323
324
325
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 329

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



317
318
319
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 317

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



179
180
181
182
183
184
 
# File 'lib/openapi_client/models/ups_account_settings.rb', line 179

def valid?
  return false if !@nickname.nil? && @nickname.to_s.length < 1
  return false if !@mail_innovations_cost_center.nil? && @mail_innovations_cost_center.to_s.length < 0
  return false if !@account_postal_code.nil? && @account_postal_code.to_s.length < 5
  true
end