aftership-tracking-sdk 9.0.0 → 10.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +14 -13
  4. data/lib/aftership-tracking-sdk/api/courier.rb +3 -3
  5. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +55 -1
  6. data/lib/aftership-tracking-sdk/api/tracking.rb +16 -16
  7. data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb +3 -3
  8. data/lib/aftership-tracking-sdk/models/checkpoint.rb +22 -12
  9. data/lib/aftership-tracking-sdk/models/courier.rb +7 -7
  10. data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +47 -67
  11. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +63 -83
  12. data/lib/aftership-tracking-sdk/models/{next_couriers_tracking.rb → customers_create_tracking_request.rb} +37 -37
  13. data/lib/aftership-tracking-sdk/models/customers_create_tracking_response.rb +193 -0
  14. data/lib/aftership-tracking-sdk/models/customers_delete_tracking_by_id_response.rb +193 -0
  15. data/lib/aftership-tracking-sdk/models/customers_get_tracking_by_id_response.rb +193 -0
  16. data/lib/aftership-tracking-sdk/models/customers_mark_tracking_completed_by_id_response.rb +193 -0
  17. data/lib/aftership-tracking-sdk/models/customers_retrack_tracking_by_id_response.rb +193 -0
  18. data/lib/aftership-tracking-sdk/models/customers_tracking.rb +193 -0
  19. data/lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_request.rb +193 -0
  20. data/lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_response.rb +193 -0
  21. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +63 -83
  22. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +6 -6
  23. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +6 -6
  24. data/lib/aftership-tracking-sdk/models/destination_address_predict_request.rb +193 -0
  25. data/lib/aftership-tracking-sdk/models/destination_address_predict_response.rb +193 -0
  26. data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +24 -24
  27. data/lib/aftership-tracking-sdk/models/estimated_pickup_predict_request.rb +183 -0
  28. data/lib/aftership-tracking-sdk/models/estimated_pickup_predict_response.rb +193 -0
  29. data/lib/aftership-tracking-sdk/models/{next_couriers_delete_tracking_by_id_response.rb → first_mile_create_tracking_response.rb} +29 -29
  30. data/lib/aftership-tracking-sdk/models/{next_couriers_get_tracking_by_id_response.rb → first_mile_delete_tracking_by_id_response.rb} +29 -29
  31. data/lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb +193 -0
  32. data/lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb +193 -0
  33. data/lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb +193 -0
  34. data/lib/aftership-tracking-sdk/models/{next_couriers_mark_tracking_completed_by_id_response.rb → first_mile_tracking.rb} +29 -29
  35. data/lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb +193 -0
  36. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +63 -83
  37. data/lib/aftership-tracking-sdk/models/{next_couriers_create_tracking_request.rb → last_mile_create_tracking_request.rb} +13 -13
  38. data/lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb +203 -0
  39. data/lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb +203 -0
  40. data/lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb +203 -0
  41. data/lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb +203 -0
  42. data/lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb +203 -0
  43. data/lib/aftership-tracking-sdk/models/{next_couriers_create_tracking_response.rb → last_mile_tracking.rb} +33 -23
  44. data/lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb +203 -0
  45. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +63 -83
  46. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_request.rb +163 -0
  47. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_response.rb +163 -0
  48. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +6 -6
  49. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +6 -6
  50. data/lib/aftership-tracking-sdk/models/origin_address_predict_request.rb +193 -0
  51. data/lib/aftership-tracking-sdk/models/origin_address_predict_response.rb +193 -0
  52. data/lib/aftership-tracking-sdk/models/predict_request.rb +223 -0
  53. data/lib/aftership-tracking-sdk/models/predict_response.rb +273 -0
  54. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +63 -83
  55. data/lib/aftership-tracking-sdk/models/tracking.rb +63 -83
  56. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +37 -57
  57. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +63 -83
  58. data/lib/aftership-tracking-sdk/models/weight_predict_request.rb +163 -0
  59. data/lib/aftership-tracking-sdk/models/weight_predict_response.rb +163 -0
  60. data/lib/aftership-tracking-sdk/version.rb +1 -1
  61. metadata +41 -13
  62. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +0 -193
  63. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +0 -193
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aftership-tracking-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 9.0.0
4
+ version: 10.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - AfterShip Team
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-25 00:00:00.000000000 Z
11
+ date: 2025-01-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -103,17 +103,30 @@ files:
103
103
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb
104
104
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb
105
105
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb
106
+ - lib/aftership-tracking-sdk/models/customers_create_tracking_request.rb
107
+ - lib/aftership-tracking-sdk/models/customers_create_tracking_response.rb
108
+ - lib/aftership-tracking-sdk/models/customers_delete_tracking_by_id_response.rb
109
+ - lib/aftership-tracking-sdk/models/customers_get_tracking_by_id_response.rb
110
+ - lib/aftership-tracking-sdk/models/customers_mark_tracking_completed_by_id_response.rb
111
+ - lib/aftership-tracking-sdk/models/customers_retrack_tracking_by_id_response.rb
112
+ - lib/aftership-tracking-sdk/models/customers_tracking.rb
113
+ - lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_request.rb
114
+ - lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_response.rb
106
115
  - lib/aftership-tracking-sdk/models/data_courier_response_v1.rb
