aftership-tracking-sdk 9.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d9d12ffc6b5d7c5d11af738b1f88ebd102376ebe94f368eb517f8cee2fe7a9a
-  data.tar.gz: 530e87b908b936d8f9279cdf39e4c56583b651afe0a05121297ed05a10d785e7
+  metadata.gz: c11231862a642bdf39c9bce127c906651e22fbed9b6834bf2e2add0c71a407be
+  data.tar.gz: 61372547049616b2d9b77b4f5f0580e25ef9adca5ad86d5348fd504b568177bc
 SHA512:
-  metadata.gz: 3d0feb6a923e8ce8a90c8f45e1ed8fb4b24fa36986f5cbebfb43b4dff2e0cb3c0f24ebde2503b31824ac1b0986f1d86b407c672eb2f8efbf1c2a9466d61256cc
-  data.tar.gz: 716dab6a4e838afc02c865b53c6bcc7d6306633166abf6788c5edaf21cb90ec38835e0ae67632bc193140b7d97c69d8769501757afb8f691c92bd36d82edfc90
+  metadata.gz: ad2f7e3e4d85a563c9a3560243a19e72cfce5e88ba15edd684029221feddb815a95ae55b029fd82d004c0ff2f49ed3cd4456d9c57140d1c654d24a9e9d11997f
+  data.tar.gz: a991670c1be7810678d13b3c31a80d7b64ff1f9bfb769aaf14c4d3ed43415bf7c77a7f2953e5e9e3817572defa6cbcc2ca6f0df7ccac5992dc11546a95c13253

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

