@shipengine/js-api 4.22.0 → 4.22.1

package/labels/types.d.ts

@@ -39,6 +39,7 @@ export type Label = {
     paperlessDownload: PaperlessDownload | null;
     qrCodeDownload?: LinkedResource;
     rateDetails: RateDetail[];
+    refundDetails: RefundDetails | null;
     relayPoints: {
         shipFrom: RelayPoint;
         shipTo: RelayPoint;
@@ -58,6 +59,7 @@ export type Label = {
     trackingUrl: string;
     voided: boolean;
     voidedAt: string | null;
+    voidType: LabelVoidType | null;
 };
 export type PaperlessDownload = {
     handoffCode: string;
@@ -90,6 +92,13 @@ export type ListLabelsParams = {
      * specific rate.
      */
     rateId?: string;
+    /**
+     * `refundStatus` is an optional string to filter results by refund status.
+     * Can be a single status or multiple comma-separated statuses.
+     * @example "pending"
+     * @example "pending,approved"
+     */
+    refundStatus?: string;
     /**
      * `serviceCode` is an optional string to limit results to only labels for
      * a specific carrier service.
@@ -156,3 +165,13 @@ export type ExportLabelsParams = {
      */
     labelId?: string;
 } & ListLabelsParams;
+export type LabelVoidType = "refund_assist" | "manual";
+export type RefundStatus = "request_scheduled" | "pending" | "approved" | "rejected" | "excluded";
+export type RefundDetails = {
+    amountApproved: Money | null;
+    amountCredited: Money | null;
+    amountPaid: Money | null;
+    amountRequested: Money | null;
+    refundStatus: RefundStatus;
+    requestDate: string;
+};

package/package.json

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