@whiplashmerch/whiplash-api-client 3.0.1 → 3.0.2

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, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, 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";
1
+ import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, 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
@@ -54,6 +54,15 @@ export declare const postApiV2OrdersBulk: (client: HttpClient, data: PostApiV2Or
54
54
  * @request GET:/api/v2/orders/count
55
55
  */
56
56
  export declare const getApiV2OrdersCount: (client: HttpClient, query: GetApiV2OrdersCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
57
+ /**
58
+ * @description Returns all order types
59
+ *
60
+ * @tags orders
61
+ * @name GetApiV2OrdersOrderTypes
62
+ * @summary Order Types
63
+ * @request GET:/api/v2/orders/order_types
64
+ */
65
+ export declare const getApiV2OrdersOrderTypes: (client: HttpClient, params?: RequestParams) => Promise<ApiV2EntitiesListValue>;
57
66
  /**
58
67
  * @description Get orders traits
59
68
  *
@@ -477,6 +486,15 @@ export declare const postApiV21OrdersBulk: (client: HttpClient, data: PostApiV21
477
486
  * @request GET:/api/v2.1/orders/count
478
487
  */
479
488
  export declare const getApiV21OrdersCount: (client: HttpClient, query: GetApiV21OrdersCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
489
+ /**
490
+ * @description Returns all order types
491
+ *
492
+ * @tags orders
493
+ * @name GetApiV21OrdersOrderTypes
494
+ * @summary Order Types
495
+ * @request GET:/api/v2.1/orders/order_types
496
+ */
497
+ export declare const getApiV21OrdersOrderTypes: (client: HttpClient, params?: RequestParams) => Promise<ApiV21EntitiesListValue>;
480
498
  /**
481
499
  * @description Get orders traits
482
500
  *
@@ -1394,131 +1394,131 @@ export interface ApiV2EntitiesFilterSet {
1394
1394
  /** V2 */
1395
1395
  export interface ApiV2EntitiesFilterSetOptions {
1396
1396
  bulk_actions?: {
1397
- location_transfer?: object;
1398
- order_batch?: object;
1399
- meta_key?: object;
1397
+ location?: object;
1398
+ account_transaction?: object;
1400
1399
  shipping_method?: object;
1401
- order?: object;
1402
- project?: object;
1400
+ location_audit?: object;
1401
+ consumer_return?: object;
1402
+ order_batch?: object;
1403
1403
  incident?: object;
1404
1404
  item?: object;
1405
- manifest?: object;
1406
1405
  warehouse?: object;
1407
- account_transaction?: object;
1408
- user?: object;
1409
- consumer_return?: object;
1410
- shipnotice?: object;
1411
- location?: object;
1412
1406
  carrier_account?: object;
1413
- location_audit?: object;
1407
+ order?: object;
1408
+ location_transfer?: object;
1409
+ shipnotice?: object;
1410
+ project?: object;
1411
+ manifest?: object;
1412
+ user?: object;
1413
+ meta_key?: object;
1414
1414
  };
1415
1415
  exporters?: {
1416
- location_transfer?: object;
1416
+ location?: object;
1417
+ account_transaction?: object;
1417
1418
  shipping_method?: object;
1418
- order?: object;
1419
+ location_audit?: object;
1419
1420
  document?: object;
1421
+ consumer_return?: object;
1422
+ customer?: object;
1420
1423
  incident?: object;
1421
1424
  item?: object;
1422
- account_transaction?: object;
1423
- consumer_return?: object;
1425
+ order?: object;
1426
+ location_transfer?: object;
1424
1427
  shipnotice?: object;
1425
- location?: object;
1426
- customer?: object;
1427
- location_audit?: object;
1428
1428
  };
1429
1429
  filters?: {
1430
- location_transfer?: any[];
1431
- order_batch?: any[];
1432
- meta_key?: any[];
1430
+ location?: any[];
1431
+ account_transaction?: any[];
1433
1432
  shipping_method?: any[];
1434
- order?: any[];
1435
- project?: any[];
1433
+ location_audit?: any[];
1436
1434
  document?: any[];
1435
+ transaction?: any[];
1436
+ consumer_return?: any[];
1437
+ order_batch?: any[];
1438
+ customer?: any[];
1437
1439
  incident?: any[];
1438
1440
  item?: any[];
1439
- manifest?: any[];
1440
1441
  warehouse?: any[];
1441
- account_transaction?: any[];
1442
- user?: any[];
1443
- consumer_return?: any[];
1444
- partner?: any[];
1445
- shipnotice?: any[];
1446
- location?: any[];
1447
- transaction?: any[];
1448
1442
  carrier_account?: any[];
1449
- customer?: any[];
1450
- location_audit?: any[];
1443
+ order?: any[];
1444
+ location_transfer?: any[];
1445
+ shipnotice?: any[];
1446
+ project?: any[];
1447
+ partner?: any[];
1448
+ manifest?: any[];
1449
+ user?: any[];
1450
+ meta_key?: any[];
1451
1451
  };
1452
1452
  importers?: {
1453
- location_transfer?: any[];
1454
- order?: any[];
1455
1453
  document?: any[];
1456
- item?: any[];
1457
1454
  consumer_return?: any[];
1455
+ item?: any[];
1456
+ order?: any[];
1457
+ location_transfer?: any[];
1458
1458
  shipnotice?: any[];
1459
1459
  };
1460
1460
  required_scopes?: {
1461
- location_transfer?: any[];
1462
- order_batch?: any[];
1463
- meta_key?: any[];
1461
+ location?: any[];
1462
+ account_transaction?: any[];
1464
1463
  shipping_method?: any[];
1465
- order?: any[];
1466
- project?: any[];
1464
+ location_audit?: any[];
1467
1465
  document?: any[];
1466
+ transaction?: any[];
1467
+ consumer_return?: any[];
1468
+ order_batch?: any[];
1469
+ customer?: any[];
1468
1470
  incident?: any[];
1469
1471
  item?: any[];
1470
- manifest?: any[];
1471
1472
  warehouse?: any[];
1472
- account_transaction?: any[];
1473
- user?: any[];
1474
- consumer_return?: any[];
1475
- partner?: any[];
1476
- shipnotice?: any[];
1477
- location?: any[];
1478
- transaction?: any[];
1479
1473
  carrier_account?: any[];
1480
- customer?: any[];
1481
- location_audit?: any[];
1474
+ order?: any[];
1475
+ location_transfer?: any[];
1476
+ shipnotice?: any[];
1477
+ project?: any[];
1478
+ partner?: any[];
1479
+ manifest?: any[];
1480
+ user?: any[];
1481
+ meta_key?: any[];
1482
1482
  };
1483
1483
  resource_actions?: {
1484
- location_transfer?: object;
1485
- order_batch?: object;
1486
- meta_key?: object;
1484
+ location?: object;
1485
+ account_transaction?: object;
1487
1486
  shipping_method?: object;
1488
- order?: object;
1489
- project?: object;
1487
+ location_audit?: object;
1490
1488
  document?: object;
1489
+ consumer_return?: object;
1490
+ order_batch?: object;
1491
+ customer?: object;
1491
1492
  incident?: object;
1492
1493
  item?: object;
1493
- manifest?: object;
1494
1494
  warehouse?: object;
1495
- account_transaction?: object;
1496
- user?: object;
1497
- consumer_return?: object;
1498
- shipnotice?: object;
1499
- location?: object;
1500
1495
  carrier_account?: object;
1501
- customer?: object;
1502
- location_audit?: object;
1496
+ order?: object;
1497
+ location_transfer?: object;
1498
+ shipnotice?: object;
1499
+ project?: object;
1500
+ manifest?: object;
1501
+ user?: object;
1502
+ meta_key?: object;
1503
1503
  };
1504
1504
  rule_actions?: {
1505
1505
  batching?: object;
1506
- replenishment?: object;
1506
+ routing?: object;
1507
1507
  packing?: object;
1508
1508
  backstock?: object;
1509
- shipping_method?: object;
1510
1509
  carrier_account?: object;
1511
- routing?: object;
1510
+ replenishment?: object;
1511
+ shipping_method?: object;
1512
1512
  };
1513
1513
  traits?: {
1514
+ consumer_return?: any[];
1514
1515
  order_batch?: any[];
1515
- order?: any[];
1516
+ customer?: any[];
1516
1517
  item?: any[];
1517
1518
  warehouse?: any[];
1518
- user?: any[];
1519
- consumer_return?: any[];
1519
+ order?: any[];
1520
1520
  shipnotice?: any[];
1521
- customer?: any[];
1521
+ user?: any[];
1522
1522
  };
1523
1523
  }
1524
1524
  /** V2 */
@@ -2211,6 +2211,10 @@ export interface ApiV2EntitiesItemWarehouseQuantity {
2211
2211
  warehouse_features?: string;
2212
2212
  }
2213
2213
  /** V2 */
2214
+ export interface ApiV2EntitiesListValue {
2215
+ list?: string[];
2216
+ }
2217
+ /** V2 */
2214
2218
  export interface ApiV2EntitiesLoad {
2215
2219
  /**
2216
2220
  * the date/time of the appointment
@@ -7432,6 +7436,10 @@ export interface ApiV21EntitiesItemWarehouseQuantity {
7432
7436
  sellable_quantity?: number;
7433
7437
  }
7434
7438
  /** V3 */
7439
+ export interface ApiV21EntitiesListValue {
7440
+ list?: string[];
7441
+ }
7442
+ /** V3 */
7435
7443
  export interface ApiV21EntitiesLoad {
7436
7444
  /**
7437
7445
  * the date/time of the appointment
@@ -31953,12 +31961,12 @@ export declare enum PostApiV21RulesRequestState {
31953
31961
  /** Which type of rule this is */
31954
31962
  export declare enum PostApiV21RulesRequestType {
31955
31963
  BatchingRule = "BatchingRule",
31956
- ReplenishmentRule = "ReplenishmentRule",
31964
+ RoutingRule = "RoutingRule",
31957
31965
  PackingRule = "PackingRule",
31958
31966
  BackstockRule = "BackstockRule",
31959
- ShippingMethodRule = "ShippingMethodRule",
31960
31967
  CarrierAccountRule = "CarrierAccountRule",
31961
- RoutingRule = "RoutingRule"
31968
+ ReplenishmentRule = "ReplenishmentRule",
31969
+ ShippingMethodRule = "ShippingMethodRule"
31962
31970
  }
31963
31971
  /** locale for language settings */
31964
31972
  export declare enum PostApiV21UsersRequestLocale {
@@ -32761,12 +32769,12 @@ export declare enum PostApiV2RulesRequestState {
32761
32769
  /** Which type of rule this is */
32762
32770
  export declare enum PostApiV2RulesRequestType {
32763
32771
  BatchingRule = "BatchingRule",
32764
- ReplenishmentRule = "ReplenishmentRule",
32772
+ RoutingRule = "RoutingRule",
32765
32773
  PackingRule = "PackingRule",
32766
32774
  BackstockRule = "BackstockRule",
32767
- ShippingMethodRule = "ShippingMethodRule",
32768
32775
  CarrierAccountRule = "CarrierAccountRule",
32769
- RoutingRule = "RoutingRule"
32776
+ ReplenishmentRule = "ReplenishmentRule",
32777
+ ShippingMethodRule = "ShippingMethodRule"
32770
32778
  }
32771
32779
  /** locale for language settings */
32772
32780
  export declare enum PostApiV2UsersRequestLocale {