aftership-tracking-sdk 8.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e157cddb03c0ec7d240d811e1d497fd9b82234c39e0e4487b85963aa73e4add6
-  data.tar.gz: de2907f996886f3336adb4dd6b098c74e5bde8e754e12dcb21e21c637cebb26c
+  metadata.gz: bcaae1dbe0f4f17afeb9938bf331240e48bb821ae0833e15887faa690367d8c1
+  data.tar.gz: e1740ed9eb9f88d2786a0f3dbe2620369176bca385c4b2ca707dc83bfc99bbb6
 SHA512:
-  metadata.gz: c1b8d8cd3350aea149af0be548ebfa7da638761ab46670d5fa8e10d1ec2cec147346633d2d194c5b47712c91ede8e09c6335c3c15eae6dfbb75c367d5492abcd
-  data.tar.gz: f679adaf771518221db5100c56cb5a36da3c229de5f6b2568fb51be7bec82623217df014ae4435731470d1276da7f3261985e84fe8e7c0ef91a6075b3e7e79f4
+  metadata.gz: 58f2e8c868cf552bcdb5d8ca549d8225ae84edc643e343a37b18ae3f184a20f01eb5cf752fc9f9516445c8f75c472c3d5bf5a4b358515bbe5337dc6828f3f064
+  data.tar.gz: 6156e693a96f7d9ef3413003df2601b45a77ae17d44cae796a4ffa9179f03b2c68a0e8c515d8fac92356ffd849487ab49790c86332906ac049e9df47b2dee519

data/Gemfile

@@ -9,3 +9,4 @@ group :development, :test do
   gem 'dotenv'
   gem "webmock", "~> 3.23"
 end
+

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 AfterShip
+Copyright (c) 2025 AfterShip
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -42,6 +42,8 @@ Each SDK version is designed to work with a specific API version. Please refer t
 
 | SDK Version | Supported API Version | Branch                                                      |
 | ----------- | --------------------- | ----------------------------------------------------------- |
+| 10.x.x       | 2025-01               | https://github.com/AfterShip/tracking-sdk-ruby/tree/2025-01 |
+| 9.x.x       | 2024-10               | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-10 |
 | 8.x.x       | 2024-07               | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-07 |
 | 7.x.x       | 2024-04               | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-04 |
 | <=6.x.x     | Legacy API            | https://github.com/AfterShip/aftership-sdk-ruby             |
@@ -56,7 +58,7 @@ gem install aftership-tracking-sdk
 Or add a line to your Gemfile
 
 ```bash
-gem 'aftership-tracking-sdk', '~> 8.0.0'
+gem 'aftership-tracking-sdk', '~> 10.0.0'
 ```
 
 ## Constructor
@@ -93,20 +95,20 @@ end
 
 ## Rate Limiter
 
-See the [Rate Limit](https://www.aftership.com/docs/tracking/2024-07/quickstart/rate-limit) to understand the AfterShip rate limit policy.
+See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-01/quickstart/rate-limit) to understand the AfterShip rate limit policy.
 
 ## Error Handling
 
 The SDK will return an error object when there is any error during the request, with the following specification:
 
-| Name          | Type   | Description                    |
-| ------------- | ------ | ------------------------------ |
-| message       | string | Detail message of the error    |
-| code          | enum   | Error code enum for API Error. |
-| meta_code     | number | API response meta code.        |
-| status_code   | number | HTTP status code.              |
-| response_body | string | API response body.             |
-
+| Name            | Type   | Description                    |
+| --------------- | ------ | ------------------------------ |
+| message         | string | Detail message of the error    |
+| code            | enum   | Error code enum for API Error. |
+| meta_code       | number | API response meta code.        |
+| status_code     | number | HTTP status code.              |
+| response_body   | string | API response body.             |
+| response_headers | object | API response header.           |
 
 ### Error List
 
