@shipengine/js-api 1.11.0 → 1.13.0

package/connections/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
 /**
  * # Connections API module - /v1/connections
  */
@@ -19,4 +19,9 @@ export declare class ConnectionsAPI {
      * The `connectCarrier` method connects a carrier to account.
      */
     connectCarrier: (carrierName: string, formData: ConnectCarrierAccount) => Promise<import("axios").AxiosResponse<ConnectCarrierAccountResponse, any>>;
+    /**
+     * The `getCarrierConnectionsServicesList` method retrieves a list of services available for a given carrier,
+     * identified by the `carrier_code`.
+     */
+    getCarrierConnectionsServicesList: (carrierCode: string) => Promise<import("axios").AxiosResponse<CarrierServicesListResponse, any>>;
 }

package/connections/types.d.ts

@@ -1,3 +1,4 @@
+import { CarrierService } from "../carriers/types";
 import { GenericObject, LocaleBasedQuery } from "../resources";
 /**
  * @category Entities
@@ -38,3 +39,13 @@ export type ConnectCarrierAccountResponse = {
     carrierId?: string;
     redirectUrl?: string;
 };
+export type ServicesListSupportedCountries = {
+    fromCountry: string;
+};
+export type CarrierProviderService = Pick<CarrierService, "name" | "serviceCode" | "international"> & {
+    description: string;
+    supportedCountries: ServicesListSupportedCountries[];
+};
+export type CarrierServicesListResponse = {
+    services: CarrierProviderService[];
+};

package/funding-sources/types.d.ts

@@ -61,10 +61,17 @@ export interface Term {
     termType: string;
     version: string;
 }
-export type MetadataRequiredTerm = {
-    termType: string;
-    version: string;
-};
+export interface MetadataTermLink {
+    link: string;
+    locale: string;
+    title: string;
+}
+export interface MetadataOptionalTerm extends Term {
+    links: MetadataTermLink[];
+}
+export interface MetadataRequiredTerm extends Term {
+    links: MetadataTermLink[];
+}
 export declare enum MetadataCapability {
     AutoFunding = "auto_funding",
     UpdatePaymentMethod = "update_payment_method",
@@ -133,6 +140,7 @@ export interface MetadataResponse {
         capabilities: MetadataCapability[] | null;
         countryCode: string;
         currencyCode: string;
+        optionalTerms: MetadataOptionalTerm[];
         registrationRequirements: MetadataRegistrationRequirement[];
         requiredTerms: MetadataRequiredTerm[];
     };

package/index.js

@@ -1204,6 +1204,15 @@ class ConnectionsAPI {
         formData
       );
     });
+    /**
+     * The `getCarrierConnectionsServicesList` method retrieves a list of services available for a given carrier,
+     * identified by the `carrier_code`.
+     */
+    this.getCarrierConnectionsServicesList = (carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierCode}/services`
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -1200,6 +1200,15 @@ class ConnectionsAPI {
         formData
       );
     });
+    /**
+     * The `getCarrierConnectionsServicesList` method retrieves a list of services available for a given carrier,
+     * identified by the `carrier_code`.
+     */
+    this.getCarrierConnectionsServicesList = (carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierCode}/services`
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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