@shipengine/js-api 1.22.0 → 1.23.0

package/connections/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, ConnectionsCarrierName, ConnectionsCarrierSettingsData, ConnectionsCarrierSettingsResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
 /**
  * # Connections API module - /v1/connections
  */
@@ -24,4 +24,14 @@ export declare class ConnectionsAPI {
      * identified by the `carrier_code`.
      */
     getCarrierConnectionsServicesList: (carrierCode: string) => Promise<import("axios").AxiosResponse<CarrierServicesListResponse, any>>;
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    getCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string) => Promise<import("axios").AxiosResponse<ConnectionsCarrierSettingsResponse<T>, any>>;
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    updateCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string, formData: ConnectionsCarrierSettingsData<T>) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/connections/settings-types.d.ts

@@ -0,0 +1,42 @@
+export type DHLExpressSettings = {
+    isPrimaryAccount: boolean;
+    nickname: string;
+    shouldHideAccountNumberOnArchiveDoc: boolean;
+};
+export type FedexSettings = {
+    isPrimaryAccount: boolean;
+    letterheadImage?: string;
+    nickname: string;
+    pickupType: "none" | "regular_pickup" | "request_courier" | "drop_box" | "business_service_center" | "station";
+    signatureImage?: string;
+    smartPostEndorsement: "none" | "return_service_requested" | "forwarding_service_requested" | "address_service_requested" | "change_service_requested" | "leave_if_no_response";
+    smartPostHub: "none" | "allentown_pa" | "atlanta_ga" | "baltimore_md" | "charlotte_nc" | "chino_ca" | "dallas_tx" | "denver_co" | "detroit_mi" | "edison_nj" | "grove_city_oh" | "groveport_oh" | "houston_tx" | "indianapolis_in" | "kansas_city_ks" | "los_angeles_ca" | "martinsburg_wv" | "memphis_tn" | "minneapolis_mn" | "new_berlin_wi" | "northborough_ma" | "orlando_fl" | "phoneix_az" | "pittsburgh_pa" | "reno_nv" | "sacramento_ca" | "salt_lake_city_ut" | "seattle_wa" | "st_louis_mo" | "windsor_ct" | "newark_ny" | "south_brunswick_nj" | "scranton_pa" | "wheeling_il";
+};
+export type UPSSettings = {
+    accountCountryCode: string;
+    accountNumber: string;
+    accountPostalCode: string;
+    invoice?: {
+        controlId: string;
+        invoiceAmount: number;
+        invoiceCurrencyCode: string;
+        invoiceDate: string;
+        invoiceNumber: string;
+    };
+    isPrimaryAccount: boolean;
+    mailInnovationsCostCenter?: string;
+    mailInnovationsCustomerGuid?: string;
+    mailInnovationsCustomerId?: string;
+    mailInnovationsEndorsement: "none" | "return_service_requested" | "forwarding_service_requested" | "address_service_requested" | "change_service_requested" | "leave_if_no_response";
+    nickname: string;
+    pickupType: "daily_pickup" | "occasional_pickup" | "customer_counter";
+    useCarbonNeutralShippingProgram: boolean;
+    useConsolidationServices: boolean;
+    useGroundFreightPricing: boolean;
+    useNegotiatedRates: boolean;
+    useOrderNumberOnMailInnovationsLabels: boolean;
+};
+export type UPSUpdateSettings = Omit<UPSSettings, "accountNumber">;
+export type ConnectionsCarrierName = "dhl_express" | "fedex" | "ups";
+export type ConnectionsCarrierSettingsResponse<Name extends ConnectionsCarrierName = ConnectionsCarrierName> = Name extends "dhl_express" ? DHLExpressSettings : Name extends "fedex" ? FedexSettings : Name extends "ups" ? UPSSettings : never;
+export type ConnectionsCarrierSettingsData<Name extends ConnectionsCarrierName = ConnectionsCarrierName> = Name extends "dhl_express" ? DHLExpressSettings : Name extends "fedex" ? FedexSettings : Name extends "ups" ? UPSUpdateSettings : never;

package/connections/types.d.ts

@@ -49,3 +49,4 @@ export type CarrierProviderService = Pick<CarrierService, "name" | "serviceCode"
 export type CarrierServicesListResponse = {
     services: CarrierProviderService[];
 };
+export * from "./settings-types";

package/index.js

@@ -1221,6 +1221,25 @@ class ConnectionsAPI {
         `/v1/connections/carriers/${carrierCode}/services`
       );
     };
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.getCarrierSettings = (carrierName, carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+      );
+    };
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+      return this.client.put(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        formData
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -1217,6 +1217,25 @@ class ConnectionsAPI {
         `/v1/connections/carriers/${carrierCode}/services`
       );
     };
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.getCarrierSettings = (carrierName, carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+      );
+    };
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+      return this.client.put(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        formData
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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