aftership-tracking-sdk 9.0.0 → 11.0.0

data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb

@@ -3,7 +3,7 @@
 module AftershipAPI::Model
   class RetrackTrackingByIdResponse
 
-    # Tracking ID.
+    # A  system-generated tracking ID by default, which can be customized by the user when creating a tracking.
     # id?: String;
     attr_accessor :id
 
@@ -19,10 +19,6 @@ module AftershipAPI::Model
     # updated_at?: String;
     attr_accessor :updated_at
 
-    # (Legacy) The date and time the shipment was updated. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
-    # last_updated_at?: String;
-    attr_accessor :last_updated_at
-
     # Tracking number.
     # tracking_number?: String;
     attr_accessor :tracking_number
@@ -31,7 +27,7 @@ module AftershipAPI::Model
     # slug?: String;
     attr_accessor :slug
 
-    # 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.
+    # Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
     # active?: Boolean;
     attr_accessor :active
 
@@ -39,17 +35,13 @@ module AftershipAPI::Model
     # custom_fields?: Object;
     attr_accessor :custom_fields
 
-    # Customer name of the tracking.
-    # customer_name?: String;
-    attr_accessor :customer_name
-
     # Total transit time in days.- For delivered shipments: Transit time (in days) = Delivered date - Pick-up date- For undelivered shipments: Transit time (in days) = Current date - Pick-up dateValue as `null` for the shipment without pick-up date.
     # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The  for the origin country/region. E.g. USA for the United States.
-    # origin_country_iso3?: String;
-    attr_accessor :origin_country_iso3
+    # origin_country_region?: String;
+    attr_accessor :origin_country_region
 
     # The state of the sender’s address.
     # origin_state?: String;
@@ -68,8 +60,8 @@ module AftershipAPI::Model
     attr_accessor :origin_raw_location
 
     # The  for the destination country/region. E.g. USA for the United States.
-    # destination_country_iso3?: String;
-    attr_accessor :destination_country_iso3
+    # destination_country_region?: String;
+    attr_accessor :destination_country_region
 
     # The state of the recipient’s address.
     # destination_state?: String;
@@ -88,12 +80,8 @@ module AftershipAPI::Model
     attr_accessor :destination_raw_location
 
     # 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.
-    # courier_destination_country_iso3?: String;
-    attr_accessor :courier_destination_country_iso3
-
-    # Email address(es) to receive email notifications.
-    # emails?: String[];
-    attr_accessor :emails
+    # courier_destination_country_region?: String;
+    attr_accessor :courier_destination_country_region
 
     # The field contains the estimated delivery date provided by the carrier.
     # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateRetrackTrackingByIdResponse;
@@ -139,16 +127,12 @@ module AftershipAPI::Model
     # signed_by?: String;
     attr_accessor :signed_by
 
-    # The phone number(s) to receive sms notifications.  Phone number should begin with `+` and `Area Code` before phone number.
-    # smses?: String[];
-    attr_accessor :smses
-
     # Source of how this tracking is added.
     # source?: String;
     attr_accessor :source
 
     # Current status of tracking. (
-    # tag?: TagV1;
+    # tag?: Tag;
     attr_accessor :tag
 
     # Current subtag of tracking. (
@@ -231,7 +215,7 @@ module AftershipAPI::Model
     # tracking_key?: String;
     attr_accessor :tracking_key
 
-    # Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on  for more details.
+    # The date and time when the shipment is shipped by the merchant and ready for pickup by the carrier. The field supports the following formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZThe field serves two key purposes:- Calculate processing time metrics in the Order-to-delivery Analytics dashboard. To ensure accurate analytics, it's recommended to include timezone information when configuring this value- Required by certain carriers to retrieve tracking information as an additional tracking field.
     # tracking_ship_date?: String;
     attr_accessor :tracking_ship_date
 
@@ -275,26 +259,6 @@ module AftershipAPI::Model
     # courier_connection_id?: String;
     attr_accessor :courier_connection_id
 
