aftership-tracking-sdk 10.0.0 → 11.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -12
  3. data/lib/aftership-tracking-sdk/api/courier.rb +16 -60
  4. data/lib/aftership-tracking-sdk/api/courier_connection.rb +283 -0
  5. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +2 -2
  6. data/lib/aftership-tracking-sdk/api/tracking.rb +9 -9
  7. data/lib/aftership-tracking-sdk/models/{additional_fields_v1.rb → additional_fields.rb} +9 -9
  8. data/lib/aftership-tracking-sdk/models/checkpoint.rb +2 -2
  9. data/lib/aftership-tracking-sdk/models/courier.rb +10 -0
  10. data/lib/aftership-tracking-sdk/models/courier_connection.rb +193 -0
  11. data/lib/aftership-tracking-sdk/models/courier_connection_response_for_get_courier_connections.rb +163 -0
  12. data/lib/aftership-tracking-sdk/models/{courier_response_v1.rb → courier_response.rb} +6 -6
  13. data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +22 -52
  14. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +4 -44
  15. data/lib/aftership-tracking-sdk/models/credential_field.rb +173 -0
  16. data/lib/aftership-tracking-sdk/models/{get_user_couriers_response.rb → credentials_courier.rb} +9 -19
  17. data/lib/aftership-tracking-sdk/models/data_courier_connection_response_for_get_courier_connections.rb +163 -0
  18. data/lib/aftership-tracking-sdk/models/{data_courier_response_v1.rb → data_courier_response.rb} +2 -2
  19. data/lib/aftership-tracking-sdk/models/{data_tracking_response_get_multiple_v1.rb → data_tracking_response_for_get_trackings.rb} +4 -4
  20. data/lib/aftership-tracking-sdk/models/delete_courier_connections_by_id_response.rb +193 -0
  21. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +4 -44
  22. data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +14 -34
  23. data/lib/aftership-tracking-sdk/models/first_mile_create_tracking_response.rb +2 -2
  24. data/lib/aftership-tracking-sdk/models/first_mile_delete_tracking_by_id_response.rb +2 -2
  25. data/lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb +2 -2
  26. data/lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb +2 -2
  27. data/lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb +2 -2
  28. data/lib/aftership-tracking-sdk/models/first_mile_tracking.rb +2 -2
  29. data/lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb +2 -2
  30. data/lib/aftership-tracking-sdk/models/get_courier_connections_by_id_response.rb +193 -0
  31. data/lib/aftership-tracking-sdk/models/get_courier_connections_response.rb +163 -0
  32. data/lib/aftership-tracking-sdk/models/{get_all_couriers_response.rb → get_couriers_response.rb} +2 -2
  33. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +4 -44
  34. data/lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb +2 -2
  35. data/lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb +2 -2
  36. data/lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb +2 -2
  37. data/lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb +2 -2
  38. data/lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb +2 -2
  39. data/lib/aftership-tracking-sdk/models/last_mile_tracking.rb +2 -2
  40. data/lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb +2 -2
  41. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +10 -0
  42. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +10 -0
  43. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +10 -0
  44. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +10 -0
  45. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +10 -0
  46. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb +10 -0
  47. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +10 -0
  48. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +10 -0
  49. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +4 -44
  50. data/lib/aftership-tracking-sdk/models/{meta_v1.rb → meta.rb} +2 -2
  51. data/lib/aftership-tracking-sdk/models/pagination_data_courier_connection_response_for_get_courier_connections.rb +173 -0
  52. data/lib/aftership-tracking-sdk/models/{pagination_data_tracking_response_get_multiple_v1.rb → pagination_data_tracking_response_for_get_trackings.rb} +2 -2
  53. data/lib/aftership-tracking-sdk/models/pagination_get_courier_connections_response.rb +173 -0
  54. data/lib/aftership-tracking-sdk/models/post_courier_connections_request.rb +163 -0
  55. data/lib/aftership-tracking-sdk/models/post_courier_connections_response.rb +193 -0
  56. data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_request.rb +153 -0
  57. data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_response.rb +193 -0
  58. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +4 -44
  59. data/lib/aftership-tracking-sdk/models/{slug_group_v1.rb → slug_group.rb} +3 -3
  60. data/lib/aftership-tracking-sdk/models/{tag_v1.rb → tag.rb} +3 -3
  61. data/lib/aftership-tracking-sdk/models/tracking.rb +4 -44
  62. data/lib/aftership-tracking-sdk/models/{tracking_response_v1.rb → tracking_response.rb} +4 -4
  63. data/lib/aftership-tracking-sdk/models/{tracking_response_get_multiple_v1.rb → tracking_response_for_get_trackings.rb} +6 -6
  64. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +0 -40
  65. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +4 -44
  66. data/lib/aftership-tracking-sdk/version.rb +1 -1
  67. metadata +28 -14