107
116
  - lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb
108
117
  - lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb
109
118
  - lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb
110
119
  - lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb
120
+ - lib/aftership-tracking-sdk/models/destination_address_predict_request.rb
121
+ - lib/aftership-tracking-sdk/models/destination_address_predict_response.rb
111
122
  - lib/aftership-tracking-sdk/models/detect_courier_request.rb
112
123
  - lib/aftership-tracking-sdk/models/detect_courier_response.rb
113
124
  - lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb
114
125
  - lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb
115
126
  - lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb
116
127
  - lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb
128
+ - lib/aftership-tracking-sdk/models/estimated_pickup_predict_request.rb
129
+ - lib/aftership-tracking-sdk/models/estimated_pickup_predict_response.rb
117
130
  - lib/aftership-tracking-sdk/models/events_checkpoint.rb
118
131
  - lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb
119
132
  - lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb
@@ -122,10 +135,25 @@ files:
122
135
  - lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb
123
136
  - lib/aftership-tracking-sdk/models/first_estimated_delivery_tracking.rb
124
137
  - lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb
138
+ - lib/aftership-tracking-sdk/models/first_mile_create_tracking_response.rb
139
+ - lib/aftership-tracking-sdk/models/first_mile_delete_tracking_by_id_response.rb
140
+ - lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb
141
+ - lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb
142
+ - lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb
143
+ - lib/aftership-tracking-sdk/models/first_mile_tracking.rb
144
+ - lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb
125
145
  - lib/aftership-tracking-sdk/models/get_all_couriers_response.rb
126
146
  - lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb
127
147
  - lib/aftership-tracking-sdk/models/get_trackings_response.rb
128
148
  - lib/aftership-tracking-sdk/models/get_user_couriers_response.rb
149
+ - lib/aftership-tracking-sdk/models/last_mile_create_tracking_request.rb
150
+ - lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb
151
+ - lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb
152
+ - lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb
153
+ - lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb
154
+ - lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb
155
+ - lib/aftership-tracking-sdk/models/last_mile_tracking.rb
156
+ - lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb
129
157
  - lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb
130
158
  - lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb
131
159
  - lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb
@@ -136,23 +164,21 @@ files:
136
164
  - lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb
137
165
  - lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb
138
166
  - lib/aftership-tracking-sdk/models/meta_v1.rb
139
- - lib/aftership-tracking-sdk/models/next_couriers_create_tracking_request.rb
140
- - lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb
141
- - lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_id_response.rb
142
- - lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_id_response.rb
143
- - lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_id_response.rb
144
- - lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb
145
- - lib/aftership-tracking-sdk/models/next_couriers_tracking.rb
146
- - lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb
147
167
  - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb
148
168
  - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb
169
+ - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_request.rb
170
+ - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_response.rb
149
171
  - lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb
150
172
  - lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb
173
+ - lib/aftership-tracking-sdk/models/origin_address_predict_request.rb
174
+ - lib/aftership-tracking-sdk/models/origin_address_predict_response.rb
151
175
  - lib/aftership-tracking-sdk/models/pagination.rb
152
176
  - lib/aftership-tracking-sdk/models/pagination_data_tracking_response_get_multiple_v1.rb
153
177
  - lib/aftership-tracking-sdk/models/pagination_get_trackings_response.rb
154
178
  - lib/aftership-tracking-sdk/models/predict_batch_request.rb
155
179
  - lib/aftership-tracking-sdk/models/predict_batch_response.rb
180
+ - lib/aftership-tracking-sdk/models/predict_request.rb
181
+ - lib/aftership-tracking-sdk/models/predict_response.rb
156
182
  - lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb
157
183
  - lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb
158
184
  - lib/aftership-tracking-sdk/models/shipment_weight_create_tracking_response.rb