@@ -225,7 +227,7 @@ p resp.to_json
 **POST** /couriers/detect
 
 ```ruby
-req = AftershipAPI::Model::TrackingDetectCourierRequest.new
+req = AftershipAPI::Model::DetectCourierRequest.new
 req.tracking_number = "<tracking_number>"
 resp = AftershipAPI::Courier.detect_courier(body: req)
 p resp.to_json
@@ -240,11 +242,11 @@ edd = AftershipAPI::Model::EstimatedDeliveryDateRequest.new
 edd.slug = "<slug>"
 edd.pickup_time = "2024-08-01 06:42:30"
 origin = AftershipAPI::Model::OriginAddressEstimatedDeliveryDateRequest.new
-origin.country = "<ISO 3166-1 country/region code>"
+origin.country_region = "<ISO 3166-1 country/region code>"
 origin.state = "<ISO 3166-1 country/region code>"
 
 dest = AftershipAPI::Model::DestinationAddressEstimatedDeliveryDateRequest.new
-dest.country = "<ISO 3166-1 country/region code>"
+dest.country_region = "<ISO 3166-1 country/region code>"
 dest.state = "<ISO 3166-1 country/region code>"
 
 edd.origin_address = origin
@@ -264,6 +266,6 @@ If you get stuck, we're here to help:
 - Contact AfterShip official support via support@aftership.com
 
 ## License
-Copyright (c) 2024 AfterShip
+Copyright (c) 2025 AfterShip
 
 Licensed under the MIT license.

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

@@ -16,9 +16,9 @@ module AftershipAPI
     # @param body [Model::DetectCourierRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Model::DetectCourierResponse] 
-    def detect_courier(body:, opts: {})
+    def detect_courier(body:,opts: {})
       if "" != ""
-        body = { :'' => body }
+        body = {:'' => body}
       end
       opts[:body] = body
       data, _status_code, _headers = detect_courier_with_http_info(opts: opts)
@@ -33,7 +33,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-07/couriers/detect" 
+      local_var_path = "/tracking/2025-01/couriers/detect" 
       method = :'POST'
 
       # query parameters
@@ -81,7 +81,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-07/couriers/all" 
+      local_var_path = "/tracking/2025-01/couriers/all" 
       method = :'GET'
 
       # query parameters
@@ -129,7 +129,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-07/couriers" 
+      local_var_path = "/tracking/2025-01/couriers" 
       method = :'GET'
 
       # query parameters
@@ -160,4 +160,4 @@ module AftershipAPI
       return data, status_code, headers
     end 
   end
-end
+end

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

@@ -10,15 +10,69 @@ module AftershipAPI
       @api_client = api_client
     end
 
+    # predict
+    # > The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.You can use  to activate this feature.
+
+    # @param body [Model::PredictRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Model::PredictResponse] 
+    def predict(body:,opts: {})
+      if "" != ""
+        body = {:'' => body}
+      end
+      opts[:body] = body
+      data, _status_code, _headers = predict_with_http_info(opts: opts)
+      data
+    end
+
+    def predict_with_http_info(opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatedDeliveryDateApi.predict ...'
+      end
+
+
+
+      # resource path
+      local_var_path = "/tracking/2025-01/estimated-delivery-date/predict" 
+      method = :'POST'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = 'PredictResponse'
+      
+      new_options = opts.merge(
+        :operation => :"EstimatedDeliveryDateApi.predict",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => return_type,
+        :response_legacy_tag => "",
+        :is_paging => false
+      )
+
+      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EstimatedDeliveryDateApi#predict\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+
     # predict_batch
     # > The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.You can use  to activate this feature.Supported functionalities require:1. One `EstimatedDeliveryDate` object for one prediction result.2. Maximum 5 `EstimatedDeliveryDate` objects are allowed.3. API call will fail if any of the requests `EstimatedDeliveryDate` objects do not meet the specification requirement.
 
     # @param body [Model::PredictBatchRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Model::PredictBatchResponse] 
-    def predict_batch(body:, opts: {})
+    def predict_batch(body:,opts: {})
       if "" != ""
-        body = { :'' => body }
+        body = {:'' => body}
       end
       opts[:body] = body
       data, _status_code, _headers = predict_batch_with_http_info(opts: opts)
@@ -33,7 +87,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-07/estimated-delivery-date/predict-batch" 
+      local_var_path = "/tracking/2025-01/estimated-delivery-date/predict-batch" 
       method = :'POST'
 
       # query parameters
@@ -64,4 +118,4 @@ module AftershipAPI
       return data, status_code, headers
     end 
   end
-end
+end