@@ -3,7 +3,7 @@
3
3
  module AftershipAPI::Model
4
4
  class RetrackTrackingByIdResponse
5
5
 
6
- # Tracking ID.
6
+ # A system-generated tracking ID by default, which can be customized by the user when creating a tracking.
7
7
  # id?: String;
8
8
  attr_accessor :id
9
9
 
@@ -27,7 +27,7 @@ module AftershipAPI::Model
27
27
  # slug?: String;
28
28
  attr_accessor :slug
29
29
 
30
- # Whether or not AfterShip will continue tracking the shipments. Value is `false` when tag (status) is `Delivered`, `Expired`, or further updates for 30 days since last update.
30
+ # Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
31
31
  # active?: Boolean;
32
32
  attr_accessor :active
33
33
 
@@ -132,7 +132,7 @@ module AftershipAPI::Model
132
132
  attr_accessor :source
133
133
 
134
134
  # Current status of tracking. (
135
- # tag?: TagV1;
135
+ # tag?: Tag;
136
136
  attr_accessor :tag
137
137
 
138
138
  # Current subtag of tracking. (
@@ -259,22 +259,6 @@ module AftershipAPI::Model
259
259
  # courier_connection_id?: String;
260
260
  attr_accessor :courier_connection_id
261
261
 
262
- # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
263
- # tracking_origin_country_region?: String;
264
- attr_accessor :tracking_origin_country_region
265
-
266
- # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
267
- # tracking_destination_country_region?: String;
268
- attr_accessor :tracking_destination_country_region
269
-
270
- # (Legacy) Replaced by `destination_postal_code`. Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on for more details.
271
- # tracking_postal_code?: String;
272
- attr_accessor :tracking_postal_code
273
-
274
- # (Legacy) Replaced by `destination_state`. Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on for more details.
275
- # tracking_state?: String;
276
- attr_accessor :tracking_state
277
-
278
262
  # The model contains the total amount of carbon emissions generated by the shipment. - AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.
279
263
  # carbon_emissions?: CarbonEmissionsRetrackTrackingByIdResponse;
280
264
  attr_accessor :carbon_emissions
@@ -586,22 +570,6 @@ module AftershipAPI::Model
586
570
  self.courier_connection_id = attributes[:'courier_connection_id']
587
571
  end
588
572
 
589
- if attributes.key?(:'tracking_origin_country_region')
590
- self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
591
- end
592
-
593
- if attributes.key?(:'tracking_destination_country_region')
594
- self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
595
- end
596
-
597
- if attributes.key?(:'tracking_postal_code')
598
- self.tracking_postal_code = attributes[:'tracking_postal_code']
599
- end
600
-
601
- if attributes.key?(:'tracking_state')
602
- self.tracking_state = attributes[:'tracking_state']
603
- end
604
-
605
573
  if attributes.key?(:'carbon_emissions')
606
574
  self.carbon_emissions = attributes[:'carbon_emissions']
607
575
  end
@@ -682,7 +650,7 @@ module AftershipAPI::Model
682
650
  :'shipment_weight' => :'ShipmentWeightRetrackTrackingByIdResponse',
683
651
  :'signed_by' => :'String',
684
652
  :'source' => :'String',
685
- :'tag' => :'TagV1',
653
+ :'tag' => :'Tag',
686
654
  :'subtag' => :'String',
687
655
  :'subtag_message' => :'String',
688
656
  :'title' => :'String',
@@ -714,10 +682,6 @@ module AftershipAPI::Model
714
682
  :'latest_estimated_delivery' => :'LatestEstimatedDeliveryRetrackTrackingByIdResponse',
