aftership-tracking-sdk 14.0.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474413a4c8935bc40c471bf8a9f21d1c3d901c62734c7c6ac4917cd28e244497
-  data.tar.gz: a350b494cb8b2627ab671071992559d2667fc30971e338563d46060479034fd0
+  metadata.gz: dbba5a57b94fdd58712b2a33c84075631a22e1900c5f0201c00927dd99c3b5e1
+  data.tar.gz: 518931d07ea93e956e9608fc265d85e53b1828df913249ec0f23a0fdf51386b2
 SHA512:
-  metadata.gz: c9438daae22ec630ec1273a1f798a6cb5394c54d055ef46ddbde014e045f1f548b3230781e9b98459f98f1040c1cc9999118378fd91390931cf0c92a74d19850
-  data.tar.gz: 16ffa4134e3dcd4721165dead5f13e4134df5d6ab9fdd0557c127bb2a588d452691046c2b88f140cdf7463e40a7a1a5560e3251ffdfe508ba1a79277bc09a02d
+  metadata.gz: 5e8d3545a88eb3c4329d40b5dc32d0f6a7f803bc4efe83a8e61b25c6387e601a07e72158f16bdc67a70f33254ca333b888de85f5f8a59d2436cc30293a1d7f6e
+  data.tar.gz: 543b9f144163ecc63565bee5657d427fc7f43f65d5c4a540c3d5344c5b86d7bcb1651595cc9425df2dc1f96ad9cabb1e1ee664e2f10f520c9d5e8a0731ad3b6d

data/README.md

@@ -38,8 +38,8 @@ Before you begin to integrate:
 
 ### API and SDK Version
 
-- SDK Version: 14.0.0
-- API Version: 2026-01
+- SDK Version: 15.0.0
+- API Version: 2026-07
 ## Quick Start
 
 ### Installation
@@ -50,7 +50,7 @@ gem install aftership-tracking-sdk
 Or add a line to your Gemfile
 
 ```bash
-gem 'aftership-tracking-sdk', '~> 14.0.0'
+gem 'aftership-tracking-sdk', '~> 15.0.0'
 ```
 
 ## Constructor
