@shipengine/js-api 1.12.0 → 1.14.0

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, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceTransactionsResponse, MetadataResponse } from "./types";
+import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse } from "./types";
 /**
  * # Funding Sources API module - /v1/funding_sources
  * Docs: https://auctane.atlassian.net/wiki/spaces/SE/pages/3628370266/ShipEngine+Funding+Sources+API
@@ -23,9 +23,7 @@ export declare class FundingSourcesAPI {
      * The `create` method creates a new funding source for a given user. This requires
      * payment information to be collected from the user.
      */
-    create: (createFundingSource: CreateFundingSource) => Promise<import("axios").AxiosResponse<{
-        fundingSource: FundingSource;
-    }, any>>;
+    create: (createFundingSource: CreateFundingSource) => Promise<import("axios").AxiosResponse<FundingSourceCreateResponse, any>>;
     /**
      * The `update` method updates a funding source for a given user. This allows the
      * user to update the billing address or payment information associated with the
@@ -53,4 +51,10 @@ export declare class FundingSourcesAPI {
      * See the FundingSourceTransactions type for more information about return data.
      */
     transactions: (fundingSourceId: string, params?: PageableQuery & CreationRangeQuery) => Promise<import("axios").AxiosResponse<FundingSourceTransactionsResponse, any>>;
+    /**
+     * Now we can attach insurance providers to the user's Funding Source.
+     * This endpoint will retrieve all accepted insurance terms. For example
+     * if "ParcelGuard" appears here that means the user its using it.
+     */
+    insuranceAcceptedTerms: () => Promise<import("axios").AxiosResponse<InsuranceFundingSourceAcceptedTermsResponse, any>>;
 }

package/funding-sources/types.d.ts

@@ -25,6 +25,7 @@ export type AbbreviatedCreditCardInfo = {
     cardNumberLastFour: string;
     provider: Provider;
 };
+export type FundingSourceInsuranceProvider = "parcelguard" | "x_cover";
 export type Provider = "visa" | "mastercard" | "americanExpress" | "discover";
 export type FundingSourceCarrier = {
     acceptedTerms: Term[];
@@ -34,8 +35,15 @@ export type FundingSourceCarrier = {
     iovationBlackBox: IovationBlackBox;
     pickupAddress?: FundingSourceAddress;
 };
+export type CarrierRegistrationInsuranceProvider = {
+    acceptedTerms: Term[];
+    agreeToTerms: boolean;
+    fundingSourceId: string;
+    provider: FundingSourceInsuranceProvider;
+};
 export interface CarrierRegistration {
-    carriers: FundingSourceCarrier[];
+    carriers?: FundingSourceCarrier[];
+    insuranceProviders?: CarrierRegistrationInsuranceProvider[];
 }
 export interface FundingSourceAddress {
     addressLine1: string;
@@ -61,10 +69,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",
@@ -97,6 +112,12 @@ export type MetadataRegistrationRequirement = {
     requirementType: MetadataRequirement;
     satisfyingFormTypes: MetadataSatisfyingFormTypes[];
 };
+export type MetadataCarrierProfile = {
+    capabilities: MetadataCapability[] | null;
+    carrierCode: string;
+    registrationRequirements: MetadataRegistrationRequirement[];
+    requiredTerms: MetadataRequiredTerm[];
+};
 export type TransactionCategory = "adjustment" | "credit" | "debit" | "funds_added" | "insurance" | "label" | "refund" | "service_charge" | "unknown";
 export type FundingSourceTransaction = {
     description?: string | null;
@@ -117,6 +138,16 @@ export type FundingSourceTransaction = {
     transactionCategory: TransactionCategory;
     transactionDate: string;
 };
+export interface FundingSourceInsuranceProviderResponse {
+    errorMessage: null | string;
+    fundingSourceId: string;
+    isSuccessful: boolean;
+    provider: FundingSourceInsuranceProvider;
+}
+export interface FundingSourceCreateResponse {
+    fundingSource: FundingSource;
+    insuranceProviderAttachmentResults: FundingSourceInsuranceProviderResponse[];
+}
 export interface CarrierRegistrationResponse {
     carrierAttachmentResults: [
         {
@@ -127,22 +158,19 @@ export interface CarrierRegistrationResponse {
             nickname: string;
         }
     ];
+    insuranceProviderAttachmentResults: FundingSourceInsuranceProviderResponse[];
 }
 export interface MetadataResponse {
     defaultFundingSourceProfile: {
         capabilities: MetadataCapability[] | null;
         countryCode: string;
         currencyCode: string;
+        optionalTerms: MetadataOptionalTerm[];
         registrationRequirements: MetadataRegistrationRequirement[];
         requiredTerms: MetadataRequiredTerm[];
     };
     defaultRegionProfile: {
-        carrierProfiles: Array<{
-            capabilities: MetadataCapability[] | null;
-            carrierCode: string;
-            registrationRequirements: MetadataRegistrationRequirement[];
-            requiredTerms: MetadataRequiredTerm[];
-        }>;
+        carrierProfiles: MetadataCarrierProfile[];
         countryCode: string;
         currencyCode: string;
     };
@@ -156,4 +184,7 @@ export type AddFundsResponse = {
 export type FundingSourceTransactionsResponse = {
     transactions: FundingSourceTransaction[];
 } & PageableResult;
+export type InsuranceFundingSourceAcceptedTermsResponse = {
+    acceptedTerms: Term[];
+};
 export {};

package/index.js

@@ -3483,8 +3483,9 @@ class FundingSourcesAPI {
      */
     this.create = (createFundingSource) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.post("/v1/funding_sources", __spreadValues$2({
         endUserIpAddress
       }, createFundingSource));
@@ -3496,8 +3497,9 @@ class FundingSourcesAPI {
      */
     this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}`,
         {
@@ -3513,8 +3515,9 @@ class FundingSourcesAPI {
      */
     this.registerCarrier = (carrier) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
         endUserIpAddress
       }, carrier));
@@ -3547,6 +3550,16 @@ class FundingSourcesAPI {
         }
       );
     };
+    /**
+     * Now we can attach insurance providers to the user's Funding Source.
+     * This endpoint will retrieve all accepted insurance terms. For example
+     * if "ParcelGuard" appears here that means the user its using it.
+     */
+    this.insuranceAcceptedTerms = () => {
+      return this.client.get(
+        "/v1/insurance/funding_source/accepted_terms"
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -3479,8 +3479,9 @@ class FundingSourcesAPI {
      */
     this.create = (createFundingSource) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.post("/v1/funding_sources", __spreadValues$2({
         endUserIpAddress
       }, createFundingSource));
@@ -3492,8 +3493,9 @@ class FundingSourcesAPI {
      */
     this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}`,
         {
@@ -3509,8 +3511,9 @@ class FundingSourcesAPI {
      */
     this.registerCarrier = (carrier) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
-      if (!endUserIpAddress)
+      if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
+      }
       return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
         endUserIpAddress
       }, carrier));
@@ -3543,6 +3546,16 @@ class FundingSourcesAPI {
         }
       );
     };
+    /**
+     * Now we can attach insurance providers to the user's Funding Source.
+     * This endpoint will retrieve all accepted insurance terms. For example
+     * if "ParcelGuard" appears here that means the user its using it.
+     */
+    this.insuranceAcceptedTerms = () => {
+      return this.client.get(
+        "/v1/insurance/funding_source/accepted_terms"
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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