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

package/account-refund-assist/api.d.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { GetRefundAssistResponse } from "./types";
+/**
+ * # Account Refund Assist API module - /v1/account/refund_assist
+ */
+export declare class AccountRefundAssistAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the refund assist configuration for all carriers,
+     * including if it is enabled for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#1.--Retrieve-RA-settings-information-(with-carrier-and-RA-details)
+     */
+    get: () => Promise<import("axios").AxiosResponse<GetRefundAssistResponse, any>>;
+    /**
+     * The `enable` method enables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#2.--Enable-RA-for-a-seller
+     */
+    enable: () => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `disable` method disables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#3.--Disable-RA-for-a-seller
+     */
+    disable: () => Promise<import("axios").AxiosResponse<void, any>>;
+}

package/account-refund-assist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/account-refund-assist/types.d.ts

@@ -0,0 +1,10 @@
+/** @internal */
+export type RefundAssistCarrier = {
+    carrierId: string;
+    enabled: boolean;
+    nickname: string;
+};
+/** @internal */
+export type GetRefundAssistResponse = {
+    refundAssistCarriers: RefundAssistCarrier[];
+};

package/client.d.ts

@@ -3,6 +3,7 @@ import { AccountAddonsAPI } from "./account-addons";
 import { AccountBillingAPI } from "./account-billing";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountFeaturesAPI } from "./account-features";
+import { AccountRefundAssistAPI } from "./account-refund-assist";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { AuctanePayAPI } from "./auctane-pay";
@@ -127,6 +128,11 @@ export declare class ShipEngineAPI {
      * in ShipEngine API.
      */
     get accountBilling(): AccountBillingAPI;
+    /**
+     * The `accountRefundAssist` method provides access to the Account Refund Assist endpoints
+     * in ShipEngine API.
+     */
+    get accountRefundAssist(): AccountRefundAssistAPI;
     /**
      * The `addresses` method provides access to the Address Validation endpoints
      * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

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";
+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";
 /**
  * @category Entities
  */

package/index.d.ts

@@ -2,6 +2,7 @@ export * as SE from "./types";
 export * from "./account-settings";
 export * from "./account-addons";
 export * from "./account-features";
+export * from "./account-refund-assist";
 export * from "./addresses";
 export * from "./auctane-pay";
 export * from "./account-billing-plan";

package/index.js

@@ -269,6 +269,35 @@ class AccountFeaturesAPI {
   }
 }
 
+class AccountRefundAssistAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the refund assist configuration for all carriers,
+     * including if it is enabled for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#1.--Retrieve-RA-settings-information-(with-carrier-and-RA-details)
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/refund_assist");
+    };
+    /**
+     * The `enable` method enables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#2.--Enable-RA-for-a-seller
+     */
+    this.enable = () => {
+      return this.client.post("/v1/account/refund_assist/enable");
+    };
+    /**
+     * The `disable` method disables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#3.--Disable-RA-for-a-seller
+     */
+    this.disable = () => {
+      return this.client.post("/v1/account/refund_assist/disable");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -22010,6 +22039,13 @@ class ShipEngineAPI {
   get accountBilling() {
     return new AccountBillingAPI(this.client);
   }
+  /**
+   * The `accountRefundAssist` method provides access to the Account Refund Assist endpoints
+   * in ShipEngine API.
+   */
+  get accountRefundAssist() {
+    return new AccountRefundAssistAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -22210,6 +22246,7 @@ exports.AccountBillingAPI = AccountBillingAPI;
 exports.AccountBillingPlanAPI = AccountBillingPlanAPI;
 exports.AccountBillingPlanChangeType = AccountBillingPlanChangeType;
 exports.AccountFeaturesAPI = AccountFeaturesAPI;
+exports.AccountRefundAssistAPI = AccountRefundAssistAPI;
 exports.AccountSettingsAPI = AccountSettingsAPI;
 exports.AddressesAPI = AddressesAPI;
 exports.AuctanePayAPI = AuctanePayAPI;

package/index.mjs

@@ -265,6 +265,35 @@ class AccountFeaturesAPI {
   }
 }
 
+class AccountRefundAssistAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the refund assist configuration for all carriers,
+     * including if it is enabled for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#1.--Retrieve-RA-settings-information-(with-carrier-and-RA-details)
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/refund_assist");
+    };
+    /**
+     * The `enable` method enables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#2.--Enable-RA-for-a-seller
+     */
+    this.enable = () => {
+      return this.client.post("/v1/account/refund_assist/enable");
+    };
+    /**
+     * The `disable` method disables refund assist globally for the user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6766264564/Refund+Assist+API+contracts#3.--Disable-RA-for-a-seller
+     */
+    this.disable = () => {
+      return this.client.post("/v1/account/refund_assist/disable");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -22006,6 +22035,13 @@ class ShipEngineAPI {
   get accountBilling() {
     return new AccountBillingAPI(this.client);
   }
+  /**
+   * The `accountRefundAssist` method provides access to the Account Refund Assist endpoints
+   * in ShipEngine API.
+   */
+  get accountRefundAssist() {
+    return new AccountRefundAssistAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -22201,4 +22237,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountAddonsAPI, AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountFeaturesAPI, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FeatureId, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, UsersApi, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountAddonsAPI, AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountFeaturesAPI, AccountRefundAssistAPI, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FeatureId, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, UsersApi, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

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.21.0",
+  "version": "4.22.1-next.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/types.d.ts

@@ -4,6 +4,7 @@ export * from "./account-billing-plan/types";
 export * from "./account-billing/types";
 export * from "./account-addons/types";
 export * from "./account-features/types";
+export * from "./account-refund-assist/types";
 export * from "./addresses/types";
 export * from "./auctane-pay/types";
 export * from "./carriers/types";