@@ -89,6 +89,27 @@ end
 
 See the [Rate Limit](https://www.aftership.com/docs/tracking/quickstart/rate-limit) to understand the AfterShip rate limit policy.
 
+The API returns its current rate limit status in the headers of every response, and the SDK exposes these headers on both successful responses and rate-limited errors, so you can monitor your consumption proactively instead of waiting for `429` errors.
+
+| Header                  | Description                                                |
+| ----------------------- | ---------------------------------------------------------- |
+| `X-RateLimit-Limit`     | The rate limit ceiling for the current endpoint per second |
+| `X-RateLimit-Remaining` | The number of requests left for the 1-second window        |
+| `X-RateLimit-Reset`     | The Unix timestamp when the rate limit will be reset       |
+
+Every successful response exposes a `response_header` hash (case-insensitive lookup) alongside `data`. Taking the Quick Start example above:
+
+```ruby
+remaining = response.response_header['x-ratelimit-remaining'].to_i
+reset_at = response.response_header['x-ratelimit-reset'].to_i
+
+if remaining <= 1
+  # Throttle or defer lower-priority requests until reset_at
+end
+```
+
+When the rate limit is exceeded, the request fails with a `429` error that carries the same headers — see [Error Handling](#error-handling).
+
 ## Error Handling
 
 The SDK will return an error object when there is any error during the request, with the following specification:

data/lib/aftership-tracking-sdk/api/courier.rb

@@ -23,7 +23,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/couriers"
+      local_var_path = "/tracking/2026-07/couriers"
       method = :'GET'
 
       # query parameters
@@ -72,7 +72,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/couriers/detect"
+      local_var_path = "/tracking/2026-07/couriers/detect"
       method = :'POST'
 
       # query parameters

data/lib/aftership-tracking-sdk/api/courier_connection.rb

@@ -24,7 +24,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/courier-connections"
+      local_var_path = "/tracking/2026-07/courier-connections"
       method = :'GET'
 
       # query parameters
@@ -74,7 +74,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/courier-connections"
+      local_var_path = "/tracking/2026-07/courier-connections"
       method = :'POST'
 
       # query parameters
@@ -122,7 +122,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/courier-connections/#{id}"
+      local_var_path = "/tracking/2026-07/courier-connections/#{id}"
       method = :'GET'
 
       # query parameters
@@ -173,7 +173,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/courier-connections/#{id}"
+      local_var_path = "/tracking/2026-07/courier-connections/#{id}"
       method = :'PATCH'
 
       # query parameters
@@ -221,7 +221,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/courier-connections/#{id}"
+      local_var_path = "/tracking/2026-07/courier-connections/#{id}"
       method = :'DELETE'
 
       # query parameters

data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb

@@ -24,7 +24,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/estimated-delivery-date/predict"
+      local_var_path = "/tracking/2026-07/estimated-delivery-date/predict"
       method = :'POST'
 
       # query parameters
@@ -71,7 +71,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/estimated-delivery-date/predict-batch"
+      local_var_path = "/tracking/2026-07/estimated-delivery-date/predict-batch"
       method = :'POST'
 
       # query parameters

data/lib/aftership-tracking-sdk/api/tracking.rb

@@ -39,7 +39,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings"
+      local_var_path = "/tracking/2026-07/trackings"
       method = :'GET'
 
       # query parameters
@@ -104,7 +104,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings"
+      local_var_path = "/tracking/2026-07/trackings"
       method = :'POST'
 
       # query parameters
@@ -154,7 +154,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings/#{id}"
+      local_var_path = "/tracking/2026-07/trackings/#{id}"
       method = :'GET'
 
       # query parameters
@@ -207,7 +207,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings/#{id}"
+      local_var_path = "/tracking/2026-07/trackings/#{id}"
       method = :'PUT'
 
       # query parameters
@@ -255,7 +255,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings/#{id}"
+      local_var_path = "/tracking/2026-07/trackings/#{id}"
       method = :'DELETE'
 
       # query parameters
@@ -303,7 +303,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings/#{id}/retrack"
+      local_var_path = "/tracking/2026-07/trackings/#{id}/retrack"
       method = :'POST'
 
       # query parameters
@@ -354,7 +354,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2026-01/trackings/#{id}/mark-as-completed"
+      local_var_path = "/tracking/2026-07/trackings/#{id}/mark-as-completed"
       method = :'POST'
 
       # query parameters

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

@@ -70,6 +70,10 @@ module AftershipAPI::Model
     # source?: CheckpointSource;
     attr_accessor :source
 
+    # Unique hash identifier for each checkpoint event, could be used for deduplication.
+    # hash?: String;
+    attr_accessor :hash
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -148,6 +152,10 @@ module AftershipAPI::Model
       if attributes.key?(:'source')
         self.source = attributes[:'source']
       end
+
+      if attributes.key?(:'hash')
+        self.hash = attributes[:'hash']
+      end
     end
 
     # Attribute type mapping.
@@ -170,6 +178,7 @@ module AftershipAPI::Model
         :'raw_tag' => :'String',
         :'events' => :'Array<CheckpointEvents>',
         :'source' => :'CheckpointSource',
+        :'hash' => :'String',
       }
     end
 
@@ -193,6 +202,7 @@ module AftershipAPI::Model
         :'raw_tag' => :'raw_tag',
         :'events' => :'events',
         :'source' => :'source',
+        :'hash' => :'hash',
       }
     end
 

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

@@ -146,6 +146,10 @@ module AftershipAPI::Model
     # customers?: CreateTrackingRequestCustomers[];
     attr_accessor :customers
 
+    # Indicates the business direction of the shipment in the e-commerce fulfillment lifecycle.Possible values:- `forward`: A forward (outbound-to-customer) shipment created for order fulfillment.- `return`: A return (customer-to-merchant) shipment created for after-sales return or exchange.When provided, this field gives AfterShip additional context about the shipment's intent, enabling more accurate status identification.
+    # shipment_direction?: CreateTrackingRequestShipmentDirection;
+    attr_accessor :shipment_direction
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -300,6 +304,10 @@ module AftershipAPI::Model
       if attributes.key?(:'customers')
         self.customers = attributes[:'customers']
       end
+
+      if attributes.key?(:'shipment_direction')
+        self.shipment_direction = attributes[:'shipment_direction']
+      end
     end
 
     # Attribute type mapping.
@@ -341,6 +349,7 @@ module AftershipAPI::Model
         :'shipping_method' => :'String',
         :'last_mile' => :'CreateTrackingRequestLastMile',
         :'customers' => :'Array<CreateTrackingRequestCustomers>',
+        :'shipment_direction' => :'CreateTrackingRequestShipmentDirection',
       }
     end
 
@@ -383,6 +392,7 @@ module AftershipAPI::Model
         :'shipping_method' => :'shipping_method',
         :'last_mile' => :'last_mile',
         :'customers' => :'customers',
+        :'shipment_direction' => :'shipment_direction',
       }
     end
 

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

@@ -22,6 +22,10 @@ module AftershipAPI::Model
     # language?: String;
     attr_accessor :language
 
