Class: OpenapiClient::UpdateCarrierSettingsRequestBody

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateCarrierSettingsRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UpdateCarrierSettingsRequestBody` 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::UpdateCarrierSettingsRequestBody`. 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?(:'should_hide_account_number_on_archive_doc')
    self. = attributes[:'should_hide_account_number_on_archive_doc']
  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?(:'smart_post_hub')
    self.smart_post_hub = attributes[:'smart_post_hub']
  end

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

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

  if attributes.key?(:'receive_email_on_manifest_processing')
    self.receive_email_on_manifest_processing = attributes[:'receive_email_on_manifest_processing']
  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

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

Instance Attribute Details

#account_postal_code ⇒ Object

account postal code



57
58
59
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 57

def 
  @account_postal_code
end

#email ⇒ Object

Email



63
64
65
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 63

def email
  @email
end

#include_barcode_with_order_number ⇒ Object

Returns the value of attribute include_barcode_with_order_number.



32
33
34
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 32

def include_barcode_with_order_number
  @include_barcode_with_order_number
end

#invoice ⇒ Object

The invoice



60
61
62
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 60

def invoice
  @invoice
end

#is_primary_account ⇒ Object

Indicates if this is the primary UPS account



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

def 
  
end

#mail_innovations_cost_center ⇒ Object

mail innovations cost center



51
52
53
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 51

def mail_innovations_cost_center
  @mail_innovations_cost_center
end

#mail_innovations_endorsement ⇒ Object

Returns the value of attribute mail_innovations_endorsement.



48
49
50
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 48

def mail_innovations_endorsement
  @mail_innovations_endorsement
end

#nickname ⇒ Object

nickname



18
19
20
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 18

def nickname
  @nickname
end

#pickup_type ⇒ Object

Returns the value of attribute pickup_type.



26
27
28
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 26

def pickup_type
  @pickup_type
end

#receive_email_on_manifest_processing ⇒ Object

Returns the value of attribute receive_email_on_manifest_processing.



34
35
36
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 34

def receive_email_on_manifest_processing
  @receive_email_on_manifest_processing
end

#should_hide_account_number_on_archive_doc ⇒ Object

Indicates if the account number should be hidden on the archive documentation



21
22
23
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 21

def 
  
end

#smart_post_endorsement ⇒ Object

Returns the value of attribute smart_post_endorsement.



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

def smart_post_endorsement
  @smart_post_endorsement
end

#smart_post_hub ⇒ Object

Returns the value of attribute smart_post_hub.



28
29
30
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 28

def smart_post_hub
  @smart_post_hub
end

#use_carbon_neutral_shipping_program ⇒ Object

The use carbon neutral shipping program



37
38
39
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 37

def use_carbon_neutral_shipping_program
  @use_carbon_neutral_shipping_program
end

#use_consolidation_services ⇒ Object

The use consolidation services



43
44
45
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 43

def use_consolidation_services
  @use_consolidation_services
end

#use_ground_freight_pricing ⇒ Object

The use ground freight pricing



40
41
42
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 40

def use_ground_freight_pricing
  @use_ground_freight_pricing
end

#use_negotiated_rates ⇒ Object

The use negotiated rates



54
55
56
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 54

def use_negotiated_rates
  @use_negotiated_rates
end

#use_order_number_on_mail_innovations_labels ⇒ Object

The use order number on mail innovations labels



46
47
48
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 46

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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 66

def self.attribute_map
  {
    :'nickname' => :'nickname',
    :'should_hide_account_number_on_archive_doc' => :'should_hide_account_number_on_archive_doc',
    :'is_primary_account' => :'is_primary_account',
    :'pickup_type' => :'pickup_type',
    :'smart_post_hub' => :'smart_post_hub',
    :'smart_post_endorsement' => :'smart_post_endorsement',
    :'include_barcode_with_order_number' => :'include_barcode_with_order_number',
    :'receive_email_on_manifest_processing' => :'receive_email_on_manifest_processing',
    :'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',
    :'email' => :'email'
  }
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



347
348
349
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 347

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 114

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

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



120
121
122
123
124
125
126
127
128
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 120

def self.openapi_one_of
  [
  :'UpdateAmazonBuyShippingRequestBody',
  :'UpdateDhlExpressSettingsRequestBody',
  :'UpdateFedexSettingsRequestBody',
  :'UpdateNewgisticsSettingsRequestBody',
  :'UpdateUpsSettingsRequestBody'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 90

def self.openapi_types
  {
    :'nickname' => :'String',
    :'should_hide_account_number_on_archive_doc' => :'Boolean',
    :'is_primary_account' => :'Boolean',
    :'pickup_type' => :'UpsPickupType',
    :'smart_post_hub' => :'SmartPostHub',
    :'smart_post_endorsement' => :'AncillaryServiceEndorsement',
    :'include_barcode_with_order_number' => :'Boolean',
    :'receive_email_on_manifest_processing' => :'Boolean',
    :'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',
    :'email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nickname == o.nickname &&
       == o. &&
       == o. &&
      pickup_type == o.pickup_type &&
      smart_post_hub == o.smart_post_hub &&
      smart_post_endorsement == o.smart_post_endorsement &&
      include_barcode_with_order_number == o.include_barcode_with_order_number &&
      receive_email_on_manifest_processing == o.receive_email_on_manifest_processing &&
      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 &&
      email == o.email
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



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
409
410
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 375

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 444

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 354

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


334
335
336
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 340

def hash
  [nickname, , , pickup_type, smart_post_hub, smart_post_endorsement, include_barcode_with_order_number, receive_email_on_manifest_processing, 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, email].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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 220

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

  if !@email.nil? && @email.to_s.length < 1
    invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
  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



420
421
422
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 426

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



414
415
416
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 414

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/openapi_client/models/update_carrier_settings_request_body.rb', line 243

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
  return false if !@email.nil? && @email.to_s.length < 1
  _one_of_found = false
  self.class.openapi_one_of.each do |_class|
    _one_of = OpenapiClient.const_get(_class).build_from_hash(self.to_hash)
    if _one_of.valid?
      if _one_of_found
        return false
      else
        _one_of_found = true
      end
    end
  end

  if !_one_of_found
    return false
  end

  true
end