@shipengine/js-api 0.45.1 → 0.46.0

package/index.js

@@ -3769,6 +3769,13 @@ class ShippingRulesAPI {
     this.delete = (shippingRuleId) => {
       return this.client.delete(`/v1/shipping_rules/${shippingRuleId}`);
     };
+    /**
+     * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
+     * `ShippingRule`.
+     */
+    this.edit = (shippingRule) => {
+      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -3765,6 +3765,13 @@ class ShippingRulesAPI {
     this.delete = (shippingRuleId) => {
       return this.client.delete(`/v1/shipping_rules/${shippingRuleId}`);
     };
+    /**
+     * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
+     * `ShippingRule`.
+     */
+    this.edit = (shippingRule) => {
+      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipping-rules/api.d.ts

@@ -24,4 +24,9 @@ export declare class ShippingRulesAPI {
      * The `delete` method deletes a shipping rule by `shippingRuleId`.
      */
     delete: (shippingRuleId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
+     * `ShippingRule`.
+     */
+    edit: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
 }

package/shipping-rules/types.d.ts

@@ -15,6 +15,14 @@ export interface ShippingRulesConditions {
     operation: RuleTypeCondition;
     value: string;
 }
+/**
+ * @category Entities
+ */
+export interface Rule {
+    conditions: ShippingRulesConditions[];
+    priority: number;
+    service: ShippingRuleSelectedService;
+}
 /**
  * @category Entities
  */
@@ -34,13 +42,7 @@ export interface ShippingRule {
     deletedAt?: ISOString;
     id: string;
     name: string;
-    rules?: [
-        {
-            conditions: ShippingRulesConditions[];
-            priority: number;
-            service: ShippingRuleSelectedService;
-        }
-    ];
+    rules?: Rule[];
     updatedAt?: ISOString;
 }
 /**