@shipengine/js-api 4.4.1 → 4.5.0

package/client.d.ts

@@ -22,6 +22,7 @@ import { ServicePointsAPI } from "./service-points";
 import { ShipmentsAPI } from "./shipments";
 import { ShippingRulesAPI } from "./shipping-rules";
 import { ThemesAPI } from "./themes";
+import { UsersApi } from "./users";
 import { WarehousesAPI } from "./warehouses";
 import { WebhooksAPI } from "./webhooks";
 /**
@@ -252,4 +253,10 @@ export declare class ShipEngineAPI {
      * @see {@link AuctanePayAPI | The Auctane Pay API module}
      */
     get auctanePay(): AuctanePayAPI;
+    /**
+     * The `users` method provides access to Users endpoints in ShipEngine API.
+     *
+     * @see {@link UsersApi | The Users API module}
+     */
+    get users(): UsersApi;
 }

package/index.d.ts

@@ -32,3 +32,4 @@ export * from "./webhooks";
 export * from "./weight";
 export * from "./zones";
 export * from "./sellers";
+export * from "./users";

package/index.js

@@ -4284,6 +4284,19 @@ class ThemesAPI {
   }
 }
 
+class UsersApi {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` gets all the users of the current Seller.
+     */
+    this.list = (options) => {
+      return this.client.get("/v1/users", { params: options });
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -22005,6 +22018,14 @@ class ShipEngineAPI {
   get auctanePay() {
     return new AuctanePayAPI(this.client);
   }
+  /**
+   * The `users` method provides access to Users endpoints in ShipEngine API.
+   *
+   * @see {@link UsersApi | The Users API module}
+   */
+  get users() {
+    return new UsersApi(this.client);
+  }
 }
 
 exports.AccountBillingAPI = AccountBillingAPI;
@@ -22044,6 +22065,7 @@ exports.ShipEngineAPI = ShipEngineAPI;
 exports.ShipmentsAPI = ShipmentsAPI;
 exports.ShippingRulesAPI = ShippingRulesAPI;
 exports.ThemesAPI = ThemesAPI;
+exports.UsersApi = UsersApi;
 exports.WarehousesAPI = WarehousesAPI;
 exports.WebhooksAPI = WebhooksAPI;
 exports.camelizeKeys = camelizeKeys;

package/index.mjs

@@ -4280,6 +4280,19 @@ class ThemesAPI {
   }
 }
 
+class UsersApi {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` gets all the users of the current Seller.
+     */
+    this.list = (options) => {
+      return this.client.get("/v1/users", { params: options });
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -22001,6 +22014,14 @@ class ShipEngineAPI {
   get auctanePay() {
     return new AuctanePayAPI(this.client);
   }
+  /**
+   * The `users` method provides access to Users endpoints in ShipEngine API.
+   *
+   * @see {@link UsersApi | The Users API module}
+   */
+  get users() {
+    return new UsersApi(this.client);
+  }
 }
 
-export { AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, UsersApi, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/labels/types.d.ts

@@ -10,6 +10,9 @@ export type LabelFormat = "pdf" | "png" | "zpl";
 export type LabelLayout = "4x6" | "letter";
 export type LabelStatus = "processing" | "completed" | "error" | "voided";
 export type LabelTrackingStatus = "unknown" | "in_transit" | "delivered" | "error";
+/**
+ * Columns available for label exports
+ */
 export type LabelColumns = "shipment_id" | "label_id" | "external_order_id" | "external_shipment_id" | "packages" | "recipient" | "shipping_service" | "created_date" | "ship_date" | "status" | "tracking_status";
 export type Label = {
     alternativeIdentifiers?: string[];

package/package.json

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

package/types.d.ts

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

package/users/api.d.ts

@@ -0,0 +1,14 @@
+import { AxiosInstance } from "axios";
+import { UserListOptions, UserListResponse } from "./types";
+/**
+ * # Users API module - /v1/users
+ * @link https://docs.shipstation.com/openapi/users
+ */
+export declare class UsersApi {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` gets all the users of the current Seller.
+     */
+    list: (options?: UserListOptions) => Promise<import("axios").AxiosResponse<UserListResponse, any>>;
+}

package/users/index.d.ts

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

package/users/types.d.ts

@@ -0,0 +1,17 @@
+import { CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery } from "../resources";
+export type UserStatus = "Active" | "Inactive" | "Locked_out" | "Email_lock";
+export type User = {
+    createdAt: string;
+    email: string;
+    lastLoginAt: string;
+    name: string;
+    status: UserStatus;
+    userId: string;
+    username: string;
+};
+export type UserListOptions = {
+    status?: UserStatus;
+} & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery;
+export type UserListResponse = {
+    users: User[];
+} & PageableResult;