@whiplashmerch/whiplash-api-client 2.0.29 → 2.0.30

package/dist/generated/NotificationSubscriptions.d.ts

@@ -1,4 +1,4 @@
-import { ApiV21EntitiesNotificationSubscription, ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptionsRequest, PostApiV2NotificationSubscriptionsRequest, PutApiV21NotificationSubscriptionsIdRequest, PutApiV2NotificationSubscriptionsIdRequest } from "./data-contracts";
+import { ApiV21EntitiesNotificationSubscription, ApiV21EntitiesPostResponse, ApiV2EntitiesAudits, ApiV2EntitiesCount, ApiV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptionsRequest, PostApiV2NotificationSubscriptionsRequest, PutApiV21NotificationSubscriptionsIdRequest, PutApiV2NotificationSubscriptionsIdRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Get a list of notification subscriptions
@@ -54,6 +54,15 @@ export declare const putApiV2NotificationSubscriptionsId: (client: HttpClient, i
  * @request DELETE:/api/v2/notification_subscriptions/{id}
  */
 export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all audits for users
+ *
+ * @tags notification_subscriptions
+ * @name GetApiV2NotificationSubscriptionsIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/notification_subscriptions/{id}/audits
+ */
+export declare const getApiV2NotificationSubscriptionsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesAudits>;
 /**
  * @description Test a notification subscription
  *
@@ -117,6 +126,15 @@ export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient,
  * @request DELETE:/api/v2.1/notification_subscriptions/{id}
  */
 export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all audits for users
+ *
+ * @tags notification_subscriptions
+ * @name GetApiV21NotificationSubscriptionsIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2.1/notification_subscriptions/{id}/audits
+ */
+export declare const getApiV21NotificationSubscriptionsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesAudits>;
 /**
  * @description Test a notification subscription
  *

package/dist/generated/data-contracts.d.ts

@@ -2715,6 +2715,11 @@ export interface ApiV2EntitiesNotificationSubscription {
      * @format int32
      */
     customer_id?: number | null;
+    /**
+     * the notification subscription discarded date and time
+     * @format date-time
+     */
+    discarded_at?: string | null;
     /** the URL the subscription will hit for Slack and Webhook types */
     endpoint?: string | null;
     /**
@@ -2975,7 +2980,7 @@ export interface ApiV2EntitiesOrder {
     return_zip?: string | null;
     /** require a carrier that delivers on Saturdays for this order? */
     saturday_delivery?: boolean | null;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string | null;
     serial_numbers?: ApiV2EntitiesSerialNumber[];
     /**
@@ -3052,6 +3057,10 @@ export interface ApiV2EntitiesOrder {
     status?: ApiV2EntitiesOrderStatus;
     /** the order status name */
     status_name?: string;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string | null;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean | null;
     tracking?: string[];
     tracking_links?: string[];
     /**
@@ -7294,6 +7303,11 @@ export interface ApiV21EntitiesNotificationSubscription {
      * @format int32
      */
     customer_id?: number | null;
+    /**
+     * the notification subscription discarded date and time
+     * @format date-time
+     */
+    discarded_at?: string | null;
     /** the URL the subscription will hit for Slack and Webhook types */
     endpoint?: string | null;
     /**
@@ -7637,6 +7651,10 @@ export interface ApiV21EntitiesOrder {
     status?: ApiV21EntitiesOrderStatus;
     /** the order status name */
     status_name?: string;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string | null;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean | null;
     tracking?: string[];
     tracking_links?: string[];
     /**
@@ -15933,8 +15951,12 @@ export interface PostApiV21OrdersBulkRequest {
         email?: string;
         /** skip order shipping address verification? (staff only) */
         skip_address_verification?: boolean;
-        /** the order scac number */
+        /** the orders Standard Carrier Alpha Code number */
         scac?: string;
+        /** The Transport Management System ID for the order, if applicable */
+        tms_id?: string;
+        /** Does the order require a Transport Management System ID */
+        tms_required?: boolean;
         /** the order shop warehouse ids */
         shop_warehouse_ids?: number[];
         /** the order shop shipping method currency */
@@ -16833,7 +16855,7 @@ export interface PostApiV21OrdersRequest {
     return_zip?: string;
     /** require a carrier that delivers on Saturdays for this order? */
     saturday_delivery?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
     /** the order ship notes */
     ship_notes?: string;
@@ -16894,6 +16916,10 @@ export interface PostApiV21OrdersRequest {
      * @format int32
      */
     status?: PostApiV21OrdersRequestStatus;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order tracking numbers */
     tracking?: string[];
     /** the order tracking links */
@@ -19560,8 +19586,12 @@ export interface PostApiV2OrdersBulkRequest {
         email?: string;
         /** skip order shipping address verification? (staff only) */
         skip_address_verification?: boolean;
-        /** the order scac number */
+        /** the orders Standard Carrier Alpha Code number */
         scac?: string;
+        /** The Transport Management System ID for the order, if applicable */
+        tms_id?: string;
+        /** Does the order require a Transport Management System ID */
+        tms_required?: boolean;
         /** the order shop warehouse ids */
         shop_warehouse_ids?: number[];
         /** the order shop shipping method currency */
@@ -20460,7 +20490,7 @@ export interface PostApiV2OrdersRequest {
     return_zip?: string;
     /** require a carrier that delivers on Saturdays for this order? */
     saturday_delivery?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
     /** the order ship notes */
     ship_notes?: string;
@@ -20521,6 +20551,10 @@ export interface PostApiV2OrdersRequest {
      * @format int32
      */
     status?: PostApiV2OrdersRequestStatus;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order tracking numbers */
     tracking?: string[];
     /** the order tracking links */
@@ -22872,6 +22906,11 @@ export interface PutApiV21NotificationSubscriptionsIdRequest {
      * @format int32
      */
     customer_id?: number;
+    /**
+     * the notification subscription discarded date and time
+     * @format date-time
+     */
+    discarded_at?: string;
     /** the URL the subscription will hit for Slack and Webhook types */
     endpoint?: string;
     /**
@@ -23415,7 +23454,7 @@ export interface PutApiV21OrdersIdRequest {
     return_zip?: string;
     /** require a carrier that delivers on Saturdays for this order? */
     saturday_delivery?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
     /** the order ship notes */
     ship_notes?: string;
@@ -23471,6 +23510,10 @@ export interface PutApiV21OrdersIdRequest {
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order tracking numbers */
     tracking?: string[];
     /** the order tracking links */
@@ -25859,6 +25902,11 @@ export interface PutApiV2NotificationSubscriptionsIdRequest {
      * @format int32
      */
     customer_id?: number;
+    /**
+     * the notification subscription discarded date and time
+     * @format date-time
+     */
+    discarded_at?: string;
     /** the URL the subscription will hit for Slack and Webhook types */
     endpoint?: string;
     /**
@@ -26402,7 +26450,7 @@ export interface PutApiV2OrdersIdRequest {
     return_zip?: string;
     /** require a carrier that delivers on Saturdays for this order? */
     saturday_delivery?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
     /** the order ship notes */
     ship_notes?: string;
@@ -26458,6 +26506,10 @@ export interface PutApiV2OrdersIdRequest {
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order tracking numbers */
     tracking?: string[];
     /** the order tracking links */

package/generated/data-contracts.ts

@@ -1255,6 +1255,11 @@ export interface ApiV2EntitiesNotificationSubscription {
    * @format int32
    */
   customer_id?: number | null;
+  /**
+   * the notification subscription discarded date and time
+   * @format date-time
+   */
+  discarded_at?: string | null;
   /** the URL the subscription will hit for Slack and Webhook types */
   endpoint?: string | null;
   /**
@@ -1516,7 +1521,7 @@ export interface ApiV2EntitiesOrder {
   return_zip?: string | null;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean | null;
-  /** the order scac number */
+  /** the orders Standard Carrier Alpha Code number */
   scac?: string | null;
   serial_numbers?: ApiV2EntitiesSerialNumber[];
   /**
@@ -1593,6 +1598,10 @@ export interface ApiV2EntitiesOrder {
   status?: ApiV2EntitiesOrderStatus;
   /** the order status name */
   status_name?: string;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string | null;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean | null;
   tracking?: string[];
   tracking_links?: string[];
   /**
@@ -3695,6 +3704,11 @@ export interface ApiV21EntitiesNotificationSubscription {
    * @format int32
    */
   customer_id?: number | null;
+  /**
+   * the notification subscription discarded date and time
+   * @format date-time
+   */
+  discarded_at?: string | null;
   /** the URL the subscription will hit for Slack and Webhook types */
   endpoint?: string | null;
   /**
@@ -4039,6 +4053,10 @@ export interface ApiV21EntitiesOrder {
   status?: ApiV21EntitiesOrderStatus;
   /** the order status name */
   status_name?: string;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string | null;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean | null;
   tracking?: string[];
   tracking_links?: string[];
   /**
@@ -6415,8 +6433,12 @@ export interface PostApiV21OrdersBulkRequest {
     email?: string;
     /** skip order shipping address verification? (staff only) */
     skip_address_verification?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
     /** the order shop shipping method currency */
@@ -7214,7 +7236,7 @@ export interface PostApiV21OrdersRequest {
   return_zip?: string;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean;
-  /** the order scac number */
+  /** the orders Standard Carrier Alpha Code number */
   scac?: string;
   /** the order ship notes */
   ship_notes?: string;
@@ -7275,6 +7297,10 @@ export interface PostApiV21OrdersRequest {
    * @format int32
    */
   status?: PostApiV21OrdersRequestStatus;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean;
   /** the order tracking numbers */
   tracking?: string[];
   /** the order tracking links */
@@ -8367,8 +8393,12 @@ export interface PostApiV2OrdersBulkRequest {
     email?: string;
     /** skip order shipping address verification? (staff only) */
     skip_address_verification?: boolean;
-    /** the order scac number */
+    /** the orders Standard Carrier Alpha Code number */
     scac?: string;
+    /** The Transport Management System ID for the order, if applicable */
+    tms_id?: string;
+    /** Does the order require a Transport Management System ID */
+    tms_required?: boolean;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
     /** the order shop shipping method currency */
@@ -9166,7 +9196,7 @@ export interface PostApiV2OrdersRequest {
   return_zip?: string;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean;
-  /** the order scac number */
+  /** the orders Standard Carrier Alpha Code number */
   scac?: string;
   /** the order ship notes */
   ship_notes?: string;
@@ -9227,6 +9257,10 @@ export interface PostApiV2OrdersRequest {
    * @format int32
    */
   status?: PostApiV2OrdersRequestStatus;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean;
   /** the order tracking numbers */
   tracking?: string[];
   /** the order tracking links */
@@ -10202,6 +10236,11 @@ export interface PutApiV21NotificationSubscriptionsIdRequest {
    * @format int32
    */
   customer_id?: number;
+  /**
+   * the notification subscription discarded date and time
+   * @format date-time
+   */
+  discarded_at?: string;
   /** the URL the subscription will hit for Slack and Webhook types */
   endpoint?: string;
   /**
@@ -10605,7 +10644,7 @@ export interface PutApiV21OrdersIdRequest {
   return_zip?: string;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean;
-  /** the order scac number */
+  /** the orders Standard Carrier Alpha Code number */
   scac?: string;
   /** the order ship notes */
   ship_notes?: string;
@@ -10661,6 +10700,10 @@ export interface PutApiV21OrdersIdRequest {
   skip_address_verification?: boolean;
   /** skip street date for this order? */
   skip_street_date?: boolean;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean;
   /** the order tracking numbers */
   tracking?: string[];
   /** the order tracking links */
@@ -11432,6 +11475,11 @@ export interface PutApiV2NotificationSubscriptionsIdRequest {
    * @format int32
    */
   customer_id?: number;
+  /**
+   * the notification subscription discarded date and time
+   * @format date-time
+   */
+  discarded_at?: string;
   /** the URL the subscription will hit for Slack and Webhook types */
   endpoint?: string;
   /**
@@ -11835,7 +11883,7 @@ export interface PutApiV2OrdersIdRequest {
   return_zip?: string;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean;
-  /** the order scac number */
+  /** the orders Standard Carrier Alpha Code number */
   scac?: string;
   /** the order ship notes */
   ship_notes?: string;
@@ -11891,6 +11939,10 @@ export interface PutApiV2OrdersIdRequest {
   skip_address_verification?: boolean;
   /** skip street date for this order? */
   skip_street_date?: boolean;
+  /** The Transport Management System ID for the order, if applicable */
+  tms_id?: string;
+  /** Does the order require a Transport Management System ID */
+  tms_required?: boolean;
   /** the order tracking numbers */
   tracking?: string[];
   /** the order tracking links */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whiplashmerch/whiplash-api-client",
-  "version": "2.0.29",
+  "version": "2.0.30",
   "description": "",
   "devDependencies": {},
   "scripts": {