@shipengine/js-api 0.38.0 → 0.39.0

package/index.js

@@ -3644,6 +3644,12 @@ class ShippingRulesAPI {
     this.list = () => {
       return this.client.get(`/v1/shipping_rules`);
     };
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    this.create = (shippingRule) => {
+      return this.client.post("/v1/shipping_rules", shippingRule);
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -3640,6 +3640,12 @@ class ShippingRulesAPI {
     this.list = () => {
       return this.client.get(`/v1/shipping_rules`);
     };
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    this.create = (shippingRule) => {
+      return this.client.post("/v1/shipping_rules", shippingRule);
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipping-rules/api.d.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { RequiredFields } from "../types";
 import { ShippingRule } from "./types";
 /**
  * # Shipping Rules API module - /v1/shipping_rules
@@ -12,4 +13,8 @@ export declare class ShippingRulesAPI {
     list: () => Promise<import("axios").AxiosResponse<{
         shippingRules: ShippingRule[];
     }, any>>;
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    create: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<RequiredFields<ShippingRule, "id">, any>>;
 }

package/shipping-rules/types.d.ts

@@ -10,7 +10,7 @@ type RuleTypeCondition = "is" | "is_less" | "is_more" | "is_not";
 /**
  * @category Entities
  */
-export interface Conditions {
+export interface ShippingRulesConditions {
     identifier: RuleType;
     operation: RuleTypeCondition;
     value: string;
@@ -18,7 +18,7 @@ export interface Conditions {
 /**
  * @category Entities
  */
-export interface SelectedService {
+export interface ShippingRuleSelectedService {
     carrierId: string;
     carrierServiceCode: string;
 }
@@ -30,8 +30,8 @@ export interface ShippingRule {
     code?: string;
     createdAt?: ISOString;
     default: {
-        services: SelectedService[];
-        sortBy: string;
+        services: ShippingRuleSelectedService[];
+        sortBy?: string;
     };
     deleted?: boolean;
     deletedAt?: ISOString;
@@ -39,10 +39,10 @@ export interface ShippingRule {
     name: string;
     rules?: [
         {
-            conditions: Conditions[];
+            conditions: ShippingRulesConditions[];
             priority: number;
-            services: SelectedService[];
-            sortBy: string;
+            services: ShippingRuleSelectedService[];
+            sortBy?: string;
         }
     ];
     updatedAt?: ISOString;

package/types.d.ts

@@ -1,3 +1,4 @@
+export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export * from "./account-settings/types";
 export * from "./addresses/types";
 export * from "./carriers/types";
@@ -16,6 +17,7 @@ export * from "./resources/types";
 export * from "./sales-order-shipments/types";
 export * from "./sales-orders/types";
 export * from "./shipments/types";
+export * from "./shipping-rules/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
 export * from "./weight-band/types";