aftership-tracking-sdk 8.0.0 → 9.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/README.md +4 -3
- data/lib/aftership-tracking-sdk/api/courier.rb +6 -6
- data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +4 -4
- data/lib/aftership-tracking-sdk/api/tracking.rb +23 -389
- data/lib/aftership-tracking-sdk/api_client.rb +2 -2
- data/lib/aftership-tracking-sdk/configuration.rb +108 -108
- data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb +1 -1
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/checkpoint.rb +2 -0
- data/lib/aftership-tracking-sdk/models/coordinate_checkpoint.rb +2 -0
- data/lib/aftership-tracking-sdk/models/courier.rb +2 -0
- data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_create_tracking_response.rb} +7 -15
- data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_delete_tracking_by_id_response.rb} +7 -15
- data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_get_tracking_by_id_response.rb} +7 -15
- data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +173 -0
- data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_retrack_tracking_by_id_response.rb +173 -0
- data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_tracking.rb} +7 -15
- data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_update_tracking_by_id_response.rb +173 -0
- data/lib/aftership-tracking-sdk/models/courier_response_v1.rb +2 -0
- data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/data_courier_response_v1.rb +2 -0
- data/lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb +8 -126
- data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/detect_courier_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/events_checkpoint.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/get_all_couriers_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/get_trackings_response.rb +5 -3
- data/lib/aftership-tracking-sdk/models/get_user_couriers_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/meta_v1.rb +2 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_create_tracking_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_id_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_id_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_id_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_tracking.rb +22 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +22 -0
- data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/pagination.rb +14 -6
- data/lib/aftership-tracking-sdk/models/{next_couriers_get_tracking_by_slug_tracking_number_response.rb → pagination_data_tracking_response_get_multiple_v1.rb} +25 -23
- data/lib/aftership-tracking-sdk/models/{next_couriers_delete_tracking_by_slug_tracking_number_response.rb → pagination_get_trackings_response.rb} +25 -23
- data/lib/aftership-tracking-sdk/models/predict_batch_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/predict_batch_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb +2 -0
- data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/shipment_weight_create_tracking_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_tracking.rb +2 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb +2 -0
- data/lib/aftership-tracking-sdk/models/slug_group_v1.rb +1 -1
- data/lib/aftership-tracking-sdk/models/tag_v1.rb +1 -1
- data/lib/aftership-tracking-sdk/models/tracking.rb +29 -7
- data/lib/aftership-tracking-sdk/models/tracking_response_get_multiple_v1.rb +2 -0
- data/lib/aftership-tracking-sdk/models/tracking_response_v1.rb +2 -0
- data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +29 -7
- data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb +2 -0
- data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb +2 -0
- data/lib/aftership-tracking-sdk/version.rb +1 -1
- metadata +11 -45
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +0 -181
- data/lib/aftership-tracking-sdk/models/custom_fields_update_tracking_by_slug_tracking_number_request.rb +0 -139
- data/lib/aftership-tracking-sdk/models/delete_tracking_by_slug_tracking_number_response.rb +0 -931
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/get_tracking_by_slug_tracking_number_response.rb +0 -931
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +0 -191
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_request.rb +0 -151
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_response.rb +0 -931
- data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -171
- data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_slug_tracking_number_response.rb +0 -171
- data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_slug_tracking_number_response.rb +0 -171
- data/lib/aftership-tracking-sdk/models/retrack_tracking_by_slug_tracking_number_response.rb +0 -931
- data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_slug_tracking_number_response.rb +0 -161
- data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_request.rb +0 -391
- data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_response.rb +0 -931
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CreateTrackingResponse
|
5
|
+
|
5
6
|
# Tracking ID.
|
6
7
|
# id?: String;
|
7
8
|
attr_accessor :id
|
@@ -94,9 +95,9 @@ module AftershipAPI::Model
|
|
94
95
|
# emails?: String[];
|
95
96
|
attr_accessor :emails
|
96
97
|
|
97
|
-
# The estimated delivery date provided by the carrier.
|
98
|
-
#
|
99
|
-
attr_accessor :
|
98
|
+
# The field contains the estimated delivery date provided by the carrier.
|
99
|
+
# courier_estimated_delivery_date?: CourierEstimatedDeliveryDateCreateTrackingResponse;
|
100
|
+
attr_accessor :courier_estimated_delivery_date
|
100
101
|
|
101
102
|
# Text field for the note.
|
102
103
|
# note?: String;
|
@@ -318,6 +319,14 @@ module AftershipAPI::Model
|
|
318
319
|
# delivery_location_type?: String;
|
319
320
|
attr_accessor :delivery_location_type
|
320
321
|
|
322
|
+
# The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
|
323
|
+
# aftership_tracking_url?: String;
|
324
|
+
attr_accessor :aftership_tracking_url
|
325
|
+
|
326
|
+
# The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
|
327
|
+
# aftership_tracking_order_url?: String;
|
328
|
+
attr_accessor :aftership_tracking_order_url
|
329
|
+
|
321
330
|
# Initializes the object
|
322
331
|
# @param [Hash] attributes Model attributes in the form of hash
|
323
332
|
def initialize(attributes = {})
|
@@ -421,8 +430,8 @@ module AftershipAPI::Model
|
|
421
430
|
self.emails = attributes[:'emails']
|
422
431
|
end
|
423
432
|
|
424
|
-
if attributes.key?(:'
|
425
|
-
self.
|
433
|
+
if attributes.key?(:'courier_estimated_delivery_date')
|
434
|
+
self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
|
426
435
|
end
|
427
436
|
|
428
437
|
if attributes.key?(:'note')
|
@@ -644,6 +653,14 @@ module AftershipAPI::Model
|
|
644
653
|
if attributes.key?(:'delivery_location_type')
|
645
654
|
self.delivery_location_type = attributes[:'delivery_location_type']
|
646
655
|
end
|
656
|
+
|
657
|
+
if attributes.key?(:'aftership_tracking_url')
|
658
|
+
self.aftership_tracking_url = attributes[:'aftership_tracking_url']
|
659
|
+
end
|
660
|
+
|
661
|
+
if attributes.key?(:'aftership_tracking_order_url')
|
662
|
+
self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
|
663
|
+
end
|
647
664
|
end
|
648
665
|
|
649
666
|
# Attribute type mapping.
|
@@ -672,7 +689,7 @@ module AftershipAPI::Model
|
|
672
689
|
:'destination_raw_location' => :'String',
|
673
690
|
:'courier_destination_country_iso3' => :'String',
|
674
691
|
:'emails' => :'Array<String>',
|
675
|
-
:'
|
692
|
+
:'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateCreateTrackingResponse',
|
676
693
|
:'note' => :'String',
|
677
694
|
:'order_id' => :'String',
|
678
695
|
:'order_id_path' => :'String',
|
@@ -728,6 +745,8 @@ module AftershipAPI::Model
|
|
728
745
|
:'failed_delivery_attempts' => :'Integer',
|
729
746
|
:'signature_requirement' => :'String',
|
730
747
|
:'delivery_location_type' => :'String',
|
748
|
+
:'aftership_tracking_url' => :'String',
|
749
|
+
:'aftership_tracking_order_url' => :'String',
|
731
750
|
}
|
732
751
|
end
|
733
752
|
|
@@ -757,7 +776,7 @@ module AftershipAPI::Model
|
|
757
776
|
:'destination_raw_location' => :'destination_raw_location',
|
758
777
|
:'courier_destination_country_iso3' => :'courier_destination_country_iso3',
|
759
778
|
:'emails' => :'emails',
|
760
|
-
:'
|
779
|
+
:'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
|
761
780
|
:'note' => :'note',
|
762
781
|
:'order_id' => :'order_id',
|
763
782
|
:'order_id_path' => :'order_id_path',
|
@@ -813,6 +832,8 @@ module AftershipAPI::Model
|
|
813
832
|
:'failed_delivery_attempts' => :'failed_delivery_attempts',
|
814
833
|
:'signature_requirement' => :'signature_requirement',
|
815
834
|
:'delivery_location_type' => :'delivery_location_type',
|
835
|
+
:'aftership_tracking_url' => :'aftership_tracking_url',
|
836
|
+
:'aftership_tracking_order_url' => :'aftership_tracking_order_url',
|
816
837
|
}
|
817
838
|
end
|
818
839
|
|
@@ -929,3 +950,4 @@ module AftershipAPI::Model
|
|
929
950
|
end
|
930
951
|
end
|
931
952
|
end
|
953
|
+
|
data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateCreateTrackingResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateDeleteTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateGetTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateMarkTrackingCompletedByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateRetrackTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateTracking
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class CustomEstimatedDeliveryDateUpdateTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,57 +2,10 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class DataTrackingResponseGetMultipleV1
|
5
|
-
# Page to show. (Default: 1)
|
6
|
-
# page?: Integer;
|
7
|
-
attr_accessor :page
|
8
5
|
|
9
|
-
#
|
10
|
-
#
|
11
|
-
attr_accessor :
|
12
|
-
|
13
|
-
# Number of returned trackings
|
14
|
-
# count?: Integer;
|
15
|
-
attr_accessor :count
|
16
|
-
|
17
|
-
# Search the content of the tracking record fields: `tracking_number`, `title`, `order_id`, `customer_name`, `custom_fields`, `order_id`, `emails`, `smses`
|
18
|
-
# keyword?: String;
|
19
|
-
attr_accessor :keyword
|
20
|
-
|
21
|
-
# Unique
|
22
|
-
# slug?: String;
|
23
|
-
attr_accessor :slug
|
24
|
-
|
25
|
-
# Origin country/region of trackings. Use
|
26
|
-
# origin?: String[];
|
27
|
-
attr_accessor :origin
|
28
|
-
|
29
|
-
# Destination country/region of trackings. Use
|
30
|
-
# destination?: String[];
|
31
|
-
attr_accessor :destination
|
32
|
-
|
33
|
-
# Current status of tracking. (
|
34
|
-
# tag?: TagV1;
|
35
|
-
attr_accessor :tag
|
36
|
-
|
37
|
-
# Start date and time of trackings created. AfterShip only stores data of 120 days.
|
38
|
-
# created_at_min?: String;
|
39
|
-
attr_accessor :created_at_min
|
40
|
-
|
41
|
-
# End date and time of trackings created.
|
42
|
-
# created_at_max?: String;
|
43
|
-
attr_accessor :created_at_max
|
44
|
-
|
45
|
-
# Date and time the tracking was last updated
|
46
|
-
# last_updated_at?: String;
|
47
|
-
attr_accessor :last_updated_at
|
48
|
-
|
49
|
-
# Whether or not the shipment is returned to sender. Value is `true` when any of its checkpoints has subtag `Exception_010` (returning to sender) or `Exception_011` (returned to sender). Otherwise value is `false`
|
50
|
-
# return_to_sender?: Boolean[];
|
51
|
-
attr_accessor :return_to_sender
|
52
|
-
|
53
|
-
# Destination country/region of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be `null` if the courier doesn't provide the destination country.
|
54
|
-
# courier_destination_country_iso3?: String[];
|
55
|
-
attr_accessor :courier_destination_country_iso3
|
6
|
+
# The Pagination holds the information for the pagination when the response contains multiple objects.
|
7
|
+
# pagination?: PaginationDataTrackingResponseGetMultipleV1;
|
8
|
+
attr_accessor :pagination
|
56
9
|
|
57
10
|
# Array of
|
58
11
|
# trackings?: Tracking[];
|
@@ -69,56 +22,8 @@ module AftershipAPI::Model
|
|
69
22
|
h[k.to_sym] = v
|
70
23
|
}
|
71
24
|
|
72
|
-
if attributes.key?(:'
|
73
|
-
self.
|
74
|
-
end
|
75
|
-
|
76
|
-
if attributes.key?(:'limit')
|
77
|
-
self.limit = attributes[:'limit']
|
78
|
-
end
|
79
|
-
|
80
|
-
if attributes.key?(:'count')
|
81
|
-
self.count = attributes[:'count']
|
82
|
-
end
|
83
|
-
|
84
|
-
if attributes.key?(:'keyword')
|
85
|
-
self.keyword = attributes[:'keyword']
|
86
|
-
end
|
87
|
-
|
88
|
-
if attributes.key?(:'slug')
|
89
|
-
self.slug = attributes[:'slug']
|
90
|
-
end
|
91
|
-
|
92
|
-
if attributes.key?(:'origin')
|
93
|
-
self.origin = attributes[:'origin']
|
94
|
-
end
|
95
|
-
|
96
|
-
if attributes.key?(:'destination')
|
97
|
-
self.destination = attributes[:'destination']
|
98
|
-
end
|
99
|
-
|
100
|
-
if attributes.key?(:'tag')
|
101
|
-
self.tag = attributes[:'tag']
|
102
|
-
end
|
103
|
-
|
104
|
-
if attributes.key?(:'created_at_min')
|
105
|
-
self.created_at_min = attributes[:'created_at_min']
|
106
|
-
end
|
107
|
-
|
108
|
-
if attributes.key?(:'created_at_max')
|
109
|
-
self.created_at_max = attributes[:'created_at_max']
|
110
|
-
end
|
111
|
-
|
112
|
-
if attributes.key?(:'last_updated_at')
|
113
|
-
self.last_updated_at = attributes[:'last_updated_at']
|
114
|
-
end
|
115
|
-
|
116
|
-
if attributes.key?(:'return_to_sender')
|
117
|
-
self.return_to_sender = attributes[:'return_to_sender']
|
118
|
-
end
|
119
|
-
|
120
|
-
if attributes.key?(:'courier_destination_country_iso3')
|
121
|
-
self.courier_destination_country_iso3 = attributes[:'courier_destination_country_iso3']
|
25
|
+
if attributes.key?(:'pagination')
|
26
|
+
self.pagination = attributes[:'pagination']
|
122
27
|
end
|
123
28
|
|
124
29
|
if attributes.key?(:'trackings')
|
@@ -129,19 +34,7 @@ module AftershipAPI::Model
|
|
129
34
|
# Attribute type mapping.
|
130
35
|
def self.openapi_types
|
131
36
|
{
|
132
|
-
:'
|
133
|
-
:'limit' => :'Integer',
|
134
|
-
:'count' => :'Integer',
|
135
|
-
:'keyword' => :'String',
|
136
|
-
:'slug' => :'String',
|
137
|
-
:'origin' => :'Array<String>',
|
138
|
-
:'destination' => :'Array<String>',
|
139
|
-
:'tag' => :'TagV1',
|
140
|
-
:'created_at_min' => :'String',
|
141
|
-
:'created_at_max' => :'String',
|
142
|
-
:'last_updated_at' => :'String',
|
143
|
-
:'return_to_sender' => :'Array<Boolean>',
|
144
|
-
:'courier_destination_country_iso3' => :'Array<String>',
|
37
|
+
:'pagination' => :'PaginationDataTrackingResponseGetMultipleV1',
|
145
38
|
:'trackings' => :'Array<Tracking>',
|
146
39
|
}
|
147
40
|
end
|
@@ -149,19 +42,7 @@ module AftershipAPI::Model
|
|
149
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
150
43
|
def self.attribute_map
|
151
44
|
{
|
152
|
-
:'
|
153
|
-
:'limit' => :'limit',
|
154
|
-
:'count' => :'count',
|
155
|
-
:'keyword' => :'keyword',
|
156
|
-
:'slug' => :'slug',
|
157
|
-
:'origin' => :'origin',
|
158
|
-
:'destination' => :'destination',
|
159
|
-
:'tag' => :'tag',
|
160
|
-
:'created_at_min' => :'created_at_min',
|
161
|
-
:'created_at_max' => :'created_at_max',
|
162
|
-
:'last_updated_at' => :'last_updated_at',
|
163
|
-
:'return_to_sender' => :'return_to_sender',
|
164
|
-
:'courier_destination_country_iso3' => :'courier_destination_country_iso3',
|
45
|
+
:'pagination' => :'pagination',
|
165
46
|
:'trackings' => :'trackings',
|
166
47
|
}
|
167
48
|
end
|
@@ -279,3 +160,4 @@ module AftershipAPI::Model
|
|
279
160
|
end
|
280
161
|
end
|
281
162
|
end
|
163
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class DeleteTrackingByIdResponse
|
5
|
+
|
5
6
|
# Tracking ID.
|
6
7
|
# id?: String;
|
7
8
|
attr_accessor :id
|
@@ -94,9 +95,9 @@ module AftershipAPI::Model
|
|
94
95
|
# emails?: String[];
|
95
96
|
attr_accessor :emails
|
96
97
|
|
97
|
-
# The estimated delivery date provided by the carrier.
|
98
|
-
#
|
99
|
-
attr_accessor :
|
98
|
+
# The field contains the estimated delivery date provided by the carrier.
|
99
|
+
# courier_estimated_delivery_date?: CourierEstimatedDeliveryDateDeleteTrackingByIdResponse;
|
100
|
+
attr_accessor :courier_estimated_delivery_date
|
100
101
|
|
101
102
|
# Text field for the note.
|
102
103
|
# note?: String;
|
@@ -318,6 +319,14 @@ module AftershipAPI::Model
|
|
318
319
|
# delivery_location_type?: String;
|
319
320
|
attr_accessor :delivery_location_type
|
320
321
|
|
322
|
+
# The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
|
323
|
+
# aftership_tracking_url?: String;
|
324
|
+
attr_accessor :aftership_tracking_url
|
325
|
+
|
326
|
+
# The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
|
327
|
+
# aftership_tracking_order_url?: String;
|
328
|
+
attr_accessor :aftership_tracking_order_url
|
329
|
+
|
321
330
|
# Initializes the object
|
322
331
|
# @param [Hash] attributes Model attributes in the form of hash
|
323
332
|
def initialize(attributes = {})
|
@@ -421,8 +430,8 @@ module AftershipAPI::Model
|
|
421
430
|
self.emails = attributes[:'emails']
|
422
431
|
end
|
423
432
|
|
424
|
-
if attributes.key?(:'
|
425
|
-
self.
|
433
|
+
if attributes.key?(:'courier_estimated_delivery_date')
|
434
|
+
self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
|
426
435
|
end
|
427
436
|
|
428
437
|
if attributes.key?(:'note')
|
@@ -644,6 +653,14 @@ module AftershipAPI::Model
|
|
644
653
|
if attributes.key?(:'delivery_location_type')
|
645
654
|
self.delivery_location_type = attributes[:'delivery_location_type']
|
646
655
|
end
|
656
|
+
|
657
|
+
if attributes.key?(:'aftership_tracking_url')
|
658
|
+
self.aftership_tracking_url = attributes[:'aftership_tracking_url']
|
659
|
+
end
|
660
|
+
|
661
|
+
if attributes.key?(:'aftership_tracking_order_url')
|
662
|
+
self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
|
663
|
+
end
|
647
664
|
end
|
648
665
|
|
649
666
|
# Attribute type mapping.
|
@@ -672,7 +689,7 @@ module AftershipAPI::Model
|
|
672
689
|
:'destination_raw_location' => :'String',
|
673
690
|
:'courier_destination_country_iso3' => :'String',
|
674
691
|
:'emails' => :'Array<String>',
|
675
|
-
:'
|
692
|
+
:'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateDeleteTrackingByIdResponse',
|
676
693
|
:'note' => :'String',
|
677
694
|
:'order_id' => :'String',
|
678
695
|
:'order_id_path' => :'String',
|
@@ -728,6 +745,8 @@ module AftershipAPI::Model
|
|
728
745
|
:'failed_delivery_attempts' => :'Integer',
|
729
746
|
:'signature_requirement' => :'String',
|
730
747
|
:'delivery_location_type' => :'String',
|
748
|
+
:'aftership_tracking_url' => :'String',
|
749
|
+
:'aftership_tracking_order_url' => :'String',
|
731
750
|
}
|
732
751
|
end
|
733
752
|
|
@@ -757,7 +776,7 @@ module AftershipAPI::Model
|
|
757
776
|
:'destination_raw_location' => :'destination_raw_location',
|
758
777
|
:'courier_destination_country_iso3' => :'courier_destination_country_iso3',
|
759
778
|
:'emails' => :'emails',
|
760
|
-
:'
|
779
|
+
:'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
|
761
780
|
:'note' => :'note',
|
762
781
|
:'order_id' => :'order_id',
|
763
782
|
:'order_id_path' => :'order_id_path',
|
@@ -813,6 +832,8 @@ module AftershipAPI::Model
|
|
813
832
|
:'failed_delivery_attempts' => :'failed_delivery_attempts',
|
814
833
|
:'signature_requirement' => :'signature_requirement',
|
815
834
|
:'delivery_location_type' => :'delivery_location_type',
|
835
|
+
:'aftership_tracking_url' => :'aftership_tracking_url',
|
836
|
+
:'aftership_tracking_order_url' => :'aftership_tracking_order_url',
|
816
837
|
}
|
817
838
|
end
|
818
839
|
|
@@ -929,3 +950,4 @@ module AftershipAPI::Model
|
|
929
950
|
end
|
930
951
|
end
|
931
952
|
end
|
953
|
+
|
data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class DestinationAddressEstimatedDeliveryDateRequest
|
5
|
+
|
5
6
|
# The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.
|
6
7
|
# country: String;
|
7
8
|
attr_accessor :country
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class DestinationAddressEstimatedDeliveryDateResponse
|
5
|
+
|
5
6
|
# The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.
|
6
7
|
# country: String;
|
7
8
|
attr_accessor :country
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class DetectCourierRequest
|
5
|
+
|
5
6
|
# Tracking number of a shipment.
|
6
7
|
# tracking_number: String;
|
7
8
|
attr_accessor :tracking_number
|
@@ -259,3 +260,4 @@ module AftershipAPI::Model
|
|
259
260
|
end
|
260
261
|
end
|
261
262
|
end
|
263
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class EstimatedDeliveryDateRequest
|
5
|
+
|
5
6
|
# AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.
|
6
7
|
# slug: String;
|
7
8
|
attr_accessor :slug
|
@@ -219,3 +220,4 @@ module AftershipAPI::Model
|
|
219
220
|
end
|
220
221
|
end
|
221
222
|
end
|
223
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class EstimatedDeliveryDateResponse
|
5
|
+
|
5
6
|
# A string that acts as a unique identifier for the estimated delivery date value generated by AfterShip Predict API
|
6
7
|
# id: String;
|
7
8
|
attr_accessor :id
|
@@ -269,3 +270,4 @@ module AftershipAPI::Model
|
|
269
270
|
end
|
270
271
|
end
|
271
272
|
end
|
273
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class EstimatedPickupEstimatedDeliveryDateRequest
|
5
|
+
|
5
6
|
# The local order time in the origin address time zone of the package.
|
6
7
|
# order_time: String;
|
7
8
|
attr_accessor :order_time
|
@@ -179,3 +180,4 @@ module AftershipAPI::Model
|
|
179
180
|
end
|
180
181
|
end
|
181
182
|
end
|
183
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class EstimatedPickupEstimatedDeliveryDateResponse
|
5
|
+
|
5
6
|
# The local order time in the origin address time zone of the package.
|
6
7
|
# order_time: String;
|
7
8
|
attr_accessor :order_time
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class FirstEstimatedDeliveryCreateTrackingResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class FirstEstimatedDeliveryDeleteTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class FirstEstimatedDeliveryGetTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class FirstEstimatedDeliveryMarkTrackingCompletedByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|
data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
module AftershipAPI::Model
|
4
4
|
class FirstEstimatedDeliveryRetrackTrackingByIdResponse
|
5
|
+
|
5
6
|
# The format of the EDD. Either a single date or a date range.
|
6
7
|
# type?: String;
|
7
8
|
attr_accessor :type
|
@@ -189,3 +190,4 @@ module AftershipAPI::Model
|
|
189
190
|
end
|
190
191
|
end
|
191
192
|
end
|
193
|
+
|