@shipengine/js-api 4.22.1 → 4.23.1-next.0

package/errors/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * @category Entities
  */
-export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "billing_info_not_found" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_name" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "funding_source_registration_in_progress" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "insurance_failure" | "invalid_address" | "invalid_billing_info" | "invalid_billing_plan" | "invalid_currency" | "invalid_field_value" | "invalid_file_size" | "invalid_file_type" | "invalid_identifier" | "invalid_packages" | "invalid_rates" | "invalid_service" | "invalid_shipping_rule" | "invalid_status" | "invalid_string_length" | "invalid_weight_bands_rates" | "invalid_weight_bands" | "invalid_zones" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "repeated_surcharges_in_rate_card" | "repeated_surcharges_in_services" | "repeated_surcharges_in_zone" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict" | "system_api_error" | "inactive_addon_error" | "addons_disabling_missing_seller_addon_error" | "addons_disabling_inactive_addon_error" | "addons_disabling_general_error" | "request_seller_feature_error" | "refund_assist_already_enabled" | "refund_assist_not_available" | "refund_assist_not_enabled";
+export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "billing_info_not_found" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_name" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "funding_source_registration_in_progress" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "insurance_failure" | "invalid_address" | "invalid_billing_info" | "invalid_billing_plan" | "invalid_currency" | "invalid_field_value" | "invalid_file_size" | "invalid_file_type" | "invalid_identifier" | "invalid_label_refund_status" | "invalid_packages" | "invalid_rates" | "invalid_service" | "invalid_shipping_rule" | "invalid_status" | "invalid_string_length" | "invalid_weight_bands_rates" | "invalid_weight_bands" | "invalid_zones" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "repeated_surcharges_in_rate_card" | "repeated_surcharges_in_services" | "repeated_surcharges_in_zone" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict" | "system_api_error" | "inactive_addon_error" | "addons_disabling_missing_seller_addon_error" | "addons_disabling_inactive_addon_error" | "addons_disabling_general_error" | "request_seller_feature_error" | "refund_assist_already_enabled" | "refund_assist_not_available" | "refund_assist_not_enabled";
 /**
  * @category Entities
  */

package/index.js

@@ -3911,6 +3911,12 @@ class LabelsAPI {
     this.void = (labelId) => {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
+    /**
+     * The `cancelRefund` method allows a user to cancel a refund request for a label by `labelId`.
+     */
+    this.cancelRefund = (labelId) => {
+      return this.client.post(`/v1/labels/${labelId}/cancel_refund`);
+    };
     /**
      * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */

package/index.mjs

@@ -3907,6 +3907,12 @@ class LabelsAPI {
     this.void = (labelId) => {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
+    /**
+     * The `cancelRefund` method allows a user to cancel a refund request for a label by `labelId`.
+     */
+    this.cancelRefund = (labelId) => {
+      return this.client.post(`/v1/labels/${labelId}/cancel_refund`);
+    };
     /**
      * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */

package/labels/api.d.ts

@@ -32,6 +32,10 @@ export declare class LabelsAPI {
      * The `void` method allows a user to void a label by `labelId`.
      */
     void: (labelId: string) => Promise<import("axios").AxiosResponse<VoidRequest, any>>;
+    /**
+     * The `cancelRefund` method allows a user to cancel a refund request for a label by `labelId`.
+     */
+    cancelRefund: (labelId: string) => Promise<import("axios").AxiosResponse<Label, any>>;
     /**
      * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */

package/labels/types.d.ts

@@ -10,6 +10,8 @@ export type LabelFormat = "pdf" | "png" | "zpl";
 export type LabelLayout = "4x6" | "letter";
 export type LabelStatus = "processing" | "completed" | "error" | "voided";
 export type LabelTrackingStatus = "unknown" | "in_transit" | "delivered" | "error";
+export type LabelVoidType = "refund_assist" | "manual";
+export type RefundStatus = "request_scheduled" | "pending" | "approved" | "rejected" | "excluded";
 /**
  * Columns available for label exports
  */
@@ -94,11 +96,9 @@ export type ListLabelsParams = {
     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"
+     * Can be a single status or multiple comma-separated statuses
      */
-    refundStatus?: string;
+    refundStatus?: RefundStatus[] | RefundStatus;
     /**
      * `serviceCode` is an optional string to limit results to only labels for
      * a specific carrier service.
@@ -165,8 +165,6 @@ 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;

package/package.json

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