@whiplashmerch/whiplash-api-client 3.1.13 → 3.2.1

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, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, 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, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdShippingDocumentsParams, 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
@@ -396,6 +396,15 @@ export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: num
396
396
  * @request GET:/api/v2/orders/{id}/shipment_rates
397
397
  */
398
398
  export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesShippingRate[]>;
399
+ /**
400
+ * @description List all shipping documents for a order
401
+ *
402
+ * @tags orders
403
+ * @name GetApiV2OrdersIdShippingDocuments
404
+ * @summary List shipping documents for a order
405
+ * @request GET:/api/v2/orders/{id}/shipping_documents
406
+ */
407
+ export declare const getApiV2OrdersIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV2EntitiesShippingDocument[]>;
399
408
  /**
400
409
  * @description List shipping rates for an order
401
410
  *
@@ -837,6 +846,15 @@ export declare const getApiV21OrdersIdSerialNumbers: (client: HttpClient, id: nu
837
846
  * @request GET:/api/v2.1/orders/{id}/shipment_rates
838
847
  */
839
848
  export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesShippingRate[]>;
849
+ /**
850
+ * @description List all shipping documents for a order
851
+ *
852
+ * @tags orders
853
+ * @name GetApiV21OrdersIdShippingDocuments
854
+ * @summary List shipping documents for a order
855
+ * @request GET:/api/v2.1/orders/{id}/shipping_documents
856
+ */
857
+ export declare const getApiV21OrdersIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV21EntitiesShippingDocument[]>;
840
858
  /**
841
859
  * @description List shipping rates for an order
842
860
  *
@@ -1,4 +1,4 @@
1
- import { ApiSharedEntitiesAudits, ApiV21EntitiesCount, ApiV21EntitiesPackage, ApiV21EntitiesResult, ApiV2EntitiesCount, ApiV2EntitiesPackage, ApiV2EntitiesResult, GetApiV21PackagesAggregateParams, GetApiV21PackagesIdCallTraitParams, GetApiV21PackagesIdTraitsParams, GetApiV21PackagesParams, GetApiV2PackagesAggregateParams, GetApiV2PackagesIdCallTraitParams, GetApiV2PackagesIdTraitsParams, GetApiV2PackagesParams, PutApiV21PackagesIdCallActionRequest, PutApiV21PackagesIdRequest, PutApiV2PackagesIdCallActionRequest, PutApiV2PackagesIdRequest } from "./data-contracts";
1
+ import { ApiSharedEntitiesAudits, ApiV21EntitiesCount, ApiV21EntitiesPackage, ApiV21EntitiesResult, ApiV21EntitiesShippingDocument, ApiV2EntitiesCount, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesShippingDocument, GetApiV21PackagesAggregateParams, GetApiV21PackagesIdCallTraitParams, GetApiV21PackagesIdShippingDocumentsParams, GetApiV21PackagesIdTraitsParams, GetApiV21PackagesParams, GetApiV2PackagesAggregateParams, GetApiV2PackagesIdCallTraitParams, GetApiV2PackagesIdShippingDocumentsParams, GetApiV2PackagesIdTraitsParams, GetApiV2PackagesParams, PutApiV21PackagesIdCallActionRequest, PutApiV21PackagesIdRequest, PutApiV2PackagesIdCallActionRequest, PutApiV2PackagesIdRequest } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description get packages
@@ -99,6 +99,15 @@ export declare const getApiV2PackagesIdCallTrait: (client: HttpClient, { trait,
99
99
  * @request GET:/api/v2/packages/{id}/shipment
100
100
  */
101
101
  export declare const getApiV2PackagesIdShipment: (client: HttpClient, id: number, params?: RequestParams) => Promise<any>;
102
+ /**
103
+ * @description List all shipping documents for a package
104
+ *
105
+ * @tags packages
106
+ * @name GetApiV2PackagesIdShippingDocuments
107
+ * @summary List shipping documents for a package
108
+ * @request GET:/api/v2/packages/{id}/shipping_documents
109
+ */
110
+ export declare const getApiV2PackagesIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV2PackagesIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV2EntitiesShippingDocument[]>;
102
111
  /**
103
112
  * @description Get the specified packages traits
104
113
  *
@@ -207,6 +216,15 @@ export declare const getApiV21PackagesIdCallTrait: (client: HttpClient, { trait,
207
216
  * @request GET:/api/v2.1/packages/{id}/shipment
208
217
  */
209
218
  export declare const getApiV21PackagesIdShipment: (client: HttpClient, id: number, params?: RequestParams) => Promise<any>;
219
+ /**
220
+ * @description List all shipping documents for a package
221
+ *
222
+ * @tags packages
223
+ * @name GetApiV21PackagesIdShippingDocuments
224
+ * @summary List shipping documents for a package
225
+ * @request GET:/api/v2.1/packages/{id}/shipping_documents
226
+ */
227
+ export declare const getApiV21PackagesIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV21PackagesIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV21EntitiesShippingDocument[]>;
210
228
  /**
211
229
  * @description Get the specified packages traits
212
230
  *