@@ -171,13 +197,15 @@ files:
171
197
  - lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb
172
198
  - lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb
173
199
  - lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb
200
+ - lib/aftership-tracking-sdk/models/weight_predict_request.rb
201
+ - lib/aftership-tracking-sdk/models/weight_predict_response.rb
174
202
  - lib/aftership-tracking-sdk/sign_string.rb
175
203
  - lib/aftership-tracking-sdk/version.rb
176
204
  homepage: https://www.aftership.com/docs/tracking/quickstart/api-quick-start
177
205
  licenses:
178
206
  - MIT
179
207
  metadata: {}
180
- post_install_message:
208
+ post_install_message:
181
209
  rdoc_options: []
182
210
  require_paths:
183
211
  - lib
@@ -193,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
193
221
  version: '0'
194
222
  requirements: []
195
223
  rubygems_version: 3.1.4
196
- signing_key:
224
+ signing_key:
197
225
  specification_version: 4
198
226
  summary: API Overview Ruby Gem
199
227
  test_files: []
@@ -1,193 +0,0 @@
1
- # This code was auto generated by AfterShip SDK Generator.
2
- # Do not edit the class manually.
3
- module AftershipAPI::Model
4
- class NextCouriersRetrackTrackingByIdResponse
5
-
6
- # Unique code of courier. Get courier
7
- # slug: String;
8
- attr_accessor :slug
9
-
10
- # Tracking number.
11
- # tracking_number: String;
12
- attr_accessor :tracking_number
13
-
14
- # Source of next couriers.
15
- # source?: String;
16
- attr_accessor :source
17
-
18
- # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
- # courier_tracking_link?: String;
20
- attr_accessor :courier_tracking_link
21
-
22
- # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
- # courier_redirect_link?: String;
24
- attr_accessor :courier_redirect_link
25
-
26
- # Initializes the object
27
- # @param [Hash] attributes Model attributes in the form of hash
28
- def initialize(attributes = {})
29
- if (!attributes.is_a?(Hash))
30
- fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::NextCouriersRetrackTrackingByIdResponse` initialize method"
31
- end
32
-
33
- attributes = attributes.each_with_object({}) { |(k, v), h|
34
- h[k.to_sym] = v
35
- }
36
-
37
- if attributes.key?(:'slug')
38
- self.slug = attributes[:'slug']
39
- end
40
-
41
- if attributes.key?(:'tracking_number')
42
- self.tracking_number = attributes[:'tracking_number']
43
- end
44
-
45
- if attributes.key?(:'source')
46
- self.source = attributes[:'source']
47
- end
48
-
49
- if attributes.key?(:'courier_tracking_link')
50
- self.courier_tracking_link = attributes[:'courier_tracking_link']
51
- end
52
-
53
- if attributes.key?(:'courier_redirect_link')
54
- self.courier_redirect_link = attributes[:'courier_redirect_link']
55
- end
56
- end
57
-
58
- # Attribute type mapping.
59
- def self.openapi_types
60
- {
61
- :'slug' => :'String',
62
- :'tracking_number' => :'String',
63
- :'source' => :'String',
64
- :'courier_tracking_link' => :'String',
65
- :'courier_redirect_link' => :'String',
66
- }
67
- end
68
-
69
- # Attribute mapping from ruby-style variable name to JSON key.
70
- def self.attribute_map
71
- {
72
- :'slug' => :'slug',
73
- :'tracking_number' => :'tracking_number',
74
- :'source' => :'source',
75
- :'courier_tracking_link' => :'courier_tracking_link',
76
- :'courier_redirect_link' => :'courier_redirect_link',
77
- }
78
- end
79
-
80
- # Builds the object from hash
81
- # @param attributes [Hash] Model attributes in the form of hash
82
- # @return [Object] Returns the model itself
83
- def self.build_from_hash(attributes)
84
- return nil unless attributes.is_a?(Hash)
85
- attributes = attributes.transform_keys(&:to_sym)
86
- transformed_hash = {}
87
- openapi_types.each_pair do |key, type|
88
- if attributes.key?(key) && attributes[key].nil?
89
- transformed_hash["#{key}"] = nil
90
- elsif type =~ /\AArray<(.*)>/i
91
- # check to ensure the input is an array given that the attribute
92
- # is documented as an array but the input is not
93
- if attributes[key].is_a?(Array)
94
- transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
95
- end
96
- elsif !attributes[key].nil?
97
- transformed_hash["#{key}"] = _deserialize(type, attributes[key])
98
- end
99
- end
100
- new(transformed_hash)
101
- end
102
-
103
- # Deserializes the data based on type
104
- # @param type [String] Data type
105
- # @param value [String] Value to be deserialized
106
- # @return [Object] Deserialized data
107
- def self._deserialize(type, value)
108
- case type.to_sym
109
- when :Time
110
- Time.parse(value)
111
- when :Date
112
- Date.parse(value)
113
- when :String
114
- value.to_s
115
- when :Integer
116
- value.to_i
117
- when :Float
118
- value.to_f
119
- when :Boolean
120
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
121
- true
122
- else
123
- false
124
- end
125
- when :Object
126
- # generic object (usually a Hash), return directly
127
- value
128
- when /\AArray<(?<inner_type>.+)>\z/
129
- inner_type = Regexp.last_match[:inner_type]
130
- value.map { |v| _deserialize(inner_type, v) }
131
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
132
- k_type = Regexp.last_match[:k_type]
133
- v_type = Regexp.last_match[:v_type]
134
- {}.tap do |hash|
135
- value.each do |k, v|
136
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
137
- end
138
- end
139
- else # model
140
- klass = AftershipAPI::Model.const_get(type)
141
- klass.build_from_hash(value)
142
- end
143
- end
144
-
145
- # Returns the string representation of the object
146
- # @return [String] String presentation of the object
147
- def to_s
148
- to_hash.to_s
149
- end
150
-
151
- # to_body is an alias to to_hash (backward compatibility)
152
- # @return [Hash] Returns the object in the form of hash
153
- def to_body
154
- to_hash
155
- end
156
-
157
- # Returns the object in the form of hash
158
- # @return [Hash] Returns the object in the form of hash
159
- def to_hash
160
- hash = {}
161
- self.class.attribute_map.each_pair do |attr, param|
162
- value = self.send(attr)
163
- next if value.nil?
164
-
165
- hash[param] = _to_hash(value)
166
- end
167
- hash
168
- end
169
-
170
- # Outputs non-array value in the form of hash
171
- # For object, use to_hash. Otherwise, just return the value
172
- # @param value [Object] Any valid value
173
- # @return [Hash] Returns the value in the form of hash
174
- def _to_hash(value)
175
- if value.is_a?(Array)
176
- value.compact.map { |v| _to_hash(v) }
177
- elsif value.is_a?(Hash)
178
- {}.tap do |hash|
179
- value.each { |k, v| hash[k] = _to_hash(v) }
180
- end
181
- elsif value.respond_to? :to_hash
182
- value.to_hash
183
- else
184
- value
185
- end
186
- end
187
-
188
- def to_json(*a)
189
- to_hash.to_json(*a)
190
- end
191
- end
192
- end
193
-
@@ -1,193 +0,0 @@
1
- # This code was auto generated by AfterShip SDK Generator.
2
- # Do not edit the class manually.
3
- module AftershipAPI::Model
4
- class NextCouriersUpdateTrackingByIdResponse
5
-
6
- # Unique code of courier. Get courier
7
- # slug: String;
8
- attr_accessor :slug
9
-
10
- # Tracking number.
11
- # tracking_number: String;
12
- attr_accessor :tracking_number
13
-
14
- # Source of next couriers.
15
- # source?: String;
16
- attr_accessor :source
17
-
18
- # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
- # courier_tracking_link?: String;
20
- attr_accessor :courier_tracking_link
21
-
22
- # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
- # courier_redirect_link?: String;
24
- attr_accessor :courier_redirect_link
25
-
26
- # Initializes the object
27
- # @param [Hash] attributes Model attributes in the form of hash
28
- def initialize(attributes = {})
29
- if (!attributes.is_a?(Hash))
30
- fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::NextCouriersUpdateTrackingByIdResponse` initialize method"
31
- end
32
-
33
- attributes = attributes.each_with_object({}) { |(k, v), h|
34
- h[k.to_sym] = v
35
- }
36
-
37
- if attributes.key?(:'slug')
38
- self.slug = attributes[:'slug']
39
- end
40
-
41
- if attributes.key?(:'tracking_number')
42
- self.tracking_number = attributes[:'tracking_number']
43
- end
44
-
45
- if attributes.key?(:'source')
46
- self.source = attributes[:'source']
47
- end
48
-
49
- if attributes.key?(:'courier_tracking_link')
50
- self.courier_tracking_link = attributes[:'courier_tracking_link']
51
- end
52
-
53
- if attributes.key?(:'courier_redirect_link')
54
- self.courier_redirect_link = attributes[:'courier_redirect_link']
55
- end
56
- end
57
-
58
- # Attribute type mapping.
59
- def self.openapi_types
60
- {
61
- :'slug' => :'String',
62
- :'tracking_number' => :'String',
63
- :'source' => :'String',
64
- :'courier_tracking_link' => :'String',
65
- :'courier_redirect_link' => :'String',
66
- }
67
- end
68
-
69
- # Attribute mapping from ruby-style variable name to JSON key.
70
- def self.attribute_map
71
- {
72
- :'slug' => :'slug',
73
- :'tracking_number' => :'tracking_number',
74
- :'source' => :'source',
75
- :'courier_tracking_link' => :'courier_tracking_link',
76
- :'courier_redirect_link' => :'courier_redirect_link',
77
- }
78
- end
79
-
80
- # Builds the object from hash
81
- # @param attributes [Hash] Model attributes in the form of hash
82
- # @return [Object] Returns the model itself
83
- def self.build_from_hash(attributes)
84
- return nil unless attributes.is_a?(Hash)
85
- attributes = attributes.transform_keys(&:to_sym)
86
- transformed_hash = {}
87
- openapi_types.each_pair do |key, type|
88
- if attributes.key?(key) && attributes[key].nil?
89
- transformed_hash["#{key}"] = nil
90
- elsif type =~ /\AArray<(.*)>/i
91
- # check to ensure the input is an array given that the attribute
92
- # is documented as an array but the input is not
93
- if attributes[key].is_a?(Array)
94
- transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
95
- end
96
- elsif !attributes[key].nil?
97
- transformed_hash["#{key}"] = _deserialize(type, attributes[key])
98
- end
99
- end
100
- new(transformed_hash)
101
- end
102
-
103
- # Deserializes the data based on type
104
- # @param type [String] Data type
105
- # @param value [String] Value to be deserialized
106
- # @return [Object] Deserialized data
107
- def self._deserialize(type, value)
108
- case type.to_sym
109
- when :Time
110
- Time.parse(value)
111
- when :Date
112
- Date.parse(value)
113
- when :String
114
- value.to_s
115
- when :Integer
116
- value.to_i
117
- when :Float
118
- value.to_f
119
- when :Boolean
120
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
121
- true
122
- else
123
- false
124
- end
125
- when :Object
126
- # generic object (usually a Hash), return directly
127
- value
128
- when /\AArray<(?<inner_type>.+)>\z/
129
- inner_type = Regexp.last_match[:inner_type]
130
- value.map { |v| _deserialize(inner_type, v) }
131
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
132
- k_type = Regexp.last_match[:k_type]
133
- v_type = Regexp.last_match[:v_type]
134
- {}.tap do |hash|
135
- value.each do |k, v|
136
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
137
- end
138
- end
139
- else # model
140
- klass = AftershipAPI::Model.const_get(type)
141
- klass.build_from_hash(value)
142
- end
143
- end
144
-
145
- # Returns the string representation of the object
146
- # @return [String] String presentation of the object
147
- def to_s
148
- to_hash.to_s
149
- end
150
-
151
- # to_body is an alias to to_hash (backward compatibility)
152
- # @return [Hash] Returns the object in the form of hash
153
- def to_body
154
- to_hash
155
- end
156
-
157
- # Returns the object in the form of hash
158
- # @return [Hash] Returns the object in the form of hash
159
- def to_hash
160
- hash = {}
161
- self.class.attribute_map.each_pair do |attr, param|
162
- value = self.send(attr)
163
- next if value.nil?
164
-
165
- hash[param] = _to_hash(value)
166
- end
167
- hash
168
- end
169
-
170
- # Outputs non-array value in the form of hash
171
- # For object, use to_hash. Otherwise, just return the value
172
- # @param value [Object] Any valid value
173
- # @return [Hash] Returns the value in the form of hash
174
- def _to_hash(value)
175
- if value.is_a?(Array)
176
- value.compact.map { |v| _to_hash(v) }
177
- elsif value.is_a?(Hash)
178
- {}.tap do |hash|
179
- value.each { |k, v| hash[k] = _to_hash(v) }
180
- end
181
- elsif value.respond_to? :to_hash
182
- value.to_hash
183
- else
184
- value
185
- end
186
- end
187
-
188
- def to_json(*a)
189
- to_hash.to_json(*a)
190
- end
191
- end
192
- end
193
-