@whiplashmerch/whiplash-api-client 3.2.52 → 3.2.54
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
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";
|
|
1
|
+
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";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get a list of items
|
|
@@ -297,6 +297,15 @@ export declare const postApiV2ItemsIdOriginators: (client: HttpClient, id: numbe
|
|
|
297
297
|
* @request GET:/api/v2/items/{id}/originators/count
|
|
298
298
|
*/
|
|
299
299
|
export declare const getApiV2ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
|
|
300
|
+
/**
|
|
301
|
+
* @description show scancode history associated with this item
|
|
302
|
+
*
|
|
303
|
+
* @tags items
|
|
304
|
+
* @name GetApiV2ItemsIdScancodeHistory
|
|
305
|
+
* @summary List all scancode history associated with this item
|
|
306
|
+
* @request GET:/api/v2/items/{id}/scancode_history
|
|
307
|
+
*/
|
|
308
|
+
export declare const getApiV2ItemsIdScancodeHistory: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodeHistoryParams, params?: RequestParams) => Promise<ApiV2EntitiesScancodeHistory>;
|
|
300
309
|
/**
|
|
301
310
|
* @description show scancodes associated with this item
|
|
302
311
|
*
|
|
@@ -675,6 +684,15 @@ export declare const postApiV21ItemsIdOriginators: (client: HttpClient, id: numb
|
|
|
675
684
|
* @request GET:/api/v2.1/items/{id}/originators/count
|
|
676
685
|
*/
|
|
677
686
|
export declare const getApiV21ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
687
|
+
/**
|
|
688
|
+
* @description show scancode history associated with this item
|
|
689
|
+
*
|
|
690
|
+
* @tags items
|
|
691
|
+
* @name GetApiV21ItemsIdScancodeHistory
|
|
692
|
+
* @summary List all scancode history associated with this item
|
|
693
|
+
* @request GET:/api/v2.1/items/{id}/scancode_history
|
|
694
|
+
*/
|
|
695
|
+
export declare const getApiV21ItemsIdScancodeHistory: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodeHistoryParams, params?: RequestParams) => Promise<ApiV2EntitiesScancodeHistory>;
|
|
678
696
|
/**
|
|
679
697
|
* @description show scancodes associated with this item
|
|
680
698
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesCount, ApiV21EntitiesOrderBatchRequest, ApiV2EntitiesCount, ApiV2EntitiesOrderBatchRequest, GetApiV21OrderBatchRequestsCountParams, GetApiV21OrderBatchRequestsParams, GetApiV2OrderBatchRequestsCountParams, GetApiV2OrderBatchRequestsParams } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesCount, ApiV21EntitiesOrderBatchRequest, ApiV2EntitiesCount, ApiV2EntitiesOrderBatchRequest, GetApiV21OrderBatchRequestsCountParams, GetApiV21OrderBatchRequestsParams, GetApiV2OrderBatchRequestsCountParams, GetApiV2OrderBatchRequestsParams, PutApiV21OrderBatchRequestsIdCallActionRequest, PutApiV2OrderBatchRequestsIdCallActionRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Returns all order batch requests
|
|
@@ -27,6 +27,15 @@ export declare const getApiV2OrderBatchRequestsCount: (client: HttpClient, query
|
|
|
27
27
|
* @request GET:/api/v2/order_batch_requests/{id}
|
|
28
28
|
*/
|
|
29
29
|
export declare const getApiV2OrderBatchRequestsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOrderBatchRequest>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Perform an action on an order batch request
|
|
32
|
+
*
|
|
33
|
+
* @tags order_batch_requests
|
|
34
|
+
* @name PutApiV2OrderBatchRequestsIdCallAction
|
|
35
|
+
* @summary Perform an action on an order batch request
|
|
36
|
+
* @request PUT:/api/v2/order_batch_requests/{id}/call/{action}
|
|
37
|
+
*/
|
|
38
|
+
export declare const putApiV2OrderBatchRequestsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV2OrderBatchRequestsIdCallActionRequest, params?: RequestParams) => Promise<ApiV2EntitiesOrderBatchRequest>;
|
|
30
39
|
/**
|
|
31
40
|
* @description Returns all order batch requests
|
|
32
41
|
*
|
|
@@ -54,3 +63,12 @@ export declare const getApiV21OrderBatchRequestsCount: (client: HttpClient, quer
|
|
|
54
63
|
* @request GET:/api/v2.1/order_batch_requests/{id}
|
|
55
64
|
*/
|
|
56
65
|
export declare const getApiV21OrderBatchRequestsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOrderBatchRequest>;
|
|
66
|
+
/**
|
|
67
|
+
* @description Perform an action on an order batch request
|
|
68
|
+
*
|
|
69
|
+
* @tags order_batch_requests
|
|
70
|
+
* @name PutApiV21OrderBatchRequestsIdCallAction
|
|
71
|
+
* @summary Perform an action on an order batch request
|
|
72
|
+
* @request PUT:/api/v2.1/order_batch_requests/{id}/call/{action}
|
|
73
|
+
*/
|
|
74
|
+
export declare const putApiV21OrderBatchRequestsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV21OrderBatchRequestsIdCallActionRequest, params?: RequestParams) => Promise<void>;
|
|
@@ -4651,6 +4651,25 @@ export interface ApiV2EntitiesScancode {
|
|
|
4651
4651
|
updated_at?: string;
|
|
4652
4652
|
}
|
|
4653
4653
|
/** V2 */
|
|
4654
|
+
export interface ApiV2EntitiesScancodeHistory {
|
|
4655
|
+
/** the kind of scancode change: created, added, removed, promoted */
|
|
4656
|
+
action?: string;
|
|
4657
|
+
/**
|
|
4658
|
+
* the audit id
|
|
4659
|
+
* @format int32
|
|
4660
|
+
*/
|
|
4661
|
+
id?: number;
|
|
4662
|
+
/** The scancode affected by this action */
|
|
4663
|
+
scancode?: string;
|
|
4664
|
+
/**
|
|
4665
|
+
* when the scancode change occurred
|
|
4666
|
+
* @format date-time
|
|
4667
|
+
*/
|
|
4668
|
+
updated_at?: string;
|
|
4669
|
+
/** the user who made the change, or "system" if none */
|
|
4670
|
+
user?: object;
|
|
4671
|
+
}
|
|
4672
|
+
/** V2 */
|
|
4654
4673
|
export interface ApiV2EntitiesSerialNumber {
|
|
4655
4674
|
/**
|
|
4656
4675
|
* if not null, the DateTime when the serial was deleted
|
|
@@ -11793,6 +11812,23 @@ export interface GetApiV21ItemsIdOriginatorsParams {
|
|
|
11793
11812
|
page_links?: boolean;
|
|
11794
11813
|
id: number;
|
|
11795
11814
|
}
|
|
11815
|
+
export interface GetApiV21ItemsIdScancodeHistoryParams {
|
|
11816
|
+
/**
|
|
11817
|
+
* Page of results to fetch
|
|
11818
|
+
* @format int32
|
|
11819
|
+
*/
|
|
11820
|
+
page?: number;
|
|
11821
|
+
/**
|
|
11822
|
+
* Number of results to return per page
|
|
11823
|
+
* @format int32
|
|
11824
|
+
*/
|
|
11825
|
+
per_page?: number;
|
|
11826
|
+
/** Include total count of results */
|
|
11827
|
+
page_total?: boolean;
|
|
11828
|
+
/** Include prev/next links in response headers */
|
|
11829
|
+
page_links?: boolean;
|
|
11830
|
+
id: number;
|
|
11831
|
+
}
|
|
11796
11832
|
export interface GetApiV21ItemsIdScancodesCountParams {
|
|
11797
11833
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11798
11834
|
search?: string;
|
|
@@ -14707,6 +14743,23 @@ export interface GetApiV2ItemsIdOriginatorsParams {
|
|
|
14707
14743
|
page_links?: boolean;
|
|
14708
14744
|
id: number;
|
|
14709
14745
|
}
|
|
14746
|
+
export interface GetApiV2ItemsIdScancodeHistoryParams {
|
|
14747
|
+
/**
|
|
14748
|
+
* Page of results to fetch
|
|
14749
|
+
* @format int32
|
|
14750
|
+
*/
|
|
14751
|
+
page?: number;
|
|
14752
|
+
/**
|
|
14753
|
+
* Number of results to return per page
|
|
14754
|
+
* @format int32
|
|
14755
|
+
*/
|
|
14756
|
+
per_page?: number;
|
|
14757
|
+
/** Include total count of results */
|
|
14758
|
+
page_total?: boolean;
|
|
14759
|
+
/** Include prev/next links in response headers */
|
|
14760
|
+
page_links?: boolean;
|
|
14761
|
+
id: number;
|
|
14762
|
+
}
|
|
14710
14763
|
export interface GetApiV2ItemsIdScancodesCountParams {
|
|
14711
14764
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
14712
14765
|
search?: string;
|
|
@@ -25092,6 +25145,11 @@ export interface PutApiV21OrderBatchItemsIdCallActionRequest {
|
|
|
25092
25145
|
/** Method params */
|
|
25093
25146
|
args?: object;
|
|
25094
25147
|
}
|
|
25148
|
+
export interface PutApiV21OrderBatchRequestsIdCallActionRequest {
|
|
25149
|
+
action?: string;
|
|
25150
|
+
/** Method params */
|
|
25151
|
+
args?: object;
|
|
25152
|
+
}
|
|
25095
25153
|
export interface PutApiV21OrderBatchesIdCallActionRequest {
|
|
25096
25154
|
action?: string;
|
|
25097
25155
|
/** Method params */
|
|
@@ -27978,6 +28036,11 @@ export interface PutApiV2OrderBatchItemsIdCallActionRequest {
|
|
|
27978
28036
|
/** Method params */
|
|
27979
28037
|
args?: object;
|
|
27980
28038
|
}
|
|
28039
|
+
export interface PutApiV2OrderBatchRequestsIdCallActionRequest {
|
|
28040
|
+
action?: string;
|
|
28041
|
+
/** Method params */
|
|
28042
|
+
args?: object;
|
|
28043
|
+
}
|
|
27981
28044
|
export interface PutApiV2OrderBatchesIdCallActionRequest {
|
|
27982
28045
|
action?: string;
|
|
27983
28046
|
/** Method params */
|