@shipengine/js-api - npm Package Compare versions

Comparing version 4.33.0 to 4.34.0

carriers/api.d.ts

 import { AxiosInstance } from "axios";
 import { Currency, Money } from "../payments";
 import { SandboxableQuery } from "../resources";
-import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierTerm, CarrierZone, PackageRatingType } from "./types";
+import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierTerm, CarrierZone, ListCarriersQueryParams, PackageRatingType } from "./types";
 /**
@@ -14,3 +14,3 @@ * # Carriers API module - /v1/carriers
      */
-    list: (props?: SandboxableQuery) => Promise<import("axios").AxiosResponse<{
+    list: (props?: SandboxableQuery<ListCarriersQueryParams>) => Promise<import("axios").AxiosResponse<{
         carriers: Carrier[];
@@ -17,0 +17,0 @@ }, any>>;

carriers/types.d.ts

@@ -144,2 +144,25 @@ import { Address } from "../addresses";
 /**
+ * @category Queries
+ */
+export interface ListCarriersQueryParams {
+    /**
+     * Include account balance information in the response.
+     * @default true
+     */
+    includeBalance?: boolean;
+    /**
+     * Include extended carrier details (packages and advanced options) in the response.
+     * Setting to false reduces payload size by approximately 80%.
+     * @default true
+     */
+    includeExtendedDetails?: boolean;
+    /**
+     * Filter carriers by wallet type.
+     * - `true`: Returns only wallet carriers (carriers with fundingSourceId)
+     * - `false`: Returns only BYOA carriers (carriers without fundingSourceId)
+     * - `undefined`: Returns all carriers (default behavior)
+     */
+    isWallet?: boolean;
+}
+/**
  * @category Responses
@@ -146,0 +169,0 @@ */

package.json

 {
   "name": "@shipengine/js-api",
-  "version": "4.33.0",
+  "version": "4.34.0",
   "main": "./index.js",
@@ -5,0 +5,0 @@ "types": "./index.d.ts",

No alert changes

Improved metrics

Total package byte prevSize

1623429

0.06%

Lines of code

46006

0.06%

No dependency changes