@shipengine/js-api 0.36.0 → 0.38.0

package/account-billing-plan/api.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+import { AccountBillingPlanResponse } from "./types";
+/**
+ * # Account Billing Plan API module - /v1/account/billing_plan
+ */
+export declare class AccountBillingPlanAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    get: () => Promise<import("axios").AxiosResponse<AccountBillingPlanResponse, any>>;
+}

package/account-billing-plan/index.d.ts

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

package/account-billing-plan/types.d.ts

@@ -0,0 +1,30 @@
+export declare enum AccountBillingPlanChangeType {
+    Downgrade = 0,
+    Cancellation = 1
+}
+export type AccountBillingPlan = {
+    code: string;
+    name: string;
+};
+/**
+ * Responses
+ */
+/**
+ * "cancelledAt", "pendingChange" and "trialEndAt" are only available when applies
+ * won't be on the response otherwise
+ */
+export type AccountBillingPlanResponse = {
+    billingPlan: AccountBillingPlan;
+    cancelledAt?: string;
+    currentBillingCycle: {
+        endsAt: string;
+        startedAt: string;
+    };
+    pendingChange?: {
+        changeTo: AccountBillingPlan;
+        effectiveAt: string;
+        requestedAt: string;
+        type: AccountBillingPlanChangeType;
+    };
+    trialEndAt?: string;
+};

package/client.d.ts

@@ -1,4 +1,5 @@
 import { AxiosRequestHeaders } from "axios";
+import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { CarriersAPI } from "./carriers";
@@ -12,6 +13,7 @@ import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
 import { ShipmentsAPI } from "./shipments";
+import { ShippingRulesAPI } from "./shipping-rules";
 import { WarehousesAPI } from "./warehouses";
 /**
  * # ShipEngine API Client Headers
@@ -54,6 +56,11 @@ export declare class ShipEngineAPI {
      * @see {@link AccountSettingsAPI | The Account Settings API module}
      */
     get accountSettings(): AccountSettingsAPI;
+    /**
+     * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+     * in ShipEngine API.
+     */
+    get accountBillingPlan(): AccountBillingPlanAPI;
     /**
      * The `addresses` method provides access to the Address Validation endpoints
      * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -145,4 +152,11 @@ export declare class ShipEngineAPI {
      * @see {@link WarehousesAPI | The Warehouses API module}
      */
     get warehouses(): WarehousesAPI;
+    /**
+     * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
+     * API.
+     *
+     * @see {@link ShippingRulesAPI | The Shipping Rules API module}
+     */
+    get shippingRules(): ShippingRulesAPI;
 }

package/index.d.ts

@@ -18,6 +18,7 @@ export * from "./resources";
 export * from "./sales-order-shipments";
 export * from "./sales-orders";
 export * from "./shipments";
+export * from "./shipping-rules";
 export * from "./utilities";
 export * from "./warehouses";
 export * from "./weight";

package/index.js

@@ -3227,6 +3227,19 @@ var lib = {
     stringify: stringify
 };
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    this.client = client;
+  }
+}
+
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -3622,6 +3635,19 @@ class ShipmentsAPI {
   }
 }
 
+class ShippingRulesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves the list of shipping rules by seller.
+     */
+    this.list = () => {
+      return this.client.get(`/v1/shipping_rules`);
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -3825,6 +3851,13 @@ class ShipEngineAPI {
   get accountSettings() {
     return new AccountSettingsAPI(this.client);
   }
+  /**
+   * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+   * in ShipEngine API.
+   */
+  get accountBillingPlan() {
+    return new AccountBillingPlanAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -3942,6 +3975,15 @@ class ShipEngineAPI {
   get warehouses() {
     return new WarehousesAPI(this.client);
   }
+  /**
+   * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
+   * API.
+   *
+   * @see {@link ShippingRulesAPI | The Shipping Rules API module}
+   */
+  get shippingRules() {
+    return new ShippingRulesAPI(this.client);
+  }
 }
 
 exports.AccountSettingsAPI = AccountSettingsAPI;
@@ -3967,6 +4009,7 @@ exports.SalesOrderShipmentsAPI = SalesOrderShipmentsAPI;
 exports.SalesOrdersAPI = SalesOrdersAPI;
 exports.ShipEngineAPI = ShipEngineAPI;
 exports.ShipmentsAPI = ShipmentsAPI;
+exports.ShippingRulesAPI = ShippingRulesAPI;
 exports.WarehousesAPI = WarehousesAPI;
 exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;

package/index.mjs

@@ -3223,6 +3223,19 @@ var lib = {
     stringify: stringify
 };
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    this.client = client;
+  }
+}
+
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -3618,6 +3631,19 @@ class ShipmentsAPI {
   }
 }
 
+class ShippingRulesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves the list of shipping rules by seller.
+     */
+    this.list = () => {
+      return this.client.get(`/v1/shipping_rules`);
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -3821,6 +3847,13 @@ class ShipEngineAPI {
   get accountSettings() {
     return new AccountSettingsAPI(this.client);
   }
+  /**
+   * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+   * in ShipEngine API.
+   */
+  get accountBillingPlan() {
+    return new AccountBillingPlanAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -3938,6 +3971,15 @@ class ShipEngineAPI {
   get warehouses() {
     return new WarehousesAPI(this.client);
   }
+  /**
+   * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
+   * API.
+   *
+   * @see {@link ShippingRulesAPI | The Shipping Rules API module}
+   */
+  get shippingRules() {
+    return new ShippingRulesAPI(this.client);
+  }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, 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, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };

package/package.json

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

package/shipping-rules/api.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+import { ShippingRule } from "./types";
+/**
+ * # Shipping Rules API module - /v1/shipping_rules
+ */
+export declare class ShippingRulesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves the list of shipping rules by seller.
+     */
+    list: () => Promise<import("axios").AxiosResponse<{
+        shippingRules: ShippingRule[];
+    }, any>>;
+}

package/shipping-rules/index.d.ts

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

package/shipping-rules/types.d.ts

@@ -0,0 +1,50 @@
+import { ISOString } from "../resources";
+/**
+ * @category Entities
+ */
+type RuleType = "dimension" | "number_of_packages" | "ship_from_address_residential_indicator" | "ship_from_country_code" | "ship_to_address_residential_indicator" | "ship_to_country_code" | "warehouse_id" | "weight";
+/**
+ * @category Entities
+ */
+type RuleTypeCondition = "is" | "is_less" | "is_more" | "is_not";
+/**
+ * @category Entities
+ */
+export interface Conditions {
+    identifier: RuleType;
+    operation: RuleTypeCondition;
+    value: string;
+}
+/**
+ * @category Entities
+ */
+export interface SelectedService {
+    carrierId: string;
+    carrierServiceCode: string;
+}
+/**
+ * @category Entities
+ */
+export interface ShippingRule {
+    active?: boolean;
+    code?: string;
+    createdAt?: ISOString;
+    default: {
+        services: SelectedService[];
+        sortBy: string;
+    };
+    deleted?: boolean;
+    deletedAt?: ISOString;
+    id?: string;
+    name: string;
+    rules?: [
+        {
+            conditions: Conditions[];
+            priority: number;
+            services: SelectedService[];
+            sortBy: string;
+        }
+    ];
+    updatedAt?: ISOString;
+}
+export {};