aftership-tracking-sdk 9.0.0 → 11.0.0

data/lib/aftership-tracking-sdk/models/{courier_response_v1.rb → courier_response.rb}

@@ -1,21 +1,21 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class CourierResponseV1
+  class CourierResponse
 
     # Meta data
-    # meta: MetaV1;
+    # meta: Meta;
     attr_accessor :meta
 
     # 
-    # data: DataCourierResponseV1;
+    # data: DataCourierResponse;
     attr_accessor :data
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::CourierResponseV1` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::CourierResponse` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -34,8 +34,8 @@ module AftershipAPI::Model
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'MetaV1',
-        :'data' => :'DataCourierResponseV1',
+        :'meta' => :'Meta',
+        :'data' => :'DataCourierResponse',
       }
     end
 

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

@@ -3,6 +3,10 @@
 module AftershipAPI::Model
   class CreateTrackingRequest
 
+    # Tracking ID that is system-generated by default and can be customized by the user when creating a tracking.
+    # id?: String;
+    attr_accessor :id
+
     # Tracking number of a shipment.Duplicated tracking numbers, tracking numbers with invalid tracking number format will not be accepted.We only accept tracking numbers with length from 4 to 100We currently support the following characters in a tracking number:- A - Z- 0 - 9- `-` (Hyphen)- . (Period)- _ (Underscore)- / (Slash)
     # tracking_number: String;
     attr_accessor :tracking_number
@@ -19,14 +23,14 @@ module AftershipAPI::Model
     # order_id?: String;
     attr_accessor :order_id
 
-    # The URL for the order in your system or store.
-    # order_id_path?: String;
-    attr_accessor :order_id_path
-
     # Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any 
     # custom_fields?: Object;
     attr_accessor :custom_fields
 
+    # The URL for the order in your system or store.
+    # order_id_path?: String;
+    attr_accessor :order_id_path
+
     # The recipient’s language. If you set up AfterShip notifications in different languages, we use this to send the recipient tracking updates in their preferred language. Use an  to specify the language.
     # language?: String;
     attr_accessor :language
@@ -55,25 +59,13 @@ 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
 
-    # Email address(es) to receive email notifications. Accept either array. Supports up to 3 email addresses.
-    # emails?: String[];
-    attr_accessor :emails
-
-    # The phone number(s) to receive sms notifications.  Enter `+` andarea `code before` phone number. Accept either array. Supports up to 3 phone numbers.
-    # smses?: String[];
-    attr_accessor :smses
-
-    # Customer name of the tracking.
-    # customer_name?: String;
-    attr_accessor :customer_name
-
     # The  for more details.
-    # 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. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
     # origin_state?: String;
@@ -92,8 +84,8 @@ module AftershipAPI::Model
     attr_accessor :origin_raw_location
 
     # The  for more details.
-    # 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. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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.
     # destination_state?: String;
@@ -116,7 +108,7 @@ module AftershipAPI::Model
     attr_accessor :note
 
     # Slug group is a group of slugs which belong to same courier. For example, when you inpit "fedex-group" as slug_group, AfterShip will detect the tracking with "fedex-uk", "fedex-fims", and other slugs which belong to "fedex". It cannot be used with slug at the same time. (
-    # slug_group?: SlugGroupV1;
+    # slug_group?: SlugGroup;
     attr_accessor :slug_group
 
     # Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00
@@ -139,26 +131,6 @@ module AftershipAPI::Model
     # courier_connection_id?: String;
     attr_accessor :courier_connection_id
 
-    # If a shipment has multiple carriers, you can use the next_couriers field to tell AfterShip who the second carrier is. This is useful if the first carrier does not send us this information. 
-    # next_couriers?: NextCouriersCreateTrackingRequest[];
-    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 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 .
     # location_id?: String;
     attr_accessor :location_id
@@ -167,6 +139,14 @@ module AftershipAPI::Model
     # shipping_method?: String;
     attr_accessor :shipping_method
 
+    # 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?: LastMileCreateTrackingRequest;
+    attr_accessor :last_mile
+
+    # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
+    # customers?: CustomersCreateTrackingRequest[];
+    attr_accessor :customers
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -178,6 +158,10 @@ module AftershipAPI::Model
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end 
+
       if attributes.key?(:'tracking_number')
         self.tracking_number = attributes[:'tracking_number']
       end 
