aftership - npm Package Compare versions

Comparing version 7.0.4 to 7.0.5

CHANGELOG.md

@@ -1,31 +0,66 @@
-## Release History
+# Changelog
+All notable changes to this project will be documented in this file.
 
-## Change log
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-### 7.0.1 (2021-07-30)
+## [7.0.5] 2022-07-20
+### Added
+- add API endpoint `predict-batch` 
+- update tracking fields 
+
+## [7.0.4] 2022-05-11
+### Added
+- update tracking fields
+### Fixed
+- fix #80
+
+## [7.0.3] 2022-02-11
+### Fixed
+- #74 fix the tracking interface
+
+## [7.0.2] 2021-10-26
+### Fixed
+- #69 Fixed Axios sending empty body issue
+
+## [7.0.1] 2021-07-30
+### Fixed
 - fix list trackings interface
 
-### 7.0.0 (2021-02-09)
-- Breaking changes
-	- DeliveryStatus Enum change to string instead of integer
+## [7.0.0] 2021-02-09
+### Breaking Changes
+- DeliveryStatus Enum change to string instead of integer
 
-### 6.1.0 (2020-07-29)
+## [6.1.0] 2020-07-29
+### Added
 - Added support for markAsCompleted() of tracking resource
 - Updated package dependencies
 
-### 6.0.0 (2020-04-24)
-- New features
-	- Support latest features in v4 API
-	- Support TypeScript
-	- Support IntelliSense, bring more convenient to consumers
-  - The SDK is now isomorphic
-- Compatibility
-	- Node >=10.0
-- Breaking changes
-	- Don't support `callback` anymore, please use `Promise` instead.
-	- Removed `auto retry` feature, consumers need to retry the request by themselves.
-	- Removed `call` method
-  - Remove `meta` in SDK `response` object.
+## [6.0.0] 2020-04-24
+### Added
+- Support latest features in v4 API
+- Support TypeScript
+- Support IntelliSense, bring more convenient to consumers
+- The SDK is now isomorphic
 
-### 5.0.0 (2016-01-13)
-* Update to 5.0.0, use Context-less interface, go to README.md for more
+Compatibility
+- Node >=10.0
+
+### Breaking Changes
+- Don't support `callback` anymore, please use `Promise` instead.
+- Removed `auto retry` feature, consumers need to retry the request by themselves.
+- Removed `call` method
+- Remove `meta` in SDK `response` object.
+
+## [5.0.0] 2016-01-13
+- Update to 5.0.0, use Context-less interface, go to README.md for more
+
+[7.0.5]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/7.0.4...7.0.5
+[7.0.4]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/7.0.3...7.0.4
+[7.0.3]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/7.0.2...7.0.3
+[7.0.2]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/7.0.1...7.0.2
+[7.0.1]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/7.0.0...7.0.1
+[7.0.0]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/6.1.0...7.0.0
+[6.1.0]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/6.0.0...6.1.0
+[6.0.0]: https://github.com/AfterShip/aftership-sdk-nodejs/compare/5.0.0...6.0.0
+[5.0.0]: https://github.com/AfterShip/aftership-sdk-nodejs/releases/tag/5.0.0

dist/index.d.ts

@@ -7,2 +7,3 @@ import { AftershipOption } from './model/aftership_option';
 import { TrackingEndpoint } from './endpoint/tracking_endpoint';
