Class: AftershipAPI::Model::Courier

Inherits:
Object
  • Object
show all
Defined in:
lib/aftership-tracking-sdk/models/courier.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Courier

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 51

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

  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#credentials ⇒ Object

Refers to the authentication details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to create a carrier connection. The content varies by carrier. credentials?: CourierCredentials;



47
48
49
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 47

def credentials
  @credentials
end

#default_language ⇒ Object

Default language of tracking results default_language?: String;



35
36
37
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 35

def default_language
  @default_language
end

#name ⇒ Object

Name of courier name?: String;



11
12
13
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 11

def name
  @name
end

#optional_fields ⇒ Object

The extra fields which are optional for tracking. Basically it’s the same as required_fields, but the difference is that only some of the tracking numbers require these fields. optional_fields?: AdditionalFields[];



31
32
33
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 31

def optional_fields
  @optional_fields
end

#other_name ⇒ Object

Other name of courier other_name?: String;



19
20
21
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 19

def other_name
  @other_name
end

#phone ⇒ Object

Contact phone number of courier phone?: String;



15
16
17
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 15

def phone
  @phone
end

#required_fields ⇒ Object

The extra fields need for tracking, such as ‘tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country_region` required_fields?: AdditionalFields[];



27
28
29
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 27

def required_fields
  @required_fields
end

#service_from_country_regions ⇒ Object

Country/Region code (ISO Alpha-3) where the courier provides service service_from_country_regions?: String[];



43
44
45
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 43

def service_from_country_regions
  @service_from_country_regions
end

#slug ⇒ Object

Unique code of courier. Get the slugs from . slug?: String;



7
8
9
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 7

def slug
  @slug
end

#support_languages ⇒ Object

Other supported languages support_languages?: String[];



39
40
41
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 39

def support_languages
  @support_languages
end

#web_url ⇒ Object

Website link of courier web_url?: String;



23
24
25
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 23

def web_url
  @web_url
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (String) —

    Data type

  • value (String) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 166

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = AftershipAPI::Model.const_get(type)
    klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 123

def self.attribute_map
  {
    :'slug' => :'slug',
    :'name' => :'name',
    :'phone' => :'phone',
    :'other_name' => :'other_name',
    :'web_url' => :'web_url',
    :'required_fields' => :'required_fields',
    :'optional_fields' => :'optional_fields',
    :'default_language' => :'default_language',
    :'support_languages' => :'support_languages',
    :'service_from_country_regions' => :'service_from_country_regions',
    :'credentials' => :'credentials',
  }
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 142

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?(key) && attributes[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[key].is_a?(Array)
        transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[key].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[key])
    end
  end
  new(transformed_hash)
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 106

def self.openapi_types
  {
    :'slug' => :'String',
    :'name' => :'String',
    :'phone' => :'String',
    :'other_name' => :'String',
    :'web_url' => :'String',
    :'required_fields' => :'Array<AdditionalFields>',
    :'optional_fields' => :'Array<AdditionalFields>',
    :'default_language' => :'String',
    :'support_languages' => :'Array<String>',
    :'service_from_country_regions' => :'Array<String>',
    :'credentials' => :'CourierCredentials',
  }
end

Instance Method Details

#_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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 233

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 212

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



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 218

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_json(*a) ⇒ Object 



247
248
249
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 247

def to_json(*a)
  to_hash.to_json(*a)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



206
207
208
 
# File 'lib/aftership-tracking-sdk/models/courier.rb', line 206

def to_s
  to_hash.to_s
end