-    # The next couriers get the second carrier information from user or AfterShip.
-    # next_couriers?: NextCouriersRetrackTrackingByIdResponse[];
-    attr_accessor :next_couriers
-
-    # (Legacy) Replaced by `origin_country_iso3`. 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.
-    # tracking_origin_country?: String;
-    attr_accessor :tracking_origin_country
-
-    # (Legacy) Replaced by `destination_country_iso3`. 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.
-    # tracking_destination_country?: String;
-    attr_accessor :tracking_destination_country
-
-    # (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.
-    # tracking_postal_code?: String;
-    attr_accessor :tracking_postal_code
-
-    # (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.
-    # tracking_state?: String;
-    attr_accessor :tracking_state
-
     # 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.
     # carbon_emissions?: CarbonEmissionsRetrackTrackingByIdResponse;
     attr_accessor :carbon_emissions
@@ -327,6 +291,18 @@ module AftershipAPI::Model
     # aftership_tracking_order_url?: String;
     attr_accessor :aftership_tracking_order_url
 
+    # The field contains information about the first leg of the shipping starting from the carrier picking up the shipment from the shipper to the point where they hand it over to the last-mile carrier. Once AfterShip detects the shipment is multi-leg, we will populate the first-mile information under this object. 
+    # first_mile?: FirstMileRetrackTrackingByIdResponse;
+    attr_accessor :first_mile
+
+    # This field contains information about the last leg of the shipment, starting from the carrier who hands it over to the last-mile carrier, all the way to delivery. Once AfterShip detects that the shipment involves multiple legs and identifies the last-mile carrier, we will populate the last-mile carrier information in this object. Alternatively, the user can provide this information in this field to specify the last-mile carrier, which is helpful if AfterShip is unable to detect it automatically.
+    # last_mile?: LastMileRetrackTrackingByIdResponse;
+    attr_accessor :last_mile
+
+    # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
+    # customers?: CustomersRetrackTrackingByIdResponse[];
+    attr_accessor :customers
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -354,10 +330,6 @@ module AftershipAPI::Model
         self.updated_at = attributes[:'updated_at']
       end 
 
-      if attributes.key?(:'last_updated_at')
-        self.last_updated_at = attributes[:'last_updated_at']
-      end 
-
       if attributes.key?(:'tracking_number')
         self.tracking_number = attributes[:'tracking_number']
       end 
@@ -374,16 +346,12 @@ module AftershipAPI::Model
         self.custom_fields = attributes[:'custom_fields']
       end 
 
-      if attributes.key?(:'customer_name')
-        self.customer_name = attributes[:'customer_name']
-      end 
-
       if attributes.key?(:'transit_time')
         self.transit_time = attributes[:'transit_time']
       end 
 
-      if attributes.key?(:'origin_country_iso3')
-        self.origin_country_iso3 = attributes[:'origin_country_iso3']
+      if attributes.key?(:'origin_country_region')
+        self.origin_country_region = attributes[:'origin_country_region']
       end 
 
       if attributes.key?(:'origin_state')
@@ -402,8 +370,8 @@ module AftershipAPI::Model
         self.origin_raw_location = attributes[:'origin_raw_location']
       end 
 
-      if attributes.key?(:'destination_country_iso3')
-        self.destination_country_iso3 = attributes[:'destination_country_iso3']
+      if attributes.key?(:'destination_country_region')
+        self.destination_country_region = attributes[:'destination_country_region']
       end 
 
       if attributes.key?(:'destination_state')
@@ -422,12 +390,8 @@ module AftershipAPI::Model
         self.destination_raw_location = attributes[:'destination_raw_location']
       end 
 
-      if attributes.key?(:'courier_destination_country_iso3')
-        self.courier_destination_country_iso3 = attributes[:'courier_destination_country_iso3']
-      end 
-
-      if attributes.key?(:'emails')
-        self.emails = attributes[:'emails']
+      if attributes.key?(:'courier_destination_country_region')
+        self.courier_destination_country_region = attributes[:'courier_destination_country_region']
       end 
 
       if attributes.key?(:'courier_estimated_delivery_date')
@@ -474,10 +438,6 @@ module AftershipAPI::Model
         self.signed_by = attributes[:'signed_by']
       end 
 
-      if attributes.key?(:'smses')
-        self.smses = attributes[:'smses']
-      end 
-
       if attributes.key?(:'source')
         self.source = attributes[:'source']
       end 
