@whiplashmerch/whiplash-api-client 0.2.0 → 0.2.2

package/dist/generated/Orders.d.ts

@@ -1,7 +1,7 @@
 import { APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesResult, APIV2EntitiesSerialNumber, GetApiV21OrdersCountParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersParams, PostApiV21Orders, PostApiV21OrdersIdOrderDocuments, PostApiV21OrdersIdOrderItems, PostApiV2Orders, PostApiV2OrdersIdOrderDocuments, PostApiV2OrdersIdOrderItems, PutApiV21Orders, PutApiV21OrdersIdCall, PutApiV21OrdersIdMetaFields, PutApiV21OrdersOriginator, PutApiV2Orders, PutApiV2OrdersIdCall, PutApiV2OrdersIdMetaFields, PutApiV2OrdersOriginator } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
- * No description
+ * @description Create an order
  *
  * @tags orders
  * @name PostApiV2Orders
@@ -10,7 +10,7 @@ import { HttpClient, RequestParams } from "./http-client";
  */
 export declare const postApiV2Orders: (client: HttpClient, ApiV2Orders: PostApiV2Orders, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
 /**
- * No description
+ * @description Retrieves a list of orders
  *
  * @tags orders
  * @name GetApiV2Orders
@@ -19,7 +19,7 @@ export declare const postApiV2Orders: (client: HttpClient, ApiV2Orders: PostApiV
  */
 export declare const getApiV2Orders: (client: HttpClient, query: GetApiV2OrdersParams, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
 /**
- * No description
+ * @description Returns count of orders
  *
  * @tags orders
  * @name GetApiV2OrdersCount
@@ -46,7 +46,7 @@ export declare const postApiV2OrdersBulk: (client: HttpClient, resources: object
  */
 export declare const getApiV2OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
 /**
- * No description
+ * @description Update an order
  *
  * @tags originators
  * @name PutApiV2OrdersOriginatorOriginatorId
@@ -55,7 +55,7 @@ export declare const getApiV2OrdersActions: (client: HttpClient, params?: Reques
  */
 export declare const putApiV2OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV2OrdersOriginator: PutApiV2OrdersOriginator, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags originators
  * @name GetApiV2OrdersOriginatorOriginatorId
@@ -64,7 +64,7 @@ export declare const putApiV2OrdersOriginatorOriginatorId: (client: HttpClient,
  */
 export declare const getApiV2OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
 /**
- * No description
+ * @description Returns count of order's events
  *
  * @tags orders
  * @name GetApiV2OrdersIdEventsCount
@@ -73,7 +73,7 @@ export declare const getApiV2OrdersOriginatorOriginatorId: (client: HttpClient,
  */
 export declare const getApiV2OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
 /**
- * No description
+ * @description Get the order history
  *
  * @tags orders
  * @name GetApiV2OrdersIdEvents
@@ -82,7 +82,7 @@ export declare const getApiV2OrdersIdEventsCount: (client: HttpClient, { id, ...
  */
 export declare const getApiV2OrdersIdEvents: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdEventsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderEvent[]>;
 /**
- * No description
+ * @description Update an order
  *
  * @tags orders
  * @name PutApiV2OrdersId
@@ -91,7 +91,7 @@ export declare const getApiV2OrdersIdEvents: (client: HttpClient, { id, ...query
  */
 export declare const putApiV2OrdersId: (client: HttpClient, id: number, ApiV2Orders: PutApiV2Orders, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags orders
  * @name GetApiV2OrdersId
@@ -181,7 +181,7 @@ export declare const putApiV2OrdersIdCallAction: (client: HttpClient, action: st
  */
 export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber[]>;
 /**
- * No description
+ * @description Create an order
  *
  * @tags orders
  * @name PostApiV21Orders
@@ -190,7 +190,7 @@ export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: num
  */
 export declare const postApiV21Orders: (client: HttpClient, ApiV21Orders: PostApiV21Orders, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
 /**
- * No description
+ * @description Retrieves a list of orders
  *
  * @tags orders
  * @name GetApiV21Orders
@@ -199,7 +199,7 @@ export declare const postApiV21Orders: (client: HttpClient, ApiV21Orders: PostAp
  */
 export declare const getApiV21Orders: (client: HttpClient, query: GetApiV21OrdersParams, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
 /**
- * No description
+ * @description Returns count of orders
  *
  * @tags orders
  * @name GetApiV21OrdersCount
@@ -226,7 +226,7 @@ export declare const postApiV21OrdersBulk: (client: HttpClient, resources: objec
  */
 export declare const getApiV21OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
 /**
- * No description
+ * @description Update an order
  *
  * @tags originators
  * @name PutApiV21OrdersOriginatorOriginatorId
@@ -235,7 +235,7 @@ export declare const getApiV21OrdersActions: (client: HttpClient, params?: Reque
  */
 export declare const putApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV21OrdersOriginator: PutApiV21OrdersOriginator, params?: RequestParams) => Promise<void>;
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags originators
  * @name GetApiV21OrdersOriginatorOriginatorId
@@ -244,7 +244,7 @@ export declare const putApiV21OrdersOriginatorOriginatorId: (client: HttpClient,
  */
 export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
 /**
- * No description
+ * @description Returns count of order's events
  *
  * @tags orders
  * @name GetApiV21OrdersIdEventsCount
@@ -253,7 +253,7 @@ export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient,
  */
 export declare const getApiV21OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
 /**
- * No description
+ * @description Get the order history
  *
  * @tags orders
  * @name GetApiV21OrdersIdEvents
@@ -262,7 +262,7 @@ export declare const getApiV21OrdersIdEventsCount: (client: HttpClient, { id, ..
  */
 export declare const getApiV21OrdersIdEvents: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdEventsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderEvent[]>;
 /**
- * No description
+ * @description Update an order
  *
  * @tags orders
  * @name PutApiV21OrdersId
@@ -271,7 +271,7 @@ export declare const getApiV21OrdersIdEvents: (client: HttpClient, { id, ...quer
  */
 export declare const putApiV21OrdersId: (client: HttpClient, id: number, ApiV21Orders: PutApiV21Orders, params?: RequestParams) => Promise<void>;
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags orders
  * @name GetApiV21OrdersId

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

@@ -1238,6 +1238,7 @@ export interface APIV2EntitiesOrderDocument {
     /** the order document file url */
     url?: string;
 }
+/** Get the order history */
 export interface APIV2EntitiesOrderEvent {
     /**
      * the event date and time
@@ -1757,7 +1758,7 @@ export interface APIV2EntitiesShipnotice {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
-    shipnotice_items?: APIV2EntitiesShipnoticeItem;
+    shipnotice_items?: APIV2EntitiesShipnoticeItem[];
     /** url of the shipping label */
     shipping_label_url?: string;
     shipping_method?: APIV2EntitiesShippingMethod;
@@ -2060,20 +2061,14 @@ export interface APIV2EntitiesUser {
     id?: number;
     /** last name of the user */
     last_name?: string;
-    /**
-     * locale for language settings
-     * @default "en"
-     */
+    /** locale for language settings */
     locale?: ApiV2EntitiesUserLocale;
     /**
      * partner_id of the user
      * @format int32
      */
     partner_id?: number;
-    /**
-     * role of the user
-     * @default "customer"
-     */
+    /** role of the user */
     role?: ApiV2EntitiesUserRole;
     /**
      * the user sign in count
@@ -3468,18 +3463,12 @@ export declare enum ApiV2EntitiesOrderIncoterm {
     DEQ = "DEQ",
     DDU = "DDU"
 }
-/**
- * locale for language settings
- * @default "en"
- */
+/** locale for language settings */
 export declare enum ApiV2EntitiesUserLocale {
     En = "en",
     Es = "es"
 }
-/**
- * role of the user
- * @default "customer"
- */
+/** role of the user */
 export declare enum ApiV2EntitiesUserRole {
     Admin = "admin",
     Manager = "manager",
@@ -4760,6 +4749,7 @@ export interface PostApiV21Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     shipnotice_items_attributes?: {
         /**
          * the number of this shipnotice item in the shipnotice
@@ -6184,6 +6174,7 @@ export interface PostApiV2Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     shipnotice_items_attributes?: {
         /**
          * the number of this shipnotice item in the shipnotice
@@ -8307,6 +8298,7 @@ export interface PutApiV21Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     /** url of the shipping label */
     shipping_label_url?: string;
     /**
@@ -8432,6 +8424,7 @@ export interface PutApiV21ShipnoticesOriginator {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     /** url of the shipping label */
     shipping_label_url?: string;
     /**
@@ -10460,6 +10453,7 @@ export interface PutApiV2Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     /** url of the shipping label */
     shipping_label_url?: string;
     /**
@@ -10583,6 +10577,7 @@ export interface PutApiV2ShipnoticesOriginator {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
+    shipnotice_items?: string;
     /** url of the shipping label */
     shipping_label_url?: string;
     /**

package/generated/Orders.ts

@@ -54,7 +54,7 @@ import {
 import { ContentType, HttpClient, RequestParams } from "./http-client";
 
 /**
- * No description
+ * @description Create an order
  *
  * @tags orders
  * @name PostApiV2Orders
@@ -72,7 +72,7 @@ export const postApiV2Orders = (client: HttpClient, ApiV2Orders: PostApiV2Orders
   });
 };
 /**
- * No description
+ * @description Retrieves a list of orders
  *
  * @tags orders
  * @name GetApiV2Orders
@@ -89,7 +89,7 @@ export const getApiV2Orders = (client: HttpClient, query: GetApiV2OrdersParams,
   });
 };
 /**
- * No description
+ * @description Returns count of orders
  *
  * @tags orders
  * @name GetApiV2OrdersCount
@@ -143,7 +143,7 @@ export const getApiV2OrdersActions = (client: HttpClient, params: RequestParams
   });
 };
 /**
- * No description
+ * @description Update an order
  *
  * @tags originators
  * @name PutApiV2OrdersOriginatorOriginatorId
@@ -166,7 +166,7 @@ export const putApiV2OrdersOriginatorOriginatorId = (
   });
 };
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags originators
  * @name GetApiV2OrdersOriginatorOriginatorId
@@ -186,7 +186,7 @@ export const getApiV2OrdersOriginatorOriginatorId = (
   });
 };
 /**
- * No description
+ * @description Returns count of order's events
  *
  * @tags orders
  * @name GetApiV2OrdersIdEventsCount
@@ -207,7 +207,7 @@ export const getApiV2OrdersIdEventsCount = (
   });
 };
 /**
- * No description
+ * @description Get the order history
  *
  * @tags orders
  * @name GetApiV2OrdersIdEvents
@@ -228,7 +228,7 @@ export const getApiV2OrdersIdEvents = (
   });
 };
 /**
- * No description
+ * @description Update an order
  *
  * @tags orders
  * @name PutApiV2OrdersId
@@ -251,7 +251,7 @@ export const putApiV2OrdersId = (
   });
 };
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags orders
  * @name GetApiV2OrdersId
@@ -459,7 +459,7 @@ export const getApiV2OrdersIdSerialNumbers = (client: HttpClient, id: number, pa
   });
 };
 /**
- * No description
+ * @description Create an order
  *
  * @tags orders
  * @name PostApiV21Orders
@@ -477,7 +477,7 @@ export const postApiV21Orders = (client: HttpClient, ApiV21Orders: PostApiV21Ord
   });
 };
 /**
- * No description
+ * @description Retrieves a list of orders
  *
  * @tags orders
  * @name GetApiV21Orders
@@ -494,7 +494,7 @@ export const getApiV21Orders = (client: HttpClient, query: GetApiV21OrdersParams
   });
 };
 /**
- * No description
+ * @description Returns count of orders
  *
  * @tags orders
  * @name GetApiV21OrdersCount
@@ -548,7 +548,7 @@ export const getApiV21OrdersActions = (client: HttpClient, params: RequestParams
   });
 };
 /**
- * No description
+ * @description Update an order
  *
  * @tags originators
  * @name PutApiV21OrdersOriginatorOriginatorId
@@ -570,7 +570,7 @@ export const putApiV21OrdersOriginatorOriginatorId = (
   });
 };
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags originators
  * @name GetApiV21OrdersOriginatorOriginatorId
@@ -590,7 +590,7 @@ export const getApiV21OrdersOriginatorOriginatorId = (
   });
 };
 /**
- * No description
+ * @description Returns count of order's events
  *
  * @tags orders
  * @name GetApiV21OrdersIdEventsCount
@@ -611,7 +611,7 @@ export const getApiV21OrdersIdEventsCount = (
   });
 };
 /**
- * No description
+ * @description Get the order history
  *
  * @tags orders
  * @name GetApiV21OrdersIdEvents
@@ -632,7 +632,7 @@ export const getApiV21OrdersIdEvents = (
   });
 };
 /**
- * No description
+ * @description Update an order
  *
  * @tags orders
  * @name PutApiV21OrdersId
@@ -654,7 +654,7 @@ export const putApiV21OrdersId = (
   });
 };
 /**
- * No description
+ * @description Retrieve an order
  *
  * @tags orders
  * @name GetApiV21OrdersId

package/generated/data-contracts.ts

@@ -1264,6 +1264,7 @@ export interface APIV2EntitiesOrderDocument {
   url?: string;
 }
 
+/** Get the order history */
 export interface APIV2EntitiesOrderEvent {
   /**
    * the event date and time
@@ -1791,7 +1792,7 @@ export interface APIV2EntitiesShipnotice {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
-  shipnotice_items?: APIV2EntitiesShipnoticeItem;
+  shipnotice_items?: APIV2EntitiesShipnoticeItem[];
   /** url of the shipping label */
   shipping_label_url?: string;
   shipping_method?: APIV2EntitiesShippingMethod;
@@ -2100,20 +2101,14 @@ export interface APIV2EntitiesUser {
   id?: number;
   /** last name of the user */
   last_name?: string;
-  /**
-   * locale for language settings
-   * @default "en"
-   */
+  /** locale for language settings */
   locale?: ApiV2EntitiesUserLocale;
   /**
    * partner_id of the user
    * @format int32
    */
   partner_id?: number;
-  /**
-   * role of the user
-   * @default "customer"
-   */
+  /** role of the user */
   role?: ApiV2EntitiesUserRole;
   /**
    * the user sign in count
@@ -3590,19 +3585,13 @@ export enum ApiV2EntitiesOrderIncoterm {
   DDU = "DDU",
 }
 
-/**
- * locale for language settings
- * @default "en"
- */
+/** locale for language settings */
 export enum ApiV2EntitiesUserLocale {
   En = "en",
   Es = "es",
 }
 
-/**
- * role of the user
- * @default "customer"
- */
+/** role of the user */
 export enum ApiV2EntitiesUserRole {
   Admin = "admin",
   Manager = "manager",
@@ -4898,6 +4887,7 @@ export interface PostApiV21Shipnotices {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   shipnotice_items_attributes?: {
     /**
      * the number of this shipnotice item in the shipnotice
@@ -6342,6 +6332,7 @@ export interface PostApiV2Shipnotices {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   shipnotice_items_attributes?: {
     /**
      * the number of this shipnotice item in the shipnotice
@@ -8498,6 +8489,7 @@ export interface PutApiV21Shipnotices {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   /** url of the shipping label */
   shipping_label_url?: string;
   /**
@@ -8625,6 +8617,7 @@ export interface PutApiV21ShipnoticesOriginator {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   /** url of the shipping label */
   shipping_label_url?: string;
   /**
@@ -10686,6 +10679,7 @@ export interface PutApiV2Shipnotices {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   /** url of the shipping label */
   shipping_label_url?: string;
   /**
@@ -10811,6 +10805,7 @@ export interface PutApiV2ShipnoticesOriginator {
    * @format int32
    */
   shipnotice_item_sku_count?: number;
+  shipnotice_items?: string;
   /** url of the shipping label */
   shipping_label_url?: string;
   /**

package/package.json

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