Class: AftershipAPI::Model::DetectCourierRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetectCourierRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
104
105
106
107
108
109
110
111
112
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 56

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#destination_country_iso3 ⇒ Object

Enter . destination_country_iso3?: String;



52
53
54
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 52

def destination_country_iso3
  @destination_country_iso3
end

#origin_country_iso3 ⇒ Object

Enter . origin_country_iso3?: String;



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

def origin_country_iso3
  @origin_country_iso3
end

#slug ⇒ Object

If not specified, Aftership will automatically detect the courier based on the tracking number format and your . Use array to input a list of couriers for auto detect. Cannot be used with slug_group at the same time. slug?: String[];



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

def slug
  @slug
end

#slug_group ⇒ Object

Slug group is a group of slugs which belong to same courier. For example, when you inpit “fedex-group” as slug_group, AfterShip will detect the tracking with “fedex-uk”, “fedex-fims”, and other slugs which belong to “fedex”. It cannot be used with slug at the same time. ( slug_group?: SlugGroupV1;



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

def slug_group
  @slug_group
end

#tracking_account_number ⇒ Object

Account number of the shipper for a specific courier. Required by some couriers. Refer to for more details tracking_account_number?: String;



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

def 
  @tracking_account_number
end

#tracking_destination_country ⇒ Object

Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to for more details tracking_destination_country?: String;



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

def tracking_destination_country
  @tracking_destination_country
end

#tracking_key ⇒ Object

Key of the shipment for a specific courier. Required by some couriers. Refer to for more details tracking_key?: String;



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

def tracking_key
  @tracking_key
end

#tracking_number ⇒ Object

Tracking number of a shipment. tracking_number: String;



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

def tracking_number
  @tracking_number
end

#tracking_origin_country ⇒ Object

Origin Country/Region of the shipment for a specific courier. Required by some couriers. tracking_origin_country?: String;



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

def tracking_origin_country
  @tracking_origin_country
end

#tracking_postal_code ⇒ Object

The postal code of receiver’s address. Required by some couriers. Refer to for more details tracking_postal_code?: String;



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

def tracking_postal_code
  @tracking_postal_code
end

#tracking_ship_date ⇒ Object

Shipping date in ‘YYYYMMDD` format. Required by some couriers. Refer to for more details tracking_ship_date?: String;



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

def tracking_ship_date
  @tracking_ship_date
end

#tracking_state ⇒ Object

State of the destination shipping address of the shipment. Required by some couriers. tracking_state?: String;



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

def tracking_state
  @tracking_state
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



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

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.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 133

def self.attribute_map
  {
    :'tracking_number' => :'tracking_number',
    :'slug' => :'slug',
    :'tracking_postal_code' => :'tracking_postal_code',
    :'tracking_ship_date' => :'tracking_ship_date',
    :'tracking_account_number' => :'tracking_account_number',
    :'tracking_key' => :'tracking_key',
    :'tracking_origin_country' => :'tracking_origin_country',
    :'tracking_destination_country' => :'tracking_destination_country',
    :'tracking_state' => :'tracking_state',
    :'slug_group' => :'slug_group',
    :'origin_country_iso3' => :'origin_country_iso3',
    :'destination_country_iso3' => :'destination_country_iso3',
  }
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 153

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.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 115

def self.openapi_types
  {
    :'tracking_number' => :'String',
    :'slug' => :'Array<String>',
    :'tracking_postal_code' => :'String',
    :'tracking_ship_date' => :'String',
    :'tracking_account_number' => :'String',
    :'tracking_key' => :'String',
    :'tracking_origin_country' => :'String',
    :'tracking_destination_country' => :'String',
    :'tracking_state' => :'String',
    :'slug_group' => :'SlugGroupV1',
    :'origin_country_iso3' => :'String',
    :'destination_country_iso3' => :'String',
  }
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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 244

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



223
224
225
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 223

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



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 229

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 



258
259
260
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 258

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



217
218
219
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 217

def to_s
  to_hash.to_s
end