@@ -610,26 +570,6 @@ module AftershipAPI::Model
         self.courier_connection_id = attributes[:'courier_connection_id']
       end 
 
-      if attributes.key?(:'next_couriers')
-        self.next_couriers = attributes[:'next_couriers']
-      end 
-
-      if attributes.key?(:'tracking_origin_country')
-        self.tracking_origin_country = attributes[:'tracking_origin_country']
-      end 
-
-      if attributes.key?(:'tracking_destination_country')
-        self.tracking_destination_country = attributes[:'tracking_destination_country']
-      end 
-
-      if attributes.key?(:'tracking_postal_code')
-        self.tracking_postal_code = attributes[:'tracking_postal_code']
-      end 
-
-      if attributes.key?(:'tracking_state')
-        self.tracking_state = attributes[:'tracking_state']
-      end 
-
       if attributes.key?(:'carbon_emissions')
         self.carbon_emissions = attributes[:'carbon_emissions']
       end 
@@ -661,6 +601,18 @@ module AftershipAPI::Model
       if attributes.key?(:'aftership_tracking_order_url')
         self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
       end 
+
+      if attributes.key?(:'first_mile')
+        self.first_mile = attributes[:'first_mile']
+      end 
+
+      if attributes.key?(:'last_mile')
+        self.last_mile = attributes[:'last_mile']
+      end 
+
+      if attributes.key?(:'customers')
+        self.customers = attributes[:'customers']
+      end 
     end
 
     # Attribute type mapping.
@@ -670,25 +622,22 @@ module AftershipAPI::Model
         :'legacy_id' => :'String',
         :'created_at' => :'String',
         :'updated_at' => :'String',
-        :'last_updated_at' => :'String',
         :'tracking_number' => :'String',
         :'slug' => :'String',
         :'active' => :'Boolean',
         :'custom_fields' => :'Object',
-        :'customer_name' => :'String',
         :'transit_time' => :'Integer',
-        :'origin_country_iso3' => :'String',
+        :'origin_country_region' => :'String',
         :'origin_state' => :'String',
         :'origin_city' => :'String',
         :'origin_postal_code' => :'String',
         :'origin_raw_location' => :'String',
-        :'destination_country_iso3' => :'String',
+        :'destination_country_region' => :'String',
         :'destination_state' => :'String',
         :'destination_city' => :'String',
         :'destination_postal_code' => :'String',
         :'destination_raw_location' => :'String',
-        :'courier_destination_country_iso3' => :'String',
-        :'emails' => :'Array<String>',
+        :'courier_destination_country_region' => :'String',
         :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateRetrackTrackingByIdResponse',
         :'note' => :'String',
         :'order_id' => :'String',
@@ -700,9 +649,8 @@ module AftershipAPI::Model
         :'shipment_type' => :'String',
         :'shipment_weight' => :'ShipmentWeightRetrackTrackingByIdResponse',
         :'signed_by' => :'String',
-        :'smses' => :'Array<String>',
         :'source' => :'String',
-        :'tag' => :'TagV1',
+        :'tag' => :'Tag',
         :'subtag' => :'String',
         :'subtag_message' => :'String',
         :'title' => :'String',
@@ -734,11 +682,6 @@ module AftershipAPI::Model
         :'latest_estimated_delivery' => :'LatestEstimatedDeliveryRetrackTrackingByIdResponse',
         :'shipment_tags' => :'Array<String>',
         :'courier_connection_id' => :'String',
-        :'next_couriers' => :'Array<NextCouriersRetrackTrackingByIdResponse>',
-        :'tracking_origin_country' => :'String',
-        :'tracking_destination_country' => :'String',
-        :'tracking_postal_code' => :'String',
-        :'tracking_state' => :'String',
         :'carbon_emissions' => :'CarbonEmissionsRetrackTrackingByIdResponse',
         :'location_id' => :'String',
         :'shipping_method' => :'String',
@@ -747,6 +690,9 @@ module AftershipAPI::Model
         :'delivery_location_type' => :'String',
         :'aftership_tracking_url' => :'String',
         :'aftership_tracking_order_url' => :'String',
