@shipengine/js-api 1.24.0 → 1.26.0

package/addresses/types.d.ts

@@ -1,3 +1,4 @@
+export type AddressResidentialIndicator = "yes" | "no" | "unknown";
 /**
  * @category Entities
  */
@@ -5,7 +6,7 @@ export interface Address {
     addressLine1: string;
     addressLine2?: string;
     addressLine3?: string;
-    addressResidentialIndicator?: "yes" | "no" | "unknown";
+    addressResidentialIndicator?: AddressResidentialIndicator;
     cityLocality: string;
     companyName?: string;
     countryCode: string;
@@ -81,7 +82,7 @@ export interface AddressExtraction {
         type: "postal_code";
     } | {
         result: {
-            value: "yes" | "no" | "unknown";
+            value: AddressResidentialIndicator;
         };
         type: "residential_indicator";
     } | {

package/carriers/types.d.ts

@@ -1,5 +1,6 @@
 import { Address } from "../addresses";
 import { DimensionsWithUnit } from "../dimensions";
+import { LabelDisplayScheme } from "../labels";
 import { CreditCard, Money } from "../payments";
 import { WeightWithUnit } from "../weight";
 /**
@@ -32,6 +33,7 @@ export interface CarrierAutoFundingSettingsResponse {
 export interface CarrierService {
     carrierCode: string;
     carrierId: string;
+    displaySchemes: LabelDisplayScheme[];
     domestic: boolean;
     international: boolean;
     isMultiPackageSupported: boolean;

package/labels/types.d.ts

@@ -5,7 +5,7 @@ import { CreationRangeQuery, Download, LinkedResource, PageableQuery, PageableRe
 import { ShipmentPackage } from "../shipments";
 import { RateDetail } from "../types";
 export type LabelChargeEvent = "carrier_default" | "on_creation" | "on_carrier_acceptance";
-export type LabelDisplayScheme = "label" | "qr_code" | "label_and_paperless";
+export type LabelDisplayScheme = "label" | "paperless" | "qr_code" | "label_and_paperless";
 export type LabelFormat = "pdf" | "png" | "zpl";
 export type LabelLayout = "4x6" | "letter";
 export type LabelStatus = "processing" | "completed" | "error" | "voided";
@@ -106,7 +106,7 @@ export interface CreateLabelOptions {
     /**
      * `displayScheme` is an optional string to control the display scheme of the label.
      */
-    displayScheme?: string;
+    displayScheme?: LabelDisplayScheme;
     /**
      * `labelDownloadType` is an optional string to control the download type of the label.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "1.24.0",
+  "version": "1.26.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/rates/types.d.ts

@@ -1,6 +1,8 @@
+import { AddressResidentialIndicator } from "../addresses";
 import { DimensionsWithUnit } from "../dimensions";
 import { CodedError } from "../errors";
 import { Currency, Money } from "../payments";
+import { ConfirmationType } from "../shipments";
 import { WeightWithUnit } from "../weight";
 export type RateType = "check" | "shipment";
 export type RateDetailType = "uncategorized" | "shipping" | "insurance" | "confirmation" | "discount" | "fuel_charge" | "additional_fees" | "tariff" | "tax" | "delivery" | "handling" | "special_goods" | "pickup" | "location_fee" | "oversize" | "returns" | "notifications" | "tip" | "duties_and_taxes" | "brokerage_fee" | "admin_fee" | "adjustment";
@@ -81,9 +83,9 @@ export interface CalculateRatesOptions {
     serviceCodes?: string[];
 }
 export interface RatesEstimateParams {
-    addressResidentialIndicator: string;
+    addressResidentialIndicator: AddressResidentialIndicator;
     carrierIds: string[];
-    confirmation: string;
+    confirmation: ConfirmationType;
     dimensions: DimensionsWithUnit;
     fromCityLocality: string;
     fromCountryCode: string;