+    # The customer's identifier on the merchant or platform (for example, Shopify) side.
+    # id?: String;
+    attr_accessor :id
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -52,6 +56,10 @@ module AftershipAPI::Model
       if attributes.key?(:'language')
         self.language = attributes[:'language']
       end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
     end
 
     # Attribute type mapping.
@@ -62,6 +70,7 @@ module AftershipAPI::Model
         :'phone_number' => :'String',
         :'email' => :'String',
         :'language' => :'String',
+        :'id' => :'String',
       }
     end
 
@@ -73,6 +82,7 @@ module AftershipAPI::Model
         :'phone_number' => :'phone_number',
         :'email' => :'email',
         :'language' => :'language',
+        :'id' => :'id',
       }
     end
 

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

@@ -0,0 +1,26 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class CreateTrackingRequestShipmentDirection
+    FORWARD = "forward".freeze
+    RETURN = "return".freeze
+    def self.all_vars
+      @all_vars ||= [FORWARD, RETURN,].freeze
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @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 CreateTrackingRequestShipmentDirection.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CreateTrackingRequestShipmentDirection"
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module AftershipAPI::Model
     # country_region: String;
     attr_accessor :country_region
 
-    # State, province, or the equivalent location of the destination address where the package will be delivered.Either `destination_address.state` or `destination_address.postal_code` is required.
+    # State, province, or the equivalent location of the destination address where the package will be delivered.</br><span style=color:#ff6b2b;padding:2px>**Either `destination_address.state` or `destination_address.postal_code` is required.**</span>
     # state?: String;
     attr_accessor :state
 
@@ -14,7 +14,7 @@ module AftershipAPI::Model
     # city?: String;
     attr_accessor :city
 
-    # Postal code of the destination address.Either `destination_address.state` or `destination_address.postal_code` is required.
+    # Postal code of the destination address.</br><span style=color:#ff6b2b;padding:2px>**Either `destination_address.state` or `destination_address.postal_code` is required.**</span>
     # postal_code?: String;
     attr_accessor :postal_code
 

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

@@ -6,7 +6,7 @@ module AftershipAPI::Model
     # country_region: String;
     attr_accessor :country_region
 
-    # State, province, or the equivalent location of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without state. Either `origin_address.state` or `origin_address.postal_code` is required.
+    # State, province, or the equivalent location of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without state. </br><span style=color:#ff6b2b;padding:2px>**Either `origin_address.state` or `origin_address.postal_code` is required.**</span>
     # state?: String;
     attr_accessor :state
 
@@ -14,7 +14,7 @@ module AftershipAPI::Model
     # city?: String;
     attr_accessor :city
 
-    # Postal code of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without postal code. Either `origin_address.state` or `origin_address.postal_code` is required.
+    # Postal code of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without postal code. </br><span style=color:#ff6b2b;padding:2px>**Either `origin_address.state` or `origin_address.postal_code` is required.**</span>
     # postal_code?: String;
     attr_accessor :postal_code
 

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

@@ -122,6 +122,10 @@ module AftershipAPI::Model
     # shipment_weight?: TrackingShipmentWeight;
     attr_accessor :shipment_weight
 
+    # Physical dimensions of the package (length, width and height).
+    # shipment_dimensions?: TrackingShipmentDimensions;
+    attr_accessor :shipment_dimensions
+
     # Signed by information for delivered shipment.
     # signed_by?: String;
     attr_accessor :signed_by
@@ -298,6 +302,26 @@ module AftershipAPI::Model
     # customers?: TrackingCustomers[];
     attr_accessor :customers
 
+    # An array of proof of delivery (POD) records, such as a signature or photo captured upon successful delivery.This field returns a value only after the feature is enabled. Please contact your customer success manager if you'd like to know more.
+    # proof_of_delivery?: TrackingProofOfDelivery[];
+    attr_accessor :proof_of_delivery
+
+    # Multi-piece shipment refers to a scenario where a single shipment order is fulfilled by multiple physical packages. Each piece has its own carrier-assigned tracking number, but all pieces belong to the same shipment. This commonly occurs when an order is too large to fit in one box, or when items are packed separately for handling reasons.This field contains multi-piece shipment metadata describing a group of packages that belong to the same shipment.This field returns a value only when your subscription plan includes a multi-piece feature. To enable, go to .
+    # multi_piece_info?: TrackingMultiPieceInfo;
+    attr_accessor :multi_piece_info
+
+    # Indicates the business direction of the shipment in the e-commerce fulfillment lifecycle.Possible values:- `forward`: A forward (outbound-to-customer) shipment created for order fulfillment.- `return`: A return (customer-to-merchant) shipment created for after-sales return or exchange.This field is populated in either of the following cases:1. You explicitly provided it when creating the tracking.2. AfterShip automatically detected a linked forward or return shipment.It also determines which related shipment object (`forward_shipment` or `return_shipment`) may appear in the response.
+    # shipment_direction?: TrackingShipmentDirection;
+    attr_accessor :shipment_direction
+
+    # The associated return shipment linked to the current outbound shipment.This field is only present when `shipment_direction = "forward"` and AfterShip has detected a linked return shipment.
+    # return_shipment?: TrackingReturnShipment;
+    attr_accessor :return_shipment
+
+    # The original outbound shipment linked to this return. Use this to trace a return back to its source delivery.This field is only present when `shipment_direction = "return"` and AfterShip has detected a linked forward shipment.
+    # forward_shipment?: TrackingForwardShipment;
+    attr_accessor :forward_shipment
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -429,6 +453,10 @@ module AftershipAPI::Model
         self.shipment_weight = attributes[:'shipment_weight']
       end
 