+        :'first_mile' => :'FirstMileRetrackTrackingByIdResponse',
+        :'last_mile' => :'LastMileRetrackTrackingByIdResponse',
+        :'customers' => :'Array<CustomersRetrackTrackingByIdResponse>',
       }
     end
 
@@ -757,25 +703,22 @@ module AftershipAPI::Model
         :'legacy_id' => :'legacy_id',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
-        :'last_updated_at' => :'last_updated_at',
         :'tracking_number' => :'tracking_number',
         :'slug' => :'slug',
         :'active' => :'active',
         :'custom_fields' => :'custom_fields',
-        :'customer_name' => :'customer_name',
         :'transit_time' => :'transit_time',
-        :'origin_country_iso3' => :'origin_country_iso3',
+        :'origin_country_region' => :'origin_country_region',
         :'origin_state' => :'origin_state',
         :'origin_city' => :'origin_city',
         :'origin_postal_code' => :'origin_postal_code',
         :'origin_raw_location' => :'origin_raw_location',
-        :'destination_country_iso3' => :'destination_country_iso3',
+        :'destination_country_region' => :'destination_country_region',
         :'destination_state' => :'destination_state',
         :'destination_city' => :'destination_city',
         :'destination_postal_code' => :'destination_postal_code',
         :'destination_raw_location' => :'destination_raw_location',
-        :'courier_destination_country_iso3' => :'courier_destination_country_iso3',
-        :'emails' => :'emails',
+        :'courier_destination_country_region' => :'courier_destination_country_region',
         :'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
         :'note' => :'note',
         :'order_id' => :'order_id',
@@ -787,7 +730,6 @@ module AftershipAPI::Model
         :'shipment_type' => :'shipment_type',
         :'shipment_weight' => :'shipment_weight',
         :'signed_by' => :'signed_by',
-        :'smses' => :'smses',
         :'source' => :'source',
         :'tag' => :'tag',
         :'subtag' => :'subtag',
@@ -821,11 +763,6 @@ module AftershipAPI::Model
         :'latest_estimated_delivery' => :'latest_estimated_delivery',
         :'shipment_tags' => :'shipment_tags',
         :'courier_connection_id' => :'courier_connection_id',
-        :'next_couriers' => :'next_couriers',
-        :'tracking_origin_country' => :'tracking_origin_country',
-        :'tracking_destination_country' => :'tracking_destination_country',
-        :'tracking_postal_code' => :'tracking_postal_code',
-        :'tracking_state' => :'tracking_state',
         :'carbon_emissions' => :'carbon_emissions',
         :'location_id' => :'location_id',
         :'shipping_method' => :'shipping_method',
@@ -834,6 +771,9 @@ module AftershipAPI::Model
         :'delivery_location_type' => :'delivery_location_type',
         :'aftership_tracking_url' => :'aftership_tracking_url',
         :'aftership_tracking_order_url' => :'aftership_tracking_order_url',
+        :'first_mile' => :'first_mile',
+        :'last_mile' => :'last_mile',
+        :'customers' => :'customers',
       }
     end
 

data/lib/aftership-tracking-sdk/models/{slug_group_v1.rb → slug_group.rb}

@@ -2,7 +2,7 @@
 # Do not edit the class manually.
 
 module AftershipAPI::Model
-  class SlugGroupV1
+  class SlugGroup
     AMAZON_GROUP = "amazon-group".freeze
     FEDEX_GROUP = "fedex-group".freeze
     TOLL_GROUP = "toll-group".freeze
@@ -30,8 +30,8 @@ module AftershipAPI::Model
     # @param value [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if SlugGroupV1.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #SlugGroupV1"
+      return value if SlugGroup.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SlugGroup"
     end
   end
 end

data/lib/aftership-tracking-sdk/models/{tag_v1.rb → tag.rb}

@@ -2,7 +2,7 @@
 # Do not edit the class manually.
 
 module AftershipAPI::Model
-  class TagV1
+  class Tag
     PENDING = "Pending".freeze
     INFORECEIVED = "InfoReceived".freeze
     INTRANSIT = "InTransit".freeze
@@ -27,8 +27,8 @@ module AftershipAPI::Model
     # @param value [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if TagV1.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TagV1"
+      return value if Tag.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Tag"
     end
   end
 end