@shipengine/js-api 0.47.1 → 0.48.0

package/index.js

@@ -3774,7 +3774,16 @@ class ShippingRulesAPI {
      * `ShippingRule`.
      */
     this.edit = (shippingRule) => {
-      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+      return this.client.put(
+        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
+        shippingRule
+      );
+    };
+    /**
+     * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
+     */
+    this.getConditionOptions = () => {
+      return this.client.get(`/v1/shipping_rules/rule_conditions_options`);
     };
     this.client = client;
   }

package/index.mjs

@@ -3770,7 +3770,16 @@ class ShippingRulesAPI {
      * `ShippingRule`.
      */
     this.edit = (shippingRule) => {
-      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+      return this.client.put(
+        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
+        shippingRule
+      );
+    };
+    /**
+     * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
+     */
+    this.getConditionOptions = () => {
+      return this.client.get(`/v1/shipping_rules/rule_conditions_options`);
     };
     this.client = client;
   }

package/package.json

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

package/shipping-rules/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ShippingRule, ShippingRuleInput } from "./types";
+import { RuleConditionsOptions, ShippingRule, ShippingRuleInput } from "./types";
 /**
  * # Shipping Rules API module - /v1/shipping_rules
  */
@@ -29,4 +29,8 @@ export declare class ShippingRulesAPI {
      * `ShippingRule`.
      */
     edit: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    /**
+     * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
+     */
+    getConditionOptions: () => Promise<import("axios").AxiosResponse<RuleConditionsOptions[], any>>;
 }

package/shipping-rules/types.d.ts

@@ -2,17 +2,25 @@ 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";
+type RuleIdentifier = "MAX_DIMENSION" | "NUMBER_OF_PACKAGES" | "SHIP_FROM_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_FROM_COUNTRY_CODE" | "SHIP_TO_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_TO_COUNTRY_CODE" | "SHIP_TO_POSTAL_CODE" | "SHIP_FROM_POSTAL_CODE" | "SHIPMENT_VALUE" | "WAREHOUSE_ID" | "WEIGHT";
 /**
  * @category Entities
  */
-type RuleTypeCondition = "is" | "is_less" | "is_more" | "is_not";
+type RuleOperation = "IS" | "IS_LESS_THAN" | "IS_GREATER_THAN" | "IS_NOT" | "IN" | "NOT_IN" | "STARTS_WITH" | "IS_LESS_OR_EQUAL_TO" | "IS_GREATER_OR_EQUAL_TO";
+/**
+ * @category Entities
+ */
+type RuleValueType = "STRING" | "LIST" | "INTEGER" | "DECIMAL";
+/**
+ * @category Entities
+ */
+type RuleValueField = "SELECT" | "MULTISELECT" | "FIELD";
 /**
  * @category Entities
  */
 export interface ShippingRulesConditions {
-    identifier: RuleType;
-    operation: RuleTypeCondition;
+    identifier: RuleIdentifier;
+    operation: RuleOperation;
     value: string;
 }
 /**
@@ -28,7 +36,7 @@ export interface Rule {
  */
 export interface ShippingRuleSelectedService {
     carrierId: string;
-    carrierServiceCode: string;
+    serviceCode: string;
 }
 /**
  * @category Entities
@@ -40,13 +48,24 @@ export interface ShippingRule {
     default: ShippingRuleSelectedService;
     deleted?: boolean;
     deletedAt?: ISOString;
-    id: string;
     name: string;
     rules?: Rule[];
+    shippingRuleId: string;
     updatedAt?: ISOString;
 }
 /**
  * @category Entities
  */
-export type ShippingRuleInput = Omit<ShippingRule, "id">;
+export type ShippingRuleInput = Omit<ShippingRule, "shippingRuleId">;
+/**
+ * @category Entities
+ */
+export interface RuleConditionsOptions {
+    identifier: RuleIdentifier;
+    operations: RuleOperation[];
+    unitOptions?: string[];
+    valueField: RuleValueField;
+    valueOptions?: string[];
+    valueType: RuleValueType;
+}
 export {};