715
683
  :'shipment_tags' => :'Array<String>',
716
684
  :'courier_connection_id' => :'String',
717
- :'tracking_origin_country_region' => :'String',
718
- :'tracking_destination_country_region' => :'String',
719
- :'tracking_postal_code' => :'String',
720
- :'tracking_state' => :'String',
721
685
  :'carbon_emissions' => :'CarbonEmissionsRetrackTrackingByIdResponse',
722
686
  :'location_id' => :'String',
723
687
  :'shipping_method' => :'String',
@@ -799,10 +763,6 @@ module AftershipAPI::Model
799
763
  :'latest_estimated_delivery' => :'latest_estimated_delivery',
800
764
  :'shipment_tags' => :'shipment_tags',
801
765
  :'courier_connection_id' => :'courier_connection_id',
802
- :'tracking_origin_country_region' => :'tracking_origin_country_region',
803
- :'tracking_destination_country_region' => :'tracking_destination_country_region',
804
- :'tracking_postal_code' => :'tracking_postal_code',
805
- :'tracking_state' => :'tracking_state',
806
766
  :'carbon_emissions' => :'carbon_emissions',
807
767
  :'location_id' => :'location_id',
808
768
  :'shipping_method' => :'shipping_method',
@@ -2,7 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
 
4
4
  module AftershipAPI::Model
5
- class SlugGroupV1
5
+ class SlugGroup
6
6
  AMAZON_GROUP = "amazon-group".freeze
7
7
  FEDEX_GROUP = "fedex-group".freeze
8
8
  TOLL_GROUP = "toll-group".freeze
@@ -30,8 +30,8 @@ module AftershipAPI::Model
30
30
  # @param value [String] The enum value in the form of the string
31
31
  # @return [String] The enum value
32
32
  def build_from_hash(value)
33
- return value if SlugGroupV1.all_vars.include?(value)
34
- raise "Invalid ENUM value #{value} for class #SlugGroupV1"
33
+ return value if SlugGroup.all_vars.include?(value)
34
+ raise "Invalid ENUM value #{value} for class #SlugGroup"
35
35
  end
36
36
  end
37
37
  end
@@ -2,7 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
 
4
4
  module AftershipAPI::Model
5
- class TagV1
5
+ class Tag
6
6
  PENDING = "Pending".freeze
7
7
  INFORECEIVED = "InfoReceived".freeze
8
8
  INTRANSIT = "InTransit".freeze
@@ -27,8 +27,8 @@ module AftershipAPI::Model
27
27
  # @param value [String] The enum value in the form of the string
28
28
  # @return [String] The enum value
29
29
  def build_from_hash(value)
30
- return value if TagV1.all_vars.include?(value)
31
- raise "Invalid ENUM value #{value} for class #TagV1"
30
+ return value if Tag.all_vars.include?(value)
31
+ raise "Invalid ENUM value #{value} for class #Tag"
32
32
  end
33
33
  end
34
34
  end
@@ -3,7 +3,7 @@
3
3
  module AftershipAPI::Model
4
4
  class Tracking
5
5
 
6
- # Tracking ID.
6
+ # A system-generated tracking ID by default, which can be customized by the user when creating a tracking.
7
7
  # id?: String;
8
8
  attr_accessor :id
9
9
 
@@ -27,7 +27,7 @@ module AftershipAPI::Model
27
27
  # slug?: String;
28
28
  attr_accessor :slug
29
29
 
30
- # Whether or not AfterShip will continue tracking the shipments. Value is `false` when tag (status) is `Delivered`, `Expired`, or further updates for 30 days since last update.
30
+ # Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
31
31
  # active?: Boolean;
32
32
  attr_accessor :active
33
33
 
@@ -132,7 +132,7 @@ module AftershipAPI::Model
132
132
  attr_accessor :source
133
133
 
134
134
  # Current status of tracking. (
135
- # tag?: TagV1;
135
+ # tag?: Tag;
136
136
  attr_accessor :tag
137
137
 
138
138
  # Current subtag of tracking. (
@@ -259,22 +259,6 @@ module AftershipAPI::Model
259
259
  # courier_connection_id?: String;
260
260
  attr_accessor :courier_connection_id
261
261
 
