@whiplashmerch/whiplash-api-client 2.0.28 → 2.0.30

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 { ApiV21EntitiesNotificationSubscription, ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptionsRequest, PostApiV2NotificationSubscriptionsRequest, PutApiV21NotificationSubscriptionsIdRequest, PutApiV2NotificationSubscriptionsIdRequest } from "./data-contracts";
1
+ import { ApiV21EntitiesNotificationSubscription, ApiV21EntitiesPostResponse, ApiV2EntitiesAudits, ApiV2EntitiesCount, ApiV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptionsRequest, PostApiV2NotificationSubscriptionsRequest, PutApiV21NotificationSubscriptionsIdRequest, PutApiV2NotificationSubscriptionsIdRequest } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get a list of notification subscriptions
@@ -54,6 +54,15 @@ export declare const putApiV2NotificationSubscriptionsId: (client: HttpClient, i
54
54
  * @request DELETE:/api/v2/notification_subscriptions/{id}
55
55
  */
56
56
  export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
57
+ /**
58
+ * @description Get all audits for users
59
+ *
60
+ * @tags notification_subscriptions
61
+ * @name GetApiV2NotificationSubscriptionsIdAudits
62
+ * @summary Retrieve audit info for users
63
+ * @request GET:/api/v2/notification_subscriptions/{id}/audits
64
+ */
65
+ export declare const getApiV2NotificationSubscriptionsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesAudits>;
57
66
  /**
58
67
  * @description Test a notification subscription
59
68
  *
@@ -117,6 +126,15 @@ export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient,
117
126
  * @request DELETE:/api/v2.1/notification_subscriptions/{id}
118
127
  */
119
128
  export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
129
+ /**
130
+ * @description Get all audits for users
131
+ *
132
+ * @tags notification_subscriptions
133
+ * @name GetApiV21NotificationSubscriptionsIdAudits
134
+ * @summary Retrieve audit info for users
135
+ * @request GET:/api/v2.1/notification_subscriptions/{id}/audits
136
+ */
137
+ export declare const getApiV21NotificationSubscriptionsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesAudits>;
120
138
  /**
121
139
  * @description Test a notification subscription
122
140
  *
@@ -1,4 +1,4 @@
1
- import { ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesOrder, ApiV21EntitiesOrderItem, ApiV21EntitiesPostResponse, ApiV21EntitiesWholesale, ApiV2EntitiesAudits, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesMessage, ApiV2EntitiesMetaFields, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesSidekiqBatch, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
1
+ import { ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesOrder, ApiV21EntitiesOrderItem, ApiV21EntitiesPostResponse, ApiV21EntitiesWholesale, ApiV2EntitiesAudits, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesMessage, ApiV2EntitiesMetaFields, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesSidekiqBatch, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Retrieves a list of orders
@@ -324,6 +324,15 @@ export declare const getApiV2OrdersIdPackages: (client: HttpClient, { id, ...que
324
324
  * @request POST:/api/v2/orders/{id}/packages
325
325
  */
326
326
  export declare const postApiV2OrdersIdPackages: (client: HttpClient, id: number, data: PostApiV2OrdersIdPackagesRequest, params?: RequestParams) => Promise<ApiV2EntitiesPackage>;
327
+ /**
328
+ * @description Get count of packages for an order
329
+ *
330
+ * @tags orders
331
+ * @name GetApiV2OrdersIdPackagesCount
332
+ * @summary Count the packages for an order
333
+ * @request GET:/api/v2/orders/{id}/packages/count
334
+ */
335
+ export declare const getApiV2OrdersIdPackagesCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdPackagesCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
327
336
  /**
328
337
  * @description returns the binary form of an order packingslip pdf
329
338
  *
@@ -738,6 +747,15 @@ export declare const getApiV21OrdersIdPackages: (client: HttpClient, { id, ...qu
738
747
  * @request POST:/api/v2.1/orders/{id}/packages
739
748
  */
740
749
  export declare const postApiV21OrdersIdPackages: (client: HttpClient, id: number, data: PostApiV21OrdersIdPackagesRequest, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
750
+ /**
751
+ * @description Get count of packages for an order
752
+ *
753
+ * @tags orders
754
+ * @name GetApiV21OrdersIdPackagesCount
755
+ * @summary Count the packages for an order
756
+ * @request GET:/api/v2.1/orders/{id}/packages/count
757
+ */
758
+ export declare const getApiV21OrdersIdPackagesCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdPackagesCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
741
759
  /**
742
760
  * @description returns the binary form of an order packingslip pdf
743
761
  *
@@ -2715,6 +2715,11 @@ export interface ApiV2EntitiesNotificationSubscription {
2715
2715
  * @format int32
2716
2716
  */
2717
2717
  customer_id?: number | null;
2718
+ /**
2719
+ * the notification subscription discarded date and time
2720
+ * @format date-time
2721
+ */
2722
+ discarded_at?: string | null;
2718
2723
  /** the URL the subscription will hit for Slack and Webhook types */
2719
2724
  endpoint?: string | null;
2720
2725
  /**
@@ -2975,7 +2980,7 @@ export interface ApiV2EntitiesOrder {
2975
2980
  return_zip?: string | null;
2976
2981
  /** require a carrier that delivers on Saturdays for this order? */
2977
2982
  saturday_delivery?: boolean | null;
2978
- /** the order scac number */
2983
+ /** the orders Standard Carrier Alpha Code number */
2979
2984
  scac?: string | null;
2980
2985
  serial_numbers?: ApiV2EntitiesSerialNumber[];
2981
2986
  /**
@@ -3052,6 +3057,10 @@ export interface ApiV2EntitiesOrder {
3052
3057
  status?: ApiV2EntitiesOrderStatus;
3053
3058
  /** the order status name */
3054
3059
  status_name?: string;
3060
+ /** The Transport Management System ID for the order, if applicable */
3061
+ tms_id?: string | null;
3062
+ /** Does the order require a Transport Management System ID */
3063
+ tms_required?: boolean | null;
3055
3064
  tracking?: string[];
3056
3065
  tracking_links?: string[];
3057
3066
  /**
@@ -7294,6 +7303,11 @@ export interface ApiV21EntitiesNotificationSubscription {
7294
7303
  * @format int32
7295
7304
  */
7296
7305
  customer_id?: number | null;
7306
+ /**
7307
+ * the notification subscription discarded date and time
7308
+ * @format date-time
7309
+ */
7310
+ discarded_at?: string | null;
7297
7311
  /** the URL the subscription will hit for Slack and Webhook types */
7298
7312
  endpoint?: string | null;
7299
7313
  /**
@@ -7637,6 +7651,10 @@ export interface ApiV21EntitiesOrder {
7637
7651
  status?: ApiV21EntitiesOrderStatus;
7638
7652
  /** the order status name */
7639
7653
  status_name?: string;
7654
+ /** The Transport Management System ID for the order, if applicable */
7655
+ tms_id?: string | null;
7656
+ /** Does the order require a Transport Management System ID */
7657
+ tms_required?: boolean | null;
7640
7658
  tracking?: string[];
7641
7659
  tracking_links?: string[];
7642
7660
  /**
@@ -10721,6 +10739,11 @@ export interface GetApiV21OrdersIdOrderItemsParams {
10721
10739
  page_links?: boolean;
10722
10740
  id: number;
10723
10741
  }
10742
+ export interface GetApiV21OrdersIdPackagesCountParams {
10743
+ /** JSON search string like {"attribute_eq": "Term"} */
10744
+ search?: string;
10745
+ id: number;
10746
+ }
10724
10747
  export interface GetApiV21OrdersIdPackagesParams {
10725
10748
  /** JSON search string like {"attribute_eq": "Term"} */
10726
10749
  search?: string;
@@ -13417,6 +13440,11 @@ export interface GetApiV2OrdersIdOrderItemsParams {
13417
13440
  page_links?: boolean;
13418
13441
  id: number;
13419
13442
  }
13443
+ export interface GetApiV2OrdersIdPackagesCountParams {
13444
+ /** JSON search string like {"attribute_eq": "Term"} */
13445
+ search?: string;
13446
+ id: number;
13447
+ }
13420
13448
  export interface GetApiV2OrdersIdPackagesParams {
13421
13449
  /** JSON search string like {"attribute_eq": "Term"} */
13422
13450
  search?: string;
@@ -15923,8 +15951,12 @@ export interface PostApiV21OrdersBulkRequest {
15923
15951
  email?: string;
15924
15952
  /** skip order shipping address verification? (staff only) */
15925
15953
  skip_address_verification?: boolean;
15926
- /** the order scac number */
15954
+ /** the orders Standard Carrier Alpha Code number */
15927
15955
  scac?: string;
15956
+ /** The Transport Management System ID for the order, if applicable */
15957
+ tms_id?: string;
15958
+ /** Does the order require a Transport Management System ID */
15959
+ tms_required?: boolean;
15928
15960
  /** the order shop warehouse ids */
15929
15961
  shop_warehouse_ids?: number[];
15930
15962
  /** the order shop shipping method currency */
@@ -16823,7 +16855,7 @@ export interface PostApiV21OrdersRequest {
16823
16855
  return_zip?: string;
16824
16856
  /** require a carrier that delivers on Saturdays for this order? */
16825
16857
  saturday_delivery?: boolean;
16826
- /** the order scac number */
16858
+ /** the orders Standard Carrier Alpha Code number */
16827
16859
  scac?: string;
16828
16860
  /** the order ship notes */
16829
16861
  ship_notes?: string;
@@ -16884,6 +16916,10 @@ export interface PostApiV21OrdersRequest {
16884
16916
  * @format int32
16885
16917
  */
16886
16918
  status?: PostApiV21OrdersRequestStatus;
16919
+ /** The Transport Management System ID for the order, if applicable */
16920
+ tms_id?: string;
16921
+ /** Does the order require a Transport Management System ID */
16922
+ tms_required?: boolean;
16887
16923
  /** the order tracking numbers */
16888
16924
  tracking?: string[];
16889
16925
  /** the order tracking links */
@@ -19550,8 +19586,12 @@ export interface PostApiV2OrdersBulkRequest {
19550
19586
  email?: string;
19551
19587
  /** skip order shipping address verification? (staff only) */
19552
19588
  skip_address_verification?: boolean;
19553
- /** the order scac number */
19589
+ /** the orders Standard Carrier Alpha Code number */
19554
19590
  scac?: string;
19591
+ /** The Transport Management System ID for the order, if applicable */
19592
+ tms_id?: string;
19593
+ /** Does the order require a Transport Management System ID */
19594
+ tms_required?: boolean;
19555
19595
  /** the order shop warehouse ids */
19556
19596
  shop_warehouse_ids?: number[];
19557
19597
  /** the order shop shipping method currency */
@@ -20450,7 +20490,7 @@ export interface PostApiV2OrdersRequest {
20450
20490
  return_zip?: string;
20451
20491
  /** require a carrier that delivers on Saturdays for this order? */
20452
20492
  saturday_delivery?: boolean;
20453
- /** the order scac number */
20493
+ /** the orders Standard Carrier Alpha Code number */
20454
20494
  scac?: string;
20455
20495
  /** the order ship notes */
20456
20496
  ship_notes?: string;
@@ -20511,6 +20551,10 @@ export interface PostApiV2OrdersRequest {
20511
20551
  * @format int32
20512
20552
  */
20513
20553
  status?: PostApiV2OrdersRequestStatus;
20554
+ /** The Transport Management System ID for the order, if applicable */
20555
+ tms_id?: string;
20556
+ /** Does the order require a Transport Management System ID */
20557
+ tms_required?: boolean;
20514
20558
  /** the order tracking numbers */
20515
20559
  tracking?: string[];
20516
20560
  /** the order tracking links */
@@ -22862,6 +22906,11 @@ export interface PutApiV21NotificationSubscriptionsIdRequest {
22862
22906
  * @format int32
22863
22907
  */
22864
22908
  customer_id?: number;
22909
+ /**
22910
+ * the notification subscription discarded date and time
22911
+ * @format date-time
22912
+ */
22913
+ discarded_at?: string;
22865
22914
  /** the URL the subscription will hit for Slack and Webhook types */
22866
22915
  endpoint?: string;
22867
22916
  /**
@@ -23405,7 +23454,7 @@ export interface PutApiV21OrdersIdRequest {
23405
23454
  return_zip?: string;
23406
23455
  /** require a carrier that delivers on Saturdays for this order? */
23407
23456
  saturday_delivery?: boolean;
23408
- /** the order scac number */
23457
+ /** the orders Standard Carrier Alpha Code number */
23409
23458
  scac?: string;
23410
23459
  /** the order ship notes */
23411
23460
  ship_notes?: string;
@@ -23461,6 +23510,10 @@ export interface PutApiV21OrdersIdRequest {
23461
23510
  skip_address_verification?: boolean;
23462
23511
  /** skip street date for this order? */
23463
23512
  skip_street_date?: boolean;
23513
+ /** The Transport Management System ID for the order, if applicable */
23514
+ tms_id?: string;
23515
+ /** Does the order require a Transport Management System ID */
23516
+ tms_required?: boolean;
23464
23517
  /** the order tracking numbers */
23465
23518
  tracking?: string[];
23466
23519
  /** the order tracking links */
@@ -25849,6 +25902,11 @@ export interface PutApiV2NotificationSubscriptionsIdRequest {
25849
25902
  * @format int32
25850
25903
  */
25851
25904
  customer_id?: number;
25905
+ /**
25906
+ * the notification subscription discarded date and time
25907
+ * @format date-time
25908
+ */
25909
+ discarded_at?: string;
25852
25910
  /** the URL the subscription will hit for Slack and Webhook types */
25853
25911
  endpoint?: string;
25854
25912
  /**
@@ -26392,7 +26450,7 @@ export interface PutApiV2OrdersIdRequest {
26392
26450
  return_zip?: string;
26393
26451
  /** require a carrier that delivers on Saturdays for this order? */
26394
26452
  saturday_delivery?: boolean;
26395
- /** the order scac number */
26453
+ /** the orders Standard Carrier Alpha Code number */
26396
26454
  scac?: string;
26397
26455
  /** the order ship notes */
26398
26456
  ship_notes?: string;
@@ -26448,6 +26506,10 @@ export interface PutApiV2OrdersIdRequest {
26448
26506
  skip_address_verification?: boolean;
26449
26507
  /** skip street date for this order? */
26450
26508
  skip_street_date?: boolean;
26509
+ /** The Transport Management System ID for the order, if applicable */
26510
+ tms_id?: string;
26511
+ /** Does the order require a Transport Management System ID */
26512
+ tms_required?: boolean;
26451
26513
  /** the order tracking numbers */
26452
26514
  tracking?: string[];
26453
26515
  /** the order tracking links */
@@ -1255,6 +1255,11 @@ export interface ApiV2EntitiesNotificationSubscription {
1255
1255
  * @format int32
1256
1256
  */
1257
1257
  customer_id?: number | null;
1258
+ /**
1259
+ * the notification subscription discarded date and time
1260
+ * @format date-time
1261
+ */
1262
+ discarded_at?: string | null;
1258
1263
  /** the URL the subscription will hit for Slack and Webhook types */
1259
1264
  endpoint?: string | null;
1260
1265
  /**
@@ -1516,7 +1521,7 @@ export interface ApiV2EntitiesOrder {
1516
1521
  return_zip?: string | null;
1517
1522
  /** require a carrier that delivers on Saturdays for this order? */
1518
1523
  saturday_delivery?: boolean | null;
1519
- /** the order scac number */
1524
+ /** the orders Standard Carrier Alpha Code number */
1520
1525
  scac?: string | null;
1521
1526
  serial_numbers?: ApiV2EntitiesSerialNumber[];
1522
1527
  /**
@@ -1593,6 +1598,10 @@ export interface ApiV2EntitiesOrder {
1593
1598
  status?: ApiV2EntitiesOrderStatus;
1594
1599
  /** the order status name */
1595
1600
  status_name?: string;
1601
+ /** The Transport Management System ID for the order, if applicable */
1602
+ tms_id?: string | null;
1603
+ /** Does the order require a Transport Management System ID */
1604
+ tms_required?: boolean | null;
1596
1605
  tracking?: string[];
1597
1606
  tracking_links?: string[];
1598
1607
  /**
@@ -3695,6 +3704,11 @@ export interface ApiV21EntitiesNotificationSubscription {
3695
3704
  * @format int32
3696
3705
  */
3697
3706
  customer_id?: number | null;
3707
+ /**
3708
+ * the notification subscription discarded date and time
3709
+ * @format date-time
3710
+ */
3711
+ discarded_at?: string | null;
3698
3712
  /** the URL the subscription will hit for Slack and Webhook types */
3699
3713
  endpoint?: string | null;
3700
3714
  /**
@@ -4039,6 +4053,10 @@ export interface ApiV21EntitiesOrder {
4039
4053
  status?: ApiV21EntitiesOrderStatus;
4040
4054
  /** the order status name */
4041
4055
  status_name?: string;
4056
+ /** The Transport Management System ID for the order, if applicable */
4057
+ tms_id?: string | null;
4058
+ /** Does the order require a Transport Management System ID */
4059
+ tms_required?: boolean | null;
4042
4060
  tracking?: string[];
4043
4061
  tracking_links?: string[];
4044
4062
  /**
@@ -6415,8 +6433,12 @@ export interface PostApiV21OrdersBulkRequest {
6415
6433
  email?: string;
6416
6434
  /** skip order shipping address verification? (staff only) */
6417
6435
  skip_address_verification?: boolean;
6418
- /** the order scac number */
6436
+ /** the orders Standard Carrier Alpha Code number */
6419
6437
  scac?: string;
6438
+ /** The Transport Management System ID for the order, if applicable */
6439
+ tms_id?: string;
6440
+ /** Does the order require a Transport Management System ID */
6441
+ tms_required?: boolean;
6420
6442
  /** the order shop warehouse ids */
6421
6443
  shop_warehouse_ids?: number[];
6422
6444
  /** the order shop shipping method currency */
@@ -7214,7 +7236,7 @@ export interface PostApiV21OrdersRequest {
7214
7236
  return_zip?: string;
7215
7237
  /** require a carrier that delivers on Saturdays for this order? */
7216
7238
  saturday_delivery?: boolean;
7217
- /** the order scac number */
7239
+ /** the orders Standard Carrier Alpha Code number */
7218
7240
  scac?: string;
7219
7241
  /** the order ship notes */
7220
7242
  ship_notes?: string;
@@ -7275,6 +7297,10 @@ export interface PostApiV21OrdersRequest {
7275
7297
  * @format int32
7276
7298
  */
7277
7299
  status?: PostApiV21OrdersRequestStatus;
7300
+ /** The Transport Management System ID for the order, if applicable */
7301
+ tms_id?: string;
7302
+ /** Does the order require a Transport Management System ID */
7303
+ tms_required?: boolean;
7278
7304
  /** the order tracking numbers */
7279
7305
  tracking?: string[];
7280
7306
  /** the order tracking links */
@@ -8367,8 +8393,12 @@ export interface PostApiV2OrdersBulkRequest {
8367
8393
  email?: string;
8368
8394
  /** skip order shipping address verification? (staff only) */
8369
8395
  skip_address_verification?: boolean;
8370
- /** the order scac number */
8396
+ /** the orders Standard Carrier Alpha Code number */
8371
8397
  scac?: string;
8398
+ /** The Transport Management System ID for the order, if applicable */
8399
+ tms_id?: string;
8400
+ /** Does the order require a Transport Management System ID */
8401
+ tms_required?: boolean;
8372
8402
  /** the order shop warehouse ids */
8373
8403
  shop_warehouse_ids?: number[];
8374
8404
  /** the order shop shipping method currency */
@@ -9166,7 +9196,7 @@ export interface PostApiV2OrdersRequest {
9166
9196
  return_zip?: string;
9167
9197
  /** require a carrier that delivers on Saturdays for this order? */
9168
9198
  saturday_delivery?: boolean;
9169
- /** the order scac number */
9199
+ /** the orders Standard Carrier Alpha Code number */
9170
9200
  scac?: string;
9171
9201
  /** the order ship notes */
9172
9202
  ship_notes?: string;
@@ -9227,6 +9257,10 @@ export interface PostApiV2OrdersRequest {
9227
9257
  * @format int32
9228
9258
  */
9229
9259
  status?: PostApiV2OrdersRequestStatus;
9260
+ /** The Transport Management System ID for the order, if applicable */
9261
+ tms_id?: string;
9262
+ /** Does the order require a Transport Management System ID */
9263
+ tms_required?: boolean;
9230
9264
  /** the order tracking numbers */
9231
9265
  tracking?: string[];
9232
9266
  /** the order tracking links */
@@ -10202,6 +10236,11 @@ export interface PutApiV21NotificationSubscriptionsIdRequest {
10202
10236
  * @format int32
10203
10237
  */
10204
10238
  customer_id?: number;
10239
+ /**
10240
+ * the notification subscription discarded date and time
10241
+ * @format date-time
10242
+ */
10243
+ discarded_at?: string;
10205
10244
  /** the URL the subscription will hit for Slack and Webhook types */
10206
10245
  endpoint?: string;
10207
10246
  /**
@@ -10605,7 +10644,7 @@ export interface PutApiV21OrdersIdRequest {
10605
10644
  return_zip?: string;
10606
10645
  /** require a carrier that delivers on Saturdays for this order? */
10607
10646
  saturday_delivery?: boolean;
10608
- /** the order scac number */
10647
+ /** the orders Standard Carrier Alpha Code number */
10609
10648
  scac?: string;
10610
10649
  /** the order ship notes */
10611
10650
  ship_notes?: string;
@@ -10661,6 +10700,10 @@ export interface PutApiV21OrdersIdRequest {
10661
10700
  skip_address_verification?: boolean;
10662
10701
  /** skip street date for this order? */
10663
10702
  skip_street_date?: boolean;
10703
+ /** The Transport Management System ID for the order, if applicable */
10704
+ tms_id?: string;
10705
+ /** Does the order require a Transport Management System ID */
10706
+ tms_required?: boolean;
10664
10707
  /** the order tracking numbers */
10665
10708
  tracking?: string[];
10666
10709
  /** the order tracking links */
@@ -11432,6 +11475,11 @@ export interface PutApiV2NotificationSubscriptionsIdRequest {
11432
11475
  * @format int32
11433
11476
  */
11434
11477
  customer_id?: number;
11478
+ /**
11479
+ * the notification subscription discarded date and time
11480
+ * @format date-time
11481
+ */
11482
+ discarded_at?: string;
11435
11483
  /** the URL the subscription will hit for Slack and Webhook types */
11436
11484
  endpoint?: string;
11437
11485
  /**
@@ -11835,7 +11883,7 @@ export interface PutApiV2OrdersIdRequest {
11835
11883
  return_zip?: string;
11836
11884
  /** require a carrier that delivers on Saturdays for this order? */
11837
11885
  saturday_delivery?: boolean;
11838
- /** the order scac number */
11886
+ /** the orders Standard Carrier Alpha Code number */
11839
11887
  scac?: string;
11840
11888
  /** the order ship notes */
11841
11889
  ship_notes?: string;
@@ -11891,6 +11939,10 @@ export interface PutApiV2OrdersIdRequest {
11891
11939
  skip_address_verification?: boolean;
11892
11940
  /** skip street date for this order? */
11893
11941
  skip_street_date?: boolean;
11942
+ /** The Transport Management System ID for the order, if applicable */
11943
+ tms_id?: string;
11944
+ /** Does the order require a Transport Management System ID */
11945
+ tms_required?: boolean;
11894
11946
  /** the order tracking numbers */
11895
11947
  tracking?: string[];
11896
11948
  /** the order tracking links */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "2.0.28",
3
+ "version": "2.0.30",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {