@shipengine/js-api 1.5.0 → 1.7.0

package/client.d.ts

@@ -14,6 +14,7 @@ import { RateCardsAPI } from "./rate-cards";
 import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
+import { SellersAPI } from "./sellers";
 import { ServicePointsAPI } from "./service-points";
 import { ShipmentsAPI } from "./shipments";
 import { ShippingRulesAPI } from "./shipping-rules";
@@ -187,4 +188,14 @@ export declare class ShipEngineAPI {
      * @see {@link ShippingRulesAPI | The Shipping Rules API module}
      */
     get shippingRules(): ShippingRulesAPI;
+    /**
+     * The `sellers` method provides access to the Sellers endpoints in ShipEngine
+     * API.
+     *
+     * These endpoints are old and do not follow the ShipEngine API standards that current endpoints follow.
+     * It is very likely that in the future these endpoints will be deprecated by other endpoints.
+     *
+     * @see {@link SellersAPI | The Sellers API module}
+     */
+    get sellers(): SellersAPI;
 }

package/funding-sources/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
-import { PageableQuery } from "../resources";
+import { CreationRangeQuery, PageableQuery } from "../resources";
 import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceTransactionsResponse, MetadataResponse } from "./types";
 /**
  * # Funding Sources API module - /v1/funding_sources
@@ -52,5 +52,5 @@ export declare class FundingSourcesAPI {
      * The `transactions` method returns all the transactions of a funding source.
      * See the FundingSourceTransactions type for more information about return data.
      */
-    transactions: (fundingSourceId: string, params?: PageableQuery) => Promise<import("axios").AxiosResponse<FundingSourceTransactionsResponse, any>>;
+    transactions: (fundingSourceId: string, params?: PageableQuery & CreationRangeQuery) => Promise<import("axios").AxiosResponse<FundingSourceTransactionsResponse, any>>;
 }

package/index.d.ts

@@ -26,3 +26,4 @@ export * from "./themes";
 export * from "./warehouses";
 export * from "./weight";
 export * from "./zones";
+export * from "./sellers";

package/index.js

@@ -3781,6 +3781,35 @@ class SalesOrdersAPI {
   }
 }
 
+class SellersAPI {
+  constructor(client) {
+    /**
+     * Given a seller ID, returns a list of sandbox seller IDs for that seller.
+     */
+    this.listSandboxSellerIds = ({ sellerId }) => {
+      return this.client.get(`/v1/sellers/sandbox_sellers/${sellerId}`);
+    };
+    /**
+     * Creates a sandbox seller account for a given seller ID
+     * you can pass in a flag to try to reuse the carrier connection.
+     */
+    this.createSandboxSeller = ({ sellerId, tryReuseCarrierConnection }) => {
+      return this.client.post(`/v1/sellers/create_sandbox_seller/${sellerId}`, {
+        tryReuseCarrierConnection
+      });
+    };
+    /**
+     * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
+     */
+    this.addSandboxCarriers = ({ sellerId, tryReuseCarrierConnection }) => {
+      return this.client.post(`/v1/sellers/add_sandbox_carriers/${sellerId}`, {
+        tryReuseCarrierConnection
+      });
+    };
+    this.client = client;
+  }
+}
+
 var __defProp$1 = Object.defineProperty;
 var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
 var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
@@ -4272,6 +4301,18 @@ class ShipEngineAPI {
   get shippingRules() {
     return new ShippingRulesAPI(this.client);
   }
+  /**
+   * The `sellers` method provides access to the Sellers endpoints in ShipEngine
+   * API.
+   *
+   * These endpoints are old and do not follow the ShipEngine API standards that current endpoints follow.
+   * It is very likely that in the future these endpoints will be deprecated by other endpoints.
+   *
+   * @see {@link SellersAPI | The Sellers API module}
+   */
+  get sellers() {
+    return new SellersAPI(this.client);
+  }
 }
 
 exports.AccountSettingsAPI = AccountSettingsAPI;
@@ -4299,6 +4340,7 @@ exports.RatesAPI = RatesAPI;
 exports.SE = types;
 exports.SalesOrderShipmentsAPI = SalesOrderShipmentsAPI;
 exports.SalesOrdersAPI = SalesOrdersAPI;
+exports.SellersAPI = SellersAPI;
 exports.ServicePointsAPI = ServicePointsAPI;
 exports.ShipEngineAPI = ShipEngineAPI;
 exports.ShipmentsAPI = ShipmentsAPI;

package/index.mjs

@@ -3777,6 +3777,35 @@ class SalesOrdersAPI {
   }
 }
 
+class SellersAPI {
+  constructor(client) {
+    /**
+     * Given a seller ID, returns a list of sandbox seller IDs for that seller.
+     */
+    this.listSandboxSellerIds = ({ sellerId }) => {
+      return this.client.get(`/v1/sellers/sandbox_sellers/${sellerId}`);
+    };
+    /**
+     * Creates a sandbox seller account for a given seller ID
+     * you can pass in a flag to try to reuse the carrier connection.
+     */
+    this.createSandboxSeller = ({ sellerId, tryReuseCarrierConnection }) => {
+      return this.client.post(`/v1/sellers/create_sandbox_seller/${sellerId}`, {
+        tryReuseCarrierConnection
+      });
+    };
+    /**
+     * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
+     */
+    this.addSandboxCarriers = ({ sellerId, tryReuseCarrierConnection }) => {
+      return this.client.post(`/v1/sellers/add_sandbox_carriers/${sellerId}`, {
+        tryReuseCarrierConnection
+      });
+    };
+    this.client = client;
+  }
+}
+
 var __defProp$1 = Object.defineProperty;
 var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
 var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
@@ -4268,6 +4297,18 @@ class ShipEngineAPI {
   get shippingRules() {
     return new ShippingRulesAPI(this.client);
   }
+  /**
+   * The `sellers` method provides access to the Sellers endpoints in ShipEngine
+   * API.
+   *
+   * These endpoints are old and do not follow the ShipEngine API standards that current endpoints follow.
+   * It is very likely that in the future these endpoints will be deprecated by other endpoints.
+   *
+   * @see {@link SellersAPI | The Sellers API module}
+   */
+  get sellers() {
+    return new SellersAPI(this.client);
+  }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/package.json

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

package/sellers/api.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from "axios";
+import type { ListSandboxSellersParams, SandboxMethodParams } from "./types";
+/**
+ * Sellers API endpoints
+ */
+export declare class SellersAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Given a seller ID, returns a list of sandbox seller IDs for that seller.
+     */
+    listSandboxSellerIds: ({ sellerId }: ListSandboxSellersParams) => Promise<import("axios").AxiosResponse<string[], any>>;
+    /**
+     * Creates a sandbox seller account for a given seller ID
+     * you can pass in a flag to try to reuse the carrier connection.
+     */
+    createSandboxSeller: ({ sellerId, tryReuseCarrierConnection }: SandboxMethodParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
+     */
+    addSandboxCarriers: ({ sellerId, tryReuseCarrierConnection }: SandboxMethodParams) => Promise<import("axios").AxiosResponse<void, any>>;
+}

package/sellers/index.d.ts

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

package/sellers/types.d.ts

@@ -0,0 +1,7 @@
+export type ListSandboxSellersParams = {
+    sellerId: string;
+};
+export type SandboxMethodParams = {
+    sellerId: string;
+    tryReuseCarrierConnection?: boolean;
+};

package/types.d.ts

@@ -26,3 +26,4 @@ export * from "./warehouses/types";
 export * from "./weight/types";
 export * from "./weight-band/types";
 export * from "./zones/types";
+export * from "./sellers/types";