@whiplashmerch/whiplash-api-client 0.4.111 → 0.4.113
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.
- package/dist/client.esm.js +151 -1
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/OrderTotes.d.ts +73 -1
- package/dist/generated/data-contracts.d.ts +104 -0
- package/dist/utils/warehouse.d.ts +15 -0
- package/generated/OrderTotes.ts +105 -0
- package/generated/data-contracts.ts +24 -0
- package/generated/index.ts +1 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesOrderTote, GetApiV21OrderTotesParams, GetApiV2OrderTotesParams } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesOrder, APIV21EntitiesOrderItem, APIV2EntitiesCount, APIV2EntitiesOrder, APIV2EntitiesOrderItem, APIV2EntitiesOrderTote, GetApiV21OrderTotesCodeOrderItemsCountParams, GetApiV21OrderTotesCodeOrderItemsParams, GetApiV21OrderTotesCodeOrdersCountParams, GetApiV21OrderTotesCodeOrdersParams, GetApiV21OrderTotesParams, GetApiV2OrderTotesCodeOrderItemsCountParams, GetApiV2OrderTotesCodeOrderItemsParams, GetApiV2OrderTotesCodeOrdersCountParams, GetApiV2OrderTotesCodeOrdersParams, GetApiV2OrderTotesParams } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -9,6 +9,42 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
9
9
|
* @request GET:/api/v2/order_totes
|
|
10
10
|
*/
|
|
11
11
|
export declare const getApiV2OrderTotes: (client: HttpClient, query: GetApiV2OrderTotesParams, params?: RequestParams) => Promise<APIV2EntitiesOrderTote[]>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Retrieve all orders for a tote
|
|
14
|
+
*
|
|
15
|
+
* @tags order_totes
|
|
16
|
+
* @name GetApiV2OrderTotesCodeOrders
|
|
17
|
+
* @summary List all orders for a tote
|
|
18
|
+
* @request GET:/api/v2/order_totes/{code}/orders
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2OrderTotesCodeOrders: (client: HttpClient, { code, ...query }: GetApiV2OrderTotesCodeOrdersParams, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags order_totes
|
|
25
|
+
* @name GetApiV2OrderTotesCodeOrdersCount
|
|
26
|
+
* @summary Count orders for a tote
|
|
27
|
+
* @request GET:/api/v2/order_totes/{code}/orders/count
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2OrderTotesCodeOrdersCount: (client: HttpClient, { code, ...query }: GetApiV2OrderTotesCodeOrdersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Retrieve all order items for an order tote
|
|
32
|
+
*
|
|
33
|
+
* @tags order_totes
|
|
34
|
+
* @name GetApiV2OrderTotesCodeOrderItems
|
|
35
|
+
* @summary List all order items for an order tote
|
|
36
|
+
* @request GET:/api/v2/order_totes/{code}/order_items
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2OrderTotesCodeOrderItems: (client: HttpClient, { code, ...query }: GetApiV2OrderTotesCodeOrderItemsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderItem[]>;
|
|
39
|
+
/**
|
|
40
|
+
* No description
|
|
41
|
+
*
|
|
42
|
+
* @tags order_totes
|
|
43
|
+
* @name GetApiV2OrderTotesCodeOrderItemsCount
|
|
44
|
+
* @summary Count order items for an order tote
|
|
45
|
+
* @request GET:/api/v2/order_totes/{code}/order_items/count
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2OrderTotesCodeOrderItemsCount: (client: HttpClient, { code, ...query }: GetApiV2OrderTotesCodeOrderItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
12
48
|
/**
|
|
13
49
|
* No description
|
|
14
50
|
*
|
|
@@ -18,3 +54,39 @@ export declare const getApiV2OrderTotes: (client: HttpClient, query: GetApiV2Ord
|
|
|
18
54
|
* @request GET:/api/v2.1/order_totes
|
|
19
55
|
*/
|
|
20
56
|
export declare const getApiV21OrderTotes: (client: HttpClient, query: GetApiV21OrderTotesParams, params?: RequestParams) => Promise<APIV2EntitiesOrderTote[]>;
|
|
57
|
+
/**
|
|
58
|
+
* @description Retrieve all orders for a tote
|
|
59
|
+
*
|
|
60
|
+
* @tags order_totes
|
|
61
|
+
* @name GetApiV21OrderTotesCodeOrders
|
|
62
|
+
* @summary List all orders for a tote
|
|
63
|
+
* @request GET:/api/v2.1/order_totes/{code}/orders
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV21OrderTotesCodeOrders: (client: HttpClient, { code, ...query }: GetApiV21OrderTotesCodeOrdersParams, params?: RequestParams) => Promise<APIV21EntitiesOrder[]>;
|
|
66
|
+
/**
|
|
67
|
+
* No description
|
|
68
|
+
*
|
|
69
|
+
* @tags order_totes
|
|
70
|
+
* @name GetApiV21OrderTotesCodeOrdersCount
|
|
71
|
+
* @summary Count orders for a tote
|
|
72
|
+
* @request GET:/api/v2.1/order_totes/{code}/orders/count
|
|
73
|
+
*/
|
|
74
|
+
export declare const getApiV21OrderTotesCodeOrdersCount: (client: HttpClient, { code, ...query }: GetApiV21OrderTotesCodeOrdersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
75
|
+
/**
|
|
76
|
+
* @description Retrieve all order items for an order tote
|
|
77
|
+
*
|
|
78
|
+
* @tags order_totes
|
|
79
|
+
* @name GetApiV21OrderTotesCodeOrderItems
|
|
80
|
+
* @summary List all order items for an order tote
|
|
81
|
+
* @request GET:/api/v2.1/order_totes/{code}/order_items
|
|
82
|
+
*/
|
|
83
|
+
export declare const getApiV21OrderTotesCodeOrderItems: (client: HttpClient, { code, ...query }: GetApiV21OrderTotesCodeOrderItemsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem[]>;
|
|
84
|
+
/**
|
|
85
|
+
* No description
|
|
86
|
+
*
|
|
87
|
+
* @tags order_totes
|
|
88
|
+
* @name GetApiV21OrderTotesCodeOrderItemsCount
|
|
89
|
+
* @summary Count order items for an order tote
|
|
90
|
+
* @request GET:/api/v2.1/order_totes/{code}/order_items/count
|
|
91
|
+
*/
|
|
92
|
+
export declare const getApiV21OrderTotesCodeOrderItemsCount: (client: HttpClient, { code, ...query }: GetApiV21OrderTotesCodeOrderItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
@@ -9170,6 +9170,58 @@ export interface GetApiV21OrderItemsParams {
|
|
|
9170
9170
|
*/
|
|
9171
9171
|
per_page?: number;
|
|
9172
9172
|
}
|
|
9173
|
+
export interface GetApiV21OrderTotesCodeOrderItemsCountParams {
|
|
9174
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
9175
|
+
search?: string;
|
|
9176
|
+
code: string;
|
|
9177
|
+
}
|
|
9178
|
+
export interface GetApiV21OrderTotesCodeOrderItemsParams {
|
|
9179
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
9180
|
+
search?: string;
|
|
9181
|
+
/** A list of sort options (ex: name asc,created_at desc) */
|
|
9182
|
+
sort?: string;
|
|
9183
|
+
/** Comma-separated list of fields to include in the response */
|
|
9184
|
+
fields?: string;
|
|
9185
|
+
/**
|
|
9186
|
+
* Page of results to fetch.
|
|
9187
|
+
* @format int32
|
|
9188
|
+
* @default 1
|
|
9189
|
+
*/
|
|
9190
|
+
page?: number;
|
|
9191
|
+
/**
|
|
9192
|
+
* Number of results to return per page.
|
|
9193
|
+
* @format int32
|
|
9194
|
+
* @default 25
|
|
9195
|
+
*/
|
|
9196
|
+
per_page?: number;
|
|
9197
|
+
code: string;
|
|
9198
|
+
}
|
|
9199
|
+
export interface GetApiV21OrderTotesCodeOrdersCountParams {
|
|
9200
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
9201
|
+
search?: string;
|
|
9202
|
+
code: string;
|
|
9203
|
+
}
|
|
9204
|
+
export interface GetApiV21OrderTotesCodeOrdersParams {
|
|
9205
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
9206
|
+
search?: string;
|
|
9207
|
+
/** A list of sort options (ex: name asc,created_at desc) */
|
|
9208
|
+
sort?: string;
|
|
9209
|
+
/** Comma-separated list of fields to include in the response */
|
|
9210
|
+
fields?: string;
|
|
9211
|
+
/**
|
|
9212
|
+
* Page of results to fetch.
|
|
9213
|
+
* @format int32
|
|
9214
|
+
* @default 1
|
|
9215
|
+
*/
|
|
9216
|
+
page?: number;
|
|
9217
|
+
/**
|
|
9218
|
+
* Number of results to return per page.
|
|
9219
|
+
* @format int32
|
|
9220
|
+
* @default 25
|
|
9221
|
+
*/
|
|
9222
|
+
per_page?: number;
|
|
9223
|
+
code: string;
|
|
9224
|
+
}
|
|
9173
9225
|
export interface GetApiV21OrderTotesParams {
|
|
9174
9226
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
9175
9227
|
search?: string;
|
|
@@ -11371,6 +11423,58 @@ export interface GetApiV2OrderItemsParams {
|
|
|
11371
11423
|
*/
|
|
11372
11424
|
per_page?: number;
|
|
11373
11425
|
}
|
|
11426
|
+
export interface GetApiV2OrderTotesCodeOrderItemsCountParams {
|
|
11427
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11428
|
+
search?: string;
|
|
11429
|
+
code: string;
|
|
11430
|
+
}
|
|
11431
|
+
export interface GetApiV2OrderTotesCodeOrderItemsParams {
|
|
11432
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11433
|
+
search?: string;
|
|
11434
|
+
/** A list of sort options (ex: name asc,created_at desc) */
|
|
11435
|
+
sort?: string;
|
|
11436
|
+
/** Comma-separated list of fields to include in the response */
|
|
11437
|
+
fields?: string;
|
|
11438
|
+
/**
|
|
11439
|
+
* Page of results to fetch.
|
|
11440
|
+
* @format int32
|
|
11441
|
+
* @default 1
|
|
11442
|
+
*/
|
|
11443
|
+
page?: number;
|
|
11444
|
+
/**
|
|
11445
|
+
* Number of results to return per page.
|
|
11446
|
+
* @format int32
|
|
11447
|
+
* @default 25
|
|
11448
|
+
*/
|
|
11449
|
+
per_page?: number;
|
|
11450
|
+
code: string;
|
|
11451
|
+
}
|
|
11452
|
+
export interface GetApiV2OrderTotesCodeOrdersCountParams {
|
|
11453
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11454
|
+
search?: string;
|
|
11455
|
+
code: string;
|
|
11456
|
+
}
|
|
11457
|
+
export interface GetApiV2OrderTotesCodeOrdersParams {
|
|
11458
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11459
|
+
search?: string;
|
|
11460
|
+
/** A list of sort options (ex: name asc,created_at desc) */
|
|
11461
|
+
sort?: string;
|
|
11462
|
+
/** Comma-separated list of fields to include in the response */
|
|
11463
|
+
fields?: string;
|
|
11464
|
+
/**
|
|
11465
|
+
* Page of results to fetch.
|
|
11466
|
+
* @format int32
|
|
11467
|
+
* @default 1
|
|
11468
|
+
*/
|
|
11469
|
+
page?: number;
|
|
11470
|
+
/**
|
|
11471
|
+
* Number of results to return per page.
|
|
11472
|
+
* @format int32
|
|
11473
|
+
* @default 25
|
|
11474
|
+
*/
|
|
11475
|
+
per_page?: number;
|
|
11476
|
+
code: string;
|
|
11477
|
+
}
|
|
11374
11478
|
export interface GetApiV2OrderTotesParams {
|
|
11375
11479
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11376
11480
|
search?: string;
|
|
@@ -24,3 +24,18 @@ export interface ApiV21WarehousesIdOpenBatchesAgainstShelfResult {
|
|
|
24
24
|
result?: string[];
|
|
25
25
|
}
|
|
26
26
|
export declare const getWarehouseIdOpenBatchesAgainstShelf: (client: HttpClient, warehouseId: number, params: CallTraitOpenBatchesAgainstShelfParams) => Promise<ApiV21WarehousesIdOpenBatchesAgainstShelfResult>;
|
|
27
|
+
export interface CallTraitWarehouseIdValidForDuppedLotRelocateParams {
|
|
28
|
+
args: {
|
|
29
|
+
source_shelf: string;
|
|
30
|
+
destination_shelf: string;
|
|
31
|
+
item_id?: number;
|
|
32
|
+
new_role?: ApiV21EntitiesLocationRole;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
export interface ApiV21WarehousesIdValidForDuppedLotRelocateResult {
|
|
36
|
+
result?: {
|
|
37
|
+
valid: boolean;
|
|
38
|
+
reason?: string;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export declare const getWarehouseIdValidForDuplicatedLotRelocate: (client: HttpClient, warehouseId: number, params: CallTraitWarehouseIdValidForDuppedLotRelocateParams) => Promise<ApiV21WarehousesIdValidForDuppedLotRelocateResult>;
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/*
|
|
4
|
+
* ---------------------------------------------------------------
|
|
5
|
+
* ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
|
|
6
|
+
* ## ##
|
|
7
|
+
* ## AUTHOR: acacode ##
|
|
8
|
+
* ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
|
|
9
|
+
* ---------------------------------------------------------------
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import {
|
|
13
|
+
APIV2EntitiesApiError,
|
|
14
|
+
APIV2EntitiesCount,
|
|
15
|
+
GetApiV21OrderTotesCodeOrderItemsCountParams,
|
|
16
|
+
GetApiV21OrderTotesCodeOrdersCountParams,
|
|
17
|
+
GetApiV2OrderTotesCodeOrderItemsCountParams,
|
|
18
|
+
GetApiV2OrderTotesCodeOrdersCountParams,
|
|
19
|
+
} from "./data-contracts";
|
|
20
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* No description
|
|
24
|
+
*
|
|
25
|
+
* @tags order_totes
|
|
26
|
+
* @name GetApiV2OrderTotesCodeOrdersCount
|
|
27
|
+
* @summary Count orders for a tote
|
|
28
|
+
* @request GET:/api/v2/order_totes/{code}/orders/count
|
|
29
|
+
*/
|
|
30
|
+
export const getApiV2OrderTotesCodeOrdersCount = (
|
|
31
|
+
client: HttpClient,
|
|
32
|
+
{ code, ...query }: GetApiV2OrderTotesCodeOrdersCountParams,
|
|
33
|
+
params: RequestParams = {},
|
|
34
|
+
) => {
|
|
35
|
+
return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
|
|
36
|
+
path: `/api/v2/order_totes/${code}/orders/count`,
|
|
37
|
+
method: "GET",
|
|
38
|
+
query: query,
|
|
39
|
+
format: "json",
|
|
40
|
+
...params,
|
|
41
|
+
});
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* No description
|
|
45
|
+
*
|
|
46
|
+
* @tags order_totes
|
|
47
|
+
* @name GetApiV2OrderTotesCodeOrderItemsCount
|
|
48
|
+
* @summary Count order items for an order tote
|
|
49
|
+
* @request GET:/api/v2/order_totes/{code}/order_items/count
|
|
50
|
+
*/
|
|
51
|
+
export const getApiV2OrderTotesCodeOrderItemsCount = (
|
|
52
|
+
client: HttpClient,
|
|
53
|
+
{ code, ...query }: GetApiV2OrderTotesCodeOrderItemsCountParams,
|
|
54
|
+
params: RequestParams = {},
|
|
55
|
+
) => {
|
|
56
|
+
return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
|
|
57
|
+
path: `/api/v2/order_totes/${code}/order_items/count`,
|
|
58
|
+
method: "GET",
|
|
59
|
+
query: query,
|
|
60
|
+
format: "json",
|
|
61
|
+
...params,
|
|
62
|
+
});
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* No description
|
|
66
|
+
*
|
|
67
|
+
* @tags order_totes
|
|
68
|
+
* @name GetApiV21OrderTotesCodeOrdersCount
|
|
69
|
+
* @summary Count orders for a tote
|
|
70
|
+
* @request GET:/api/v2.1/order_totes/{code}/orders/count
|
|
71
|
+
*/
|
|
72
|
+
export const getApiV21OrderTotesCodeOrdersCount = (
|
|
73
|
+
client: HttpClient,
|
|
74
|
+
{ code, ...query }: GetApiV21OrderTotesCodeOrdersCountParams,
|
|
75
|
+
params: RequestParams = {},
|
|
76
|
+
) => {
|
|
77
|
+
return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
|
|
78
|
+
path: `/api/v2.1/order_totes/${code}/orders/count`,
|
|
79
|
+
method: "GET",
|
|
80
|
+
query: query,
|
|
81
|
+
format: "json",
|
|
82
|
+
...params,
|
|
83
|
+
});
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* No description
|
|
87
|
+
*
|
|
88
|
+
* @tags order_totes
|
|
89
|
+
* @name GetApiV21OrderTotesCodeOrderItemsCount
|
|
90
|
+
* @summary Count order items for an order tote
|
|
91
|
+
* @request GET:/api/v2.1/order_totes/{code}/order_items/count
|
|
92
|
+
*/
|
|
93
|
+
export const getApiV21OrderTotesCodeOrderItemsCount = (
|
|
94
|
+
client: HttpClient,
|
|
95
|
+
{ code, ...query }: GetApiV21OrderTotesCodeOrderItemsCountParams,
|
|
96
|
+
params: RequestParams = {},
|
|
97
|
+
) => {
|
|
98
|
+
return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
|
|
99
|
+
path: `/api/v2.1/order_totes/${code}/order_items/count`,
|
|
100
|
+
method: "GET",
|
|
101
|
+
query: query,
|
|
102
|
+
format: "json",
|
|
103
|
+
...params,
|
|
104
|
+
});
|
|
105
|
+
};
|
|
@@ -4333,6 +4333,18 @@ export interface GetApiV21OrderItemsIdParams {
|
|
|
4333
4333
|
id: number;
|
|
4334
4334
|
}
|
|
4335
4335
|
|
|
4336
|
+
export interface GetApiV21OrderTotesCodeOrderItemsCountParams {
|
|
4337
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4338
|
+
search?: string;
|
|
4339
|
+
code: string;
|
|
4340
|
+
}
|
|
4341
|
+
|
|
4342
|
+
export interface GetApiV21OrderTotesCodeOrdersCountParams {
|
|
4343
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4344
|
+
search?: string;
|
|
4345
|
+
code: string;
|
|
4346
|
+
}
|
|
4347
|
+
|
|
4336
4348
|
export interface GetApiV21OrdersCountParams {
|
|
4337
4349
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4338
4350
|
search?: string;
|
|
@@ -4874,6 +4886,18 @@ export interface GetApiV2OrderItemsIdParams {
|
|
|
4874
4886
|
id: number;
|
|
4875
4887
|
}
|
|
4876
4888
|
|
|
4889
|
+
export interface GetApiV2OrderTotesCodeOrderItemsCountParams {
|
|
4890
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4891
|
+
search?: string;
|
|
4892
|
+
code: string;
|
|
4893
|
+
}
|
|
4894
|
+
|
|
4895
|
+
export interface GetApiV2OrderTotesCodeOrdersCountParams {
|
|
4896
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4897
|
+
search?: string;
|
|
4898
|
+
code: string;
|
|
4899
|
+
}
|
|
4900
|
+
|
|
4877
4901
|
export interface GetApiV2OrdersCountParams {
|
|
4878
4902
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
4879
4903
|
search?: string;
|
package/generated/index.ts
CHANGED
|
@@ -7,6 +7,7 @@ export * from './NotificationEvents';
|
|
|
7
7
|
export * from './NotificationSubscriptions';
|
|
8
8
|
export * from './OrderDocuments';
|
|
9
9
|
export * from './OrderItems';
|
|
10
|
+
export * from './OrderTotes';
|
|
10
11
|
export * from './Orders';
|
|
11
12
|
export * from './Originators';
|
|
12
13
|
export * from './Projects';
|