@whiplashmerch/whiplash-api-client 3.2.51 → 3.2.53

package/dist/generated/Items.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesBundleItem, ApiV21EntitiesCount, ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesItemLocation, ApiV21EntitiesItemWarehouseQuantity, ApiV21EntitiesListValue, ApiV21EntitiesLocation, ApiV21EntitiesMessage, ApiV21EntitiesOriginator, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesScancode, ApiV21EntitiesShipnoticeItem, ApiV21EntitiesTransaction, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemLocation, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesListValue, ApiV2EntitiesLocation, ApiV2EntitiesMessage, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdLocationsWithTransferCountParams, GetApiV21ItemsIdMessagesCountParams, GetApiV21ItemsIdMessagesParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsCountParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesCountParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdLocationsWithTransferCountParams, GetApiV2ItemsIdMessagesCountParams, GetApiV2ItemsIdMessagesParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsCountParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesCountParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsParams, PostApiV21ItemsIdBundleItemsRequest, PostApiV21ItemsIdIncidentsRequest, PostApiV21ItemsIdLocationsRequest, PostApiV21ItemsIdMessagesRequest, PostApiV21ItemsIdOriginatorsRequest, PostApiV21ItemsRequest, PostApiV2ItemsIdBundleItemsRequest, PostApiV2ItemsIdIncidentsRequest, PostApiV2ItemsIdLocationsRequest, PostApiV2ItemsIdMessagesRequest, PostApiV2ItemsIdOriginatorsRequest, PostApiV2ItemsRequest, PutApiV21ItemsIdCallActionRequest, PutApiV21ItemsIdCallAsyncActionRequest, PutApiV21ItemsIdMetaFieldsRequest, PutApiV21ItemsIdRequest, PutApiV2ItemsIdCallActionRequest, PutApiV2ItemsIdCallAsyncActionRequest, PutApiV2ItemsIdMetaFieldsRequest, PutApiV2ItemsIdRequest } from "./data-contracts";
+import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesBundleItem, ApiV21EntitiesCount, ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesItemLocation, ApiV21EntitiesItemWarehouseQuantity, ApiV21EntitiesListValue, ApiV21EntitiesLocation, ApiV21EntitiesMessage, ApiV21EntitiesOriginator, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesScancode, ApiV21EntitiesShipnoticeItem, ApiV21EntitiesTransaction, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemLocation, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesListValue, ApiV2EntitiesLocation, ApiV2EntitiesMessage, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesScancodeHistory, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdLocationsWithTransferCountParams, GetApiV21ItemsIdMessagesCountParams, GetApiV21ItemsIdMessagesParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsCountParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodeHistoryParams, GetApiV21ItemsIdScancodesCountParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdLocationsWithTransferCountParams, GetApiV2ItemsIdMessagesCountParams, GetApiV2ItemsIdMessagesParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsCountParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodeHistoryParams, GetApiV2ItemsIdScancodesCountParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsParams, PostApiV21ItemsIdBundleItemsRequest, PostApiV21ItemsIdIncidentsRequest, PostApiV21ItemsIdLocationsRequest, PostApiV21ItemsIdMessagesRequest, PostApiV21ItemsIdOriginatorsRequest, PostApiV21ItemsRequest, PostApiV2ItemsIdBundleItemsRequest, PostApiV2ItemsIdIncidentsRequest, PostApiV2ItemsIdLocationsRequest, PostApiV2ItemsIdMessagesRequest, PostApiV2ItemsIdOriginatorsRequest, PostApiV2ItemsRequest, PutApiV21ItemsIdCallActionRequest, PutApiV21ItemsIdCallAsyncActionRequest, PutApiV21ItemsIdMetaFieldsRequest, PutApiV21ItemsIdRequest, PutApiV2ItemsIdCallActionRequest, PutApiV2ItemsIdCallAsyncActionRequest, PutApiV2ItemsIdMetaFieldsRequest, PutApiV2ItemsIdRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Get a list of items
@@ -297,6 +297,15 @@ export declare const postApiV2ItemsIdOriginators: (client: HttpClient, id: numbe
  * @request GET:/api/v2/items/{id}/originators/count
  */
 export declare const getApiV2ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description show scancode history associated with this item
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdScancodeHistory
+ * @summary List all scancode history associated with this item
+ * @request GET:/api/v2/items/{id}/scancode_history
+ */
+export declare const getApiV2ItemsIdScancodeHistory: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodeHistoryParams, params?: RequestParams) => Promise<ApiV2EntitiesScancodeHistory>;
 /**
  * @description show scancodes associated with this item
  *
@@ -675,6 +684,15 @@ export declare const postApiV21ItemsIdOriginators: (client: HttpClient, id: numb
  * @request GET:/api/v2.1/items/{id}/originators/count
  */
 export declare const getApiV21ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
+/**
+ * @description show scancode history associated with this item
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdScancodeHistory
+ * @summary List all scancode history associated with this item
+ * @request GET:/api/v2.1/items/{id}/scancode_history
+ */
+export declare const getApiV21ItemsIdScancodeHistory: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodeHistoryParams, params?: RequestParams) => Promise<ApiV2EntitiesScancodeHistory>;
 /**
  * @description show scancodes associated with this item
  *

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

@@ -1,6 +1,10 @@
 /** Shared */
 export interface ApiSharedEntitiesApiError {
-    /** error message */
+    /** top-level error class */
+    error?: string;
+    /** short code for error, used for error response logic */
+    error_code?: string;
+    /** readable error message */
     message?: string;
 }
 /** Shared */
@@ -4647,6 +4651,25 @@ export interface ApiV2EntitiesScancode {
     updated_at?: string;
 }
 /** V2 */
+export interface ApiV2EntitiesScancodeHistory {
+    /** the kind of scancode change: created, added, removed, promoted */
+    action?: string;
+    /**
+     * the audit id
+     * @format int32
+     */
+    id?: number;
+    /** The scancode affected by this action */
+    scancode?: string;
+    /**
+     * when the scancode change occurred
+     * @format date-time
+     */
+    updated_at?: string;
+    /** the user who made the change, or "system" if none */
+    user?: object;
+}
+/** V2 */
 export interface ApiV2EntitiesSerialNumber {
     /**
      * if not null, the DateTime when the serial was deleted
@@ -11789,6 +11812,23 @@ export interface GetApiV21ItemsIdOriginatorsParams {
     page_links?: boolean;
     id: number;
 }
+export interface GetApiV21ItemsIdScancodeHistoryParams {
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV21ItemsIdScancodesCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -13765,7 +13805,7 @@ export interface GetApiV21UsersIdTraitsParams {
 }
 export interface GetApiV21UsersJwtParams {
     /** Integration provider to generate JWT for. Currently only supports pandium */
-    provider: string;
+    provider: GetApiV21UsersJwtParamsProvider;
 }
 export interface GetApiV21UsersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
@@ -14703,6 +14743,23 @@ export interface GetApiV2ItemsIdOriginatorsParams {
     page_links?: boolean;
     id: number;
 }
+export interface GetApiV2ItemsIdScancodeHistoryParams {
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV2ItemsIdScancodesCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -16679,7 +16736,7 @@ export interface GetApiV2UsersIdTraitsParams {
 }
 export interface GetApiV2UsersJwtParams {
     /** Integration provider to generate JWT for. Currently only supports pandium */
-    provider: string;
+    provider: GetApiV2UsersJwtParamsProvider;
 }
 export interface GetApiV2UsersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
@@ -31093,6 +31150,10 @@ export declare enum GetApiV21ItemsIdLocationsWithTransferCountParamsRole {
 export declare enum GetApiV21SchemasLotsParamsSchema {
     ItemDetail = "ItemDetail"
 }
+/** Integration provider to generate JWT for. Currently only supports pandium */
+export declare enum GetApiV21UsersJwtParamsProvider {
+    Pandium = "pandium"
+}
 /** Type of inbound ship notice to fetch (Shipnotice or ConsumerReturn) */
 export declare enum GetApiV2ItemsIdInboundParamsType {
     Shipnotice = "Shipnotice",
@@ -31115,6 +31176,10 @@ export declare enum GetApiV2ItemsIdLocationsWithTransferCountParamsRole {
 export declare enum GetApiV2SchemasLotsParamsSchema {
     ItemDetail = "ItemDetail"
 }
+/** Integration provider to generate JWT for. Currently only supports pandium */
+export declare enum GetApiV2UsersJwtParamsProvider {
+    Pandium = "pandium"
+}
 export declare enum PostApiV21BillOfLadingsIdAddressesRequestAddressType {
     ShipTo = "ship_to",
     ShipFrom = "ship_from",

package/generated/data-contracts.ts

@@ -11,7 +11,11 @@
 
 /** Shared */
 export interface ApiSharedEntitiesApiError {
-  /** error message */
+  /** top-level error class */
+  error?: string;
+  /** short code for error, used for error response logic */
+  error_code?: string;
+  /** readable error message */
   message?: string;
 }
 

package/package.json

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