@shipengine/connect-carrier-api 4.12.1 → 4.13.0

package/lib/models/billing/billing-line-item.d.ts

@@ -1,5 +1,6 @@
 import { BillingCategories } from './billing-categories';
 import { Currency } from '../currency';
+import { TaxDetails } from './tax-details';
 /** @description Basic structure of each charge or line item */
 export declare class BillingLineItem {
     /** A generalized category for what type of billing line item this is */
@@ -14,4 +15,6 @@ export declare class BillingLineItem {
     amount: Currency;
     /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
     provider_billed_amount?: Currency;
+    /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+    tax_details?: TaxDetails;
 }

package/lib/models/billing/billing-line-item.js

@@ -15,6 +15,8 @@ class BillingLineItem {
     amount;
     /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
     provider_billed_amount;
+    /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+    tax_details;
 }
 exports.BillingLineItem = BillingLineItem;
 //# sourceMappingURL=billing-line-item.js.map

package/lib/models/billing/billing-line-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;AAGA,+DAA+D;AAC/D,MAAa,eAAe;IAC1B,wEAAwE;IACxE,gBAAgB,CAAqB;IACrC,+JAA+J;IAC/J,mBAAmB,CAAU;IAC7B,8DAA8D;IAC9D,oBAAoB,CAAU;IAC9B,6MAA6M;IAC7M,IAAI,CAAU;IACd,oFAAoF;IACpF,MAAM,CAAY;IAClB,oIAAoI;IACpI,sBAAsB,CAAY;CACnC;AAbD,0CAaC"}
+{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;AAIA,+DAA+D;AAC/D,MAAa,eAAe;IAC1B,wEAAwE;IACxE,gBAAgB,CAAqB;IACrC,+JAA+J;IAC/J,mBAAmB,CAAU;IAC7B,8DAA8D;IAC9D,oBAAoB,CAAU;IAC9B,6MAA6M;IAC7M,IAAI,CAAU;IACd,oFAAoF;IACpF,MAAM,CAAY;IAClB,oIAAoI;IACpI,sBAAsB,CAAY;IAClC,8JAA8J;IAC9J,WAAW,CAAc;CAC1B;AAfD,0CAeC"}

package/lib/models/billing/index.d.ts

@@ -3,3 +3,4 @@ export * from './billing-categories-schema';
 export * from './billing-line-item';
 export * from './billing-line-item-schema';
 export * from './billing-to-party';
+export * from './tax-details';

package/lib/models/billing/index.js

@@ -6,4 +6,5 @@ tslib_1.__exportStar(require("./billing-categories-schema"), exports);
 tslib_1.__exportStar(require("./billing-line-item"), exports);
 tslib_1.__exportStar(require("./billing-line-item-schema"), exports);
 tslib_1.__exportStar(require("./billing-to-party"), exports);
+tslib_1.__exportStar(require("./tax-details"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/billing/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/billing/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,sEAA4C;AAC5C,8DAAoC;AACpC,qEAA2C;AAC3C,6DAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/billing/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,sEAA4C;AAC5C,8DAAoC;AACpC,qEAA2C;AAC3C,6DAAmC;AACnC,wDAA8B"}

package/lib/models/billing/tax-details.d.ts

@@ -0,0 +1,7 @@
+import { TaxType } from '../taxes';
+export declare class TaxDetails {
+    tax_type?: TaxType;
+    tax_code?: string;
+    /** @description Tax percentage, e.g. 20, 23.7 */
+    tax_percentage?: number;
+}

package/lib/models/billing/tax-details.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxDetails = void 0;
+class TaxDetails {
+    tax_type;
+    tax_code;
+    /** @description Tax percentage, e.g. 20, 23.7 */
+    tax_percentage;
+}
+exports.TaxDetails = TaxDetails;
+//# sourceMappingURL=tax-details.js.map

package/lib/models/billing/tax-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-details.js","sourceRoot":"","sources":["../../../src/models/billing/tax-details.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IACrB,QAAQ,CAAW;IACnB,QAAQ,CAAU;IAClB,iDAAiD;IACjD,cAAc,CAAU;CACzB;AALD,gCAKC"}

package/lib/models/labels/void-request.d.ts

@@ -6,4 +6,6 @@ export declare class VoidRequest extends ShippedShipment {
     void_request_id: string;
     /** @description The location the shipment was shipped from */
     ship_from: ShipFrom;
+    /** @description The shipment's user provided reference */
+    reference?: string;
 }

package/lib/models/labels/void-request.js

@@ -8,6 +8,8 @@ class VoidRequest extends shipped_shipment_1.ShippedShipment {
     void_request_id;
     /** @description The location the shipment was shipped from */
     ship_from;
+    /** @description The shipment's user provided reference */
+    reference;
 }
 exports.VoidRequest = VoidRequest;
 //# sourceMappingURL=void-request.js.map

package/lib/models/labels/void-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;IAC9C,0GAA0G;IAC1G,eAAe,CAAU;IACzB,8DAA8D;IAC9D,SAAS,CAAY;CACtB;AALD,kCAKC"}
+{"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;IAC9C,0GAA0G;IAC1G,eAAe,CAAU;IACzB,8DAA8D;IAC9D,SAAS,CAAY;IACrB,0DAA0D;IAC1D,SAAS,CAAU;CACpB;AAPD,kCAOC"}

package/lib/models/taxes/index.d.ts

@@ -1,2 +1,3 @@
 export * from './tax-identifier-type';
 export * from './tax-identifier';
+export * from './tax-type';

package/lib/models/taxes/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./tax-identifier-type"), exports);
 tslib_1.__exportStar(require("./tax-identifier"), exports);
+tslib_1.__exportStar(require("./tax-type"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/taxes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/taxes/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2DAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/taxes/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2DAAiC;AACjC,qDAA2B"}

package/lib/models/taxes/tax-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum TaxType {
+    VAT = "vat"
+}

package/lib/models/taxes/tax-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxType = void 0;
+var TaxType;
+(function (TaxType) {
+    TaxType["VAT"] = "vat";
+})(TaxType || (exports.TaxType = TaxType = {}));
+//# sourceMappingURL=tax-type.js.map

package/lib/models/taxes/tax-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-type.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,sBAAW,CAAA;AACb,CAAC,EAFW,OAAO,uBAAP,OAAO,QAElB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.12.1",
+  "version": "4.13.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.25.1"
+    "version": "1.26.0"
   },
   "paths": {
     "/Register": {
@@ -1005,7 +1005,7 @@
           },
           "memo": {
             "type": "string",
-            "description": "Maximum length of 250 characters. This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters.",
+            "description": "This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters.",
             "nullable": true
           },
           "amount": {
@@ -1026,6 +1026,9 @@
             },
             "description": "Total amount of the line item to be billed to the end customer.",
             "nullable": true
+          },
+          "tax_details": {
+            "$ref": "#/components/schemas/TaxDetails"
           }
         },
         "additionalProperties": false
@@ -4353,6 +4356,25 @@
         "type": "string",
         "description": "This represents the ShipEngine supported detail codes for a shipment."
       },
+      "TaxDetails": {
+        "type": "object",
+        "properties": {
+          "tax_type": {
+            "$ref": "#/components/schemas/TaxType"
+          },
+          "tax_code": {
+            "type": "string",
+            "nullable": true
+          },
+          "tax_percentage": {
+            "type": "number",
+            "description": "Tax percentage, e.g. 20, 23.7",
+            "format": "double",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "TaxIdentificationType": {
         "enum": [
           "tin",
@@ -4401,6 +4423,12 @@
         "additionalProperties": false,
         "description": "Entity representing a Tax Identification number, type, and country of registration."
       },
+      "TaxType": {
+        "enum": [
+          "vat"
+        ],
+        "type": "string"
+      },
       "TermsOfTradeCode": {
         "enum": [
           "exw",
@@ -5002,6 +5030,11 @@
           },
           "ship_from": {
             "$ref": "#/components/schemas/ShipFrom"
+          },
+          "reference": {
+            "type": "string",
+            "description": "A user specified free form string to identify this shipment in their own system.\r\nMight be used instead of tracking number/alternative_identifiers\r\nAdded in 1.25.2",
+            "nullable": true
           }
         },
         "additionalProperties": false,
@@ -5195,4 +5228,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}

package/src/models/billing/billing-line-item.ts

@@ -1,5 +1,6 @@
 import { BillingCategories } from './billing-categories';
 import { Currency } from '../currency';
+import { TaxDetails } from './tax-details';
 
 /** @description Basic structure of each charge or line item */
 export class BillingLineItem {
@@ -15,4 +16,6 @@ export class BillingLineItem {
   amount!: Currency;
   /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
   provider_billed_amount?: Currency;
+  /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+  tax_details?: TaxDetails;
 }

package/src/models/billing/index.ts

@@ -3,3 +3,4 @@ export * from './billing-categories-schema';
 export * from './billing-line-item';
 export * from './billing-line-item-schema';
 export * from './billing-to-party';
+export * from './tax-details';

package/src/models/billing/tax-details.ts

@@ -0,0 +1,8 @@
+import { TaxType } from '../taxes';
+
+export class TaxDetails {
+  tax_type?: TaxType;
+  tax_code?: string;
+  /** @description Tax percentage, e.g. 20, 23.7 */
+  tax_percentage?: number;
+}

package/src/models/labels/void-request.ts

@@ -7,4 +7,6 @@ export class VoidRequest extends ShippedShipment {
   void_request_id!: string;
   /** @description The location the shipment was shipped from */
   ship_from!: ShipFrom;
+  /** @description The shipment's user provided reference */
+  reference?: string;
 }

package/src/models/taxes/index.ts

@@ -1,2 +1,3 @@
 export * from './tax-identifier-type';
 export * from './tax-identifier';
+export * from './tax-type';

package/src/models/taxes/tax-type.ts

@@ -0,0 +1,3 @@
+export enum TaxType {
+  VAT = 'vat',
+}