@shipengine/js-api 4.20.0 → 4.22.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/carriers/api.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
 import { Currency, Money } from "../payments";
 import { SandboxableQuery } from "../resources";
-import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierZone, PackageRatingType } from "./types";
+import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierTerm, CarrierZone, PackageRatingType } from "./types";
 /**
  * # Carriers API module - /v1/carriers
  */
@@ -87,4 +87,13 @@ export declare class CarriersAPI {
      * https://shipengine.github.io/shipengine-openapi/#operation/disconnect_carrier_by_id
      */
     delete: (carrierId: string) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `acceptTerms` method allows users to accept new versions of carrier terms.
+     * Returns the status of each term.
+     */
+    acceptTerms: (carrierId: string, request: {
+        acceptedTerms: CarrierTerm[];
+    }) => Promise<import("axios").AxiosResponse<{
+        acceptedTerms: CarrierTerm[];
+    }, any>>;
 }

package/carriers/types.d.ts

@@ -20,13 +20,6 @@ export interface CarrierAutoFundingSettings {
     maximumPurchasesPerDay?: number;
     purchaseAmount: Money;
 }
-export interface CarrierAutoFundingSettingsResponse {
-    autoPurchaseAmount: number;
-    autoPurchaseCutoff?: number;
-    autoPurchaseThreshold: number;
-    balance: number;
-    isAutoPurchaseEnabled: boolean;
-}
 /**
  * @category Entities
  */
@@ -128,3 +121,23 @@ export type CarrierZone = {
     apiCode: string;
     name: string;
 };
+/**
+ * @category Entities
+ */
+/** @internal */
+export type CarrierTermsStatus = "saved" | "not_found" | "already_saved" | "error";
+export type CarrierTermCategory = "funding_source" | "carrier" | "insurance";
+export interface CarrierTerm {
+    status?: CarrierTermsStatus;
+    termCategory?: CarrierTermCategory;
+    termType: string;
+    version: string;
+}
+/** @internal */
+export interface CarrierAutoFundingSettingsResponse {
+    autoPurchaseAmount: number;
+    autoPurchaseCutoff?: number;
+    autoPurchaseThreshold: number;
+    balance: number;
+    isAutoPurchaseEnabled: boolean;
+}

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/funding-sources/api.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
 import { CreationRangeQuery, PageableQuery } from "../resources";
-import { AddFundsResponse, AuctanePayInfo, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse } from "./types";
+import { AddFundsResponse, AuctanePayInfo, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse, Term } from "./types";
 /**
  * @internal
  * # Funding Sources API module - /v1/funding_sources
@@ -58,4 +58,18 @@ export declare class FundingSourcesAPI {
      * if "ParcelGuard" appears here that means the user its using it.
      */
     insuranceAcceptedTerms: () => Promise<import("axios").AxiosResponse<InsuranceFundingSourceAcceptedTermsResponse, any>>;
+    /**
+     * The `acceptedTerms` method retrieves all accepted terms for a specific funding source.
+     */
+    acceptedTerms: (fundingSourceId: string) => Promise<import("axios").AxiosResponse<{
+        acceptedTerms: Term[];
+    }, any>>;
+    /**
+     * The`acceptTerms` method allows users to accept new versions of funding source terms.
+     */
+    acceptTerms: (fundingSourceId: string, request: {
+        acceptedTerms: Term[];
+    }) => Promise<import("axios").AxiosResponse<{
+        acceptedTerms: Term[];
+    }, any>>;
 }

package/funding-sources/types.d.ts

@@ -89,7 +89,12 @@ export interface CreditCardInfo {
     provider: Provider;
 }
 /** @internal */
+export type TermsStatus = "saved" | "not_found" | "already_saved" | "error";
+export type TermCategory = "funding_source" | "carrier" | "insurance";
+/** @internal */
 export interface Term {
+    status?: TermsStatus;
+    termCategory?: TermCategory;
     termType: string;
     version: string;
 }

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;
@@ -1379,6 +1408,16 @@ class CarriersAPI {
     this.delete = (carrierId) => {
       return this.client.delete(`/v1/carriers/${carrierId}`);
     };
+    /**
+     * The `acceptTerms` method allows users to accept new versions of carrier terms.
+     * Returns the status of each term.
+     */
+    this.acceptTerms = (carrierId, request) => {
+      return this.client.post(
+        `/v1/carriers/${carrierId}/accepted_terms`,
+        request
+      );
+    };
     this.client = client;
   }
 }
@@ -3744,6 +3783,23 @@ class FundingSourcesAPI {
         "/v1/insurance/funding_source/accepted_terms"
       );
     };
+    /**
+     * The `acceptedTerms` method retrieves all accepted terms for a specific funding source.
+     */
+    this.acceptedTerms = (fundingSourceId) => {
+      return this.client.get(
+        `/v1/funding_sources/${fundingSourceId}/accepted_terms`
+      );
+    };
+    /**
+     * The`acceptTerms` method allows users to accept new versions of funding source terms.
+     */
+    this.acceptTerms = (fundingSourceId, request) => {
+      return this.client.post(
+        `/v1/funding_sources/${fundingSourceId}/accepted_terms`,
+        request
+      );
+    };
     this.client = client;
   }
 }
@@ -21983,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.
@@ -22183,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;
@@ -1375,6 +1404,16 @@ class CarriersAPI {
     this.delete = (carrierId) => {
       return this.client.delete(`/v1/carriers/${carrierId}`);
     };
+    /**
+     * The `acceptTerms` method allows users to accept new versions of carrier terms.
+     * Returns the status of each term.
+     */
+    this.acceptTerms = (carrierId, request) => {
+      return this.client.post(
+        `/v1/carriers/${carrierId}/accepted_terms`,
+        request
+      );
+    };
     this.client = client;
   }
 }
@@ -3740,6 +3779,23 @@ class FundingSourcesAPI {
         "/v1/insurance/funding_source/accepted_terms"
       );
     };
+    /**
+     * The `acceptedTerms` method retrieves all accepted terms for a specific funding source.
+     */
+    this.acceptedTerms = (fundingSourceId) => {
+      return this.client.get(
+        `/v1/funding_sources/${fundingSourceId}/accepted_terms`
+      );
+    };
+    /**
+     * The`acceptTerms` method allows users to accept new versions of funding source terms.
+     */
+    this.acceptTerms = (fundingSourceId, request) => {
+      return this.client.post(
+        `/v1/funding_sources/${fundingSourceId}/accepted_terms`,
+        request
+      );
+    };
     this.client = client;
   }
 }
@@ -21979,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.
@@ -22174,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "4.20.0",
+  "version": "4.22.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";