+import { EstimatedDeliveryDateEndpoint } from './endpoint/estimated_delivery_date_endpoint';
 export declare class AfterShip {
@@ -32,2 +33,6 @@ readonly apiKey: string;
     readonly tracking: TrackingEndpoint;
+    /**
+     * EstimatedDeliveryDate endpoint
+     */
+    readonly estimated_delivery_date: EstimatedDeliveryDateEndpoint;
     constructor(apiKey: string, options?: AftershipOption);
@@ -34,0 +39,0 @@ /**

dist/index.js

@@ -12,2 +12,3 @@ "use strict";
 var tracking_1 = require("./implementation/tracking");
+var estimated_delivery_date_1 = require("./implementation/estimated_delivery_date");
 var DEFAULT_ENDPOINT = 'https://api.aftership.com/v4';
@@ -43,2 +44,3 @@ var DEFAULT_USER_AGENT = 'aftership-sdk-nodejs';
         this.tracking = new tracking_1.TrackingImplementation(request);
+        this.estimated_delivery_date = new estimated_delivery_date_1.EstimatedDeliveryDateImplementation(request);
     }
@@ -45,0 +47,0 @@ /**

dist/model/courier/courier_detect_list.d.ts

 import { Courier } from './courier';
-import { Tracking } from '../tracking/tracking';
 /**
@@ -12,6 +11,2 @@ * The response of couriers detect request
     /**
-     * Hash describes the tracking information.
-     */
-    tracking: Tracking;
-    /**
      * A list of matched couriers based on tracking number format.
@@ -18,0 +13,0 @@ */

dist/model/tracking/tracking_create_params.d.ts

@@ -33,10 +33,38 @@ import { DeliveryType } from './delivery_type';
     /**
-     * The postal code of receiver's address. Required by some couriers, such asdeutsch-post
+     * Title of the tracking. Default value astracking_number
      */
-    tracking_postal_code?: string;
+    title?: string;
     /**
-     * Shipping date inYYYYMMDDformat. Required by some couriers, such asdeutsch-post
+     * Text field for order ID
      */
-    tracking_ship_date?: string;
+    order_id?: string;
     /**
+     * Text field for order path
+     */
+    order_id_path?: string;
+    /**
+     * Custom fields that accept a hash with string, boolean or number fields
+     */
+    custom_fields?: Object;
+    /**
+     * Enter ISO 639-1 Language Code to specify the store, customer or order language.
+     */
+    language?: string;
+    /**
+     * Promised delivery date of an order inYYYY-MM-DDformat.
+     */
+    order_promised_delivery_date?: string;
+    /**
+     * Shipment delivery type
+     */
+    delivery_type?: DeliveryType;
+    /**
+     * Shipment pickup location for receiver
+     */
+    pickup_location?: string;
+    /**
+     * Shipment pickup note for receiver
+     */
+    pickup_note?: string;
+    /**
      * Account number of the shipper for a specific courier. Required by some couriers, such asdynamic-logistics
@@ -46,6 +74,2 @@ */
     /**
-     * Key of the shipment for a specific courier. Required by some couriers, such assic-teliway
-     */
-    tracking_key?: string;
-    /**
      * Origin Country of the shipment for a specific courier. Required by some couriers, such asdhl
@@ -59,2 +83,14 @@ */
     /**
+     * Key of the shipment for a specific courier. Required by some couriers, such assic-teliway
+     */
+    tracking_key?: string;
+    /**
+     * The postal code of receiver's address. Required by some couriers, such asdeutsch-post
+     */
+    tracking_postal_code?: string;
+    /**
+     * Shipping date inYYYYMMDDformat. Required by some couriers, such asdeutsch-post
+     */
+    tracking_ship_date?: string;
+    /**
      * Located state of the shipment for a specific courier. Required by some couriers, such asstar-track-courier
@@ -64,11 +100,11 @@ */
     /**
-     * Google cloud message registration IDs to receive the push notifications.
+     * Apple iOS device IDs to receive the push notifications.
      * Accept either array or comma separated as input.
      */
-    android?: string | [string];
+    ios?: string | [string];
     /**
-     * Apple iOS device IDs to receive the push notifications.
+     * Google cloud message registration IDs to receive the push notifications.
      * Accept either array or comma separated as input.
      */
-    ios?: string | [string];
+    android?: string | [string];
     /**
@@ -86,6 +122,2 @@ * Email address(es) to receive email notifications.
     /**
-     * Title of the tracking. Default value astracking_number
-     */
-    title?: string;
-    /**
      * Customer name of the tracking.
@@ -105,14 +137,14 @@ */
     /**
-     * Text field for order ID
+     * Text field for the note
      */
-    order_id?: string;
+    note?: string;
     /**
-     * Text field for order path
+     * 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.
      */
-    order_id_path?: string;
+    slug_group?: string;
     /**
-     * Text field for order number
-     */
-    order_number?: string;
-    /**
      * Date and time of the order created
@@ -122,30 +154,10 @@ */
     /**
-     * Custom fields that accept a hash with string, boolean or number fields
+     * Text field for order number
      */
-    custom_fields?: Object;
+    order_number?: string;
     /**
-     * Text field for the note
+     * The carrier’s shipment type. When you input this field, AfterShip will not get updates from the carrier.
      */
-    note?: string;
-    /**
-     * Enter ISO 639-1 Language Code to specify the store, customer or order language.
-     */
-    language?: string;
-    /**
-     * Promised delivery date of an order inYYYY-MM-DDformat.
-     */
-    order_promised_delivery_date?: string;
-    /**
-     * Shipment delivery type
-     */
-    delivery_type?: DeliveryType;
-    /**
-     * Shipment pickup location for receiver
-     */
-    pickup_location?: string;
-    /**
-     * Shipment pickup note for receiver
-     */
-    pickup_note?: string;
+    shipment_type?: string;
 }
 //# sourceMappingURL=tracking_create_params.d.ts.map

