@shipengine/connect-carrier-api 4.7.0 → 4.8.0

package/lib/models/manifests/manifest-customs-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const CustomsSchema: Joi.ObjectSchema<any>;

package/lib/models/manifests/manifest-customs-schema.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const customs_content_types_schema_1 = require("../customs/customs-content-types-schema");
+const customs_non_delivery_schema_1 = require("../customs/customs-non-delivery-schema");
+const customs_item_schema_1 = require("../customs/customs-item-schema");
+const connect_carrier_api_1 = require("@shipengine/connect-carrier-api");
+const terms_of_trade_code_schema_1 = require("../inconterms/terms-of-trade-code-schema");
+const importer_of_record_schema_1 = require("../importer-records/importer-of-record-schema");
+const customs_charges_schema_1 = require("../customs/customs-charges-schema");
+exports.CustomsSchema = joi_1.default.object({
+    contents: customs_content_types_schema_1.CustomsContentTypesSchema.optional(),
+    non_delivery: customs_non_delivery_schema_1.CustomsNonDeliverySchema.optional(),
+    customs_items: joi_1.default.array().items(customs_item_schema_1.CustomsItemSchema).required(),
+    buyer_shipping_amount_paid: connect_carrier_api_1.CurrencySchema.optional(),
+    duties_paid: connect_carrier_api_1.CurrencySchema.optional(),
+    declaration: joi_1.default.string().optional(),
+    terms_of_trade_code: terms_of_trade_code_schema_1.TermsOfTradeCodeSchema.optional(),
+    importer_of_record: importer_of_record_schema_1.ImporterOfRecordSchema.optional(),
+    invoice_additional_details: customs_charges_schema_1.CustomsChargesSchema.optional(),
+    contents_explanation: joi_1.default.string().optional(),
+    export_declaration_number: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=manifest-customs-schema.js.map

package/lib/models/manifests/manifest-customs-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-customs-schema.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-customs-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,0FAAoF;AACpF,wFAAkF;AAClF,wEAAmE;AACnE,yEAAiE;AACjE,yFAAkF;AAClF,6FAAuF;AACvF,8EAAyE;AAE5D,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,wDAAyB,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,sDAAwB,CAAC,QAAQ,EAAE;IACjD,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,uCAAiB,CAAC,CAAC,QAAQ,EAAE;IAC9D,0BAA0B,EAAE,oCAAc,CAAC,QAAQ,EAAE;IACrD,WAAW,EAAE,oCAAc,CAAC,QAAQ,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,mBAAmB,EAAE,mDAAsB,CAAC,QAAQ,EAAE;IACtD,kBAAkB,EAAE,kDAAsB,CAAC,QAAQ,EAAE;IACrD,0BAA0B,EAAE,6CAAoB,CAAC,QAAQ,EAAE;IAC3D,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7C,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC"}

package/lib/models/manifests/manifest-customs.d.ts

@@ -0,0 +1,29 @@
+import { Currency, CustomsContentTypes, CustomsItem, CustomsNonDelivery } from '@shipengine/connect-carrier-api';
+import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
+import { ImporterOfRecord } from '../importer-records/importer-of-record';
+import { CustomsCharges } from '../customs/customs-charges';
+/** @description Basic structure for a customs declaration for manifest */
+export declare class ManifestCustoms {
+    /** @description Indicates the type of contents associated with this shipment */
+    contents?: CustomsContentTypes;
+    /** @description Indicates what the seller would like done in case of an issue with delivery */
+    non_delivery?: CustomsNonDelivery;
+    /** @description A list of customs items to declare */
+    customs_items: CustomsItem[];
+    /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
+    buyer_shipping_amount_paid?: Currency;
+    /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
+    duties_paid?: Currency;
+    /** @description Declaration statement to be placed on the commercial invoice */
+    declaration?: string;
+    /** @description Incoterms specify who is responsible for paying for and managing the shipment*/
+    terms_of_trade_code?: TermsOfTradeCode;
+    /** @description The owner or purchaser of the products being imported into a destination country.*/
+    importer_of_record?: ImporterOfRecord;
+    /** @description The charges related with customs.*/
+    invoice_additional_details?: CustomsCharges;
+    /**@description: text explanation for the content */
+    contents_explanation?: string;
+    /**@description: An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
+    export_declaration_number?: string;
+}

package/lib/models/manifests/manifest-customs.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestCustoms = void 0;
+/** @description Basic structure for a customs declaration for manifest */
+class ManifestCustoms {
+    /** @description Indicates the type of contents associated with this shipment */
+    contents;
+    /** @description Indicates what the seller would like done in case of an issue with delivery */
+    non_delivery;
+    /** @description A list of customs items to declare */
+    customs_items;
+    /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
+    buyer_shipping_amount_paid;
+    /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
+    duties_paid;
+    /** @description Declaration statement to be placed on the commercial invoice */
+    declaration;
+    /** @description Incoterms specify who is responsible for paying for and managing the shipment*/
+    terms_of_trade_code;
+    /** @description The owner or purchaser of the products being imported into a destination country.*/
+    importer_of_record;
+    /** @description The charges related with customs.*/
+    invoice_additional_details;
+    /**@description: text explanation for the content */
+    contents_explanation;
+    /**@description: An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
+    export_declaration_number;
+}
+exports.ManifestCustoms = ManifestCustoms;
+//# sourceMappingURL=manifest-customs.js.map

package/lib/models/manifests/manifest-customs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-customs.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-customs.ts"],"names":[],"mappings":";;;AAUA,0EAA0E;AAC1E,MAAa,eAAe;IAC1B,gFAAgF;IAChF,QAAQ,CAAuB;IAC/B,+FAA+F;IAC/F,YAAY,CAAsB;IAClC,sDAAsD;IACtD,aAAa,CAAiB;IAC9B,sJAAsJ;IACtJ,0BAA0B,CAAY;IACtC,iJAAiJ;IACjJ,WAAW,CAAY;IACvB,gFAAgF;IAChF,WAAW,CAAU;IACrB,gGAAgG;IAChG,mBAAmB,CAAoB;IACvC,oGAAoG;IACpG,kBAAkB,CAAoB;IACtC,oDAAoD;IACpD,0BAA0B,CAAkB;IAC5C,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,oNAAoN;IACpN,yBAAyB,CAAU;CACpC;AAvBD,0CAuBC"}

package/lib/models/manifests/manifest-request-shipment.d.ts

@@ -1,6 +1,8 @@
 import { ShippedShipment } from '../pickup/shipped-shipment';
+import { ManifestCustoms } from './manifest-customs';
 export declare class ManifestRequestShipment extends ShippedShipment {
     manifest_request_shipment_id: string;
     ship_datetime?: string;
     reference?: string;
+    manifest_customs?: ManifestCustoms;
 }

package/lib/models/manifests/manifest-request-shipment.js

@@ -6,6 +6,7 @@ class ManifestRequestShipment extends shipped_shipment_1.ShippedShipment {
     manifest_request_shipment_id;
     ship_datetime;
     reference;
+    manifest_customs;
 }
 exports.ManifestRequestShipment = ManifestRequestShipment;
 //# sourceMappingURL=manifest-request-shipment.js.map

package/lib/models/manifests/manifest-request-shipment.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-request-shipment.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-request-shipment.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAE7D,MAAa,uBAAwB,SAAQ,kCAAe;IAC1D,4BAA4B,CAAU;IACtC,aAAa,CAAU;IACvB,SAAS,CAAU;CACpB;AAJD,0DAIC"}
+{"version":3,"file":"manifest-request-shipment.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-request-shipment.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,MAAa,uBAAwB,SAAQ,kCAAe;IAC1D,4BAA4B,CAAU;IACtC,aAAa,CAAU;IACvB,SAAS,CAAU;IACnB,gBAAgB,CAAmB;CACpC;AALD,0DAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.7.0",
+  "version": "4.8.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.21.0"
+    "version": "1.22.0"
   },
   "paths": {
     "/Register": {
@@ -2812,6 +2812,83 @@
         "additionalProperties": false,
         "description": "This model represents a single manifest created with a shipping provider."
       },
+      "ManifestCustoms": {
+        "type": "object",
+        "properties": {
+          "contents": {
+            "$ref": "#/components/schemas/CustomsContentTypes"
+          },
+          "non_delivery": {
+            "$ref": "#/components/schemas/CustomsNonDelivery"
+          },
+          "buyer_shipping_amount_paid": {
+            "required": [
+              "currency",
+              "amount"
+            ],
+            "type": "object",
+            "properties": {
+              "amount": {
+                "type": "string",
+                "description": "Decimal currency value, as a string."
+              },
+              "currency": {
+                "type": "string",
+                "description": "Alpha-3 currency code complying with ISO 4217."
+              }
+            },
+            "description": "Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed\r\nto the shipper.",
+            "nullable": true
+          },
+          "duties_paid": {
+            "required": [
+              "currency",
+              "amount"
+            ],
+            "type": "object",
+            "properties": {
+              "amount": {
+                "type": "string",
+                "description": "Decimal currency value, as a string."
+              },
+              "currency": {
+                "type": "string",
+                "description": "Alpha-3 currency code complying with ISO 4217."
+              }
+            },
+            "description": "The amount of duties paid by the shipper, if any. This is generally only necessary for DDP\r\n(bill_duties_to_sender) shipments.",
+            "nullable": true
+          },
+          "bill_duties_to": {
+            "$ref": "#/components/schemas/BillTo"
+          },
+          "declaration": {
+            "type": "string",
+            "description": "Declaration statement to be placed on the commercial invoice",
+            "nullable": true
+          },
+          "terms_of_trade_code": {
+            "$ref": "#/components/schemas/TermsOfTradeCode"
+          },
+          "importer_of_record": {
+            "$ref": "#/components/schemas/ImporterOfRecord"
+          },
+          "invoice_additional_details": {
+            "$ref": "#/components/schemas/CustomCharges"
+          },
+          "contents_explanation": {
+            "type": "string",
+            "description": "Text explanation for the content",
+            "nullable": true
+          },
+          "export_declaration_number": {
+            "type": "string",
+            "description": "An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "ManifestError": {
         "type": "object",
         "properties": {
@@ -2854,6 +2931,9 @@
             "type": "string",
             "description": "Shipment reference number.",
             "nullable": true
+          },
+          "customs": {
+            "$ref": "#/components/schemas/ManifestCustoms"
           }
         },
         "additionalProperties": false

package/src/models/manifests/manifest-customs-schema.ts

@@ -0,0 +1,22 @@
+import Joi from 'joi';
+import { CustomsContentTypesSchema } from '../customs/customs-content-types-schema';
+import { CustomsNonDeliverySchema } from '../customs/customs-non-delivery-schema';
+import { CustomsItemSchema } from '../customs/customs-item-schema';
+import { CurrencySchema } from '@shipengine/connect-carrier-api';
+import { TermsOfTradeCodeSchema } from '../inconterms/terms-of-trade-code-schema';
+import { ImporterOfRecordSchema } from '../importer-records/importer-of-record-schema';
+import { CustomsChargesSchema } from '../customs/customs-charges-schema';
+
+export const CustomsSchema = Joi.object({
+  contents: CustomsContentTypesSchema.optional(),
+  non_delivery: CustomsNonDeliverySchema.optional(),
+  customs_items: Joi.array().items(CustomsItemSchema).required(),
+  buyer_shipping_amount_paid: CurrencySchema.optional(),
+  duties_paid: CurrencySchema.optional(),
+  declaration: Joi.string().optional(),
+  terms_of_trade_code: TermsOfTradeCodeSchema.optional(),
+  importer_of_record: ImporterOfRecordSchema.optional(),
+  invoice_additional_details: CustomsChargesSchema.optional(),
+  contents_explanation: Joi.string().optional(),
+  export_declaration_number: Joi.string().optional(),
+});

package/src/models/manifests/manifest-customs.ts

@@ -0,0 +1,35 @@
+import {
+  Currency,
+  CustomsContentTypes,
+  CustomsItem,
+  CustomsNonDelivery,
+} from '@shipengine/connect-carrier-api';
+import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
+import { ImporterOfRecord } from '../importer-records/importer-of-record';
+import { CustomsCharges } from '../customs/customs-charges';
+
+/** @description Basic structure for a customs declaration for manifest */
+export class ManifestCustoms {
+  /** @description Indicates the type of contents associated with this shipment */
+  contents?: CustomsContentTypes;
+  /** @description Indicates what the seller would like done in case of an issue with delivery */
+  non_delivery?: CustomsNonDelivery;
+  /** @description A list of customs items to declare */
+  customs_items!: CustomsItem[];
+  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
+  buyer_shipping_amount_paid?: Currency;
+  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
+  duties_paid?: Currency;
+  /** @description Declaration statement to be placed on the commercial invoice */
+  declaration?: string;
+  /** @description Incoterms specify who is responsible for paying for and managing the shipment*/
+  terms_of_trade_code?: TermsOfTradeCode;
+  /** @description The owner or purchaser of the products being imported into a destination country.*/
+  importer_of_record?: ImporterOfRecord;
+  /** @description The charges related with customs.*/
+  invoice_additional_details?: CustomsCharges;
+  /**@description: text explanation for the content */
+  contents_explanation?: string;
+  /**@description: An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
+  export_declaration_number?: string;
+}

package/src/models/manifests/manifest-request-shipment.ts

@@ -1,7 +1,9 @@
 import { ShippedShipment } from '../pickup/shipped-shipment';
+import { ManifestCustoms } from './manifest-customs';
 
 export class ManifestRequestShipment extends ShippedShipment {
   manifest_request_shipment_id!: string;
   ship_datetime?: string;
   reference?: string;
+  manifest_customs?: ManifestCustoms;
 }