@shipengine/js-api - npm Package Compare versions

Comparing version 4.21.0 to 4.22.0

account-refund-assist/api.d.ts

+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>>;
+}

account-refund-assist/index.d.ts

+export * from "./api";
+export * from "./types";

account-refund-assist/types.d.ts

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

client.d.ts

@@ -6,2 +6,3 @@ import { AxiosError, AxiosRequestHeaders } from "axios";
 import { AccountFeaturesAPI } from "./account-features";
+import { AccountRefundAssistAPI } from "./account-refund-assist";
 import { AccountSettingsAPI } from "./account-settings";
@@ -132,2 +133,7 @@ import { AddressesAPI } from "./addresses";
     /**
+     * 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
@@ -134,0 +140,0 @@ * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

errors/types.d.ts

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

index.d.ts

@@ -5,2 +5,3 @@ export * as SE from "./types";
 export * from "./account-features";
+export * from "./account-refund-assist";
 export * from "./addresses";
@@ -7,0 +8,0 @@ export * from "./auctane-pay";

package.json

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

types.d.ts

@@ -7,2 +7,3 @@ export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export * from "./account-features/types";
+export * from "./account-refund-assist/types";
 export * from "./addresses/types";
@@ -9,0 +10,0 @@ export * from "./auctane-pay/types";

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1613077

0.3%

Number of package files

112

2.75%

Lines of code

45711

0.25%

No dependency changes