+      if attributes.key?(:'shipment_dimensions')
+        self.shipment_dimensions = attributes[:'shipment_dimensions']
+      end
+
       if attributes.key?(:'signed_by')
         self.signed_by = attributes[:'signed_by']
       end
@@ -604,6 +632,26 @@ module AftershipAPI::Model
       if attributes.key?(:'customers')
         self.customers = attributes[:'customers']
       end
+
+      if attributes.key?(:'proof_of_delivery')
+        self.proof_of_delivery = attributes[:'proof_of_delivery']
+      end
+
+      if attributes.key?(:'multi_piece_info')
+        self.multi_piece_info = attributes[:'multi_piece_info']
+      end
+
+      if attributes.key?(:'shipment_direction')
+        self.shipment_direction = attributes[:'shipment_direction']
+      end
+
+      if attributes.key?(:'return_shipment')
+        self.return_shipment = attributes[:'return_shipment']
+      end
+
+      if attributes.key?(:'forward_shipment')
+        self.forward_shipment = attributes[:'forward_shipment']
+      end
     end
 
     # Attribute type mapping.
@@ -639,6 +687,7 @@ module AftershipAPI::Model
         :'shipment_delivery_date' => :'String',
         :'shipment_type' => :'String',
         :'shipment_weight' => :'TrackingShipmentWeight',
+        :'shipment_dimensions' => :'TrackingShipmentDimensions',
         :'signed_by' => :'String',
         :'source' => :'String',
         :'tag' => :'Tag',
@@ -683,6 +732,11 @@ module AftershipAPI::Model
         :'first_mile' => :'TrackingFirstMile',
         :'last_mile' => :'TrackingLastMile',
         :'customers' => :'Array<TrackingCustomers>',
+        :'proof_of_delivery' => :'Array<TrackingProofOfDelivery>',
+        :'multi_piece_info' => :'TrackingMultiPieceInfo',
+        :'shipment_direction' => :'TrackingShipmentDirection',
+        :'return_shipment' => :'TrackingReturnShipment',
+        :'forward_shipment' => :'TrackingForwardShipment',
       }
     end
 
@@ -719,6 +773,7 @@ module AftershipAPI::Model
         :'shipment_delivery_date' => :'shipment_delivery_date',
         :'shipment_type' => :'shipment_type',
         :'shipment_weight' => :'shipment_weight',
+        :'shipment_dimensions' => :'shipment_dimensions',
         :'signed_by' => :'signed_by',
         :'source' => :'source',
         :'tag' => :'tag',
@@ -763,6 +818,11 @@ module AftershipAPI::Model
         :'first_mile' => :'first_mile',
         :'last_mile' => :'last_mile',
         :'customers' => :'customers',
+        :'proof_of_delivery' => :'proof_of_delivery',
+        :'multi_piece_info' => :'multi_piece_info',
+        :'shipment_direction' => :'shipment_direction',
+        :'return_shipment' => :'return_shipment',
+        :'forward_shipment' => :'forward_shipment',
       }
     end
 

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

@@ -22,6 +22,10 @@ module AftershipAPI::Model
     # language?: String;
     attr_accessor :language
 
+    # The customer's identifier on the merchant or platform (for example, Shopify) side.
+    # id?: String;
+    attr_accessor :id
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -52,6 +56,10 @@ module AftershipAPI::Model
       if attributes.key?(:'language')
         self.language = attributes[:'language']
       end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
     end
 
     # Attribute type mapping.
@@ -62,6 +70,7 @@ module AftershipAPI::Model
         :'phone_number' => :'String',
         :'email' => :'String',
         :'language' => :'String',
+        :'id' => :'String',
       }
     end
 
@@ -73,6 +82,7 @@ module AftershipAPI::Model
         :'phone_number' => :'phone_number',
         :'email' => :'email',
         :'language' => :'language',
+        :'id' => :'id',
       }
     end