@shipengine/connect-carrier-api 4.16.6 → 4.16.8-beta.1

package/src/models/index.ts

@@ -1,37 +1,37 @@
-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';
-export * from './currency';
-export * from './customs';
-export * from './display-scheme-schema';
-export * from './display-scheme';
-export * from './documents';
-export * from './errors';
-export * from './fulfillment-plans';
-export * from './identifier-schema';
-export * from './identifier';
-export * from './inbound-content-types-schema';
-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';
-export * from './registration';
-export * from './relay-points';
-export * from './resource-download-schema';
-export * from './resource-download';
-export * from './taxes';
-export * from './time-window-schema';
-export * from './time-window';
-export * from './tracking';
-export * from './units';
-export * from './bill-to';
-export * from './labels/paperless-details';
+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';
+export * from './currency';
+export * from './customs';
+export * from './display-scheme-schema';
+export * from './display-scheme';
+export * from './documents';
+export * from './errors';
+export * from './fulfillment-plans';
+export * from './identifier-schema';
+export * from './identifier';
+export * from './inbound-content-types-schema';
+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';
+export * from './registration';
+export * from './relay-points';
+export * from './resource-download-schema';
+export * from './resource-download';
+export * from './taxes';
+export * from './time-window-schema';
+export * from './time-window';
+export * from './tracking';
+export * from './units';
+export * from './bill-to';
+export * from './labels/paperless-details';

package/src/models/insurance-providers.ts

@@ -1,9 +1,9 @@
-/** @description Who provides insurance */
-export enum InsuranceProviders {
-  None = 'None',
-  ShipStation = 'ShipStation',
-  Carrier = 'Carrier',
-  External = 'External',
-  XCover = 'XCover',
-  ParcelGuard = 'ParcelGuard',
-}
+/** @description Who provides insurance */
+export enum InsuranceProviders {
+  None = 'None',
+  ShipStation = 'ShipStation',
+  Carrier = 'Carrier',
+  External = 'External',
+  XCover = 'XCover',
+  ParcelGuard = 'ParcelGuard',
+}

package/src/models/labels/document-formats-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { DocumentFormat } from './document-formats';
-
-export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));
+import Joi from 'joi';
+import { DocumentFormat } from './document-formats';
+
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/labels/document-formats.ts

@@ -1,2 +1,2 @@
-/** @description Label data type */
-export { DocumentFormat } from '@shipengine/connect-runtime';
+/** @description Label data type */
+export { DocumentFormat } from '@shipengine/connect-runtime';

package/src/models/labels/form-download-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { ResourceDownloadSchema } from '../resource-download-schema';
-
-export const FormDownloadSchema = ResourceDownloadSchema.keys({
-  form_data: Joi.string().optional().empty(),
-});
+import Joi from 'joi';
+import { ResourceDownloadSchema } from '../resource-download-schema';
+
+export const FormDownloadSchema = ResourceDownloadSchema.keys({
+  form_data: Joi.string().optional().empty(),
+});

package/src/models/labels/form-download.ts

@@ -1,7 +1,7 @@
-import { ResourceDownload } from '../resource-download';
-
-/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
-export class FormDownload extends ResourceDownload {
-  /** @description The base64 encoded resource data. */
-  form_data?: string;
-}
+import { ResourceDownload } from '../resource-download';
+
+/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
+export class FormDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
+  form_data?: string;
+}

package/src/models/labels/index.ts

@@ -1,14 +1,14 @@
-export * from './document-formats-schema';
-export * from './document-formats';
-export * from './form-download-schema';
-export * from './form-download';
-export * from './label-download-schema';
-export * from './label-download';
-export * from './label-layouts';
-export * from './label-message';
-export * from './label-package-schema';
-export * from './label-package';
-export * from './return-label-details';
-export * from './void-request';
-export * from './void-response-schema';
-export * from './void-response';
+export * from './document-formats-schema';
+export * from './document-formats';
+export * from './form-download-schema';
+export * from './form-download';
+export * from './label-download-schema';
+export * from './label-download';
+export * from './label-layouts';
+export * from './label-message';
+export * from './label-package-schema';
+export * from './label-package';
+export * from './return-label-details';
+export * from './void-request';
+export * from './void-response-schema';
+export * from './void-response';

package/src/models/labels/label-download-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { ResourceDownloadSchema } from '../resource-download-schema';
-
-export const LabelDownloadSchema = ResourceDownloadSchema.keys({
-  label_data: Joi.string().optional().empty(),
-});
+import Joi from 'joi';
+import { ResourceDownloadSchema } from '../resource-download-schema';
+
+export const LabelDownloadSchema = ResourceDownloadSchema.keys({
+  label_data: Joi.string().optional().empty(),
+});

package/src/models/labels/label-download.ts

@@ -1,7 +1,7 @@
-import { ResourceDownload } from '../resource-download';
-
-/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
-export class LabelDownload extends ResourceDownload {
-  /** @description The base64 encoded resource data. */
-  label_data?: string;
-}
+import { ResourceDownload } from '../resource-download';
+
+/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
+export class LabelDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
+  label_data?: string;
+}

package/src/models/labels/label-layouts.ts

@@ -1,11 +1,11 @@
-/** @description Label sizes */
-export enum LabelLayouts {
-  /** @description 4x6 inches */
-  FourBySix = '4x6',
-  /** @description 8.5x11 inches */
-  Letter = 'letter',
-  /** @description A4 layout */
-  A4 = 'A4',
-  /** @description A6 layout */
-  A6 = 'A6',
-}
+/** @description Label sizes */
+export enum LabelLayouts {
+  /** @description 4x6 inches */
+  FourBySix = '4x6',
+  /** @description 8.5x11 inches */
+  Letter = 'letter',
+  /** @description A4 layout */
+  A4 = 'A4',
+  /** @description A6 layout */
+  A6 = 'A6',
+}

package/src/models/labels/label-message-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-
-export const LabelMessageSchema = Joi.object({
-  reference1: Joi.string().optional(),
-  reference2: Joi.string().optional(),
-  reference3: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export const LabelMessageSchema = Joi.object({
+  reference1: Joi.string().optional(),
+  reference2: Joi.string().optional(),
+  reference3: Joi.string().optional(),
+});

package/src/models/labels/label-message.ts

@@ -1,6 +1,6 @@
-/** @description References or messages that appear on a label */
-export class LabelMessage {
-  reference1?: string;
-  reference2?: string;
-  reference3?: string;
-}
+/** @description References or messages that appear on a label */
+export class LabelMessage {
+  reference1?: string;
+  reference2?: string;
+  reference3?: string;
+}

package/src/models/labels/label-package-schema.ts

@@ -1,10 +1,10 @@
-import Joi from 'joi';
-import { DocumentSchema } from '../documents/document-schema';
-import { IdentifierSchema } from '../identifier-schema';
-
-export const LabelPackageSchema = Joi.object({
-  tracking_number: Joi.string().optional().empty(),
-  tracking_url: Joi.string().optional().empty(),
-  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
-  documents: Joi.array().optional().items(DocumentSchema),
-});
+import Joi from 'joi';
+import { DocumentSchema } from '../documents/document-schema';
+import { IdentifierSchema } from '../identifier-schema';
+
+export const LabelPackageSchema = Joi.object({
+  tracking_number: Joi.string().optional().empty(),
+  tracking_url: Joi.string().optional().empty(),
+  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
+  documents: Joi.array().optional().items(DocumentSchema),
+});

package/src/models/labels/label-package.ts

@@ -1,17 +1,17 @@
-import { Identifier } from '../identifier';
-import { Document } from '../documents';
-import { PaperlessDetails } from './paperless-details';
-
-/** @description Package information provided by the carrier */
-export class LabelPackage {
-  /** @description Tracking number for the package */
-  tracking_number?: string;
-  /** @description Tracking URL for the package */
-  tracking_url?: string;
-  /** @description Non-tracking alternative ids associated with this package */
-  alternative_identifiers?: Identifier[];
-  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
-  documents?: Document[];
-  /** @description Paperless details */
-  paperless_details?: PaperlessDetails;
-}
+import { Identifier } from '../identifier';
+import { Document } from '../documents';
+import { PaperlessDetails } from './paperless-details';
+
+/** @description Package information provided by the carrier */
+export class LabelPackage {
+  /** @description Tracking number for the package */
+  tracking_number?: string;
+  /** @description Tracking URL for the package */
+  tracking_url?: string;
+  /** @description Non-tracking alternative ids associated with this package */
+  alternative_identifiers?: Identifier[];
+  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
+  documents?: Document[];
+  /** @description Paperless details */
+  paperless_details?: PaperlessDetails;
+}

package/src/models/labels/paperless-details-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const PaperlessDetailsSchema = Joi.object({
-  instructions: Joi.string().optional(),
-  handoffCode: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export const PaperlessDetailsSchema = Joi.object({
+  instructions: Joi.string().optional(),
+  handoffCode: Joi.string().optional(),
+});

package/src/models/labels/paperless-details.ts

@@ -1,5 +1,5 @@
-/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
-export class PaperlessDetails {
-  instructions!: string;
-  handoff_code!: string;
-}
+/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
+export class PaperlessDetails {
+  instructions!: string;
+  handoff_code!: string;
+}

package/src/models/labels/return-label-details.ts

@@ -1,5 +1,5 @@
-/** @description Basic structure for a return label */
-export class ReturnLabelDetails {
-  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
-  rma_number?: string;
-}
+/** @description Basic structure for a return label */
+export class ReturnLabelDetails {
+  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
+  rma_number?: string;
+}

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

@@ -1,12 +1,10 @@
-import { ShippedShipment } from '../pickup/shipped-shipment';
-import { ShipFrom } from '../addresses';
-
-/** @description Basic structure for a request to void a label */
-export class VoidRequest extends ShippedShipment {
-  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
-  void_request_id!: string;
-  /** @description The location the shipment was shipped from */
-  ship_from!: ShipFrom;
-  /** @description The shipment's user provided reference */
-  reference?: string;
-}
+import { ShippedShipment } from '../pickup/shipped-shipment';
+import { ShipFrom } from '../addresses';
+
+/** @description Basic structure for a request to void a label */
+export class VoidRequest extends ShippedShipment {
+  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
+  void_request_id!: string;
+  /** @description The location the shipment was shipped from */
+  ship_from!: ShipFrom;
+}

package/src/models/labels/void-response-schema.ts

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-import { BillingLineItemSchema } from '../billing/billing-line-item-schema';
-
-export const VoidResponseSchema = Joi.object({
-  void_request_id: Joi.string().required(),
-  message: Joi.string().optional().empty(),
-  errors: Joi.array().optional().items(Joi.string()),
-  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
-});
+import Joi from 'joi';
+import { BillingLineItemSchema } from '../billing/billing-line-item-schema';
+
+export const VoidResponseSchema = Joi.object({
+  void_request_id: Joi.string().required(),
+  message: Joi.string().optional().empty(),
+  errors: Joi.array().optional().items(Joi.string()),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

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

@@ -1,13 +1,13 @@
-import { BillingLineItem } from '../billing';
-
-/** @description Basic structure for a response to void a label */
-export class VoidResponse {
-  /** @description Id for the void response */
-  void_request_id!: string;
-  /** @description Void message, if applicable */
-  message?: string;
-  /** @description Any errors from attempting to void */
-  errors?: string[];
-  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
-  billing_line_items?: BillingLineItem[];
-}
+import { BillingLineItem } from '../billing';
+
+/** @description Basic structure for a response to void a label */
+export class VoidResponse {
+  /** @description Id for the void response */
+  void_request_id!: string;
+  /** @description Void message, if applicable */
+  message?: string;
+  /** @description Any errors from attempting to void */
+  errors?: string[];
+  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
+  billing_line_items?: BillingLineItem[];
+}

package/src/models/manifest-status-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { ManifestStatus } from './manifest-status';
-
-export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));
+import Joi from 'joi';
+import { ManifestStatus } from './manifest-status';
+
+export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));

package/src/models/manifest-status.ts

@@ -1,8 +1,8 @@
-/** @description Possible status values for Created Manifest */
-export enum ManifestStatus {
-  /** @description Unknown, The request is in process */
-  Unknown = 'unknown',
-  InProgress = 'in_progress',
-  Completed = 'completed',
-  Failed = 'failed',
-}
+/** @description Possible status values for Created Manifest */
+export enum ManifestStatus {
+  /** @description Unknown, The request is in process */
+  Unknown = 'unknown',
+  InProgress = 'in_progress',
+  Completed = 'completed',
+  Failed = 'failed',
+}

package/src/models/manifests/index.ts

@@ -1,6 +1,6 @@
-export * from './label';
-export * from './manifest-error-schema';
-export * from './manifest-error';
-export * from './manifest-request-shipment';
-export * from './manifest-schema';
-export * from './manifest';
+export * from './label';
+export * from './manifest-error-schema';
+export * from './manifest-error';
+export * from './manifest-request-shipment';
+export * from './manifest-schema';
+export * from './manifest';

package/src/models/manifests/label.ts

@@ -1,7 +1,7 @@
-/** @description Basic structure of a manifest label */
-export class Label {
-  /** @description The carrier tracking number for this shipment */
-  tracking_number?: string;
-  /** @description The carrier specific identifier for this shipment */
-  carrier_transaction_id?: string;
-}
+/** @description Basic structure of a manifest label */
+export class Label {
+  /** @description The carrier tracking number for this shipment */
+  tracking_number?: string;
+  /** @description The carrier specific identifier for this shipment */
+  carrier_transaction_id?: string;
+}

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

@@ -1,21 +1,21 @@
-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(),
-  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(),
-});
+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(),
+  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

@@ -1,33 +1,33 @@
-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 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;
-}
+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 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-error-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const ManifestErrorSchema = Joi.object({
-  manifest_request_shipment_ids: Joi.array().required(),
-  message: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export const ManifestErrorSchema = Joi.object({
+  manifest_request_shipment_ids: Joi.array().required(),
+  message: Joi.string().optional(),
+});

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

@@ -1,4 +1,4 @@
-export interface ManifestError {
-  manifest_request_shipment_ids: string[];
-  message: string;
-}
+export interface ManifestError {
+  manifest_request_shipment_ids: string[];
+  message: string;
+}