@shipengine/js-api 0.13.1 → 0.14.1

package/client.d.ts

@@ -7,6 +7,7 @@ import { FundingSourcesAPI } from "./funding-sources";
 import { InsuranceAPI } from "./insurance";
 import { LabelsAPI } from "./labels";
 import { OrderSourcesAPI } from "./order-sources";
+import { RateCardsAPI } from "./rate-cards";
 import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
@@ -30,6 +31,7 @@ export declare class ShipEngineAPI {
     get insurance(): InsuranceAPI;
     get labels(): LabelsAPI;
     get orderSources(): OrderSourcesAPI;
+    get rateCards(): RateCardsAPI;
     get rates(): RatesAPI;
     get salesOrderShipments(): SalesOrderShipmentsAPI;
     get salesOrders(): SalesOrdersAPI;

package/funding-sources/api.d.ts

@@ -1,11 +1,13 @@
 import { AxiosInstance } from "axios";
-import { CarrierRegistration, CarrierRegistrationResponse, CreateFundingSourceResponse, CreditCardInfo, FundingSource, FundingSourceAddress, ListFundingSourcesResponse } from "./types";
+import { CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreateFundingSourceResponse, CreditCardInfo, FundingSource, FundingSourceAddress } from "./types";
 export declare class FundingSourcesAPI {
     private client;
     constructor(client: AxiosInstance);
-    list: () => Promise<import("axios").AxiosResponse<ListFundingSourcesResponse, any>>;
+    list: () => Promise<import("axios").AxiosResponse<{
+        fundingSources: FundingSource[];
+    }, any>>;
     get: (fundingSourceId: string) => Promise<import("axios").AxiosResponse<FundingSource, any>>;
-    create: (fundingSource: FundingSource) => Promise<import("axios").AxiosResponse<CreateFundingSourceResponse, any>>;
+    create: (createFundingSource: CreateFundingSource) => Promise<import("axios").AxiosResponse<CreateFundingSourceResponse, any>>;
     update: (billingInfo: FundingSourceAddress, creditCardInfo: CreditCardInfo, fundingSourceId: string) => Promise<import("axios").AxiosResponse<CreateFundingSourceResponse, any>>;
     registerCarrier: (carrier: CarrierRegistration) => Promise<import("axios").AxiosResponse<CarrierRegistrationResponse, any>>;
 }

package/funding-sources/types.d.ts

@@ -1,10 +1,18 @@
 import { CreditCardVendor } from "../payments";
-export type FundingSource = {
+export type CreateFundingSource = {
     acceptedTerms: Term[];
     agreeToTerms: boolean;
     billingInfo: FundingSourceAddress;
     paymentMethod: PaymentMethod;
 };
+export type FundingSource = {
+    billingInfo: FundingSourceAddress;
+    currencyCode: string;
+    fundingSourceId: string;
+    paymentMethod: PaymentMethod | {
+        creditCardInfo: null;
+    };
+};
 export interface CarrierRegistration {
     carriers: [
         {
@@ -64,15 +72,3 @@ export interface CreateFundingSourceResponse {
         };
     };
 }
-export interface ListFundingSourcesResponse {
-    fundingSources: [
-        {
-            billingInfo: FundingSourceAddress;
-            currencyCode: string;
-            fundingSourceId: string;
-            paymentMethod: PaymentMethod | {
-                creditCardInfo: null;
-            };
-        }
-    ];
-}

package/index.d.ts

@@ -12,6 +12,7 @@ export * from "./labels";
 export * from "./order-sources";
 export * from "./payments";
 export * from "./rates";
+export * from "./rate-cards";
 export * from "./relay-points";
 export * from "./resources";
 export * from "./sales-order-shipments";

package/index.js

@@ -5150,13 +5150,13 @@ class FundingSourcesAPI {
     this.get = (fundingSourceId) => {
       return this.client.get(`/v1/funding_sources/${fundingSourceId}`);
     };
-    this.create = (fundingSource) => __async$2(this, null, function* () {
+    this.create = (createFundingSource) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
       return yield this.client.post("/v1/funding_sources", __spreadValues$1({
         endUserIpAddress
-      }, fundingSource));
+      }, createFundingSource));
     });
     this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
@@ -5224,6 +5224,18 @@ class OrderSourcesAPI {
   }
 }
 
+class RateCardsAPI {
+  constructor(client) {
+    this.client = client;
+    this.list = (carrierIds) => {
+      return this.client.get(
+        `/v1/rate-cards?carrier_ids=${carrierIds.toString()}`
+      );
+    };
+    this.client = client;
+  }
+}
+
 class RatesAPI {
   constructor(client) {
     this.client = client;
@@ -5494,6 +5506,9 @@ class ShipEngineAPI {
   get orderSources() {
     return new OrderSourcesAPI(this.client);
   }
+  get rateCards() {
+    return new RateCardsAPI(this.client);
+  }
   get rates() {
     return new RatesAPI(this.client);
   }
@@ -5526,6 +5541,7 @@ exports.InsuranceAPI = InsuranceAPI;
 exports.InsuranceProviderType = InsuranceProviderType;
 exports.LabelsAPI = LabelsAPI;
 exports.OrderSourcesAPI = OrderSourcesAPI;
+exports.RateCardsAPI = RateCardsAPI;
 exports.RatesAPI = RatesAPI;
 exports.SE = types;
 exports.SalesOrderShipmentsAPI = SalesOrderShipmentsAPI;

package/index.mjs

@@ -5146,13 +5146,13 @@ class FundingSourcesAPI {
     this.get = (fundingSourceId) => {
       return this.client.get(`/v1/funding_sources/${fundingSourceId}`);
     };
-    this.create = (fundingSource) => __async$2(this, null, function* () {
+    this.create = (createFundingSource) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
       return yield this.client.post("/v1/funding_sources", __spreadValues$1({
         endUserIpAddress
-      }, fundingSource));
+      }, createFundingSource));
     });
     this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
@@ -5220,6 +5220,18 @@ class OrderSourcesAPI {
   }
 }
 
+class RateCardsAPI {
+  constructor(client) {
+    this.client = client;
+    this.list = (carrierIds) => {
+      return this.client.get(
+        `/v1/rate-cards?carrier_ids=${carrierIds.toString()}`
+      );
+    };
+    this.client = client;
+  }
+}
+
 class RatesAPI {
   constructor(client) {
     this.client = client;
@@ -5490,6 +5502,9 @@ class ShipEngineAPI {
   get orderSources() {
     return new OrderSourcesAPI(this.client);
   }
+  get rateCards() {
+    return new RateCardsAPI(this.client);
+  }
   get rates() {
     return new RatesAPI(this.client);
   }
@@ -5507,4 +5522,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };

package/package.json

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

package/rate-cards/api.d.ts

@@ -0,0 +1,9 @@
+import { AxiosInstance } from "axios";
+import { RateCard } from "./types";
+export declare class RateCardsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    list: (carrierIds: string[]) => Promise<import("axios").AxiosResponse<{
+        rateCards: RateCard[];
+    }, any>>;
+}

package/rate-cards/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/rate-cards/types.d.ts

@@ -0,0 +1,21 @@
+import { Currency } from "../payments";
+/**
+ * @category Entities
+ */
+export interface ShipFromLocation {
+    countryCode: string;
+    postalCode?: string;
+}
+/**
+ * @category Entities
+ */
+export interface RateCard {
+    carrierId: string;
+    currency: Currency;
+    endDate?: string;
+    id: string;
+    name: string;
+    shipFrom: ShipFromLocation;
+    startDate: string;
+    status: string;
+}

package/types.d.ts

@@ -10,6 +10,7 @@ export * from "./labels/types";
 export * from "./order-sources/types";
 export * from "./payments/types";
 export * from "./rates/types";
+export * from "./rate-cards/types";
 export * from "./relay-points/types";
 export * from "./resources/types";
 export * from "./sales-order-shipments/types";