@whiplashmerch/whiplash-api-client 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2492,7 +2492,7 @@ const getApiV21OrderItemsIdSerialNumbers = (client, id, params = {}) => {
2492
2492
 
2493
2493
  /* eslint-disable */
2494
2494
  /**
2495
- * No description
2495
+ * @description Create an order
2496
2496
  *
2497
2497
  * @tags orders
2498
2498
  * @name PostApiV2Orders
@@ -2510,7 +2510,7 @@ const postApiV2Orders = (client, ApiV2Orders, params = {}) => {
2510
2510
  });
2511
2511
  };
2512
2512
  /**
2513
- * No description
2513
+ * @description Retrieves a list of orders
2514
2514
  *
2515
2515
  * @tags orders
2516
2516
  * @name GetApiV2Orders
@@ -2527,7 +2527,7 @@ const getApiV2Orders = (client, query, params = {}) => {
2527
2527
  });
2528
2528
  };
2529
2529
  /**
2530
- * No description
2530
+ * @description Returns count of orders
2531
2531
  *
2532
2532
  * @tags orders
2533
2533
  * @name GetApiV2OrdersCount
@@ -2577,7 +2577,7 @@ const getApiV2OrdersActions = (client, params = {}) => {
2577
2577
  });
2578
2578
  };
2579
2579
  /**
2580
- * No description
2580
+ * @description Update an order
2581
2581
  *
2582
2582
  * @tags originators
2583
2583
  * @name PutApiV2OrdersOriginatorOriginatorId
@@ -2595,7 +2595,7 @@ const putApiV2OrdersOriginatorOriginatorId = (client, originatorId, ApiV2OrdersO
2595
2595
  });
2596
2596
  };
2597
2597
  /**
2598
- * No description
2598
+ * @description Retrieve an order
2599
2599
  *
2600
2600
  * @tags originators
2601
2601
  * @name GetApiV2OrdersOriginatorOriginatorId
@@ -2611,7 +2611,7 @@ const getApiV2OrdersOriginatorOriginatorId = (client, originatorId, params = {})
2611
2611
  });
2612
2612
  };
2613
2613
  /**
2614
- * No description
2614
+ * @description Returns count of order's events
2615
2615
  *
2616
2616
  * @tags orders
2617
2617
  * @name GetApiV2OrdersIdEventsCount
@@ -2628,7 +2628,7 @@ const getApiV2OrdersIdEventsCount = (client, { id, ...query }, params = {}) => {
2628
2628
  });
2629
2629
  };
2630
2630
  /**
2631
- * No description
2631
+ * @description Get the order history
2632
2632
  *
2633
2633
  * @tags orders
2634
2634
  * @name GetApiV2OrdersIdEvents
@@ -2645,7 +2645,7 @@ const getApiV2OrdersIdEvents = (client, { id, ...query }, params = {}) => {
2645
2645
  });
2646
2646
  };
2647
2647
  /**
2648
- * No description
2648
+ * @description Update an order
2649
2649
  *
2650
2650
  * @tags orders
2651
2651
  * @name PutApiV2OrdersId
@@ -2663,7 +2663,7 @@ const putApiV2OrdersId = (client, id, ApiV2Orders, params = {}) => {
2663
2663
  });
2664
2664
  };
2665
2665
  /**
2666
- * No description
2666
+ * @description Retrieve an order
2667
2667
  *
2668
2668
  * @tags orders
2669
2669
  * @name GetApiV2OrdersId
@@ -2834,7 +2834,7 @@ const getApiV2OrdersIdSerialNumbers = (client, id, params = {}) => {
2834
2834
  });
2835
2835
  };
2836
2836
  /**
2837
- * No description
2837
+ * @description Create an order
2838
2838
  *
2839
2839
  * @tags orders
2840
2840
  * @name PostApiV21Orders
@@ -2852,7 +2852,7 @@ const postApiV21Orders = (client, ApiV21Orders, params = {}) => {
2852
2852
  });
2853
2853
  };
2854
2854
  /**
2855
- * No description
2855
+ * @description Retrieves a list of orders
2856
2856
  *
2857
2857
  * @tags orders
2858
2858
  * @name GetApiV21Orders
@@ -2869,7 +2869,7 @@ const getApiV21Orders = (client, query, params = {}) => {
2869
2869
  });
2870
2870
  };
2871
2871
  /**
2872
- * No description
2872
+ * @description Returns count of orders
2873
2873
  *
2874
2874
  * @tags orders
2875
2875
  * @name GetApiV21OrdersCount
@@ -2919,7 +2919,7 @@ const getApiV21OrdersActions = (client, params = {}) => {
2919
2919
  });
2920
2920
  };
2921
2921
  /**
2922
- * No description
2922
+ * @description Update an order
2923
2923
  *
2924
2924
  * @tags originators
2925
2925
  * @name PutApiV21OrdersOriginatorOriginatorId
@@ -2936,7 +2936,7 @@ const putApiV21OrdersOriginatorOriginatorId = (client, originatorId, ApiV21Order
2936
2936
  });
2937
2937
  };
2938
2938
  /**
2939
- * No description
2939
+ * @description Retrieve an order
2940
2940
  *
2941
2941
  * @tags originators
2942
2942
  * @name GetApiV21OrdersOriginatorOriginatorId
@@ -2952,7 +2952,7 @@ const getApiV21OrdersOriginatorOriginatorId = (client, originatorId, params = {}
2952
2952
  });
2953
2953
  };
2954
2954
  /**
2955
- * No description
2955
+ * @description Returns count of order's events
2956
2956
  *
2957
2957
  * @tags orders
2958
2958
  * @name GetApiV21OrdersIdEventsCount
@@ -2969,7 +2969,7 @@ const getApiV21OrdersIdEventsCount = (client, { id, ...query }, params = {}) =>
2969
2969
  });
2970
2970
  };
2971
2971
  /**
2972
- * No description
2972
+ * @description Get the order history
2973
2973
  *
2974
2974
  * @tags orders
2975
2975
  * @name GetApiV21OrdersIdEvents
@@ -2986,7 +2986,7 @@ const getApiV21OrdersIdEvents = (client, { id, ...query }, params = {}) => {
2986
2986
  });
2987
2987
  };
2988
2988
  /**
2989
- * No description
2989
+ * @description Update an order
2990
2990
  *
2991
2991
  * @tags orders
2992
2992
  * @name PutApiV21OrdersId
@@ -3003,7 +3003,7 @@ const putApiV21OrdersId = (client, id, ApiV21Orders, params = {}) => {
3003
3003
  });
3004
3004
  };
3005
3005
  /**
3006
- * No description
3006
+ * @description Retrieve an order
3007
3007
  *
3008
3008
  * @tags orders
3009
3009
  * @name GetApiV21OrdersId
@@ -4756,19 +4756,13 @@ var ApiV2EntitiesOrderIncoterm;
4756
4756
  ApiV2EntitiesOrderIncoterm["DEQ"] = "DEQ";
4757
4757
  ApiV2EntitiesOrderIncoterm["DDU"] = "DDU";
4758
4758
  })(ApiV2EntitiesOrderIncoterm || (ApiV2EntitiesOrderIncoterm = {}));
4759
- /**
4760
- * locale for language settings
4761
- * @default "en"
4762
- */
4759
+ /** locale for language settings */
4763
4760
  var ApiV2EntitiesUserLocale;
4764
4761
  (function (ApiV2EntitiesUserLocale) {
4765
4762
  ApiV2EntitiesUserLocale["En"] = "en";
4766
4763
  ApiV2EntitiesUserLocale["Es"] = "es";
4767
4764
  })(ApiV2EntitiesUserLocale || (ApiV2EntitiesUserLocale = {}));
4768
- /**
4769
- * role of the user
4770
- * @default "customer"
4771
- */
4765
+ /** role of the user */
4772
4766
  var ApiV2EntitiesUserRole;
4773
4767
  (function (ApiV2EntitiesUserRole) {
4774
4768
  ApiV2EntitiesUserRole["Admin"] = "admin";