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



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

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?(:'destination_postal_code')
    self.destination_postal_code = attributes[:'destination_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?(:'destination_state')
    self.destination_state = attributes[:'destination_state']
  end

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

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

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

Instance Attribute Details

#destination_country_region ⇒ Object

Enter . destination_country_region?: String;



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

def destination_country_region
  @destination_country_region
end

#destination_postal_code ⇒ Object

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



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

def destination_postal_code
  @destination_postal_code
end

#destination_state ⇒ Object

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



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

def destination_state
  @destination_state
end

#origin_country_region ⇒ Object

Enter . origin_country_region?: String;



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

def origin_country_region
  @origin_country_region
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[];



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

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?: String;



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

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;



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

def 
  
end

#tracking_key ⇒ Object

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



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

def tracking_key
  @tracking_key
end

#tracking_number ⇒ Object

Tracking number of a shipment. tracking_number: String;



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

def tracking_number
  @tracking_number
end

#tracking_ship_date ⇒ Object

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



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

def tracking_ship_date
  @tracking_ship_date
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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.



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

def self.attribute_map
  {
    :'tracking_number' => :'tracking_number',
    :'slug' => :'slug',
    :'destination_postal_code' => :'destination_postal_code',
    :'tracking_ship_date' => :'tracking_ship_date',
    :'tracking_account_number' => :'tracking_account_number',
    :'tracking_key' => :'tracking_key',
    :'destination_state' => :'destination_state',
    :'slug_group' => :'slug_group',
    :'origin_country_region' => :'origin_country_region',
    :'destination_country_region' => :'destination_country_region',
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 98

def self.openapi_types
  {
    :'tracking_number' => :'String',
    :'slug' => :'Array<String>',
    :'destination_postal_code' => :'String',
    :'tracking_ship_date' => :'String',
    :'tracking_account_number' => :'String',
    :'tracking_key' => :'String',
    :'destination_state' => :'String',
    :'slug_group' => :'String',
    :'origin_country_region' => :'String',
    :'destination_country_region' => :'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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 223

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)



202
203
204
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 208

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 



237
238
239
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 237

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

#to_s ⇒ String

Returns the string representation of the object



196
197
198
 
# File 'lib/aftership-tracking-sdk/models/detect_courier_request.rb', line 196

def to_s
  to_hash.to_s
end