dist/model/tracking/tracking_update_params.d.ts

@@ -72,4 +72,8 @@ import { DeliveryType } from './delivery_type';
     pickup_note?: string;
+    /**
+     * The carrier’s shipment type. When you input this field, AfterShip will not get updates from the carrier.
+     */
+    shipment_type?: string;
 }
 export {};
 //# sourceMappingURL=tracking_update_params.d.ts.map

dist/model/tracking/tracking.d.ts

@@ -5,2 +5,3 @@ import { Checkpoint } from '../checkpoint/checkpoint';
 import { DeliveryType } from './delivery_type';
+import { LatestEstimatedDelivery } from './latest_estimated_delivery';
 /**
@@ -282,4 +283,13 @@ * Tracking Object
         order_number?: string;
+        /**
+         * The latest estimated delivery date.
+         * May come from the carrier, AfterShip AI, or based on your custom settings.
+         * This can appear in 1 of 3 formats based on the data received.
+         *  1. Date only: `YYYY-MM-DD`
+         *  2. Date and time: `YYYY-MM-DDTHH:mm:ss`
+         *  3. Date, time, and time zone: `YYYY-MM-DDTHH:mm:ssZ`
+         */
+        latest_estimated_delivery?: LatestEstimatedDelivery;
     };
 }
 //# sourceMappingURL=tracking.d.ts.map

package.json

 {
   "name": "aftership",
   "description": "node.js SDK for AfterShip API",
-  "version": "7.0.4",
+  "version": "7.0.5",
   "homepage": "https://github.com/aftership/aftership-sdk-nodejs",
@@ -6,0 +6,0 @@ "author": {

README.md

@@ -108,3 +108,3 @@ # aftership-sdk-node
 
-To understand AfterShip rate limit policy, please see `limit` section in https://www.aftership.com/docs/api/4
+See the [Rate Limit](https://www.aftership.com/docs/aftership/quickstart/rate-limit) to understand the AfterShip rate limit policy.
 
@@ -199,3 +199,3 @@ You can get the recent rate limit by `aftership.rate_limit`. Initially all value are `null`.
 Error return by the Aftership API  
-`error.type` shuold be same as https://www.aftership.com/docs/api/4/errors  
+`error.type` should be same as [request error](https://www.aftership.com/docs/aftership/quickstart/request-errors#http-status-code-summary).
 **Catch** by promise
@@ -202,0 +202,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

168359

increased by10.77%

Number of package files

182

increased by17.42%

Lines of code

2641

increased by10.64%

No dependency changes