@@ -194,14 +178,14 @@ module AftershipAPI::Model
         self.order_id = attributes[:'order_id']
       end 
 
-      if attributes.key?(:'order_id_path')
-        self.order_id_path = attributes[:'order_id_path']
-      end 
-
       if attributes.key?(:'custom_fields')
         self.custom_fields = attributes[:'custom_fields']
       end 
 
+      if attributes.key?(:'order_id_path')
+        self.order_id_path = attributes[:'order_id_path']
+      end 
+
       if attributes.key?(:'language')
         self.language = attributes[:'language']
       end 
@@ -234,20 +218,8 @@ module AftershipAPI::Model
         self.tracking_ship_date = attributes[:'tracking_ship_date']
       end 
 
-      if attributes.key?(:'emails')
-        self.emails = attributes[:'emails']
-      end 
-
-      if attributes.key?(:'smses')
-        self.smses = attributes[:'smses']
-      end 
-
-      if attributes.key?(:'customer_name')
-        self.customer_name = attributes[:'customer_name']
-      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')
@@ -266,8 +238,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')
@@ -314,26 +286,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?(:'location_id')
         self.location_id = attributes[:'location_id']
       end 
@@ -341,17 +293,26 @@ module AftershipAPI::Model
       if attributes.key?(:'shipping_method')
         self.shipping_method = attributes[:'shipping_method']
       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.
     def self.openapi_types
       {
+        :'id' => :'String',
         :'tracking_number' => :'String',
         :'slug' => :'String',
         :'title' => :'String',
         :'order_id' => :'String',
-        :'order_id_path' => :'String',
         :'custom_fields' => :'Object',
+        :'order_id_path' => :'String',
         :'language' => :'String',
         :'order_promised_delivery_date' => :'String',
         :'delivery_type' => :'String',
@@ -360,45 +321,40 @@ module AftershipAPI::Model
         :'tracking_account_number' => :'String',
         :'tracking_key' => :'String',
         :'tracking_ship_date' => :'String',
-        :'emails' => :'Array<String>',
-        :'smses' => :'Array<String>',
-        :'customer_name' => :'String',
-        :'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',
         :'note' => :'String',
-        :'slug_group' => :'SlugGroupV1',
+        :'slug_group' => :'SlugGroup',
         :'order_date' => :'String',
         :'order_number' => :'String',
         :'shipment_type' => :'String',
         :'shipment_tags' => :'Array<String>',
         :'courier_connection_id' => :'String',
-        :'next_couriers' => :'Array<NextCouriersCreateTrackingRequest>',
-        :'tracking_origin_country' => :'String',
-        :'tracking_destination_country' => :'String',
-        :'tracking_postal_code' => :'String',
-        :'tracking_state' => :'String',
         :'location_id' => :'String',
         :'shipping_method' => :'String',
+        :'last_mile' => :'LastMileCreateTrackingRequest',
+        :'customers' => :'Array<CustomersCreateTrackingRequest>',
       }
     end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'tracking_number' => :'tracking_number',
         :'slug' => :'slug',
         :'title' => :'title',
         :'order_id' => :'order_id',
-        :'order_id_path' => :'order_id_path',
         :'custom_fields' => :'custom_fields',
+        :'order_id_path' => :'order_id_path',
         :'language' => :'language',
         :'order_promised_delivery_date' => :'order_promised_delivery_date',
         :'delivery_type' => :'delivery_type',
@@ -407,15 +363,12 @@ module AftershipAPI::Model
         :'tracking_account_number' => :'tracking_account_number',
         :'tracking_key' => :'tracking_key',
         :'tracking_ship_date' => :'tracking_ship_date',
-        :'emails' => :'emails',
-        :'smses' => :'smses',
-        :'customer_name' => :'customer_name',
-        :'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',
@@ -427,13 +380,10 @@ module AftershipAPI::Model
         :'shipment_type' => :'shipment_type',
         :'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',
         :'location_id' => :'location_id',
         :'shipping_method' => :'shipping_method',
+        :'last_mile' => :'last_mile',
+        :'customers' => :'customers',
       }
     end