262
- # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
263
- # tracking_origin_country_region?: String;
264
- attr_accessor :tracking_origin_country_region
265
-
266
- # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
267
- # tracking_destination_country_region?: String;
268
- attr_accessor :tracking_destination_country_region
269
-
270
- # (Legacy) Replaced by `destination_postal_code`. Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on for more details.
271
- # tracking_postal_code?: String;
272
- attr_accessor :tracking_postal_code
273
-
274
- # (Legacy) Replaced by `destination_state`. Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on for more details.
275
- # tracking_state?: String;
276
- attr_accessor :tracking_state
277
-
278
262
  # The model contains the total amount of carbon emissions generated by the shipment. - AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.
279
263
  # carbon_emissions?: CarbonEmissionsTracking;
280
264
  attr_accessor :carbon_emissions
@@ -586,22 +570,6 @@ module AftershipAPI::Model
586
570
  self.courier_connection_id = attributes[:'courier_connection_id']
587
571
  end
588
572
 
589
- if attributes.key?(:'tracking_origin_country_region')
590
- self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
591
- end
592
-
593
- if attributes.key?(:'tracking_destination_country_region')
594
- self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
595
- end
596
-
597
- if attributes.key?(:'tracking_postal_code')
598
- self.tracking_postal_code = attributes[:'tracking_postal_code']
599
- end
600
-
601
- if attributes.key?(:'tracking_state')
602
- self.tracking_state = attributes[:'tracking_state']
603
- end
604
-
605
573
  if attributes.key?(:'carbon_emissions')
606
574
  self.carbon_emissions = attributes[:'carbon_emissions']
607
575
  end
@@ -682,7 +650,7 @@ module AftershipAPI::Model
682
650
  :'shipment_weight' => :'ShipmentWeightTracking',
683
651
  :'signed_by' => :'String',
684
652
  :'source' => :'String',
685
- :'tag' => :'TagV1',
653
+ :'tag' => :'Tag',
686
654
  :'subtag' => :'String',
687
655
  :'subtag_message' => :'String',
688
656
  :'title' => :'String',
@@ -714,10 +682,6 @@ module AftershipAPI::Model
714
682
  :'latest_estimated_delivery' => :'LatestEstimatedDeliveryTracking',
715
683
  :'shipment_tags' => :'Array<String>',
716
684
  :'courier_connection_id' => :'String',
717
- :'tracking_origin_country_region' => :'String',
718
- :'tracking_destination_country_region' => :'String',
719
- :'tracking_postal_code' => :'String',
720
- :'tracking_state' => :'String',
721
685
  :'carbon_emissions' => :'CarbonEmissionsTracking',
722
686
  :'location_id' => :'String',
723
687
  :'shipping_method' => :'String',
@@ -799,10 +763,6 @@ module AftershipAPI::Model
799
763
  :'latest_estimated_delivery' => :'latest_estimated_delivery',
800
764
  :'shipment_tags' => :'shipment_tags',
801
765
  :'courier_connection_id' => :'courier_connection_id',
802
- :'tracking_origin_country_region' => :'tracking_origin_country_region',
803
- :'tracking_destination_country_region' => :'tracking_destination_country_region',
804
- :'tracking_postal_code' => :'tracking_postal_code',
805
- :'tracking_state' => :'tracking_state',
806
766
  :'carbon_emissions' => :'carbon_emissions',
807
767
  :'location_id' => :'location_id',
808
768
  :'shipping_method' => :'shipping_method',
@@ -1,10 +1,10 @@
1
1
  # This code was auto generated by AfterShip SDK Generator.
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
- class TrackingResponseV1
4
+ class TrackingResponse
5
5
 
6
6
  # Meta data
7
- # meta: MetaV1;
7
+ # meta: Meta;
8
8
  attr_accessor :meta
9
9
 
10
10
  # Object describes the tracking information.<div style="display:none; height: 0"></div>
@@ -15,7 +15,7 @@ module AftershipAPI::Model
15
15
  # @param [Hash] attributes Model attributes in the form of hash
16
16
  def initialize(attributes = {})
17
17
  if (!attributes.is_a?(Hash))
18
- fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingResponseV1` initialize method"
18
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingResponse` initialize method"
19
19
  end
20
20
 
21
21
  attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -34,7 +34,7 @@ module AftershipAPI::Model
