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

package/src/models/errors/standardized-error-code.ts

@@ -1,16 +1,16 @@
-/** @deprecated Please Use Runtime Errors */
-export enum StandardizedErrorCode {
-  Generic = 0,
-  Serialization = 1,
-  UnhandledModuleException = 2,
-  Validation = 3,
-  ExternalBadRequest = 400,
-  ExternalUnauthorized = 401,
-  ExternalUnprocessableEntity = 422,
-  ExternalTooManyRequests = 429,
-  ExternalNotImplemented = 501,
-  ExternalBadGateway = 502,
-  ExternalServiceUnavailable = 503,
-  ExternalGatewayTimeout = 504,
-  ExternalServerError = 520,
-}
+/** @deprecated Please Use Runtime Errors */
+export enum StandardizedErrorCode {
+  Generic = 0,
+  Serialization = 1,
+  UnhandledModuleException = 2,
+  Validation = 3,
+  ExternalBadRequest = 400,
+  ExternalUnauthorized = 401,
+  ExternalUnprocessableEntity = 422,
+  ExternalTooManyRequests = 429,
+  ExternalNotImplemented = 501,
+  ExternalBadGateway = 502,
+  ExternalServiceUnavailable = 503,
+  ExternalGatewayTimeout = 504,
+  ExternalServerError = 520,
+}

package/src/models/fulfillment-plans/fulfillment-plan-details.ts

@@ -1,13 +1,13 @@
-import { Identifier } from '../identifier';
-import { FulfillmentPlanItems } from './fulfillment-plan-items';
-import { RawExternalSource } from './raw-external-source';
-
-/** @description This model contains information about the fulfillment plan. */
-export class FulfillmentPlanDetails {
-  /** @description A list of identifiers for the sales order. */
-  external_sales_order_identifiers?: Identifier[];
-  /** @description Information about the fulfillment plan item. */
-  items?: FulfillmentPlanItems[];
-  /** @description This model represents a raw external source of information */
-  raw_external_source?: RawExternalSource;
-}
+import { Identifier } from '../identifier';
+import { FulfillmentPlanItems } from './fulfillment-plan-items';
+import { RawExternalSource } from './raw-external-source';
+
+/** @description This model contains information about the fulfillment plan. */
+export class FulfillmentPlanDetails {
+  /** @description A list of identifiers for the sales order. */
+  external_sales_order_identifiers?: Identifier[];
+  /** @description Information about the fulfillment plan item. */
+  items?: FulfillmentPlanItems[];
+  /** @description This model represents a raw external source of information */
+  raw_external_source?: RawExternalSource;
+}

package/src/models/fulfillment-plans/fulfillment-plan-items.ts

@@ -1,13 +1,13 @@
-import { Identifier } from '../identifier';
-
-/** @description Information about the fulfillment plan for a set of items */
-export class FulfillmentPlanItems {
-  /** @description A list of identifiers for the sales order */
-  external_sales_order_identifiers?: Identifier[];
-  /** @description A list of identifiers specific to the selling channel */
-  external_product_identifiers?: Identifier[];
-  /** @description The name of the item */
-  name?: string;
-  /** @description The number of items */
-  quantity?: number;
-}
+import { Identifier } from '../identifier';
+
+/** @description Information about the fulfillment plan for a set of items */
+export class FulfillmentPlanItems {
+  /** @description A list of identifiers for the sales order */
+  external_sales_order_identifiers?: Identifier[];
+  /** @description A list of identifiers specific to the selling channel */
+  external_product_identifiers?: Identifier[];
+  /** @description The name of the item */
+  name?: string;
+  /** @description The number of items */
+  quantity?: number;
+}

package/src/models/fulfillment-plans/index.ts

@@ -1,3 +1,3 @@
-export * from './fulfillment-plan-details';
-export * from './fulfillment-plan-items';
-export * from './raw-external-source';
+export * from './fulfillment-plan-details';
+export * from './fulfillment-plan-items';
+export * from './raw-external-source';

package/src/models/fulfillment-plans/raw-external-source.ts

@@ -1,5 +1,5 @@
-/** @description This model represents a raw external source of information. */
-export class RawExternalSource {
-  /** @description Canonical representation of the fulfillment plan's and/or sales order's original source */
-  marketplace_code?: string;
-}
+/** @description This model represents a raw external source of information. */
+export class RawExternalSource {
+  /** @description Canonical representation of the fulfillment plan's and/or sales order's original source */
+  marketplace_code?: string;
+}

package/src/models/identifier-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const IdentifierSchema = Joi.object({
-  type: Joi.string().required(),
-  value: Joi.string().required(),
-});
+import Joi from 'joi';
+
+export const IdentifierSchema = Joi.object({
+  type: Joi.string().required(),
+  value: Joi.string().required(),
+});

package/src/models/identifier.ts

@@ -1,5 +1,5 @@
-/** @description Key value pair to allow custom properties */
-export class Identifier {
-  type!: string;
-  value!: string;
-}
+/** @description Key value pair to allow custom properties */
+export class Identifier {
+  type!: string;
+  value!: string;
+}

package/src/models/importer-records/importer-of-record-schema.ts

@@ -1,16 +1,16 @@
-import Joi from 'joi';
-import { TaxIdentifierSchema } from '../taxes/tax-identifier-schema';
-
-export const ImporterOfRecordSchema = Joi.object({
-  tax_identifiers: Joi.array().items(TaxIdentifierSchema).optional(),
-  name: Joi.string().optional(),
-  company_name: Joi.string().optional(),
-  address_line1: Joi.string().required(),
-  address_line2: Joi.string().optional(),
-  city_locality: Joi.string().optional(),
-  state_province: Joi.string().optional(),
-  postal_code: Joi.string().optional(),
-  country_code: Joi.string().optional(),
-  phone: Joi.string().optional(),
-  email: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { TaxIdentifierSchema } from '../taxes/tax-identifier-schema';
+
+export const ImporterOfRecordSchema = Joi.object({
+  tax_identifiers: Joi.array().items(TaxIdentifierSchema).optional(),
+  name: Joi.string().optional(),
+  company_name: Joi.string().optional(),
+  address_line1: Joi.string().required(),
+  address_line2: Joi.string().optional(),
+  city_locality: Joi.string().optional(),
+  state_province: Joi.string().optional(),
+  postal_code: Joi.string().optional(),
+  country_code: Joi.string().optional(),
+  phone: Joi.string().optional(),
+  email: Joi.string().optional(),
+});

package/src/models/importer-records/importer-of-record.ts

@@ -1,27 +1,27 @@
-import { TaxIdentifier } from '../taxes/tax-identifier';
-
-/** @description Basic structure for a Importer Records */
-export class ImporterOfRecord {
-  /** @description Tax Ids associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record) */
-  tax_identifiers?: TaxIdentifier[];
-  /** @description Indicates Name of the owner or purchaser of the products being imported into a destination country */
-  name?: string;
-  /** @description Indicates Company Name of the owner or purchaser of the products being imported into a destination country*/
-  company_name?: string;
-  /** @description Indicates address line one of the owner or purchaser of the products being imported into a destination country*/
-  address_line1?: string;
-  /** @description Indicates address  of the owner or purchaser of the products being imported into a destination country*/
-  address_line2?: string;
-  /** @description Indicates City  or Locality  of the owner or purchaser of the products being imported into a destination country */
-  city_locality?: string;
-  /** @description Indicates statate or providence  of the owner or purchaser of the products being imported into a destination country */
-  state_province?: string;
-  /** @description : Indicates postal code of the owner or purchaser of the products being imported into a destination country*/
-  postal_code?: string;
-  /** @description : Indicates country code of the owner or purchaser of the products being imported into a destination country*/
-  country_code?: string;
-  /** @description : Indicates phone number of the owner or purchaser of the products being imported into a destination country*/
-  phone?: string;
-  /** @description : Email associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)*/
-  email?: string;
-}
+import { TaxIdentifier } from '../taxes/tax-identifier';
+
+/** @description Basic structure for a Importer Records */
+export class ImporterOfRecord {
+  /** @description Tax Ids associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record) */
+  tax_identifiers?: TaxIdentifier[];
+  /** @description Indicates Name of the owner or purchaser of the products being imported into a destination country */
+  name?: string;
+  /** @description Indicates Company Name of the owner or purchaser of the products being imported into a destination country*/
+  company_name?: string;
+  /** @description Indicates address line one of the owner or purchaser of the products being imported into a destination country*/
+  address_line1?: string;
+  /** @description Indicates address  of the owner or purchaser of the products being imported into a destination country*/
+  address_line2?: string;
+  /** @description Indicates City  or Locality  of the owner or purchaser of the products being imported into a destination country */
+  city_locality?: string;
+  /** @description Indicates statate or providence  of the owner or purchaser of the products being imported into a destination country */
+  state_province?: string;
+  /** @description : Indicates postal code of the owner or purchaser of the products being imported into a destination country*/
+  postal_code?: string;
+  /** @description : Indicates country code of the owner or purchaser of the products being imported into a destination country*/
+  country_code?: string;
+  /** @description : Indicates phone number of the owner or purchaser of the products being imported into a destination country*/
+  phone?: string;
+  /** @description : Email associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)*/
+  email?: string;
+}

package/src/models/inbound-content-types-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { InboundDataContentTypes } from './inbound-content-types';
-
-export const InboundDataContentTypesSchema = Joi.string().valid(
-  ...Object.values(InboundDataContentTypes),
-);
+import Joi from 'joi';
+import { InboundDataContentTypes } from './inbound-content-types';
+
+export const InboundDataContentTypesSchema = Joi.string().valid(
+  ...Object.values(InboundDataContentTypes),
+);

package/src/models/inbound-content-types.ts

@@ -1,5 +1,5 @@
-/** @description Types of inbound content */
-export enum InboundDataContentTypes {
-  /** @description Tracking information */
-  Tracking = 'tracking',
-}
+/** @description Types of inbound content */
+export enum InboundDataContentTypes {
+  /** @description Tracking information */
+  Tracking = 'tracking',
+}

package/src/models/inconterms/terms-of-trade-code-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { TermsOfTradeCode } from './terms-of-trade-code';
-
-export const TermsOfTradeCodeSchema = Joi.string().valid(...Object.values(TermsOfTradeCode));
+import Joi from 'joi';
+import { TermsOfTradeCode } from './terms-of-trade-code';
+
+export const TermsOfTradeCodeSchema = Joi.string().valid(...Object.values(TermsOfTradeCode));

package/src/models/inconterms/terms-of-trade-code.ts

@@ -1,35 +1,35 @@
-/** @description Specifies the supported terms of trade codes (incoterms)*/
-export enum TermsOfTradeCode {
-  /** @description EX-WORKS incoterm  */
-  EXW = 'exw',
-
-  /** @description FREE CARRIER incoterm  */
-  FCA = 'fca',
-  /** @description CARRIAGE PAID TO incoterm */
-  CPT = 'cpt',
-  /** @description CARRIAGE AND INSURANCE PAID TO incoterm  */
-  CIP = 'cip',
-  /** @description DELIVERED PLACE UNLOADED incoterm, old name: DAT  */
-  DPU = 'dpu',
-  /** @description DELIVERED AT PLACE incoterm*/
-  DAP = 'dap',
-  /** @description DELIVERED DUTY PAID incoterm*/
-
-  DDP = 'ddp',
-  /** @description FREE ALONGSIDE SHIP incoterm (incoterm used for sea/inland waterway transport)     */
-  FAS = 'fas',
-  /** @description FREE ON BOARD incoterm (incoterm used for sea/inland waterway transport)     */
-  FOB = 'fob',
-  /** @description COST AND FREIGHT incoterm (incoterm used for sea/inland waterway transport)     */
-  CFR = 'cfr',
-  /** @description COST INSURANCE AND FREIGHT incoterm (incoterm used for sea/inland waterway transport)    */
-  CIF = 'cif',
-  /** @description DELIVERED DUTY UNPAID incoterm (incoterm retired in 2010)     */
-  DDU = 'ddu',
-  /** @description DELIVERED AT FRONTIER incoterm (incoterm retired in 2010)     */
-  DAF = 'daf',
-  /** @description DELIVERED EX QUAY incoterm (incoterm retired in 2010)     */
-  DEQ = 'deq',
-  /** @description DELIVERED EX SHIP incoterm (incoterm retired in 2010)     */
-  DES = 'des',
-}
+/** @description Specifies the supported terms of trade codes (incoterms)*/
+export enum TermsOfTradeCode {
+  /** @description EX-WORKS incoterm  */
+  EXW = 'exw',
+
+  /** @description FREE CARRIER incoterm  */
+  FCA = 'fca',
+  /** @description CARRIAGE PAID TO incoterm */
+  CPT = 'cpt',
+  /** @description CARRIAGE AND INSURANCE PAID TO incoterm  */
+  CIP = 'cip',
+  /** @description DELIVERED PLACE UNLOADED incoterm, old name: DAT  */
+  DPU = 'dpu',
+  /** @description DELIVERED AT PLACE incoterm*/
+  DAP = 'dap',
+  /** @description DELIVERED DUTY PAID incoterm*/
+
+  DDP = 'ddp',
+  /** @description FREE ALONGSIDE SHIP incoterm (incoterm used for sea/inland waterway transport)     */
+  FAS = 'fas',
+  /** @description FREE ON BOARD incoterm (incoterm used for sea/inland waterway transport)     */
+  FOB = 'fob',
+  /** @description COST AND FREIGHT incoterm (incoterm used for sea/inland waterway transport)     */
+  CFR = 'cfr',
+  /** @description COST INSURANCE AND FREIGHT incoterm (incoterm used for sea/inland waterway transport)    */
+  CIF = 'cif',
+  /** @description DELIVERED DUTY UNPAID incoterm (incoterm retired in 2010)     */
+  DDU = 'ddu',
+  /** @description DELIVERED AT FRONTIER incoterm (incoterm retired in 2010)     */
+  DAF = 'daf',
+  /** @description DELIVERED EX QUAY incoterm (incoterm retired in 2010)     */
+  DEQ = 'deq',
+  /** @description DELIVERED EX SHIP incoterm (incoterm retired in 2010)     */
+  DES = 'des',
+}

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),
+});