Class: OpenapiClient::ConnectDhlEcommerceRequestBody

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

Overview

A DHL Ecommerce account information request body

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectDhlEcommerceRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Account number



45
46
47
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 45

def 
  @account_number
end

#ancillary_endorsement ⇒ Object

Returns the value of attribute ancillary_endorsement.



42
43
44
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 42

def ancillary_endorsement
  @ancillary_endorsement
end

#api_key ⇒ Object

The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account.



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

def api_key
  @api_key
end

#api_secret ⇒ Object

The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.



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

def api_secret
  @api_secret
end

#client_id ⇒ Object

The client id



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

def client_id
  @client_id
end

#distribution_center ⇒ Object

The distribution center



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

def distribution_center
  @distribution_center
end

#ftp_password ⇒ Object

FTP password



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

def ftp_password
  @ftp_password
end

#ftp_username ⇒ Object

FTP username



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

def ftp_username
  @ftp_username
end

#nickname ⇒ Object

A nickname to help you identify this account



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

def nickname
  @nickname
end

#password ⇒ Object

The account password



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

def password
  @password
end

#pickup_number ⇒ Object

The pickup number



31
32
33
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 31

def pickup_number
  @pickup_number
end

#username ⇒ Object

The account username



25
26
27
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 25

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'nickname' => :'nickname',
    :'client_id' => :'client_id',
    :'username' => :'username',
    :'password' => :'password',
    :'pickup_number' => :'pickup_number',
    :'distribution_center' => :'distribution_center',
    :'api_key' => :'api_key',
    :'api_secret' => :'api_secret',
    :'ancillary_endorsement' => :'ancillary_endorsement',
    :'account_number' => :'account_number',
    :'ftp_username' => :'ftp_username',
    :'ftp_password' => :'ftp_password'
  }
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



425
426
427
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 425

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'nickname' => :'String',
    :'client_id' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'pickup_number' => :'String',
    :'distribution_center' => :'String',
    :'api_key' => :'String',
    :'api_secret' => :'String',
    :'ancillary_endorsement' => :'AncillaryServiceEndorsement',
    :'account_number' => :'String',
    :'ftp_username' => :'String',
    :'ftp_password' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 393

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nickname == o.nickname &&
      client_id == o.client_id &&
      username == o.username &&
      password == o.password &&
      pickup_number == o.pickup_number &&
      distribution_center == o.distribution_center &&
      api_key == o.api_key &&
      api_secret == o.api_secret &&
      ancillary_endorsement == o.ancillary_endorsement &&
       == o. &&
      ftp_username == o.ftp_username &&
      ftp_password == o.ftp_password
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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 453

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



522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 522

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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 432

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


412
413
414
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



418
419
420
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 418

def hash
  [nickname, client_id, username, password, pickup_number, distribution_center, api_key, api_secret, ancillary_endorsement, , ftp_username, ftp_password].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



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 161

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

  if @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 @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  if @client_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_id", the character length must be great than or equal to 1.')
  end

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

  if @username.to_s.length < 1
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
  end

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

  if @password.to_s.length < 1
    invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.')
  end

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

  if @pickup_number.to_s.length < 1
    invalid_properties.push('invalid value for "pickup_number", the character length must be great than or equal to 1.')
  end

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

  if @distribution_center.to_s.length < 1
    invalid_properties.push('invalid value for "distribution_center", the character length must be great than or equal to 1.')
  end

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

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

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

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

  if !@ftp_password.nil? && @ftp_password.to_s.length < 1
    invalid_properties.push('invalid value for "ftp_password", 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



498
499
500
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 498

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



504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 504

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



492
493
494
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 492

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb', line 236

def valid?
  return false if @nickname.nil?
  return false if @nickname.to_s.length < 1
  return false if @client_id.nil?
  return false if @client_id.to_s.length < 1
  return false if @username.nil?
  return false if @username.to_s.length < 1
  return false if @password.nil?
  return false if @password.to_s.length < 1
  return false if @pickup_number.nil?
  return false if @pickup_number.to_s.length < 1
  return false if @distribution_center.nil?
  return false if @distribution_center.to_s.length < 1
  return false if !@api_key.nil? && @api_key.to_s.length < 1
  return false if !@api_secret.nil? && @api_secret.to_s.length < 1
  return false if !@account_number.nil? && @account_number.to_s.length < 1
  return false if !@ftp_username.nil? && @ftp_username.to_s.length < 1
  return false if !@ftp_password.nil? && @ftp_password.to_s.length < 1
  true
end