@shipengine/connect-carrier-api 2.2.2 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/app/carrier-app.js +6 -39
- package/lib/app/carrier-app.js.map +1 -1
- package/lib/app/internal/carrier-specification.js +14 -1
- package/lib/app/internal/carrier-specification.js.map +1 -1
- package/lib/app/internal/metadata.js.map +1 -1
- package/lib/app/metadata/account-modals.d.ts +8 -2
- package/lib/app/metadata/account-modals.js.map +1 -1
- package/lib/app/metadata/carrier-app-metadata.js.map +1 -1
- package/lib/app/metadata/carrier.d.ts +1 -0
- package/lib/app/metadata/carrier.js +6 -12
- package/lib/app/metadata/carrier.js.map +1 -1
- package/lib/app/metadata/label-formats.js.map +1 -1
- package/lib/app/metadata/label-sizes.js.map +1 -1
- package/lib/app/metadata/monoauth.js.map +1 -1
- package/lib/app/metadata/package-type.d.ts +1 -0
- package/lib/app/metadata/package-type.js +3 -0
- package/lib/app/metadata/package-type.js.map +1 -1
- package/lib/app/metadata/service-class.js.map +1 -1
- package/lib/app/metadata/service-grade.js.map +1 -1
- package/lib/app/metadata/shipping-service.d.ts +1 -0
- package/lib/app/metadata/shipping-service.js +7 -16
- package/lib/app/metadata/shipping-service.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/lib/models/addresses/address-base.d.ts +13 -13
- package/lib/models/addresses/address-base.js.map +1 -1
- package/lib/models/addresses/address-residential-indicator.d.ts +3 -0
- package/lib/models/addresses/address-residential-indicator.js +3 -0
- package/lib/models/addresses/address-residential-indicator.js.map +1 -1
- package/lib/models/addresses/ship-from-display.d.ts +1 -0
- package/lib/models/addresses/ship-from-display.js +1 -0
- package/lib/models/addresses/ship-from-display.js.map +1 -1
- package/lib/models/addresses/ship-from.d.ts +1 -0
- package/lib/models/addresses/ship-from.js +1 -0
- package/lib/models/addresses/ship-from.js.map +1 -1
- package/lib/models/addresses/ship-to.d.ts +1 -0
- package/lib/models/addresses/ship-to.js +1 -0
- package/lib/models/addresses/ship-to.js.map +1 -1
- package/lib/models/advanced-options.d.ts +1 -1
- package/lib/models/authorization.d.ts +2 -0
- package/lib/models/authorization.js.map +1 -1
- package/lib/models/billing/billing-categories.d.ts +1 -1
- package/lib/models/billing/billing-categories.js +1 -1
- package/lib/models/billing/billing-categories.js.map +1 -1
- package/lib/models/billing/billing-line-item.d.ts +5 -0
- package/lib/models/billing/billing-line-item.js +2 -2
- package/lib/models/billing/billing-line-item.js.map +1 -1
- package/lib/models/confirmation-types.d.ts +5 -5
- package/lib/models/confirmation-types.js +5 -5
- package/lib/models/confirmation-types.js.map +1 -1
- package/lib/models/currency.d.ts +2 -0
- package/lib/models/currency.js.map +1 -1
- package/lib/models/customs/customs-content-types.d.ts +5 -1
- package/lib/models/customs/customs-content-types.js +5 -1
- package/lib/models/customs/customs-content-types.js.map +1 -1
- package/lib/models/customs/customs-item.d.ts +9 -1
- package/lib/models/customs/customs-item.js +1 -1
- package/lib/models/customs/customs-item.js.map +1 -1
- package/lib/models/customs/customs-non-delivery.d.ts +2 -0
- package/lib/models/customs/customs-non-delivery.js +2 -0
- package/lib/models/customs/customs-non-delivery.js.map +1 -1
- package/lib/models/customs/customs.d.ts +6 -1
- package/lib/models/customs/customs.js +1 -1
- package/lib/models/customs/customs.js.map +1 -1
- package/lib/models/documents/document-type.d.ts +4 -0
- package/lib/models/documents/document-type.js +4 -0
- package/lib/models/documents/document-type.js.map +1 -1
- package/lib/models/documents/document.d.ts +3 -0
- package/lib/models/documents/document.js.map +1 -1
- package/lib/models/errors/detailed-error.d.ts +1 -1
- package/lib/models/errors/detailed-error.js +1 -1
- package/lib/models/errors/detailed-error.js.map +1 -1
- package/lib/models/errors/standardized-error-code.d.ts +1 -1
- package/lib/models/errors/standardized-error-code.js +1 -1
- package/lib/models/errors/standardized-error-code.js.map +1 -1
- package/lib/models/fulfillment-plans/fulfillment-plan-details.d.ts +4 -1
- package/lib/models/fulfillment-plans/fulfillment-plan-details.js +1 -1
- package/lib/models/fulfillment-plans/fulfillment-plan-details.js.map +1 -1
- package/lib/models/fulfillment-plans/fulfillment-plan-items.d.ts +4 -4
- package/lib/models/fulfillment-plans/raw-external-source.d.ts +2 -0
- package/lib/models/fulfillment-plans/raw-external-source.js +1 -0
- package/lib/models/fulfillment-plans/raw-external-source.js.map +1 -1
- package/lib/models/labels/document-formats.js.map +1 -1
- package/lib/models/labels/form-download.d.ts +2 -0
- package/lib/models/labels/form-download.js +1 -0
- package/lib/models/labels/form-download.js.map +1 -1
- package/lib/models/labels/label-download.d.ts +2 -0
- package/lib/models/labels/label-download.js +1 -0
- package/lib/models/labels/label-download.js.map +1 -1
- package/lib/models/labels/label-package.d.ts +2 -0
- package/lib/models/labels/label-package.js.map +1 -1
- package/lib/models/labels/return-label-details.d.ts +1 -0
- package/lib/models/labels/return-label-details.js.map +1 -1
- package/lib/models/labels/void-request.d.ts +2 -0
- package/lib/models/labels/void-request.js.map +1 -1
- package/lib/models/labels/void-response.d.ts +1 -1
- package/lib/models/manifests/label.d.ts +2 -0
- package/lib/models/manifests/label.js.map +1 -1
- package/lib/models/manifests/manifest.d.ts +5 -1
- package/lib/models/manifests/manifest.js +1 -1
- package/lib/models/manifests/manifest.js.map +1 -1
- package/lib/models/package.d.ts +6 -0
- package/lib/models/package.js.map +1 -1
- package/lib/models/pickup/cancellation-details.d.ts +1 -0
- package/lib/models/pickup/cancellation-details.js.map +1 -1
- package/lib/models/pickup/pickup-confirmation.d.ts +3 -0
- package/lib/models/pickup/pickup-confirmation.js.map +1 -1
- package/lib/models/pickup/pickup-contact-details.d.ts +6 -1
- package/lib/models/pickup/pickup-contact-details.js +1 -1
- package/lib/models/pickup/pickup-contact-details.js.map +1 -1
- package/lib/models/pickup/pickup-location-details.d.ts +1 -0
- package/lib/models/pickup/pickup-location-details.js.map +1 -1
- package/lib/models/pickup/pickup-package.d.ts +7 -0
- package/lib/models/pickup/pickup-package.js.map +1 -1
- package/lib/models/pickup/pickup-shipment-details.d.ts +1 -0
- package/lib/models/pickup/pickup-shipment-details.js.map +1 -1
- package/lib/models/pickup/pickup-window.d.ts +5 -1
- package/lib/models/pickup/pickup-window.js +1 -1
- package/lib/models/pickup/pickup-window.js.map +1 -1
- package/lib/models/pickup/shipment-identifier.d.ts +2 -0
- package/lib/models/pickup/shipment-identifier.js.map +1 -1
- package/lib/models/pickup/shipped-package.d.ts +7 -0
- package/lib/models/pickup/shipped-package.js.map +1 -1
- package/lib/models/pickup/shipped-shipment.d.ts +6 -0
- package/lib/models/pickup/shipped-shipment.js.map +1 -1
- package/lib/models/rates/rate.d.ts +2 -4
- package/lib/models/rates/rate.js.map +1 -1
- package/lib/models/registration/credentials.d.ts +2 -0
- package/lib/models/registration/credentials.js.map +1 -1
- package/lib/models/resource-download.d.ts +2 -0
- package/lib/models/resource-download.js.map +1 -1
- package/lib/models/taxes/tax-identifier.d.ts +1 -1
- package/lib/models/taxes/tax-identifier.js +1 -1
- package/lib/models/taxes/tax-identifier.js.map +1 -1
- package/lib/models/tracking/lat-long.d.ts +2 -2
- package/lib/models/tracking/service.d.ts +2 -0
- package/lib/models/tracking/service.js.map +1 -1
- package/lib/models/tracking/track-event.d.ts +9 -0
- package/lib/models/tracking/track-event.js.map +1 -1
- package/lib/models/tracking/tracking-info.d.ts +18 -0
- package/lib/models/tracking/tracking-info.js.map +1 -1
- package/lib/models/tracking/update-method.js.map +1 -1
- package/lib/models/units/dimension-details.d.ts +4 -0
- package/lib/models/units/dimension-details.js.map +1 -1
- package/lib/models/units/weight-details.d.ts +4 -0
- package/lib/models/units/weight-details.js.map +1 -1
- package/lib/responses/normalize-tracking-data-response.js.map +1 -1
- package/lib/responses/validate-inbound-data-response.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +355 -176
- package/src/app/carrier-app-definition.ts +5 -15
- package/src/app/carrier-app.ts +9 -45
- package/src/app/internal/carrier-specification.ts +20 -7
- package/src/app/internal/metadata.ts +1 -3
- package/src/app/metadata/account-modals.ts +8 -2
- package/src/app/metadata/carrier-app-metadata.ts +1 -6
- package/src/app/metadata/carrier.ts +11 -28
- package/src/app/metadata/label-formats.ts +1 -3
- package/src/app/metadata/label-sizes.ts +1 -3
- package/src/app/metadata/monoauth.ts +1 -4
- package/src/app/metadata/package-type.ts +4 -0
- package/src/app/metadata/service-class.ts +1 -3
- package/src/app/metadata/service-grade.ts +1 -3
- package/src/app/metadata/shipping-service.ts +10 -24
- package/src/index.ts +1 -0
- package/src/models/addresses/address-base.ts +13 -14
- package/src/models/addresses/address-residential-indicator.ts +3 -0
- package/src/models/addresses/ship-from-display.ts +1 -0
- package/src/models/addresses/ship-from.ts +1 -0
- package/src/models/addresses/ship-to.ts +1 -0
- package/src/models/advanced-options.ts +1 -1
- package/src/models/authorization.ts +2 -0
- package/src/models/billing/billing-categories.ts +2 -4
- package/src/models/billing/billing-line-item.ts +8 -6
- package/src/models/confirmation-types.ts +5 -5
- package/src/models/currency.ts +2 -0
- package/src/models/customs/customs-content-types.ts +5 -1
- package/src/models/customs/customs-item.ts +9 -1
- package/src/models/customs/customs-non-delivery.ts +2 -0
- package/src/models/customs/customs.ts +6 -1
- package/src/models/documents/document-type.ts +5 -3
- package/src/models/documents/document.ts +4 -4
- package/src/models/errors/detailed-error.ts +1 -1
- package/src/models/errors/standardized-error-code.ts +1 -1
- package/src/models/fulfillment-plans/fulfillment-plan-details.ts +4 -1
- package/src/models/fulfillment-plans/fulfillment-plan-items.ts +4 -4
- package/src/models/fulfillment-plans/raw-external-source.ts +2 -0
- package/src/models/labels/document-formats.ts +1 -3
- package/src/models/labels/form-download.ts +2 -0
- package/src/models/labels/label-download.ts +2 -0
- package/src/models/labels/label-package.ts +2 -0
- package/src/models/labels/return-label-details.ts +1 -0
- package/src/models/labels/void-request.ts +2 -0
- package/src/models/labels/void-response.ts +1 -1
- package/src/models/manifests/label.ts +2 -0
- package/src/models/manifests/manifest.ts +5 -1
- package/src/models/package.ts +6 -0
- package/src/models/pickup/cancellation-details.ts +1 -0
- package/src/models/pickup/pickup-confirmation.ts +4 -4
- package/src/models/pickup/pickup-contact-details.ts +6 -1
- package/src/models/pickup/pickup-location-details.ts +1 -0
- package/src/models/pickup/pickup-package.ts +7 -0
- package/src/models/pickup/pickup-shipment-details.ts +1 -0
- package/src/models/pickup/pickup-window.ts +5 -1
- package/src/models/pickup/shipment-identifier.ts +2 -0
- package/src/models/pickup/shipped-package.ts +7 -0
- package/src/models/pickup/shipped-shipment.ts +6 -0
- package/src/models/rates/rate.ts +3 -8
- package/src/models/registration/credentials.ts +2 -0
- package/src/models/resource-download.ts +2 -0
- package/src/models/taxes/tax-identifier.ts +1 -1
- package/src/models/tracking/lat-long.ts +2 -2
- package/src/models/tracking/service.ts +2 -0
- package/src/models/tracking/track-event.ts +9 -0
- package/src/models/tracking/tracking-info.ts +18 -0
- package/src/models/tracking/update-method.ts +1 -3
- package/src/models/units/dimension-details.ts +4 -0
- package/src/models/units/weight-details.ts +4 -0
- package/src/responses/normalize-tracking-data-response.ts +1 -6
- package/src/responses/validate-inbound-data-response.ts +1 -4
- package/tsconfig.tsbuildinfo +1 -1
package/lib/models/package.d.ts
CHANGED
|
@@ -5,10 +5,16 @@ import { LabelMessage } from './labels/label-message';
|
|
|
5
5
|
import { Customs } from './customs';
|
|
6
6
|
/** @description Basic structure for a package */
|
|
7
7
|
export declare class Package {
|
|
8
|
+
/** @description Package code defined for the carrier in ShipEngine. */
|
|
8
9
|
package_code?: string;
|
|
10
|
+
/** @description Details about the dimensions of the package */
|
|
9
11
|
dimension_details?: DimensionDetails;
|
|
12
|
+
/** @description Details about the weight of the package */
|
|
10
13
|
weight_details?: WeightDetails;
|
|
14
|
+
/** @description The insured value of this package. */
|
|
11
15
|
insured_value: Currency;
|
|
16
|
+
/** @description The message the seller requested to have on their label */
|
|
12
17
|
label_messages?: LabelMessage;
|
|
18
|
+
/** @description Basic structure for a customs declaration (Only available on international shipments) */
|
|
13
19
|
customs?: Customs;
|
|
14
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;
|
|
1
|
+
{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;CAanB;AAbD,0BAaC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { CancellationReason } from './cancellation-reason';
|
|
2
2
|
/** @description Basic structure for a cancellation */
|
|
3
3
|
export declare class CancellationDetails {
|
|
4
|
+
/** @description The reason the pickup has been cancelled */
|
|
4
5
|
reason: CancellationReason;
|
|
5
6
|
/** @description Additional properties about cancellation */
|
|
6
7
|
cancellation_options?: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cancellation-details.js","sourceRoot":"","sources":["../../../src/models/pickup/cancellation-details.ts"],"names":[],"mappings":";;;AAEA,sDAAsD;AACtD,MAAa,mBAAmB;
|
|
1
|
+
{"version":3,"file":"cancellation-details.js","sourceRoot":"","sources":["../../../src/models/pickup/cancellation-details.ts"],"names":[],"mappings":";;;AAEA,sDAAsD;AACtD,MAAa,mBAAmB;CAO/B;AAPD,kDAOC"}
|
|
@@ -3,8 +3,11 @@ import { Identifier } from '../identifier';
|
|
|
3
3
|
import { ShipmentIdentifier } from './shipment-identifier';
|
|
4
4
|
/** @description Basic structure for a pickup confirmation */
|
|
5
5
|
export declare class PickupConfirmation {
|
|
6
|
+
/** @description The primary confirmation ID for this request. */
|
|
6
7
|
confirmation_id?: string;
|
|
8
|
+
/** @description Other identifiers potentially needed in other calls. */
|
|
7
9
|
alternate_identifiers?: Identifier[];
|
|
10
|
+
/** @description List of the shipments added for this pickup. */
|
|
8
11
|
shipment_identifiers?: ShipmentIdentifier[];
|
|
9
12
|
}
|
|
10
13
|
export declare const PickupConfirmationSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-confirmation.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-confirmation.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,8CAA6D;AAC7D,+
|
|
1
|
+
{"version":3,"file":"pickup-confirmation.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-confirmation.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,8CAA6D;AAC7D,+DAAqF;AAErF,6DAA6D;AAC7D,MAAa,kBAAkB;CAO9B;AAPD,gDAOC;AACY,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,qBAAqB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;IACrE,oBAAoB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8CAAwB,CAAC;CAC7E,CAAC,CAAC"}
|
|
@@ -1,8 +1,13 @@
|
|
|
1
|
-
/** @description Contact
|
|
1
|
+
/** @description Contact information for the person who will be present for the pickup. */
|
|
2
2
|
export declare class PickupContactDetails {
|
|
3
|
+
/** @description The first name of the person who will be there for the pickup. */
|
|
3
4
|
first_name: string;
|
|
5
|
+
/** @description The last name of the person who will be there for the pickup. */
|
|
4
6
|
last_name?: string;
|
|
7
|
+
/** @description The e-mail address of the person who will be there for the pickup. */
|
|
5
8
|
email: string;
|
|
9
|
+
/** @description The phone number of the person who will be there for the pickup. */
|
|
6
10
|
phone_number: string;
|
|
11
|
+
/** @description The phone extension of the person who will be there for the pickup. */
|
|
7
12
|
phone_number_extension?: string;
|
|
8
13
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.PickupContactDetails = void 0;
|
|
4
|
-
/** @description Contact
|
|
4
|
+
/** @description Contact information for the person who will be present for the pickup. */
|
|
5
5
|
class PickupContactDetails {
|
|
6
6
|
}
|
|
7
7
|
exports.PickupContactDetails = PickupContactDetails;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-contact-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-contact-details.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"pickup-contact-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-contact-details.ts"],"names":[],"mappings":";;;AAAA,0FAA0F;AAC1F,MAAa,oBAAoB;CAWhC;AAXD,oDAWC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ShipFrom } from '../addresses/ship-from';
|
|
2
2
|
/** @description Location details for pickup */
|
|
3
3
|
export declare class PickupLocationDetails {
|
|
4
|
+
/** @description The address the pickup will take place */
|
|
4
5
|
pickup_address?: ShipFrom;
|
|
5
6
|
/** @description Any notes that may be helpful for a driver to find the pickup location */
|
|
6
7
|
location_notes?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-location-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-location-details.ts"],"names":[],"mappings":";;;AAEA,+CAA+C;AAC/C,MAAa,qBAAqB;
|
|
1
|
+
{"version":3,"file":"pickup-location-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-location-details.ts"],"names":[],"mappings":";;;AAEA,+CAA+C;AAC/C,MAAa,qBAAqB;CAOjC;AAPD,sDAOC"}
|
|
@@ -4,11 +4,18 @@ import { WeightDetails } from '../units/weight-details';
|
|
|
4
4
|
import { Dimensions } from '../units/dimensions';
|
|
5
5
|
/** @description Basic structure for a package to be picked up */
|
|
6
6
|
export declare class PickupPackage {
|
|
7
|
+
/** @description The carrier tracking number for this shipment */
|
|
7
8
|
tracking_number?: string;
|
|
9
|
+
/** @description Alternative identifiers associated with this package */
|
|
8
10
|
alternative_identifiers?: Identifier[];
|
|
11
|
+
/** @description Details about the dimensions of the package */
|
|
9
12
|
dimension_details?: DimensionDetails;
|
|
13
|
+
/** @description Details about the weight of the package */
|
|
10
14
|
weight_details?: WeightDetails;
|
|
15
|
+
/** @description The code associated with the package type */
|
|
11
16
|
package_code?: string;
|
|
17
|
+
/** @deprectated Please use the weight_details property */
|
|
12
18
|
weight?: number;
|
|
19
|
+
/** @deprectated Please use the dimension_details property */
|
|
13
20
|
dimensions?: Dimensions;
|
|
14
21
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-package.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-package.ts"],"names":[],"mappings":";;;AAKA,iEAAiE;AACjE,MAAa,aAAa;
|
|
1
|
+
{"version":3,"file":"pickup-package.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-package.ts"],"names":[],"mappings":";;;AAKA,iEAAiE;AACjE,MAAa,aAAa;CAezB;AAfD,sCAeC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ShippedShipment } from './shipped-shipment';
|
|
2
2
|
/** @description Details for a pickup shipment */
|
|
3
3
|
export declare class PickupShipmentDetails {
|
|
4
|
+
/** @description Service category for the carrier (ground, express, next_day) */
|
|
4
5
|
pickup_service_code?: string;
|
|
5
6
|
/** @description List of shipments to be picked up */
|
|
6
7
|
shipments?: ShippedShipment[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-shipment-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-shipment-details.ts"],"names":[],"mappings":";;;AAEA,iDAAiD;AACjD,MAAa,qBAAqB;
|
|
1
|
+
{"version":3,"file":"pickup-shipment-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-shipment-details.ts"],"names":[],"mappings":";;;AAEA,iDAAiD;AACjD,MAAa,qBAAqB;CAKjC;AALD,sDAKC"}
|
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
|
-
/** @description
|
|
2
|
+
/** @description This model represents a window of time a pickup could be made. */
|
|
3
3
|
export declare class PickupWindow {
|
|
4
|
+
/** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
|
|
4
5
|
time_zone_iana: string;
|
|
6
|
+
/** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
|
|
5
7
|
pickup_date: string;
|
|
8
|
+
/** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
|
|
6
9
|
start_time?: string;
|
|
10
|
+
/** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
|
|
7
11
|
end_time?: string;
|
|
8
12
|
}
|
|
9
13
|
export declare const PickupWindowSchema: Joi.ObjectSchema<any>;
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.PickupWindowSchema = exports.PickupWindow = void 0;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
5
|
const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
6
|
-
/** @description
|
|
6
|
+
/** @description This model represents a window of time a pickup could be made. */
|
|
7
7
|
class PickupWindow {
|
|
8
8
|
}
|
|
9
9
|
exports.PickupWindow = PickupWindow;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pickup-window.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-window.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,
|
|
1
|
+
{"version":3,"file":"pickup-window.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-window.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,kFAAkF;AAClF,MAAa,YAAY;CASxB;AATD,oCASC;AACY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;IAC9C,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;IAC7C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;CAC5C,CAAC,CAAC"}
|
|
@@ -2,7 +2,9 @@ import Joi from 'joi';
|
|
|
2
2
|
import { Identifier } from '../identifier';
|
|
3
3
|
/** @description Identifier object for shiments */
|
|
4
4
|
export declare class ShipmentIdentifier {
|
|
5
|
+
/** @description The carrier tracking number for this shipment */
|
|
5
6
|
tracking_number?: string;
|
|
7
|
+
/** @description A list of alternate identifiers that can be used to identify a shipment */
|
|
6
8
|
alternate_identifiers?: Identifier[];
|
|
7
9
|
}
|
|
8
10
|
export declare const ShipmentIdentifierSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shipment-identifier.js","sourceRoot":"","sources":["../../../src/models/pickup/shipment-identifier.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,8CAA6D;AAE7D,kDAAkD;AAClD,MAAa,kBAAkB;
|
|
1
|
+
{"version":3,"file":"shipment-identifier.js","sourceRoot":"","sources":["../../../src/models/pickup/shipment-identifier.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,8CAA6D;AAE7D,kDAAkD;AAClD,MAAa,kBAAkB;CAK9B;AALD,gDAKC;AAEY,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,qBAAqB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;CACtE,CAAC,CAAC"}
|
|
@@ -4,11 +4,18 @@ import { WeightDetails } from '../units/weight-details';
|
|
|
4
4
|
import { Dimensions } from '../units/dimensions';
|
|
5
5
|
/** @description Basic structure for a package that has been shipped */
|
|
6
6
|
export declare class ShippedPackage {
|
|
7
|
+
/** @description The carrier tracking number associated with this package */
|
|
7
8
|
tracking_number?: string;
|
|
9
|
+
/** @description Alternative identifiers associated with this package */
|
|
8
10
|
alternative_identifiers?: Identifier[];
|
|
11
|
+
/** @description Details about the dimensions of the package */
|
|
9
12
|
dimension_details?: DimensionDetails;
|
|
13
|
+
/** @description Details about the weight of the package */
|
|
10
14
|
weight_details?: WeightDetails;
|
|
15
|
+
/** @description The code associated with the package type */
|
|
11
16
|
package_code?: string;
|
|
17
|
+
/** @deprectated Please use the weight_details property */
|
|
12
18
|
weight?: number;
|
|
19
|
+
/** @deprectated Please use the dimension_details property */
|
|
13
20
|
dimensions?: Dimensions;
|
|
14
21
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AAKA,uEAAuE;AACvE,MAAa,cAAc;
|
|
1
|
+
{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AAKA,uEAAuE;AACvE,MAAa,cAAc;CAe1B;AAfD,wCAeC"}
|
|
@@ -5,11 +5,17 @@ import { Identifier } from '../identifier';
|
|
|
5
5
|
import { ShippedPackage } from './shipped-package';
|
|
6
6
|
/** @description Basic structure for a shipment that has been shipped */
|
|
7
7
|
export declare class ShippedShipment extends Label {
|
|
8
|
+
/** @description The carrier tracking number associated with this package */
|
|
8
9
|
tracking_number?: string;
|
|
10
|
+
/** @description The address that a shipment will be delivered to */
|
|
9
11
|
ship_to?: ShipTo;
|
|
12
|
+
/** @description Non-tracking alternative ids associated with this shipment */
|
|
10
13
|
alternative_identifiers?: Identifier[];
|
|
14
|
+
/** @description The service code used for this shipment */
|
|
11
15
|
service_code?: string;
|
|
16
|
+
/** @description The list of packages associated with this shipment */
|
|
12
17
|
packages?: ShippedPackage[];
|
|
18
|
+
/** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
|
|
13
19
|
advanced_options?: AdvancedOptions;
|
|
14
20
|
}
|
|
15
21
|
export declare class PickupShipment extends ShippedShipment {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAM3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;
|
|
1
|
+
{"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAM3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;CAazC;AAbD,0CAaC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}
|
|
@@ -3,6 +3,7 @@ import { BillingLineItem } from '../billing/billing-line-item';
|
|
|
3
3
|
import { TimeWindow } from '../time-window';
|
|
4
4
|
/** @description Basic structure for a rate */
|
|
5
5
|
export declare class Rate {
|
|
6
|
+
/** @description The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded. */
|
|
6
7
|
service_code?: string;
|
|
7
8
|
/** @description ISO 8601 formatted date for shipment */
|
|
8
9
|
ship_datetime?: string;
|
|
@@ -22,10 +23,7 @@ export declare class Rate {
|
|
|
22
23
|
delivery_window?: TimeWindow;
|
|
23
24
|
/** @description Unique identifier for the carrier rate */
|
|
24
25
|
carrier_rate_id?: string;
|
|
25
|
-
/** @description DateTime after which the rate will no longer be accepted.
|
|
26
|
-
* ISO 8601 format, with local offset.
|
|
27
|
-
* Example: 2021-08-20T14:38:36.859237-05:00
|
|
28
|
-
*/
|
|
26
|
+
/** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
|
|
29
27
|
expiration_datetime?: string;
|
|
30
28
|
}
|
|
31
29
|
export declare const RateSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,
|
|
1
|
+
{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oEAAsF;AACtF,gDAA8D;AAE9D,8CAA8C;AAC9C,MAAa,IAAI;CAuBhB;AAvBD,oBAuBC;AAEY,QAAA,UAAU,GAAG,aAAG,CAAC,MAAM,CAAC;IACnC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACxD,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAqB,CAAC;IACvE,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC1D,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC5D,eAAe,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACzC,qBAAqB,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;CAC/D,CAAC,CAAC"}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
2
|
/** @description Basic structure for credentials */
|
|
3
3
|
export declare class Credentials {
|
|
4
|
+
/** @description The username, used as the unique identifier for the account */
|
|
4
5
|
username: string;
|
|
6
|
+
/** @description The password that will be sent in future requests */
|
|
5
7
|
password: string;
|
|
6
8
|
}
|
|
7
9
|
export declare const CredentialsSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../src/models/registration/credentials.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,mDAAmD;AACnD,MAAa,WAAW;
|
|
1
|
+
{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../src/models/registration/credentials.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,mDAAmD;AACnD,MAAa,WAAW;CAKvB;AALD,kCAKC;AAEY,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
2
|
/** @description Basic structure for a resource to download */
|
|
3
3
|
export declare class ResourceDownload {
|
|
4
|
+
/** @deprecated This property is not used by the platform */
|
|
4
5
|
href?: string;
|
|
6
|
+
/** @description Base64 encoded data for the resource */
|
|
5
7
|
data?: string;
|
|
6
8
|
}
|
|
7
9
|
export declare const ResourceDownloadSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource-download.js","sourceRoot":"","sources":["../../src/models/resource-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,8DAA8D;AAC9D,MAAa,gBAAgB;
|
|
1
|
+
{"version":3,"file":"resource-download.js","sourceRoot":"","sources":["../../src/models/resource-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,8DAA8D;AAC9D,MAAa,gBAAgB;CAK5B;AALD,4CAKC;AAEY,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TaxIdentifierType } from './tax-identifier-type';
|
|
2
|
-
/** @description Entity representing a Tax Identification number, type, and country of registration
|
|
2
|
+
/** @description Entity representing a Tax Identification number, type, and country of registration */
|
|
3
3
|
export declare class TaxIdentifier {
|
|
4
4
|
/** @description Identification number */
|
|
5
5
|
id: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.TaxIdentifier = void 0;
|
|
4
|
-
/** @description Entity representing a Tax Identification number, type, and country of registration
|
|
4
|
+
/** @description Entity representing a Tax Identification number, type, and country of registration */
|
|
5
5
|
class TaxIdentifier {
|
|
6
6
|
}
|
|
7
7
|
exports.TaxIdentifier = TaxIdentifier;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tax-identifier.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier.ts"],"names":[],"mappings":";;;AAEA,
|
|
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"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
2
|
/** @description Latitude and longitude */
|
|
3
3
|
export declare class LatLong {
|
|
4
|
-
/** @description latitude */
|
|
4
|
+
/** @description The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html */
|
|
5
5
|
lat: number;
|
|
6
|
-
/** @description longitude */
|
|
6
|
+
/** @description The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html */
|
|
7
7
|
long: number;
|
|
8
8
|
}
|
|
9
9
|
export declare const LatLongSchema: Joi.ObjectSchema<any>;
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
2
|
/** @description Basic structure for a tracking service */
|
|
3
3
|
export declare class Service {
|
|
4
|
+
/** @description The code specific to a shipping provider service. */
|
|
4
5
|
code?: string;
|
|
6
|
+
/** @description The name of this shipping provider service. */
|
|
5
7
|
name?: string;
|
|
6
8
|
}
|
|
7
9
|
export declare const ServiceSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/models/tracking/service.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,0DAA0D;AAC1D,MAAa,OAAO;
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/models/tracking/service.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,0DAA0D;AAC1D,MAAa,OAAO;CAKnB;AALD,0BAKC;AACY,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
|
|
@@ -3,20 +3,29 @@ import { LatLong } from './lat-long';
|
|
|
3
3
|
import { StandardizedStatusCodes } from './standardized-status-codes';
|
|
4
4
|
/** @description Basic structure for tracking events */
|
|
5
5
|
export declare class TrackEvent {
|
|
6
|
+
/** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
|
|
6
7
|
event_datetime?: string;
|
|
8
|
+
/** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
|
|
7
9
|
event_datetime_local?: string;
|
|
10
|
+
/** @description Carrier's specific event code */
|
|
8
11
|
event_code?: string;
|
|
12
|
+
/** @description Description of the package status at this event */
|
|
9
13
|
description?: string;
|
|
14
|
+
/** @description City or Locality for this event */
|
|
10
15
|
city?: string;
|
|
11
16
|
/** @description State or province */
|
|
12
17
|
state?: string;
|
|
13
18
|
/** @description Zip or postal code */
|
|
14
19
|
postal_code?: string;
|
|
20
|
+
/** @description Country for this event */
|
|
15
21
|
country?: string;
|
|
22
|
+
/** @description The name of the company this is being delivered to */
|
|
16
23
|
company?: string;
|
|
24
|
+
/** @description If the event had a signer associated, normally on delivery */
|
|
17
25
|
signer?: string;
|
|
18
26
|
/** @description Geographical location */
|
|
19
27
|
geo?: LatLong;
|
|
28
|
+
/** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
|
|
20
29
|
status_code?: StandardizedStatusCodes;
|
|
21
30
|
}
|
|
22
31
|
export declare const TrackEventSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAiE;AAIjE,uDAAuD;AACvD,MAAa,UAAU;
|
|
1
|
+
{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAiE;AAIjE,uDAAuD;AACvD,MAAa,UAAU;CAyBtB;AAzBD,gCAyBC;AACY,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,GAAG,EAAE,gBAAa,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gCAA6B,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}
|
|
@@ -5,23 +5,41 @@ import { TrackEvent } from './track-event';
|
|
|
5
5
|
import Joi from 'joi';
|
|
6
6
|
/** @description Basic structure for tracking information */
|
|
7
7
|
export declare class TrackingInfo {
|
|
8
|
+
/** @description The human readable name of the carrier tracking this shipment. */
|
|
8
9
|
carrier_name?: string;
|
|
10
|
+
/** @description The carrier specific tracking identifier for this shipment. */
|
|
9
11
|
tracking_number?: string;
|
|
12
|
+
/** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
|
|
10
13
|
standardized_status_code: StandardizedStatusCodes;
|
|
14
|
+
/** @description The carrier specific status code of this shipment's tracking status. */
|
|
11
15
|
carrier_status_code?: string;
|
|
16
|
+
/** @description The human readable description of this shipment's tracking status. */
|
|
12
17
|
carrier_status_description?: string;
|
|
18
|
+
/** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
|
|
13
19
|
shipped_datetime?: string;
|
|
20
|
+
/** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
|
|
14
21
|
estimated_delivery_datetime?: string;
|
|
22
|
+
/** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
|
|
15
23
|
actual_delivery_datetime?: string;
|
|
24
|
+
/** @description A human readable description of why the shipment is in an error state. */
|
|
16
25
|
shipping_problem_description?: string;
|
|
26
|
+
/** @description The weight measured by the carrier of the package(s) in this shipment. */
|
|
17
27
|
weight?: number;
|
|
28
|
+
/** @description The dimensions measured by the carrier of the package(s) in this shipment. */
|
|
18
29
|
dimensions?: Dimensions;
|
|
30
|
+
/** @description A shipping provider specific service. */
|
|
19
31
|
service?: Service;
|
|
32
|
+
/** @description The carrier packaging code. */
|
|
20
33
|
packaging?: string;
|
|
34
|
+
/** @description The carrier observed count of packages in this shipment. */
|
|
21
35
|
package_count?: number;
|
|
36
|
+
/** @description A list of tracking events for this shipment */
|
|
22
37
|
events?: TrackEvent[];
|
|
38
|
+
/** @description Whether or not this shipment has entered an error state. */
|
|
23
39
|
shipping_problem?: boolean;
|
|
40
|
+
/** @description The unique identifying code for the type of error encountered by this shipment. */
|
|
24
41
|
shipping_problem_code?: string;
|
|
42
|
+
/** @description The human readable explanation of the error encountered by this shipment. */
|
|
25
43
|
error_description?: string;
|
|
26
44
|
}
|
|
27
45
|
export declare const TrackingInfoSchema: Joi.ObjectSchema<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;
|
|
1
|
+
{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;CAqCxB;AArCD,oCAqCC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,yDAA6B,CAAC,QAAQ,EAAE;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"update-method.js","sourceRoot":"","sources":["../../../src/models/tracking/update-method.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,qEAAqE;AACrE,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,kCAAiB,CAAA;IACjB,mEAAmE;IACnE,oCAAmB,CAAA;AACrB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAEY,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,
|
|
1
|
+
{"version":3,"file":"update-method.js","sourceRoot":"","sources":["../../../src/models/tracking/update-method.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,qEAAqE;AACrE,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,kCAAiB,CAAA;IACjB,mEAAmE;IACnE,oCAAmB,CAAA;AACrB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAEY,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC"}
|
|
@@ -2,8 +2,12 @@ import { Dimensions } from './dimensions';
|
|
|
2
2
|
import { DimensionUnit } from './dimension-unit';
|
|
3
3
|
/** @description Basic structure for package dimensions */
|
|
4
4
|
export declare class DimensionDetails {
|
|
5
|
+
/** @description This contains information about the dimensions in centimeters. This will always be present on the request */
|
|
5
6
|
dimensions_in_centimeters?: Dimensions;
|
|
7
|
+
/** @description This contains information about the dimensions in inches. This will always be present on the request */
|
|
6
8
|
dimensions_in_inches?: Dimensions;
|
|
9
|
+
/** @description This contains information about the dimensions in the source units. This will always be present on the request */
|
|
7
10
|
source_dimensions?: Dimensions;
|
|
11
|
+
/** @description The source units the customer provided */
|
|
8
12
|
source_dimension_unit: DimensionUnit;
|
|
9
13
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;
|
|
1
|
+
{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;CAS5B;AATD,4CASC"}
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
import { WeightUnit } from './weight-unit';
|
|
2
2
|
/** @description Basic structure for weight */
|
|
3
3
|
export declare class WeightDetails {
|
|
4
|
+
/** @description This contains information about the weight in ounces. This will always be present on the request */
|
|
4
5
|
weight_in_ounces?: number;
|
|
6
|
+
/** @description This contains information about the weight in grams. This will always be present on the request */
|
|
5
7
|
weight_in_grams?: number;
|
|
8
|
+
/** @description This contains information about the weight in source unit. This will always be present on the request */
|
|
6
9
|
source_weight?: number;
|
|
10
|
+
/** @description The source units the customer provided */
|
|
7
11
|
source_weight_unit: WeightUnit;
|
|
8
12
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;
|
|
1
|
+
{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;CASzB;AATD,sCASC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalize-tracking-data-response.js","sourceRoot":"","sources":["../../src/responses/normalize-tracking-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,
|
|
1
|
+
{"version":3,"file":"normalize-tracking-data-response.js","sourceRoot":"","sources":["../../src/responses/normalize-tracking-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAiG;AACjG,sDAAsB;AAEtB,qFAAqF;AACrF,MAAa,6BAA8B,SAAQ,4BAAY;CAQ9D;AARD,sEAQC;AAEY,QAAA,mCAAmC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACzE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAC/D,aAAa,EAAE,4BAAmB;CACnC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate-inbound-data-response.js","sourceRoot":"","sources":["../../src/responses/validate-inbound-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,
|
|
1
|
+
{"version":3,"file":"validate-inbound-data-response.js","sourceRoot":"","sources":["../../src/responses/validate-inbound-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAmF;AACnF,sDAAsB;AAEtB,2EAA2E;AAC3E,MAAa,2BAA4B,SAAQ,4BAAY;CAG5D;AAHD,kEAGC;AAEY,QAAA,iCAAiC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACvE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAA6B,CAAC;CAC3E,CAAC,CAAC"}
|
package/package.json
CHANGED