34
34
  # Attribute type mapping.
35
35
  def self.openapi_types
36
36
  {
37
- :'meta' => :'MetaV1',
37
+ :'meta' => :'Meta',
38
38
  :'data' => :'Tracking',
39
39
  }
40
40
  end
@@ -1,21 +1,21 @@
1
1
  # This code was auto generated by AfterShip SDK Generator.
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
- class TrackingResponseGetMultipleV1
4
+ class TrackingResponseForGetTrackings
5
5
 
6
6
  # Meta data
7
- # meta: MetaV1;
7
+ # meta: Meta;
8
8
  attr_accessor :meta
9
9
 
10
10
  #
11
- # data?: DataTrackingResponseGetMultipleV1;
11
+ # data?: DataTrackingResponseForGetTrackings;
12
12
  attr_accessor :data
13
13
 
14
14
  # Initializes the object
15
15
  # @param [Hash] attributes Model attributes in the form of hash
16
16
  def initialize(attributes = {})
17
17
  if (!attributes.is_a?(Hash))
18
- fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingResponseGetMultipleV1` initialize method"
18
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingResponseForGetTrackings` initialize method"
19
19
  end
20
20
 
21
21
  attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -34,8 +34,8 @@ module AftershipAPI::Model
34
34
  # Attribute type mapping.
35
35
  def self.openapi_types
36
36
  {
37
- :'meta' => :'MetaV1',
38
- :'data' => :'DataTrackingResponseGetMultipleV1',
37
+ :'meta' => :'Meta',
38
+ :'data' => :'DataTrackingResponseForGetTrackings',
39
39
  }
40
40
  end
41
41
 
@@ -111,22 +111,6 @@ module AftershipAPI::Model
111
111
  # destination_raw_location?: String;
112
112
  attr_accessor :destination_raw_location
113
113
 
114
- # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
115
- # tracking_origin_country_region?: String;
116
- attr_accessor :tracking_origin_country_region
117
-
118
- # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
119
- # tracking_destination_country_region?: String;
120
- attr_accessor :tracking_destination_country_region
121
-
122
- # (Legacy) Replaced by `destination_postal_code`. Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on for more details.
123
- # tracking_postal_code?: String;
124
- attr_accessor :tracking_postal_code
125
-
126
- # (Legacy) Replaced by `destination_state`. Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on for more details.
127
- # tracking_state?: String;
128
- attr_accessor :tracking_state
129
-
130
114
  # The location_id refers to the place where you fulfilled the items. - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.- Please make sure you add your locations .
131
115
  # location_id?: String;
132
116
  attr_accessor :location_id
@@ -258,22 +242,6 @@ module AftershipAPI::Model
258
242
  self.destination_raw_location = attributes[:'destination_raw_location']
259
243
  end
260
244
 
261
- if attributes.key?(:'tracking_origin_country_region')
262
- self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
263
- end
264
-
265
- if attributes.key?(:'tracking_destination_country_region')
266
- self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
267
- end
268
-
269
- if attributes.key?(:'tracking_postal_code')
270
- self.tracking_postal_code = attributes[:'tracking_postal_code']
271
- end
272
-
273
- if attributes.key?(:'tracking_state')
274
- self.tracking_state = attributes[:'tracking_state']
275
- end
276
-
277
245
  if attributes.key?(:'location_id')
278
246
  self.location_id = attributes[:'location_id']
279
247
  end
@@ -317,10 +285,6 @@ module AftershipAPI::Model
317
285
  :'destination_city' => :'String',
318
286
  :'destination_postal_code' => :'String',
319
287
  :'destination_raw_location' => :'String',
320
- :'tracking_origin_country_region' => :'String',
321
- :'tracking_destination_country_region' => :'String',
322
- :'tracking_postal_code' => :'String',
323
- :'tracking_state' => :'String',
324
288
  :'location_id' => :'String',
325
289
  :'shipping_method' => :'String',
326
290
  :'customers' => :'Array<CustomersUpdateTrackingByIdRequest>',
@@ -357,10 +321,6 @@ module AftershipAPI::Model
357
321
  :'destination_city' => :'destination_city',
358
322
  :'destination_postal_code' => :'destination_postal_code',
