@whiplashmerch/whiplash-api-client 0.1.22 → 0.2.0
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 +38 -360
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/Items.d.ts +13 -13
- package/dist/generated/data-contracts.d.ts +80 -232
- package/dist/generated/index.d.ts +0 -4
- package/generated/Items.ts +29 -29
- package/generated/data-contracts.ts +82 -245
- package/generated/index.ts +0 -4
- package/package.json +1 -1
- package/dist/generated/MetaKeys.d.ts +0 -110
- package/dist/generated/Public.d.ts +0 -33
- package/dist/generated/ScancodeAliases.d.ts +0 -20
- package/dist/generated/Scancodes.d.ts +0 -11
- package/generated/MetaKeys.ts +0 -250
- package/generated/Public.ts +0 -69
- package/generated/ScancodeAliases.ts +0 -61
- package/generated/Scancodes.ts +0 -31
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV2EntitiesBundleItem, APIV2EntitiesCount, APIV2EntitiesItem, APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesMetaFields, APIV2EntitiesOriginator,
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV2EntitiesBundleItem, APIV2EntitiesCount, APIV2EntitiesItem, APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesScancode, APIV2EntitiesShipnoticeItem, APIV2EntitiesTransaction, GetApiV21ItemsCountParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdScancodesParams, GetApiV21ItemsParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdScancodesParams, GetApiV2ItemsParams, PostApiV21Items, PostApiV21ItemsIdBundleItems, PostApiV2Items, PostApiV2ItemsIdBundleItems, PutApiV21Items, PutApiV21ItemsIdCall, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginator, PutApiV2Items, PutApiV2ItemsIdCall, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginator } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -31,11 +31,11 @@ export declare const getApiV2ItemsActions: (client: HttpClient, params?: Request
|
|
|
31
31
|
* @description An item may have many alternate scancodes
|
|
32
32
|
*
|
|
33
33
|
* @tags originators
|
|
34
|
-
* @name
|
|
34
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdScancodes
|
|
35
35
|
* @summary List all scancodes associated with this item
|
|
36
|
-
* @request GET:/api/v2/items/originator/{originator_id}/
|
|
36
|
+
* @request GET:/api/v2/items/originator/{originator_id}/scancodes
|
|
37
37
|
*/
|
|
38
|
-
export declare const
|
|
38
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
39
39
|
/**
|
|
40
40
|
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
41
41
|
*
|
|
@@ -112,11 +112,11 @@ export declare const getApiV2ItemsIdMetaFields: (client: HttpClient, { id, ...qu
|
|
|
112
112
|
* @description An item may have many alternate scancodes
|
|
113
113
|
*
|
|
114
114
|
* @tags items
|
|
115
|
-
* @name
|
|
115
|
+
* @name GetApiV2ItemsIdScancodes
|
|
116
116
|
* @summary List all scancodes associated with this item
|
|
117
|
-
* @request GET:/api/v2/items/{id}/
|
|
117
|
+
* @request GET:/api/v2/items/{id}/scancodes
|
|
118
118
|
*/
|
|
119
|
-
export declare const
|
|
119
|
+
export declare const getApiV2ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
122
122
|
*
|
|
@@ -274,11 +274,11 @@ export declare const getApiV21ItemsActions: (client: HttpClient, params?: Reques
|
|
|
274
274
|
* @description An item may have many alternate scancodes
|
|
275
275
|
*
|
|
276
276
|
* @tags originators
|
|
277
|
-
* @name
|
|
277
|
+
* @name GetApiV21ItemsOriginatorOriginatorIdScancodes
|
|
278
278
|
* @summary List all scancodes associated with this item
|
|
279
|
-
* @request GET:/api/v2.1/items/originator/{originator_id}/
|
|
279
|
+
* @request GET:/api/v2.1/items/originator/{originator_id}/scancodes
|
|
280
280
|
*/
|
|
281
|
-
export declare const
|
|
281
|
+
export declare const getApiV21ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
282
282
|
/**
|
|
283
283
|
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
284
284
|
*
|
|
@@ -355,11 +355,11 @@ export declare const getApiV21ItemsIdMetaFields: (client: HttpClient, { id, ...q
|
|
|
355
355
|
* @description An item may have many alternate scancodes
|
|
356
356
|
*
|
|
357
357
|
* @tags items
|
|
358
|
-
* @name
|
|
358
|
+
* @name GetApiV21ItemsIdScancodes
|
|
359
359
|
* @summary List all scancodes associated with this item
|
|
360
|
-
* @request GET:/api/v2.1/items/{id}/
|
|
360
|
+
* @request GET:/api/v2.1/items/{id}/scancodes
|
|
361
361
|
*/
|
|
362
|
-
export declare const
|
|
362
|
+
export declare const getApiV21ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
363
363
|
/**
|
|
364
364
|
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
365
365
|
*
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/** Create a meta_key */
|
|
2
1
|
export interface APIV21EntitiesPostResponse {
|
|
3
2
|
/**
|
|
4
3
|
* The Whiplash ID of the newly created resource
|
|
@@ -272,6 +271,8 @@ export interface APIV2EntitiesCustomer {
|
|
|
272
271
|
eori_number?: string;
|
|
273
272
|
/** Customer estimated monthly volume. */
|
|
274
273
|
estimated_monthly_volume?: string;
|
|
274
|
+
/** is this account flagged for exit notice? (admins only) */
|
|
275
|
+
exit_notice?: boolean;
|
|
275
276
|
/**
|
|
276
277
|
* items that are this many days from expiration will not be allowed to ship
|
|
277
278
|
* @format int32
|
|
@@ -826,44 +827,6 @@ export interface APIV2EntitiesMetaFields {
|
|
|
826
827
|
/** Hash of key/value pairs */
|
|
827
828
|
fields?: object;
|
|
828
829
|
}
|
|
829
|
-
/** Get a meta_key */
|
|
830
|
-
export interface APIV2EntitiesMetaKey {
|
|
831
|
-
/**
|
|
832
|
-
* Key creation date and time
|
|
833
|
-
* @format date-time
|
|
834
|
-
*/
|
|
835
|
-
created_at?: string;
|
|
836
|
-
/**
|
|
837
|
-
* Customer who owns this key (admins only)
|
|
838
|
-
* @format int32
|
|
839
|
-
*/
|
|
840
|
-
customer_id?: number;
|
|
841
|
-
/** Key description */
|
|
842
|
-
description?: string;
|
|
843
|
-
/**
|
|
844
|
-
* Key discard date and time (admins only)
|
|
845
|
-
* @format date-time
|
|
846
|
-
*/
|
|
847
|
-
discarded_at?: string;
|
|
848
|
-
/**
|
|
849
|
-
* Key ID
|
|
850
|
-
* @format int32
|
|
851
|
-
*/
|
|
852
|
-
id?: number;
|
|
853
|
-
/** array of tag keywords */
|
|
854
|
-
keyword_list?: string;
|
|
855
|
-
/** Key name */
|
|
856
|
-
name?: string;
|
|
857
|
-
/** Resource this key will be attached to */
|
|
858
|
-
owner_type?: string;
|
|
859
|
-
/**
|
|
860
|
-
* Key last update date and time
|
|
861
|
-
* @format date-time
|
|
862
|
-
*/
|
|
863
|
-
updated_at?: string;
|
|
864
|
-
/** Value type */
|
|
865
|
-
value_type?: string;
|
|
866
|
-
}
|
|
867
830
|
export interface APIV2EntitiesNotificationEvent {
|
|
868
831
|
/**
|
|
869
832
|
* the notification event creation date and time
|
|
@@ -1001,6 +964,8 @@ export interface APIV2EntitiesOrder {
|
|
|
1001
964
|
* @format int32
|
|
1002
965
|
*/
|
|
1003
966
|
carrier_account_id?: number;
|
|
967
|
+
/** packingslip pdf url */
|
|
968
|
+
cf_packingslip_pdf_url?: string;
|
|
1004
969
|
/** does the order contain alcohol? */
|
|
1005
970
|
contains_alcohol?: boolean;
|
|
1006
971
|
/**
|
|
@@ -1086,7 +1051,7 @@ export interface APIV2EntitiesOrder {
|
|
|
1086
1051
|
/** the order type */
|
|
1087
1052
|
order_type?: string;
|
|
1088
1053
|
originator?: APIV2EntitiesOriginator;
|
|
1089
|
-
packages?: APIV2EntitiesPackage;
|
|
1054
|
+
packages?: APIV2EntitiesPackage[];
|
|
1090
1055
|
/** url for this orders packing slip */
|
|
1091
1056
|
packingslip_pdf_url?: string;
|
|
1092
1057
|
/** Permission limited orders are not editable, but still may be processed/shipped */
|
|
@@ -1149,8 +1114,7 @@ export interface APIV2EntitiesOrder {
|
|
|
1149
1114
|
return_zip?: string;
|
|
1150
1115
|
/** require a carrier that delivers on Saturdays for this order? */
|
|
1151
1116
|
saturday_delivery?: boolean;
|
|
1152
|
-
|
|
1153
|
-
serial_numbers?: APIV2EntitiesSerialNumber;
|
|
1117
|
+
serial_numbers?: APIV2EntitiesSerialNumber[];
|
|
1154
1118
|
/**
|
|
1155
1119
|
* the order actual cost of shipping
|
|
1156
1120
|
* @format float
|
|
@@ -1622,7 +1586,7 @@ export interface APIV2EntitiesReturnItem {
|
|
|
1622
1586
|
/** item SKU */
|
|
1623
1587
|
sku?: string;
|
|
1624
1588
|
}
|
|
1625
|
-
/**
|
|
1589
|
+
/** An item may have many alternate scancodes */
|
|
1626
1590
|
export interface APIV2EntitiesScancode {
|
|
1627
1591
|
/** is this scancode active? */
|
|
1628
1592
|
active?: boolean;
|
|
@@ -1660,35 +1624,6 @@ export interface APIV2EntitiesScancode {
|
|
|
1660
1624
|
*/
|
|
1661
1625
|
updated_at?: string;
|
|
1662
1626
|
}
|
|
1663
|
-
/** An item may have many alternate scancodes */
|
|
1664
|
-
export interface APIV2EntitiesScancodeAlias {
|
|
1665
|
-
/** is this scancode_alias active? */
|
|
1666
|
-
active?: boolean;
|
|
1667
|
-
/**
|
|
1668
|
-
* scancode_alias creation date
|
|
1669
|
-
* @format date-time
|
|
1670
|
-
*/
|
|
1671
|
-
created_at?: string;
|
|
1672
|
-
/**
|
|
1673
|
-
* the scancode_alias id
|
|
1674
|
-
* @format int32
|
|
1675
|
-
*/
|
|
1676
|
-
id?: number;
|
|
1677
|
-
/**
|
|
1678
|
-
* the item_id
|
|
1679
|
-
* @format int32
|
|
1680
|
-
*/
|
|
1681
|
-
item_id?: number;
|
|
1682
|
-
/** label format for the scancode_alias */
|
|
1683
|
-
label_format?: string;
|
|
1684
|
-
/** the scancode for the scancode_alias */
|
|
1685
|
-
scancode?: string;
|
|
1686
|
-
/**
|
|
1687
|
-
* scancode_alias last updated date
|
|
1688
|
-
* @format date-time
|
|
1689
|
-
*/
|
|
1690
|
-
updated_at?: string;
|
|
1691
|
-
}
|
|
1692
1627
|
/** Serial numbers are scanned and saved during the packing process. */
|
|
1693
1628
|
export interface APIV2EntitiesSerialNumber {
|
|
1694
1629
|
/**
|
|
@@ -2125,15 +2060,21 @@ export interface APIV2EntitiesUser {
|
|
|
2125
2060
|
id?: number;
|
|
2126
2061
|
/** last name of the user */
|
|
2127
2062
|
last_name?: string;
|
|
2128
|
-
/**
|
|
2129
|
-
|
|
2063
|
+
/**
|
|
2064
|
+
* locale for language settings
|
|
2065
|
+
* @default "en"
|
|
2066
|
+
*/
|
|
2067
|
+
locale?: ApiV2EntitiesUserLocale;
|
|
2130
2068
|
/**
|
|
2131
2069
|
* partner_id of the user
|
|
2132
2070
|
* @format int32
|
|
2133
2071
|
*/
|
|
2134
2072
|
partner_id?: number;
|
|
2135
|
-
/**
|
|
2136
|
-
|
|
2073
|
+
/**
|
|
2074
|
+
* role of the user
|
|
2075
|
+
* @default "customer"
|
|
2076
|
+
*/
|
|
2077
|
+
role?: ApiV2EntitiesUserRole;
|
|
2137
2078
|
/**
|
|
2138
2079
|
* the user sign in count
|
|
2139
2080
|
* @format int32
|
|
@@ -2318,6 +2259,18 @@ export interface GetApiV21CustomersParams {
|
|
|
2318
2259
|
fields?: string;
|
|
2319
2260
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
2320
2261
|
sort?: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* Page of results to fetch.
|
|
2264
|
+
* @format int32
|
|
2265
|
+
* @default 1
|
|
2266
|
+
*/
|
|
2267
|
+
page?: number;
|
|
2268
|
+
/**
|
|
2269
|
+
* Number of results to return per page.
|
|
2270
|
+
* @format int32
|
|
2271
|
+
* @default 25
|
|
2272
|
+
*/
|
|
2273
|
+
per_page?: number;
|
|
2321
2274
|
}
|
|
2322
2275
|
export interface GetApiV21DocumentsParams {
|
|
2323
2276
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
@@ -2359,7 +2312,7 @@ export interface GetApiV21ItemsIdOriginatorsParams {
|
|
|
2359
2312
|
/** @format int32 */
|
|
2360
2313
|
id: number;
|
|
2361
2314
|
}
|
|
2362
|
-
export interface
|
|
2315
|
+
export interface GetApiV21ItemsIdScancodesParams {
|
|
2363
2316
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2364
2317
|
search?: string;
|
|
2365
2318
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
@@ -2431,7 +2384,7 @@ export interface GetApiV21ItemsIdTransactionsParams {
|
|
|
2431
2384
|
/** @format int32 */
|
|
2432
2385
|
id: number;
|
|
2433
2386
|
}
|
|
2434
|
-
export interface
|
|
2387
|
+
export interface GetApiV21ItemsOriginatorOriginatorIdScancodesParams {
|
|
2435
2388
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2436
2389
|
search?: string;
|
|
2437
2390
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
@@ -2471,30 +2424,6 @@ export interface GetApiV21ItemsParams {
|
|
|
2471
2424
|
*/
|
|
2472
2425
|
per_page?: number;
|
|
2473
2426
|
}
|
|
2474
|
-
export interface GetApiV21MetaKeysCountParams {
|
|
2475
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2476
|
-
search?: string;
|
|
2477
|
-
}
|
|
2478
|
-
export interface GetApiV21MetaKeysParams {
|
|
2479
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2480
|
-
search?: string;
|
|
2481
|
-
/** Comma-separated list of fields to include in the response */
|
|
2482
|
-
fields?: string;
|
|
2483
|
-
/** A list of sort options (ex: name asc,created_at desc) */
|
|
2484
|
-
sort?: string;
|
|
2485
|
-
/**
|
|
2486
|
-
* Page of results to fetch.
|
|
2487
|
-
* @format int32
|
|
2488
|
-
* @default 1
|
|
2489
|
-
*/
|
|
2490
|
-
page?: number;
|
|
2491
|
-
/**
|
|
2492
|
-
* Number of results to return per page.
|
|
2493
|
-
* @format int32
|
|
2494
|
-
* @default 25
|
|
2495
|
-
*/
|
|
2496
|
-
per_page?: number;
|
|
2497
|
-
}
|
|
2498
2427
|
export interface GetApiV21NotificationEventsParams {
|
|
2499
2428
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2500
2429
|
search?: string;
|
|
@@ -2681,26 +2610,6 @@ export interface GetApiV21OriginatorsParams {
|
|
|
2681
2610
|
*/
|
|
2682
2611
|
per_page?: number;
|
|
2683
2612
|
}
|
|
2684
|
-
export interface GetApiV21ScancodeAliasesParams {
|
|
2685
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2686
|
-
search?: string;
|
|
2687
|
-
/** Comma-separated list of fields to include in the response */
|
|
2688
|
-
fields?: string;
|
|
2689
|
-
/** A list of sort options (ex: name asc,created_at desc) */
|
|
2690
|
-
sort?: string;
|
|
2691
|
-
/**
|
|
2692
|
-
* Page of results to fetch.
|
|
2693
|
-
* @format int32
|
|
2694
|
-
* @default 1
|
|
2695
|
-
*/
|
|
2696
|
-
page?: number;
|
|
2697
|
-
/**
|
|
2698
|
-
* Number of results to return per page.
|
|
2699
|
-
* @format int32
|
|
2700
|
-
* @default 25
|
|
2701
|
-
*/
|
|
2702
|
-
per_page?: number;
|
|
2703
|
-
}
|
|
2704
2613
|
export interface GetApiV21ShipnoticeItemsCountParams {
|
|
2705
2614
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2706
2615
|
search?: string;
|
|
@@ -2812,6 +2721,18 @@ export interface GetApiV2CustomersParams {
|
|
|
2812
2721
|
fields?: string;
|
|
2813
2722
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
2814
2723
|
sort?: string;
|
|
2724
|
+
/**
|
|
2725
|
+
* Page of results to fetch.
|
|
2726
|
+
* @format int32
|
|
2727
|
+
* @default 1
|
|
2728
|
+
*/
|
|
2729
|
+
page?: number;
|
|
2730
|
+
/**
|
|
2731
|
+
* Number of results to return per page.
|
|
2732
|
+
* @format int32
|
|
2733
|
+
* @default 25
|
|
2734
|
+
*/
|
|
2735
|
+
per_page?: number;
|
|
2815
2736
|
}
|
|
2816
2737
|
export interface GetApiV2DocumentsParams {
|
|
2817
2738
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
@@ -2853,7 +2774,7 @@ export interface GetApiV2ItemsIdOriginatorsParams {
|
|
|
2853
2774
|
/** @format int32 */
|
|
2854
2775
|
id: number;
|
|
2855
2776
|
}
|
|
2856
|
-
export interface
|
|
2777
|
+
export interface GetApiV2ItemsIdScancodesParams {
|
|
2857
2778
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2858
2779
|
search?: string;
|
|
2859
2780
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
@@ -2925,7 +2846,7 @@ export interface GetApiV2ItemsIdTransactionsParams {
|
|
|
2925
2846
|
/** @format int32 */
|
|
2926
2847
|
id: number;
|
|
2927
2848
|
}
|
|
2928
|
-
export interface
|
|
2849
|
+
export interface GetApiV2ItemsOriginatorOriginatorIdScancodesParams {
|
|
2929
2850
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2930
2851
|
search?: string;
|
|
2931
2852
|
/** A list of sort options (ex: name asc,created_at desc) */
|
|
@@ -2965,30 +2886,6 @@ export interface GetApiV2ItemsParams {
|
|
|
2965
2886
|
*/
|
|
2966
2887
|
per_page?: number;
|
|
2967
2888
|
}
|
|
2968
|
-
export interface GetApiV2MetaKeysCountParams {
|
|
2969
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2970
|
-
search?: string;
|
|
2971
|
-
}
|
|
2972
|
-
export interface GetApiV2MetaKeysParams {
|
|
2973
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2974
|
-
search?: string;
|
|
2975
|
-
/** Comma-separated list of fields to include in the response */
|
|
2976
|
-
fields?: string;
|
|
2977
|
-
/** A list of sort options (ex: name asc,created_at desc) */
|
|
2978
|
-
sort?: string;
|
|
2979
|
-
/**
|
|
2980
|
-
* Page of results to fetch.
|
|
2981
|
-
* @format int32
|
|
2982
|
-
* @default 1
|
|
2983
|
-
*/
|
|
2984
|
-
page?: number;
|
|
2985
|
-
/**
|
|
2986
|
-
* Number of results to return per page.
|
|
2987
|
-
* @format int32
|
|
2988
|
-
* @default 25
|
|
2989
|
-
*/
|
|
2990
|
-
per_page?: number;
|
|
2991
|
-
}
|
|
2992
2889
|
export interface GetApiV2NotificationEventsParams {
|
|
2993
2890
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
2994
2891
|
search?: string;
|
|
@@ -3175,46 +3072,6 @@ export interface GetApiV2OriginatorsParams {
|
|
|
3175
3072
|
*/
|
|
3176
3073
|
per_page?: number;
|
|
3177
3074
|
}
|
|
3178
|
-
export interface GetApiV2ScancodeAliasesParams {
|
|
3179
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
3180
|
-
search?: string;
|
|
3181
|
-
/** Comma-separated list of fields to include in the response */
|
|
3182
|
-
fields?: string;
|
|
3183
|
-
/** A list of sort options (ex: name asc,created_at desc) */
|
|
3184
|
-
sort?: string;
|
|
3185
|
-
/**
|
|
3186
|
-
* Page of results to fetch.
|
|
3187
|
-
* @format int32
|
|
3188
|
-
* @default 1
|
|
3189
|
-
*/
|
|
3190
|
-
page?: number;
|
|
3191
|
-
/**
|
|
3192
|
-
* Number of results to return per page.
|
|
3193
|
-
* @format int32
|
|
3194
|
-
* @default 25
|
|
3195
|
-
*/
|
|
3196
|
-
per_page?: number;
|
|
3197
|
-
}
|
|
3198
|
-
export interface GetApiV2ScancodesParams {
|
|
3199
|
-
/** JSON search string like {"attribute_eq": "Term"} */
|
|
3200
|
-
search?: string;
|
|
3201
|
-
/** Comma-separated list of fields to include in the response */
|
|
3202
|
-
fields?: string;
|
|
3203
|
-
/** A list of sort options (ex: name asc,created_at desc) */
|
|
3204
|
-
sort?: string;
|
|
3205
|
-
/**
|
|
3206
|
-
* Page of results to fetch.
|
|
3207
|
-
* @format int32
|
|
3208
|
-
* @default 1
|
|
3209
|
-
*/
|
|
3210
|
-
page?: number;
|
|
3211
|
-
/**
|
|
3212
|
-
* Number of results to return per page.
|
|
3213
|
-
* @format int32
|
|
3214
|
-
* @default 25
|
|
3215
|
-
*/
|
|
3216
|
-
per_page?: number;
|
|
3217
|
-
}
|
|
3218
3075
|
export interface GetApiV2ShipnoticeItemsCountParams {
|
|
3219
3076
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
3220
3077
|
search?: string;
|
|
@@ -3611,6 +3468,25 @@ export declare enum ApiV2EntitiesOrderIncoterm {
|
|
|
3611
3468
|
DEQ = "DEQ",
|
|
3612
3469
|
DDU = "DDU"
|
|
3613
3470
|
}
|
|
3471
|
+
/**
|
|
3472
|
+
* locale for language settings
|
|
3473
|
+
* @default "en"
|
|
3474
|
+
*/
|
|
3475
|
+
export declare enum ApiV2EntitiesUserLocale {
|
|
3476
|
+
En = "en",
|
|
3477
|
+
Es = "es"
|
|
3478
|
+
}
|
|
3479
|
+
/**
|
|
3480
|
+
* role of the user
|
|
3481
|
+
* @default "customer"
|
|
3482
|
+
*/
|
|
3483
|
+
export declare enum ApiV2EntitiesUserRole {
|
|
3484
|
+
Admin = "admin",
|
|
3485
|
+
Manager = "manager",
|
|
3486
|
+
Staff = "staff",
|
|
3487
|
+
Customer = "customer",
|
|
3488
|
+
Partner = "partner"
|
|
3489
|
+
}
|
|
3614
3490
|
/** Create a consumer return */
|
|
3615
3491
|
export interface PostApiV21ConsumerReturns {
|
|
3616
3492
|
/**
|
|
@@ -4282,17 +4158,6 @@ export declare enum PostApiV21ItemsPackagingType {
|
|
|
4282
4158
|
SmallParcel = "SmallParcel",
|
|
4283
4159
|
MediumParcel = "MediumParcel"
|
|
4284
4160
|
}
|
|
4285
|
-
/** Create a meta_key */
|
|
4286
|
-
export interface PostApiV21MetaKeys {
|
|
4287
|
-
"Key description"?: string;
|
|
4288
|
-
"Key name"?: string;
|
|
4289
|
-
"Resource this key will be attached to"?: string;
|
|
4290
|
-
"Value type"?: string;
|
|
4291
|
-
String?: string;
|
|
4292
|
-
desc?: string;
|
|
4293
|
-
type?: string;
|
|
4294
|
-
values?: string;
|
|
4295
|
-
}
|
|
4296
4161
|
/** Create a notification subscription */
|
|
4297
4162
|
export interface PostApiV21NotificationSubscriptions {
|
|
4298
4163
|
/** is the notification subscription active? */
|
|
@@ -4381,6 +4246,8 @@ export interface PostApiV21Orders {
|
|
|
4381
4246
|
* @format int32
|
|
4382
4247
|
*/
|
|
4383
4248
|
carrier_account_id?: number;
|
|
4249
|
+
/** packingslip pdf url */
|
|
4250
|
+
cf_packingslip_pdf_url?: string;
|
|
4384
4251
|
/** does the order contain alcohol? */
|
|
4385
4252
|
contains_alcohol?: boolean;
|
|
4386
4253
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -5715,17 +5582,6 @@ export declare enum PostApiV2ItemsPackagingType {
|
|
|
5715
5582
|
SmallParcel = "SmallParcel",
|
|
5716
5583
|
MediumParcel = "MediumParcel"
|
|
5717
5584
|
}
|
|
5718
|
-
/** Create a meta_key */
|
|
5719
|
-
export interface PostApiV2MetaKeys {
|
|
5720
|
-
"Key description"?: string;
|
|
5721
|
-
"Key name"?: string;
|
|
5722
|
-
"Resource this key will be attached to"?: string;
|
|
5723
|
-
"Value type"?: string;
|
|
5724
|
-
String?: string;
|
|
5725
|
-
desc?: string;
|
|
5726
|
-
type?: string;
|
|
5727
|
-
values?: string;
|
|
5728
|
-
}
|
|
5729
5585
|
/** Create a notification subscription */
|
|
5730
5586
|
export interface PostApiV2NotificationSubscriptions {
|
|
5731
5587
|
/** is the notification subscription active? */
|
|
@@ -5814,6 +5670,8 @@ export interface PostApiV2Orders {
|
|
|
5814
5670
|
* @format int32
|
|
5815
5671
|
*/
|
|
5816
5672
|
carrier_account_id?: number;
|
|
5673
|
+
/** packingslip pdf url */
|
|
5674
|
+
cf_packingslip_pdf_url?: string;
|
|
5817
5675
|
/** does the order contain alcohol? */
|
|
5818
5676
|
contains_alcohol?: boolean;
|
|
5819
5677
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -6636,6 +6494,8 @@ export interface PutApiV21Customers {
|
|
|
6636
6494
|
eori_number?: string;
|
|
6637
6495
|
/** Customer estimated monthly volume. */
|
|
6638
6496
|
estimated_monthly_volume?: string;
|
|
6497
|
+
/** is this account flagged for exit notice? (admins only) */
|
|
6498
|
+
exit_notice?: boolean;
|
|
6639
6499
|
/**
|
|
6640
6500
|
* items that are this many days from expiration will not be allowed to ship
|
|
6641
6501
|
* @format int32
|
|
@@ -7730,17 +7590,6 @@ export declare enum PutApiV21ItemsPackagingType {
|
|
|
7730
7590
|
SmallParcel = "SmallParcel",
|
|
7731
7591
|
MediumParcel = "MediumParcel"
|
|
7732
7592
|
}
|
|
7733
|
-
/** Update a meta_key */
|
|
7734
|
-
export interface PutApiV21MetaKeys {
|
|
7735
|
-
"Key description"?: string;
|
|
7736
|
-
"Key name"?: string;
|
|
7737
|
-
"Resource this key will be attached to"?: string;
|
|
7738
|
-
"Value type"?: string;
|
|
7739
|
-
String?: string;
|
|
7740
|
-
desc?: string;
|
|
7741
|
-
type?: string;
|
|
7742
|
-
values?: string;
|
|
7743
|
-
}
|
|
7744
7593
|
/** Update a notification subscription */
|
|
7745
7594
|
export interface PutApiV21NotificationSubscriptions {
|
|
7746
7595
|
/** is the notification subscription active? */
|
|
@@ -7918,6 +7767,8 @@ export interface PutApiV21Orders {
|
|
|
7918
7767
|
* @format int32
|
|
7919
7768
|
*/
|
|
7920
7769
|
carrier_account_id?: number;
|
|
7770
|
+
/** packingslip pdf url */
|
|
7771
|
+
cf_packingslip_pdf_url?: string;
|
|
7921
7772
|
/** does the order contain alcohol? */
|
|
7922
7773
|
contains_alcohol?: boolean;
|
|
7923
7774
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -8164,6 +8015,8 @@ export interface PutApiV21OrdersOriginator {
|
|
|
8164
8015
|
* @format int32
|
|
8165
8016
|
*/
|
|
8166
8017
|
carrier_account_id?: number;
|
|
8018
|
+
/** packingslip pdf url */
|
|
8019
|
+
cf_packingslip_pdf_url?: string;
|
|
8167
8020
|
/** does the order contain alcohol? */
|
|
8168
8021
|
contains_alcohol?: boolean;
|
|
8169
8022
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -8800,6 +8653,8 @@ export interface PutApiV2Customers {
|
|
|
8800
8653
|
eori_number?: string;
|
|
8801
8654
|
/** Customer estimated monthly volume. */
|
|
8802
8655
|
estimated_monthly_volume?: string;
|
|
8656
|
+
/** is this account flagged for exit notice? (admins only) */
|
|
8657
|
+
exit_notice?: boolean;
|
|
8803
8658
|
/**
|
|
8804
8659
|
* items that are this many days from expiration will not be allowed to ship
|
|
8805
8660
|
* @format int32
|
|
@@ -9894,17 +9749,6 @@ export declare enum PutApiV2ItemsPackagingType {
|
|
|
9894
9749
|
SmallParcel = "SmallParcel",
|
|
9895
9750
|
MediumParcel = "MediumParcel"
|
|
9896
9751
|
}
|
|
9897
|
-
/** Update a meta_key */
|
|
9898
|
-
export interface PutApiV2MetaKeys {
|
|
9899
|
-
"Key description"?: string;
|
|
9900
|
-
"Key name"?: string;
|
|
9901
|
-
"Resource this key will be attached to"?: string;
|
|
9902
|
-
"Value type"?: string;
|
|
9903
|
-
String?: string;
|
|
9904
|
-
desc?: string;
|
|
9905
|
-
type?: string;
|
|
9906
|
-
values?: string;
|
|
9907
|
-
}
|
|
9908
9752
|
/** Update a notification subscription */
|
|
9909
9753
|
export interface PutApiV2NotificationSubscriptions {
|
|
9910
9754
|
/** is the notification subscription active? */
|
|
@@ -10082,6 +9926,8 @@ export interface PutApiV2Orders {
|
|
|
10082
9926
|
* @format int32
|
|
10083
9927
|
*/
|
|
10084
9928
|
carrier_account_id?: number;
|
|
9929
|
+
/** packingslip pdf url */
|
|
9930
|
+
cf_packingslip_pdf_url?: string;
|
|
10085
9931
|
/** does the order contain alcohol? */
|
|
10086
9932
|
contains_alcohol?: boolean;
|
|
10087
9933
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -10326,6 +10172,8 @@ export interface PutApiV2OrdersOriginator {
|
|
|
10326
10172
|
* @format int32
|
|
10327
10173
|
*/
|
|
10328
10174
|
carrier_account_id?: number;
|
|
10175
|
+
/** packingslip pdf url */
|
|
10176
|
+
cf_packingslip_pdf_url?: string;
|
|
10329
10177
|
/** does the order contain alcohol? */
|
|
10330
10178
|
contains_alcohol?: boolean;
|
|
10331
10179
|
/** the carrier on the customer provided label (for tracking purposes) */
|
|
@@ -3,16 +3,12 @@ export * from './ConsumerReturns';
|
|
|
3
3
|
export * from './Customers';
|
|
4
4
|
export * from './Documents';
|
|
5
5
|
export * from './Items';
|
|
6
|
-
export * from './MetaKeys';
|
|
7
6
|
export * from './NotificationEvents';
|
|
8
7
|
export * from './NotificationSubscriptions';
|
|
9
8
|
export * from './OrderDocuments';
|
|
10
9
|
export * from './OrderItems';
|
|
11
10
|
export * from './Orders';
|
|
12
11
|
export * from './Originators';
|
|
13
|
-
export * from './Public';
|
|
14
|
-
export * from './ScancodeAliases';
|
|
15
|
-
export * from './Scancodes';
|
|
16
12
|
export * from './ShipnoticeItems';
|
|
17
13
|
export * from './Shipnotices';
|
|
18
14
|
export * from './Simulate';
|