Class: OpenapiClient::Service

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

Overview

A service offered by the carrier

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Service

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
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
105
106
107
108
109
110
111
112
 
# File 'lib/openapi_client/models/service.rb', line 72

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_code ⇒ Object

Returns the value of attribute carrier_code.



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

def carrier_code
  @carrier_code
end

#carrier_id ⇒ Object

A string that uniquely identifies the carrier



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

def carrier_id
  @carrier_id
end

#domestic ⇒ Object

Supports domestic shipping



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

def domestic
  @domestic
end

#international ⇒ Object

Supports international shipping.



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

def international
  @international
end

#is_multi_package_supported ⇒ Object

Carrier supports multiple packages per shipment



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

def is_multi_package_supported
  @is_multi_package_supported
end

#name ⇒ Object

User friendly service name



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

def name
  @name
end

#service_code ⇒ Object

service code



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

def service_code
  @service_code
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/openapi_client/models/service.rb', line 39

def self.attribute_map
  {
    :'carrier_id' => :'carrier_id',
    :'carrier_code' => :'carrier_code',
    :'service_code' => :'service_code',
    :'name' => :'name',
    :'domestic' => :'domestic',
    :'international' => :'international',
    :'is_multi_package_supported' => :'is_multi_package_supported'
  }
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



186
187
188
 
# File 'lib/openapi_client/models/service.rb', line 186

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
68
 
# File 'lib/openapi_client/models/service.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_client/models/service.rb', line 52

def self.openapi_types
  {
    :'carrier_id' => :'String',
    :'carrier_code' => :'String',
    :'service_code' => :'String',
    :'name' => :'String',
    :'domestic' => :'Boolean',
    :'international' => :'Boolean',
    :'is_multi_package_supported' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/openapi_client/models/service.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      carrier_id == o.carrier_id &&
      carrier_code == o.carrier_code &&
      service_code == o.service_code &&
      name == o.name &&
      domestic == o.domestic &&
      international == o.international &&
      is_multi_package_supported == o.is_multi_package_supported
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



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

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/openapi_client/models/service.rb', line 283

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/openapi_client/models/service.rb', line 193

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


173
174
175
 
# File 'lib/openapi_client/models/service.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/openapi_client/models/service.rb', line 179

def hash
  [carrier_id, carrier_code, service_code, name, domestic, international, is_multi_package_supported].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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/openapi_client/models/service.rb', line 116

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

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



259
260
261
 
# File 'lib/openapi_client/models/service.rb', line 259

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_client/models/service.rb', line 265

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



253
254
255
 
# File 'lib/openapi_client/models/service.rb', line 253

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



131
132
133
134
135
 
# File 'lib/openapi_client/models/service.rb', line 131

def valid?
  return false if !@service_code.nil? && @service_code.to_s.length < 1
  return false if !@name.nil? && @name.to_s.length < 1
  true
end