359
323
  :'destination_raw_location' => :'destination_raw_location',
360
- :'tracking_origin_country_region' => :'tracking_origin_country_region',
361
- :'tracking_destination_country_region' => :'tracking_destination_country_region',
362
- :'tracking_postal_code' => :'tracking_postal_code',
363
- :'tracking_state' => :'tracking_state',
364
324
  :'location_id' => :'location_id',
365
325
  :'shipping_method' => :'shipping_method',
366
326
  :'customers' => :'customers',
@@ -3,7 +3,7 @@
3
3
  module AftershipAPI::Model
4
4
  class UpdateTrackingByIdResponse
5
5
 
6
- # Tracking ID.
6
+ # A system-generated tracking ID by default, which can be customized by the user when creating a tracking.
7
7
  # id?: String;
8
8
  attr_accessor :id
9
9
 
@@ -27,7 +27,7 @@ module AftershipAPI::Model
27
27
  # slug?: String;
28
28
  attr_accessor :slug
29
29
 
30
- # Whether or not AfterShip will continue tracking the shipments. Value is `false` when tag (status) is `Delivered`, `Expired`, or further updates for 30 days since last update.
30
+ # Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
31
31
  # active?: Boolean;
32
32
  attr_accessor :active
33
33
 
@@ -132,7 +132,7 @@ module AftershipAPI::Model
132
132
  attr_accessor :source
133
133
 
134
134
  # Current status of tracking. (
135
- # tag?: TagV1;
135
+ # tag?: Tag;
136
136
  attr_accessor :tag
137
137
 
138
138
  # Current subtag of tracking. (
@@ -259,22 +259,6 @@ module AftershipAPI::Model
259
259
  # courier_connection_id?: String;
260
260
  attr_accessor :courier_connection_id
261
261
 
262
- # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
263
- # tracking_origin_country_region?: String;
264
- attr_accessor :tracking_origin_country_region
265
-
266
- # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
267
- # tracking_destination_country_region?: String;
268
- attr_accessor :tracking_destination_country_region
269
-
270
- # (Legacy) Replaced by `destination_postal_code`. Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on for more details.
271
- # tracking_postal_code?: String;
272
- attr_accessor :tracking_postal_code
273
-
274
- # (Legacy) Replaced by `destination_state`. Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on for more details.
275
- # tracking_state?: String;
276
- attr_accessor :tracking_state
277
-
278
262
  # The model contains the total amount of carbon emissions generated by the shipment. - AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.
279
263
  # carbon_emissions?: CarbonEmissionsUpdateTrackingByIdResponse;
280
264
  attr_accessor :carbon_emissions
@@ -586,22 +570,6 @@ module AftershipAPI::Model
586
570
  self.courier_connection_id = attributes[:'courier_connection_id']
587
571
  end
588
572
 
589
- if attributes.key?(:'tracking_origin_country_region')
590
- self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
591
- end
592
-
593
- if attributes.key?(:'tracking_destination_country_region')
594
- self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
595
- end
596
-
597
- if attributes.key?(:'tracking_postal_code')
598
- self.tracking_postal_code = attributes[:'tracking_postal_code']
599
- end
600
-
601
- if attributes.key?(:'tracking_state')
602
- self.tracking_state = attributes[:'tracking_state']
603
- end
604
-
605
573
  if attributes.key?(:'carbon_emissions')
606
574
  self.carbon_emissions = attributes[:'carbon_emissions']
607
575
  end
@@ -682,7 +650,7 @@ module AftershipAPI::Model
682
650
  :'shipment_weight' => :'ShipmentWeightUpdateTrackingByIdResponse',
683
651
  :'signed_by' => :'String',
684
652
  :'source' => :'String',
685
- :'tag' => :'TagV1',
653
+ :'tag' => :'Tag',
686
654
  :'subtag' => :'String',
687
655
  :'subtag_message' => :'String',
688
656
  :'title' => :'String',
@@ -714,10 +682,6 @@ module AftershipAPI::Model
714
682
  :'latest_estimated_delivery' => :'LatestEstimatedDeliveryUpdateTrackingByIdResponse',
715
683
  :'shipment_tags' => :'Array<String>',
716
684
  :'courier_connection_id' => :'String',
717
- :'tracking_origin_country_region' => :'String',
718
- :'tracking_destination_country_region' => :'String',
719
- :'tracking_postal_code' => :'String',
720
- :'tracking_state' => :'String',
721
685
  :'carbon_emissions' => :'CarbonEmissionsUpdateTrackingByIdResponse',
722
686
  :'location_id' => :'String',
723
687
  :'shipping_method' => :'String',
@@ -799,10 +763,6 @@ module AftershipAPI::Model
799
763
  :'latest_estimated_delivery' => :'latest_estimated_delivery',
800
764
  :'shipment_tags' => :'shipment_tags',
801
765
  :'courier_connection_id' => :'courier_connection_id',
802
- :'tracking_origin_country_region' => :'tracking_origin_country_region',
803
- :'tracking_destination_country_region' => :'tracking_destination_country_region',
804
- :'tracking_postal_code' => :'tracking_postal_code',
805
- :'tracking_state' => :'tracking_state',
806
766
  :'carbon_emissions' => :'carbon_emissions',
807
767
  :'location_id' => :'location_id',
808
768
  :'shipping_method' => :'shipping_method',
@@ -1,5 +1,5 @@
1
1
  # This code was auto generated by AfterShip SDK Generator.
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI
4
- VERSION = '10.0.0'
4
+ VERSION = '11.0.0'
5
5
  end
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: 10.0.0
4
+ version: 11.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - AfterShip Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-20 00:00:00.000000000 Z
11
+ date: 2025-04-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -63,12 +63,13 @@ files:
63
63
  - aftership-tracking-sdk.gemspec
64
64
  - lib/aftership-tracking-sdk.rb
65
65
  - lib/aftership-tracking-sdk/api/courier.rb
66
+ - lib/aftership-tracking-sdk/api/courier_connection.rb
66
67
  - lib/aftership-tracking-sdk/api/estimated_delivery_date.rb
67
68
  - lib/aftership-tracking-sdk/api/tracking.rb
68
69
  - lib/aftership-tracking-sdk/api_client.rb
69
70
  - lib/aftership-tracking-sdk/configuration.rb
70
71
  - lib/aftership-tracking-sdk/error.rb
71
- - lib/aftership-tracking-sdk/models/additional_fields_v1.rb
72
+ - lib/aftership-tracking-sdk/models/additional_fields.rb
72
73
  - lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb
73
74
  - lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb
74
75
  - lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb
@@ -86,6 +87,8 @@ files:
86
87
  - lib/aftership-tracking-sdk/models/checkpoint.rb
87
88
  - lib/aftership-tracking-sdk/models/coordinate_checkpoint.rb
88
89
  - lib/aftership-tracking-sdk/models/courier.rb
90
+ - lib/aftership-tracking-sdk/models/courier_connection.rb
91
+ - lib/aftership-tracking-sdk/models/courier_connection_response_for_get_courier_connections.rb
89
92
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_create_tracking_response.rb
90
93
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_delete_tracking_by_id_response.rb
91
94
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_get_tracking_by_id_response.rb
@@ -93,9 +96,11 @@ files:
93
96
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_retrack_tracking_by_id_response.rb
94
97
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_tracking.rb
95
98
  - lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_update_tracking_by_id_response.rb
96
- - lib/aftership-tracking-sdk/models/courier_response_v1.rb
99
+ - lib/aftership-tracking-sdk/models/courier_response.rb
97
100
  - lib/aftership-tracking-sdk/models/create_tracking_request.rb
98
101
  - lib/aftership-tracking-sdk/models/create_tracking_response.rb
102
+ - lib/aftership-tracking-sdk/models/credential_field.rb
103
+ - lib/aftership-tracking-sdk/models/credentials_courier.rb
99
104
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb
100
105
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb
101
106
  - lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb
@@ -112,8 +117,10 @@ files:
112
117
  - lib/aftership-tracking-sdk/models/customers_tracking.rb
113
118
  - lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_request.rb
114
119
  - lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_response.rb
115
- - lib/aftership-tracking-sdk/models/data_courier_response_v1.rb
116
- - lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb
120
+ - lib/aftership-tracking-sdk/models/data_courier_connection_response_for_get_courier_connections.rb
121
+ - lib/aftership-tracking-sdk/models/data_courier_response.rb
122
+ - lib/aftership-tracking-sdk/models/data_tracking_response_for_get_trackings.rb
123
+ - lib/aftership-tracking-sdk/models/delete_courier_connections_by_id_response.rb
117
124
  - lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb
118
125
  - lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb
119
126
  - lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb
@@ -142,10 +149,11 @@ files:
142
149
  - lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb
143
150
  - lib/aftership-tracking-sdk/models/first_mile_tracking.rb
144
151
  - lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb
145
- - lib/aftership-tracking-sdk/models/get_all_couriers_response.rb
152
+ - lib/aftership-tracking-sdk/models/get_courier_connections_by_id_response.rb
153
+ - lib/aftership-tracking-sdk/models/get_courier_connections_response.rb
154
+ - lib/aftership-tracking-sdk/models/get_couriers_response.rb
146
155
  - lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb
147
156
  - lib/aftership-tracking-sdk/models/get_trackings_response.rb
148
- - lib/aftership-tracking-sdk/models/get_user_couriers_response.rb
149
157
  - lib/aftership-tracking-sdk/models/last_mile_create_tracking_request.rb
150
158
  - lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb
151
159
  - lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb
@@ -163,7 +171,7 @@ files:
163
171
  - lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb
164
172
  - lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb
165
173
  - lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb
166
- - lib/aftership-tracking-sdk/models/meta_v1.rb
174
+ - lib/aftership-tracking-sdk/models/meta.rb
167
175
  - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb
168
176
  - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb
169
177
  - lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_request.rb
@@ -173,12 +181,18 @@ files:
173
181
  - lib/aftership-tracking-sdk/models/origin_address_predict_request.rb
174
182
  - lib/aftership-tracking-sdk/models/origin_address_predict_response.rb
175
183
  - lib/aftership-tracking-sdk/models/pagination.rb
176
- - lib/aftership-tracking-sdk/models/pagination_data_tracking_response_get_multiple_v1.rb
184
+ - lib/aftership-tracking-sdk/models/pagination_data_courier_connection_response_for_get_courier_connections.rb
185
+ - lib/aftership-tracking-sdk/models/pagination_data_tracking_response_for_get_trackings.rb
186
+ - lib/aftership-tracking-sdk/models/pagination_get_courier_connections_response.rb
177
187
  - lib/aftership-tracking-sdk/models/pagination_get_trackings_response.rb
188
+ - lib/aftership-tracking-sdk/models/post_courier_connections_request.rb
189
+ - lib/aftership-tracking-sdk/models/post_courier_connections_response.rb
178
190
  - lib/aftership-tracking-sdk/models/predict_batch_request.rb
179
191
  - lib/aftership-tracking-sdk/models/predict_batch_response.rb
180
192
  - lib/aftership-tracking-sdk/models/predict_request.rb
181
193
  - lib/aftership-tracking-sdk/models/predict_response.rb
194
+ - lib/aftership-tracking-sdk/models/put_courier_connections_by_id_request.rb
195
+ - lib/aftership-tracking-sdk/models/put_courier_connections_by_id_response.rb
182
196
  - lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb
183
197
  - lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb
184
198
  - lib/aftership-tracking-sdk/models/shipment_weight_create_tracking_response.rb
@@ -188,11 +202,11 @@ files:
188
202
  - lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb
189
203
  - lib/aftership-tracking-sdk/models/shipment_weight_tracking.rb
190
204
  - lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb
191
- - lib/aftership-tracking-sdk/models/slug_group_v1.rb
192
- - lib/aftership-tracking-sdk/models/tag_v1.rb
205
+ - lib/aftership-tracking-sdk/models/slug_group.rb
206
+ - lib/aftership-tracking-sdk/models/tag.rb
193
207
  - lib/aftership-tracking-sdk/models/tracking.rb
194
- - lib/aftership-tracking-sdk/models/tracking_response_get_multiple_v1.rb
195
- - lib/aftership-tracking-sdk/models/tracking_response_v1.rb
208
+ - lib/aftership-tracking-sdk/models/tracking_response.rb
209
+ - lib/aftership-tracking-sdk/models/tracking_response_for_get_trackings.rb
196
210
  - lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb
197
211
  - lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb
198
212
  - lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb