@shipengine/connect-carrier-api 4.0.0-beta.2 → 4.0.0

package/lib/app/create-endpoint-mapping.js

@@ -4,6 +4,8 @@ exports.createEndpointMapping = void 0;
 const connect_runtime_1 = require("@shipengine/connect-runtime");
 const constants_1 = require("./constants");
 const createEndpointMapping = (definition) => [
+    //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
+    //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelNotification, definition.CancelNotification],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelPickup, definition.CancelPickup],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateLabel, definition.CreateLabel],

package/lib/app/create-endpoint-mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAAqD;AACrD,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EAC0C,EAAE,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;CAClF,CAAC;AApBW,QAAA,qBAAqB,yBAoBhC"}
+{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAAqD;AACrD,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EAC0C,EAAE,CAAC;IAC7E,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;CAClF,CAAC;AAtBW,QAAA,qBAAqB,yBAsBhC"}

package/lib/constants.d.ts

@@ -0,0 +1 @@
+export declare const rateLogicName = "rate-shipments.js";

package/lib/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rateLogicName = void 0;
+// Name of the file that will contain rating logic used by Native Rating
+exports.rateLogicName = 'rate-shipments.js';
+//# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AAC3D,QAAA,aAAa,GAAG,mBAAmB,CAAC"}

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * as models from './models';
 export * as requests from './requests';
 export * as responses from './responses';
 export * from './app';
+export * from './constants';
 export * from './models';
 export * from './requests';
 export * from './responses';

package/lib/index.js

@@ -6,6 +6,7 @@ exports.models = tslib_1.__importStar(require("./models"));
 exports.requests = tslib_1.__importStar(require("./requests"));
 exports.responses = tslib_1.__importStar(require("./responses"));
 tslib_1.__exportStar(require("./app"), exports);
+tslib_1.__exportStar(require("./constants"), exports);
 tslib_1.__exportStar(require("./models"), exports);
 tslib_1.__exportStar(require("./requests"), exports);
 tslib_1.__exportStar(require("./responses"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,2DAAmC;AACnC,+DAAuC;AACvC,iEAAyC;AAEzC,gDAAsB;AACtB,mDAAyB;AACzB,qDAA2B;AAC3B,sDAA4B;AAC5B,iDAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,2DAAmC;AACnC,+DAAuC;AACvC,iEAAyC;AAEzC,gDAAsB;AACtB,sDAA4B;AAC5B,mDAAyB;AACzB,qDAA2B;AAC3B,sDAA4B;AAC5B,iDAAuB"}

package/lib/models/advanced-options.d.ts

@@ -1,3 +1,4 @@
+import { CollectOnDelivery } from './collect-on-delivery';
 import { Currency } from './currency';
 /** @description Basic structure for shipping options */
 export declare class AdvancedOptions {
@@ -13,6 +14,10 @@ export declare class AdvancedOptions {
     saturday_delivery?: boolean;
     /** @description Amount to be paid to the driver, used for local delivery and courier services */
     tip?: Currency;
+    /** @description Describes whether Additional Handling is requested for the shipment  */
+    additional_handling?: boolean;
+    /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
+    collect_on_delivery?: CollectOnDelivery;
     /** @description Any other custom shipping options */
     [key: string]: any;
 }

package/lib/models/advanced-options.js.map

@@ -1 +1 @@
-{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAEA,wDAAwD;AACxD,MAAa,eAAe;CAe3B;AAfD,0CAeC"}
+{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAGA,wDAAwD;AACxD,MAAa,eAAe;CAmB3B;AAnBD,0CAmBC"}

package/lib/models/bill-to.d.ts

@@ -0,0 +1,14 @@
+import { AddressBase } from './addresses';
+import { BillToParty } from './billing';
+/**
+ * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
+        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
+        since address fields are often required when associating billing to
+        another account.  Additionally, this allows for a contact to be specified, if necessary.
+ */
+export declare class BillTo extends AddressBase {
+    /** @description The bill_to_party mentions the type of billing option*/
+    bill_to_party?: BillToParty;
+    /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
+    account_number?: string;
+}

package/lib/models/bill-to.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillTo = void 0;
+const addresses_1 = require("./addresses");
+/**
+ * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
+        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
+        since address fields are often required when associating billing to
+        another account.  Additionally, this allows for a contact to be specified, if necessary.
+ */
+class BillTo extends addresses_1.AddressBase {
+}
+exports.BillTo = BillTo;
+//# sourceMappingURL=bill-to.js.map

package/lib/models/bill-to.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bill-to.js","sourceRoot":"","sources":["../../src/models/bill-to.ts"],"names":[],"mappings":";;;AAAA,2CAA0C;AAG1C;;;;;GAKG;AACH,MAAa,MAAO,SAAQ,uBAAW;CAKtC;AALD,wBAKC"}

package/lib/models/billing/billing-to-party.d.ts

@@ -0,0 +1,10 @@
+/** @description The type of party responsible for a given category of charges associated with a shipment, such as
+ * shipping charges or import duties. */
+export declare enum BillToParty {
+    /** @description The shipper is generally regarded as the party responsible for the billing. */
+    Shipper = "shipper",
+    /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
+    Recipient = "recipient",
+    /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
+    ThirdPartyAccount = "third_party_account"
+}

package/lib/models/billing/billing-to-party.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillToParty = void 0;
+/** @description The type of party responsible for a given category of charges associated with a shipment, such as
+ * shipping charges or import duties. */
+var BillToParty;
+(function (BillToParty) {
+    /** @description The shipper is generally regarded as the party responsible for the billing. */
+    BillToParty["Shipper"] = "shipper";
+    /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
+    BillToParty["Recipient"] = "recipient";
+    /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
+    BillToParty["ThirdPartyAccount"] = "third_party_account";
+})(BillToParty = exports.BillToParty || (exports.BillToParty = {}));
+//# sourceMappingURL=billing-to-party.js.map

package/lib/models/billing/billing-to-party.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-to-party.js","sourceRoot":"","sources":["../../../src/models/billing/billing-to-party.ts"],"names":[],"mappings":";;;AAAA;wCACwC;AACxC,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,+FAA+F;IAC/F,kCAAmB,CAAA;IACnB,4HAA4H;IAC5H,sCAAuB,CAAA;IACvB,wHAAwH;IACxH,wDAAyC,CAAA;AAC3C,CAAC,EAPW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAOtB"}

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

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

package/lib/models/billing/index.js

@@ -5,4 +5,5 @@ tslib_1.__exportStar(require("./billing-categories"), exports);
 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);
 //# 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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/billing/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,sEAA4C;AAC5C,8DAAoC;AACpC,qEAA2C;AAC3C,6DAAmC"}

package/lib/models/cod-payment-type.d.ts

@@ -0,0 +1,9 @@
+/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
+export declare enum CodPaymentType {
+    /** @description Any payment method is permitted */
+    Any = "any",
+    /** @description Only cash is permitted */
+    Cash = "cash",
+    /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
+    GuaranteedFunds = "guaranteed_funds"
+}

package/lib/models/cod-payment-type.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodPaymentType = void 0;
+/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
+var CodPaymentType;
+(function (CodPaymentType) {
+    /** @description Any payment method is permitted */
+    CodPaymentType["Any"] = "any";
+    /** @description Only cash is permitted */
+    CodPaymentType["Cash"] = "cash";
+    /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
+    CodPaymentType["GuaranteedFunds"] = "guaranteed_funds";
+})(CodPaymentType = exports.CodPaymentType || (exports.CodPaymentType = {}));
+//# sourceMappingURL=cod-payment-type.js.map

package/lib/models/cod-payment-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cod-payment-type.js","sourceRoot":"","sources":["../../src/models/cod-payment-type.ts"],"names":[],"mappings":";;;AAAA,yHAAyH;AACzH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,mDAAmD;IACnD,6BAAW,CAAA;IACX,0CAA0C;IAC1C,+BAAa,CAAA;IACb,iGAAiG;IACjG,sDAAoC,CAAA;AACtC,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB"}

package/lib/models/collect-on-delivery.d.ts

@@ -0,0 +1,9 @@
+import { CodPaymentType } from './cod-payment-type';
+import { Currency } from './currency';
+/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
+export declare class CollectOnDelivery {
+    /** @description The payment amount for Collect on Delivery (COD) */
+    payment_amount: Currency;
+    /** @description The payment method permitted for Collect on Delivery (COD) */
+    payment_type?: CodPaymentType;
+}

package/lib/models/collect-on-delivery.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectOnDelivery = void 0;
+/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
+class CollectOnDelivery {
+}
+exports.CollectOnDelivery = CollectOnDelivery;
+//# sourceMappingURL=collect-on-delivery.js.map

package/lib/models/collect-on-delivery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect-on-delivery.js","sourceRoot":"","sources":["../../src/models/collect-on-delivery.ts"],"names":[],"mappings":";;;AAGA,kIAAkI;AAClI,MAAa,iBAAiB;CAK7B;AALD,8CAKC"}

package/lib/models/customs/customs-charges.d.ts

@@ -5,6 +5,8 @@ export declare class CustomsCharges {
     freight_charge?: Currency;
     /** @description Other charge for international shipments. */
     other_charge?: Currency;
+    /** @description : Description for other charge for international shipments.*/
+    other_charge_description?: string;
     /** @description Insurance charge for international shipments. */
     insurance_charge?: Currency;
     /** @description Discount for international shipments. */

package/lib/models/customs/customs-charges.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs-charges.js","sourceRoot":"","sources":["../../../src/models/customs/customs-charges.ts"],"names":[],"mappings":";;;AAEA,2EAA2E;AAC3E,MAAa,cAAc;CAS1B;AATD,wCASC"}
+{"version":3,"file":"customs-charges.js","sourceRoot":"","sources":["../../../src/models/customs/customs-charges.ts"],"names":[],"mappings":";;;AAEA,2EAA2E;AAC3E,MAAa,cAAc;CAW1B;AAXD,wCAWC"}

package/lib/models/customs/customs.d.ts

@@ -20,7 +20,7 @@ export declare class Customs {
     /** @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*/
-    termsOfTradeCode?: TermsOfTradeCode;
+    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.*/

package/lib/models/index.d.ts

@@ -1,6 +1,8 @@
 export * from './addresses';
 export * from './advanced-options';
 export * from './authorization';
+export * from './cod-payment-type';
+export * from './collect-on-delivery';
 export * from './billing';
 export * from './confirmation-types';
 export * from './currency-schema';
@@ -18,6 +20,7 @@ export * from './inbound-content-types';
 export * from './insurance-providers';
 export * from './labels';
 export * from './manifests';
+export * from './native-rating';
 export * from './package';
 export * from './pickup';
 export * from './rates';
@@ -30,3 +33,4 @@ export * from './time-window-schema';
 export * from './time-window';
 export * from './tracking';
 export * from './units';
+export * from './bill-to';

package/lib/models/index.js

@@ -4,6 +4,8 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./addresses"), exports);
 tslib_1.__exportStar(require("./advanced-options"), exports);
 tslib_1.__exportStar(require("./authorization"), exports);
+tslib_1.__exportStar(require("./cod-payment-type"), exports);
+tslib_1.__exportStar(require("./collect-on-delivery"), exports);
 tslib_1.__exportStar(require("./billing"), exports);
 tslib_1.__exportStar(require("./confirmation-types"), exports);
 tslib_1.__exportStar(require("./currency-schema"), exports);
@@ -21,6 +23,7 @@ tslib_1.__exportStar(require("./inbound-content-types"), exports);
 tslib_1.__exportStar(require("./insurance-providers"), exports);
 tslib_1.__exportStar(require("./labels"), exports);
 tslib_1.__exportStar(require("./manifests"), exports);
+tslib_1.__exportStar(require("./native-rating"), exports);
 tslib_1.__exportStar(require("./package"), exports);
 tslib_1.__exportStar(require("./pickup"), exports);
 tslib_1.__exportStar(require("./rates"), exports);
@@ -33,4 +36,5 @@ tslib_1.__exportStar(require("./time-window-schema"), exports);
 tslib_1.__exportStar(require("./time-window"), exports);
 tslib_1.__exportStar(require("./tracking"), exports);
 tslib_1.__exportStar(require("./units"), exports);
+tslib_1.__exportStar(require("./bill-to"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,6DAAmC;AACnC,gEAAsC;AACtC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,0DAAgC;AAChC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB;AACxB,oDAA0B"}

package/lib/models/native-rating/context-results.d.ts

@@ -0,0 +1,3 @@
+export interface ContextResults<T> {
+    [dataKey: string]: T;
+}

package/lib/models/native-rating/context-results.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context-results.js.map

package/lib/models/native-rating/context-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-results.js","sourceRoot":"","sources":["../../../src/models/native-rating/context-results.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-rates.d.ts

@@ -0,0 +1,7 @@
+import { ContextResults } from './context-results';
+import { NumericCurrency } from './numeric-currency';
+export type GetRatesResults = ContextResults<NumericCurrency>;
+/** Function to get rates from the context */
+export interface GetRates {
+    (dataKeys: string[]): Promise<GetRatesResults>;
+}

package/lib/models/native-rating/get-rates.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-rates.js.map

package/lib/models/native-rating/get-rates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-rates.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-rates.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-variables.d.ts

@@ -0,0 +1,6 @@
+import { ContextResults } from './context-results';
+export type GetVariableResults = ContextResults<any>;
+/** Function to get rating variables from the context */
+export interface GetVariables {
+    (dataKeys: string[]): Promise<GetVariableResults>;
+}

package/lib/models/native-rating/get-variables.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-variables.js.map

package/lib/models/native-rating/get-variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-variables.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-variables.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-zone.d.ts

@@ -0,0 +1,6 @@
+import { ContextResults } from './context-results';
+export type GetZoneResults = ContextResults<any>;
+/** Function to get zone data from the context */
+export interface GetZone {
+    (dataKeys: string[]): Promise<GetZoneResults>;
+}

package/lib/models/native-rating/get-zone.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-zone.js.map

package/lib/models/native-rating/get-zone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-zone.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-zone.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/implementation-type.d.ts

@@ -0,0 +1,30 @@
+import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
+import type { RatingContext } from './rating-context';
+/** A rate request shipment with its corresponding id */
+export interface ShipmentAndId {
+    /** rate_request_identifier for the rate request */
+    id: string;
+    /** Shipment for the rate request */
+    shipment: GetRatesRequest;
+}
+/** Rate results with its corresponding rate request id */
+export interface RateResultsAndId {
+    /** rate_request_identifier for the corresponding rate request */
+    id: string;
+    /** Error, if any */
+    error?: unknown;
+    /** Rates for a given rate request */
+    rates: Rate[];
+}
+/** Implementation of a carrier */
+export interface RatingCarrier {
+    /** Rate shipments
+     * @param context Native Rating context that can be used by the implementation to interact with the underlying service
+     * @param shipment Shipments that should be rated
+     * @returns List of rates for the given shipments
+     */
+    rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
+}
+/** Signify a validation error from the carrier */
+export declare class CarrierValidationError extends Error {
+}

package/lib/models/native-rating/implementation-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierValidationError = void 0;
+/** Signify a validation error from the carrier */
+class CarrierValidationError extends Error {
+}
+exports.CarrierValidationError = CarrierValidationError;
+//# sourceMappingURL=implementation-type.js.map

package/lib/models/native-rating/implementation-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation-type.js","sourceRoot":"","sources":["../../../src/models/native-rating/implementation-type.ts"],"names":[],"mappings":";;;AA+BA,kDAAkD;AAClD,MAAa,sBAAuB,SAAQ,KAAK;CAAG;AAApD,wDAAoD"}

package/lib/models/native-rating/index.d.ts

@@ -0,0 +1,7 @@
+export * from './context-results';
+export * from './get-rates';
+export * from './get-variables';
+export * from './get-zone';
+export * from './implementation-type';
+export * from './numeric-currency';
+export * from './rating-context';

package/lib/models/native-rating/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./context-results"), exports);
+tslib_1.__exportStar(require("./get-rates"), exports);
+tslib_1.__exportStar(require("./get-variables"), exports);
+tslib_1.__exportStar(require("./get-zone"), exports);
+tslib_1.__exportStar(require("./implementation-type"), exports);
+tslib_1.__exportStar(require("./numeric-currency"), exports);
+tslib_1.__exportStar(require("./rating-context"), exports);
+//# sourceMappingURL=index.js.map

package/lib/models/native-rating/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/native-rating/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,sDAA4B;AAC5B,0DAAgC;AAChC,qDAA2B;AAC3B,gEAAsC;AACtC,6DAAmC;AACnC,2DAAiC"}

package/lib/models/native-rating/numeric-currency.d.ts

@@ -0,0 +1,5 @@
+/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
+export interface NumericCurrency {
+    currency: string;
+    amount: number | undefined;
+}

package/lib/models/native-rating/numeric-currency.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=numeric-currency.js.map

package/lib/models/native-rating/numeric-currency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-currency.js","sourceRoot":"","sources":["../../../src/models/native-rating/numeric-currency.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/rating-context.d.ts

@@ -0,0 +1,15 @@
+import { Logger } from 'winston';
+import { GetVariables } from './get-variables';
+import { GetRates } from './get-rates';
+import { GetZone } from './get-zone';
+/** Rates request context */
+export interface RatingContext {
+    /** Function to get rates for given keys */
+    getRates: GetRates;
+    /** Function to get variables for given keys */
+    getVariables: GetVariables;
+    /** Function to get zone for given keys */
+    getZone: GetZone;
+    /** Logger that implementers can use */
+    log: Logger;
+}

package/lib/models/native-rating/rating-context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rating-context.js.map

package/lib/models/native-rating/rating-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rating-context.js","sourceRoot":"","sources":["../../../src/models/native-rating/rating-context.ts"],"names":[],"mappings":""}

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

@@ -5,8 +5,10 @@ export declare class TaxIdentifier {
     id: string;
     /** @description The Tax ID type */
     type: TaxIdentifierType;
-    /** @description The country where the Tax ID is registered with */
+    /** @deprecated This property has been deprecated, please use registration_country instead */
     registration_county?: string;
+    /** @description The country where the Tax ID is registered with */
+    registration_country?: string;
     /** @description Description of the tax ID that may give the customs agent more context */
     description?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"tax-identifier.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier.ts"],"names":[],"mappings":";;;AAEA,sGAAsG;AACtG,MAAa,aAAa;CASzB;AATD,sCASC"}
+{"version":3,"file":"tax-identifier.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier.ts"],"names":[],"mappings":";;;AAEA,sGAAsG;AACtG,MAAa,aAAa;CAWzB;AAXD,sCAWC"}

package/lib/requests/create-label-request.d.ts

@@ -1,5 +1,5 @@
 import { BaseRequest } from './base-request';
-import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs } from '../models';
+import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs, BillTo } from '../models';
 /** @description Basic structure for a request to create a label */
 export declare class CreateLabelRequest extends BaseRequest {
     service_code?: string;
@@ -35,4 +35,6 @@ export declare class CreateLabelRequest extends BaseRequest {
     /** @description Display schemes that the label will be returned in. Label is returned by default */
     display_schemes?: DisplayScheme[];
     customs?: Customs;
+    /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
+    bill_shipping_to?: BillTo;
 }

package/lib/requests/create-label-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAqB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;CAkClD;AAlCD,gDAkCC"}
+{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAsB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;CAoClD;AApCD,gDAoCC"}

package/lib/requests/get-rates-request.d.ts

@@ -1,5 +1,5 @@
 import { BaseRequest } from './base-request';
-import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow } from '../models';
+import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow, BillTo } from '../models';
 import { ShipmentItem } from '../models/shipment-item';
 /** @description Basic structure for a request to get rates */
 export declare class GetRatesRequest extends BaseRequest {
@@ -21,4 +21,6 @@ export declare class GetRatesRequest extends BaseRequest {
     carrier_pickup_window?: TimeWindow;
     /** Items included in the shipment */
     items?: ShipmentItem[];
+    /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
+    bill_shipping_to?: BillTo;
 }

package/lib/requests/get-rates-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAe7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAmB/C;AAnBD,0CAmBC"}
+{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAgB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAqB/C;AArBD,0CAqBC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0",
   "description": "This is the typescript/javascript definitions for carrier api",
-  "homepage": "https://github.com/ShipEngine/connect",
+  "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
@@ -37,14 +37,14 @@
     "vitest": "^0.23.4"
   },
   "optionalDependencies": {
-    "vm2": "^3.9.16"
+    "vm2": "^3.9.18"
   },
   "dependencies": {
     "joi": "^17.4.2",
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.0.0-beta.2",
+    "@shipengine/connect-runtime": "^4.0.0",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }