@shipengine/js-api 4.20.0 → 4.21.0

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/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.js

@@ -1379,6 +1379,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 +3754,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;
   }
 }

package/index.mjs

@@ -1375,6 +1375,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 +3750,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;
   }
 }

package/package.json

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