@@ -22,6 +22,7 @@ If you need support using AfterShip products, please contact support@aftership.c
   - [Endpoints](#endpoints)
     - [/trackings](#trackings)
     - [/couriers](#couriers)
+    - [/courier-connections](#courier-connections)
     - [/estimated-delivery-date](#estimated-delivery-date)
   - [Help](#help)
   - [License](#license)
@@ -42,6 +43,8 @@ Each SDK version is designed to work with a specific API version. Please refer t
 
 | SDK Version | Supported API Version | Branch                                                      |
 | ----------- | --------------------- | ----------------------------------------------------------- |
+| 11.x.x       | 2025-04               | https://github.com/AfterShip/tracking-sdk-ruby/tree/2025-04 |
+| 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 |
@@ -57,7 +60,7 @@ gem install aftership-tracking-sdk
 Or add a line to your Gemfile
 
 ```bash
-gem 'aftership-tracking-sdk', '~> 9.0.0'
+gem 'aftership-tracking-sdk', '~> 11.0.0'
 ```
 
 ## Constructor
@@ -94,20 +97,20 @@ end
 
 ## Rate Limiter
 
-See the [Rate Limit](https://www.aftership.com/docs/tracking/2024-10/quickstart/rate-limit) to understand the AfterShip rate limit policy.
+See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-04/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
 
@@ -142,6 +145,7 @@ The AfterShip instance has the following properties which are exactly the same a
 
 - courier - Get a list of our supported couriers.
 - tracking - Create trackings, update trackings, and get tracking results.
+- courier-connection - Create courier connections, update courier connections, and get courier connections results.
 - estimated-delivery-date - Get estimated delivery date for your order.
 
 
@@ -212,14 +216,7 @@ p resp.to_json
 **GET** /couriers
 
 ```ruby
-resp = AftershipAPI::Courier.get_user_couriers()
-p resp.to_json
-```
-
-**GET** /couriers/all
-
-```ruby
-resp = AftershipAPI::Courier.get_all_couriers()
+resp = AftershipAPI::Courier.get_couriers()
 p resp.to_json
 ```
 
@@ -265,6 +262,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

@@ -33,7 +33,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-10/couriers/detect" 
+      local_var_path = "/tracking/2025-04/couriers/detect" 
       method = :'POST'
 
       # query parameters
@@ -64,28 +64,32 @@ module AftershipAPI
       return data, status_code, headers
     end 
 
-    # get_all_couriers
-    # Return a list of all couriers.
+    # get_couriers
+    # Return a list of couriers.
     # @param [Hash] opts the optional parameters
-    # @return [Model::GetAllCouriersResponse] 
-    def get_all_couriers(opts: {})
-      data, _status_code, _headers = get_all_couriers_with_http_info(opts: opts)
+    # @option opts [Boolean] :active get user activated couriers
+    # @option opts [String] :slug Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)
+    # @return [Model::GetCouriersResponse] 
+    def get_couriers(opts: {})
+      data, _status_code, _headers = get_couriers_with_http_info(opts: opts)
       data
     end
 
-    def get_all_couriers_with_http_info(opts: {})
+    def get_couriers_with_http_info(opts: {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CourierApi.get_all_couriers ...'
+        @api_client.config.logger.debug 'Calling API: CourierApi.get_couriers ...'
       end
 
 
 
       # resource path
-      local_var_path = "/tracking/2024-10/couriers/all" 
+      local_var_path = "/tracking/2025-04/couriers" 
       method = :'GET'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
+      query_params[:'slug'] = opts[:'slug'] if !opts[:'slug'].nil?
       # header parameters
       header_params = opts[:header_params] || {}
 
@@ -93,10 +97,10 @@ module AftershipAPI
       post_body = opts[:body]
 
       # return_type
-      return_type = 'GetAllCouriersResponse'
+      return_type = 'GetCouriersResponse'
       
       new_options = opts.merge(
-        :operation => :"CourierApi.get_all_couriers",
+        :operation => :"CourierApi.get_couriers",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -107,55 +111,7 @@ module AftershipAPI
 
       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: CourierApi#get_all_couriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # get_user_couriers
-    # Return a list of .
-    # @param [Hash] opts the optional parameters
-    # @return [Model::GetUserCouriersResponse] 
-    def get_user_couriers(opts: {})
-      data, _status_code, _headers = get_user_couriers_with_http_info(opts: opts)
-      data
-    end
-
-    def get_user_couriers_with_http_info(opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CourierApi.get_user_couriers ...'
-      end
-
-
-
-      # resource path
-      local_var_path = "/tracking/2024-10/couriers" 
-      method = :'GET'
-
-      # 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 = 'GetUserCouriersResponse'
-      
-      new_options = opts.merge(
-        :operation => :"CourierApi.get_user_couriers",
-        :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: CourierApi#get_user_couriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: CourierApi#get_couriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end 

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

@@ -0,0 +1,283 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+require 'cgi'
+
+module AftershipAPI
+  class CourierConnectionApi 
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # delete_courier_connections_by_id
+    # Delete a courier connection.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Model::DeleteCourierConnectionsByIdResponse] 
+    def delete_courier_connections_by_id(id:, opts: {})
+      data, _status_code, _headers = delete_courier_connections_by_id_with_http_info(id:id, opts: opts)
+      data
+    end
+
+    def delete_courier_connections_by_id_with_http_info(id:, opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CourierConnectionApi.delete_courier_connections_by_id ...'
+      end
+
+      if id.nil? or id.to_s == ''
+        raise InvalidParamError.new "id cannot be nil or empty"
+      end
+
+
+      # resource path
+      local_var_path = "/tracking/2025-04/courier-connections/#{id}" 
+      method = :'DELETE'
+
+      # 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 = 'DeleteCourierConnectionsByIdResponse'
+      
+      new_options = opts.merge(
+        :operation => :"CourierConnectionApi.delete_courier_connections_by_id",
+        :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: CourierConnectionApi#delete_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+
+    # get_courier_connections
+    # Get courier connection results of multiple courier connections.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :courier_slug Unique courier code.(Example: dhl-api)
+    # @option opts [String] :cursor A string representing the cursor value for the current page of results.
+    # @option opts [String] :limit Number of courier connections each page contain. (Default: 100, Max: 200)
+    # @return [Model::GetCourierConnectionsResponse] 
+    def get_courier_connections(opts: {})
+      data, _status_code, _headers = get_courier_connections_with_http_info(opts: opts)
+      data
+    end
+
+    def get_courier_connections_with_http_info(opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections ...'
+      end
+
+
+
+      # resource path
+      local_var_path = "/tracking/2025-04/courier-connections" 
+      method = :'GET'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'courier_slug'] = opts[:'courier_slug'] if !opts[:'courier_slug'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = 'GetCourierConnectionsResponse'
+      
+      new_options = opts.merge(
+        :operation => :"CourierConnectionApi.get_courier_connections",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => return_type,
+        :response_legacy_tag => "courier_connections",
+        :is_paging => true
+      )
+
+      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: CourierConnectionApi#get_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+
+    # get_courier_connections_by_id
+    # Get courier connection results of a single courier connection.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Model::GetCourierConnectionsByIdResponse] 
+    def get_courier_connections_by_id(id:, opts: {})
+      data, _status_code, _headers = get_courier_connections_by_id_with_http_info(id:id, opts: opts)
+      data
+    end
+
+    def get_courier_connections_by_id_with_http_info(id:, opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections_by_id ...'
+      end
+
+      if id.nil? or id.to_s == ''
+        raise InvalidParamError.new "id cannot be nil or empty"
+      end
+
+
+      # resource path
+      local_var_path = "/tracking/2025-04/courier-connections/#{id}" 
+      method = :'GET'
+
+      # 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 = 'GetCourierConnectionsByIdResponse'
+      
+      new_options = opts.merge(
+        :operation => :"CourierConnectionApi.get_courier_connections_by_id",
+        :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: CourierConnectionApi#get_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+
+    # post_courier_connections
+    # 
+
+    # @param body [Model::PostCourierConnectionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Model::PostCourierConnectionsResponse] 
+    def post_courier_connections(body:,opts: {})
+      if "" != ""
+        body = {:'' => body}
+      end
+      opts[:body] = body
+      data, _status_code, _headers = post_courier_connections_with_http_info(opts: opts)
+      data
+    end
+
+    def post_courier_connections_with_http_info(opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CourierConnectionApi.post_courier_connections ...'
+      end
+
+
+
+      # resource path
+      local_var_path = "/tracking/2025-04/courier-connections" 
+      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 = 'PostCourierConnectionsResponse'
+      
+      new_options = opts.merge(
+        :operation => :"CourierConnectionApi.post_courier_connections",
+        :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: CourierConnectionApi#post_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+
+    # put_courier_connections_by_id
+    # Update a courier connection.
+    # @param id [String] 
+
+    # @param body [Model::PutCourierConnectionsByIdRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Model::PutCourierConnectionsByIdResponse] 
+    def put_courier_connections_by_id(id:, body:,opts: {})
+      if "" != ""
+        body = {:'' => body}
+      end
+      opts[:body] = body
+      data, _status_code, _headers = put_courier_connections_by_id_with_http_info(id:id, opts: opts)
+      data
+    end
+
+    def put_courier_connections_by_id_with_http_info(id:, opts: {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CourierConnectionApi.put_courier_connections_by_id ...'
+      end
+
+      if id.nil? or id.to_s == ''
+        raise InvalidParamError.new "id cannot be nil or empty"
+      end
+
+
+      # resource path
+      local_var_path = "/tracking/2025-04/courier-connections/#{id}" 
+      method = :'PATCH'
+
+      # 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 = 'PutCourierConnectionsByIdResponse'
+      
+      new_options = opts.merge(
+        :operation => :"CourierConnectionApi.put_courier_connections_by_id",
+        :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: CourierConnectionApi#put_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end 
+  end
+end

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

@@ -10,6 +10,60 @@ 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-04/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.
 
@@ -33,7 +87,7 @@ module AftershipAPI
 
 
       # resource path
-      local_var_path = "/tracking/2024-10/estimated-delivery-date/predict-batch" 
+      local_var_path = "/tracking/2025-04/estimated-delivery-date/predict-batch" 
       method = :'POST'
 
       # query parameters