@whiplashmerch/whiplash-api-client 0.0.1

package/dist/generated/v2.1/OrderItems.d.ts

@@ -0,0 +1,83 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesMetaFields, APIV21EntitiesOrderItem, APIV21EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsPayload, GetApiV21OrderItemsIdParams, PutApiV21OrderItemsIdPayload } from "./data-contracts";
+/**
+ * @description Get resource actions
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/order_items/actions
+ */
+export declare const getApiV21OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy an order item
+ *
+ * @tags order_items
+ * @name DeleteApiV21OrderItemsId
+ * @summary Destroy an order item
+ * @request DELETE:/api/v2.1/order_items/{id}
+ */
+export declare const deleteApiV21OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Update an order item
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsId
+ * @summary Update an order item
+ * @request PUT:/api/v2.1/order_items/{id}
+ */
+export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, data: PutApiV21OrderItemsIdPayload, params?: RequestParams) => Promise<void>;
+/**
+ * @description Retrieve an order item
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsId
+ * @summary Retrieve an order item
+ * @request GET:/api/v2.1/order_items/{id}
+ */
+export declare const getApiV21OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/order_items/{id}/meta_fields
+ */
+export declare const putApiV21OrderItemsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/order_items/{id}/meta_fields
+ */
+export declare const getApiV21OrderItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV21OrderItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
+/**
+ * @description Separate an order item into a new order
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdSeparate
+ * @summary Separate an order item
+ * @request PUT:/api/v2.1/order_items/{id}/separate
+ */
+export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
+/**
+ * @description Perform an action on an order_item
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdCallAction
+ * @summary Perform an action on an order_item
+ * @request PUT:/api/v2.1/order_items/{id}/call/{action}
+ */
+export declare const putApiV21OrderItemsIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
+/**
+ * @description Serial numbers are scanned and saved during the packing process.
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsIdSerialNumbers
+ * @summary List all serial numbers associated with an order item
+ * @request GET:/api/v2.1/order_items/{id}/serial_numbers
+ */
+export declare const getApiV21OrderItemsIdSerialNumbers: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesSerialNumber[]>;

package/dist/generated/v2.1/Orders.d.ts

@@ -0,0 +1,182 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesCount, APIV21EntitiesMetaFields, APIV21EntitiesOrder, APIV21EntitiesOrderDocument, APIV21EntitiesOrderEvent, APIV21EntitiesOrderItem, APIV21EntitiesPostResponse, APIV21EntitiesResult, APIV21EntitiesSerialNumber, GetApiV21OrdersCountParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdMetaFieldsPayload, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersParams, PostApiV21OrdersBulkPayload, PostApiV21OrdersIdOrderDocumentsPayload, PostApiV21OrdersIdOrderItemsPayload, PostApiV21OrdersPayload, PutApiV21OrdersIdPayload, PutApiV21OrdersOriginatorOriginatorIdPayload } from "./data-contracts";
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PostApiV21Orders
+ * @summary Create an order
+ * @request POST:/api/v2.1/orders
+ */
+export declare const postApiV21Orders: (client: HttpClient, data: PostApiV21OrdersPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21Orders
+ * @summary List all orders
+ * @request GET:/api/v2.1/orders
+ */
+export declare const getApiV21Orders: (client: HttpClient, query: GetApiV21OrdersParams, params?: RequestParams) => Promise<APIV21EntitiesOrder[]>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersCount
+ * @summary Count orders
+ * @request GET:/api/v2.1/orders/count
+ */
+export declare const getApiV21OrdersCount: (client: HttpClient, query: GetApiV21OrdersCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
+/**
+ * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
+ *
+ * @tags orders
+ * @name PostApiV21OrdersBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2.1/orders/bulk
+ */
+export declare const postApiV21OrdersBulk: (client: HttpClient, data: PostApiV21OrdersBulkPayload, params?: RequestParams) => Promise<APIV21EntitiesResult>;
+/**
+ * @description Get resource actions
+ *
+ * @tags orders
+ * @name GetApiV21OrdersActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/orders/actions
+ */
+export declare const getApiV21OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV21OrdersOriginatorOriginatorId
+ * @summary Update an order
+ * @request PUT:/api/v2.1/orders/originator/{originator_id}
+ */
+export declare const putApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV21OrdersOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21OrdersOriginatorOriginatorId
+ * @summary Retrieve an order
+ * @request GET:/api/v2.1/orders/originator/{originator_id}
+ */
+export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdEventsCount
+ * @summary Count order's events
+ * @request GET:/api/v2.1/orders/{id}/events/count
+ */
+export declare const getApiV21OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdEvents
+ * @summary Retrieve the history for an order
+ * @request GET:/api/v2.1/orders/{id}/events
+ */
+export declare const getApiV21OrdersIdEvents: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdEventsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderEvent[]>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PutApiV21OrdersId
+ * @summary Update an order
+ * @request PUT:/api/v2.1/orders/{id}
+ */
+export declare const putApiV21OrdersId: (client: HttpClient, id: number, data: PutApiV21OrdersIdPayload, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersId
+ * @summary Retrieve an order
+ * @request GET:/api/v2.1/orders/{id}
+ */
+export declare const getApiV21OrdersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags orders
+ * @name PutApiV21OrdersIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/orders/{id}/meta_fields
+ */
+export declare const putApiV21OrdersIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/orders/{id}/meta_fields
+ */
+export declare const getApiV21OrdersIdMetaFields: (client: HttpClient, id: number, data: GetApiV21OrdersIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
+/**
+ * @description OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdOrderDocuments
+ * @summary Create an order document for an order
+ * @request POST:/api/v2.1/orders/{id}/order_documents
+ */
+export declare const postApiV21OrdersIdOrderDocuments: (client: HttpClient, id: number, data: PostApiV21OrdersIdOrderDocumentsPayload, params?: RequestParams) => Promise<APIV21EntitiesOrderDocument>;
+/**
+ * @description Retrieve all order documents for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderDocuments
+ * @summary List all order documents for an order
+ * @request GET:/api/v2.1/orders/{id}/order_documents
+ */
+export declare const getApiV21OrdersIdOrderDocuments: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderDocumentsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderDocument[]>;
+/**
+ * @description Create an order item
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdOrderItems
+ * @summary Create an order item
+ * @request POST:/api/v2.1/orders/{id}/order_items
+ */
+export declare const postApiV21OrdersIdOrderItems: (client: HttpClient, id: number, data: PostApiV21OrdersIdOrderItemsPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * @description Retrieve all order items for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderItems
+ * @summary List all order items for an order
+ * @request GET:/api/v2.1/orders/{id}/order_items
+ */
+export declare const getApiV21OrdersIdOrderItems: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem[]>;
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderItemsCount
+ * @summary Count order items
+ * @request GET:/api/v2.1/orders/{id}/order_items/count
+ */
+export declare const getApiV21OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
+/**
+ * @description Actions can be performed UPON an order. They don't necessarily update the order itself. You can see which actions are available to you at /orders/actions
+ *
+ * @tags orders
+ * @name PutApiV21OrdersIdCallAction
+ * @summary Perform an action on an order
+ * @request PUT:/api/v2.1/orders/{id}/call/{action}
+ */
+export declare const putApiV21OrdersIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Serial numbers are scanned and saved during the packing process.
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdSerialNumbers
+ * @summary List all serial numbers associated with an order item
+ * @request GET:/api/v2.1/orders/{id}/serial_numbers
+ */
+export declare const getApiV21OrdersIdSerialNumbers: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesSerialNumber[]>;

package/dist/generated/v2.1/Originators.d.ts

@@ -0,0 +1,11 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesOriginator, GetApiV21OriginatorsParams } from "./data-contracts";
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21Originators
+ * @summary List originators
+ * @request GET:/api/v2.1/originators
+ */
+export declare const getApiV21Originators: (client: HttpClient, query: GetApiV21OriginatorsParams, params?: RequestParams) => Promise<APIV21EntitiesOriginator>;

package/dist/generated/v2.1/Public.d.ts

@@ -0,0 +1,17 @@
+import { HttpClient, RequestParams } from "./../http-client";
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV21PublicStatus
+ * @request GET:/api/v2.1/public/status
+ */
+export declare const getApiV21PublicStatus: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV21PublicCarrierStatus
+ * @request GET:/api/v2.1/public/carrier_status
+ */
+export declare const getApiV21PublicCarrierStatus: (client: HttpClient, params?: RequestParams) => Promise<void>;

package/dist/generated/v2.1/ScancodeAliases.d.ts

@@ -0,0 +1,10 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesScancode, GetApiV21ScancodeAliasesParams } from "./data-contracts";
+/**
+ * @description Get all scancode_aliases
+ *
+ * @tags scancode_aliases
+ * @name GetApiV21ScancodeAliases
+ * @request GET:/api/v2.1/scancode_aliases
+ */
+export declare const getApiV21ScancodeAliases: (client: HttpClient, query: GetApiV21ScancodeAliasesParams, params?: RequestParams) => Promise<APIV21EntitiesScancode[]>;

package/dist/generated/v2.1/ShipnoticeItems.d.ts

@@ -0,0 +1,65 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesCount, APIV21EntitiesMetaFields, APIV21EntitiesShipnoticeItem, GetApiV21ShipnoticeItemsCountParams, GetApiV21ShipnoticeItemsIdMetaFieldsPayload, PutApiV21ShipnoticeItemsIdPayload } from "./data-contracts";
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/shipnotice_items/actions
+ */
+export declare const getApiV21ShipnoticeItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name DeleteApiV21ShipnoticeItemsId
+ * @summary Destroy a shipnotice item
+ * @request DELETE:/api/v2.1/shipnotice_items/{id}
+ */
+export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name PutApiV21ShipnoticeItemsId
+ * @summary Update a ship notice item
+ * @request PUT:/api/v2.1/shipnotice_items/{id}
+ */
+export declare const putApiV21ShipnoticeItemsId: (client: HttpClient, id: number, data: PutApiV21ShipnoticeItemsIdPayload, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsId
+ * @summary Retrieve a ship notice item
+ * @request GET:/api/v2.1/shipnotice_items/{id}
+ */
+export declare const getApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotice_items
+ * @name PutApiV21ShipnoticeItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/shipnotice_items/{id}/meta_fields
+ */
+export declare const putApiV21ShipnoticeItemsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/shipnotice_items/{id}/meta_fields
+ */
+export declare const getApiV21ShipnoticeItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV21ShipnoticeItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsCount
+ * @summary Count ship notice items
+ * @request GET:/api/v2.1/shipnotice_items/count
+ */
+export declare const getApiV21ShipnoticeItemsCount: (client: HttpClient, query: GetApiV21ShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;

package/dist/generated/v2.1/Shipnotices.d.ts

@@ -0,0 +1,155 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesCount, APIV21EntitiesMetaFields, APIV21EntitiesPostResponse, APIV21EntitiesResult, APIV21EntitiesShipnotice, APIV21EntitiesShipnoticeItem, GetApiV21ShipnoticesCountParams, GetApiV21ShipnoticesIdMetaFieldsPayload, GetApiV21ShipnoticesIdShipnoticeItemsCountParams, GetApiV21ShipnoticesIdShipnoticeItemsParams, GetApiV21ShipnoticesParams, PostApiV21ShipnoticesBulkPayload, PostApiV21ShipnoticesIdShipnoticeItemsPayload, PostApiV21ShipnoticesPayload, PutApiV21ShipnoticesIdPayload, PutApiV21ShipnoticesOriginatorOriginatorIdPayload } from "./data-contracts";
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV21Shipnotices
+ * @summary Create a ship notice
+ * @request POST:/api/v2.1/shipnotices
+ */
+export declare const postApiV21Shipnotices: (client: HttpClient, data: PostApiV21ShipnoticesPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21Shipnotices
+ * @summary List all ship notices
+ * @request GET:/api/v2.1/shipnotices
+ */
+export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<APIV21EntitiesShipnotice[]>;
+/**
+ * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
+ *
+ * @tags shipnotices
+ * @name PostApiV21ShipnoticesBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2.1/shipnotices/bulk
+ */
+export declare const postApiV21ShipnoticesBulk: (client: HttpClient, data: PostApiV21ShipnoticesBulkPayload, params?: RequestParams) => Promise<APIV21EntitiesResult>;
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/shipnotices/actions
+ */
+export declare const getApiV21ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags originators
+ * @name DeleteApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
+ *
+ * @tags originators
+ * @name PutApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export declare const putApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV21ShipnoticesOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export declare const getApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdOrdersWaiting
+ * @summary Count orders waiting for stock in a ship notice
+ * @request GET:/api/v2.1/shipnotices/{id}/orders_waiting
+ */
+export declare const getApiV21ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name DeleteApiV21ShipnoticesId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2.1/shipnotices/{id}
+ */
+export declare const deleteApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
+ *
+ * @tags shipnotices
+ * @name PutApiV21ShipnoticesId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2.1/shipnotices/{id}
+ */
+export declare const putApiV21ShipnoticesId: (client: HttpClient, id: number, data: PutApiV21ShipnoticesIdPayload, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2.1/shipnotices/{id}
+ */
+export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV21ShipnoticesIdShipnoticeItems
+ * @summary Create a ship notice item
+ * @request POST:/api/v2.1/shipnotices/{id}/shipnotice_items
+ */
+export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, data: PostApiV21ShipnoticesIdShipnoticeItemsPayload, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdShipnoticeItems
+ * @summary List associated ship notice items
+ * @request GET:/api/v2.1/shipnotices/{id}/shipnotice_items
+ */
+export declare const getApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotices
+ * @name PutApiV21ShipnoticesIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/shipnotices/{id}/meta_fields
+ */
+export declare const putApiV21ShipnoticesIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/shipnotices/{id}/meta_fields
+ */
+export declare const getApiV21ShipnoticesIdMetaFields: (client: HttpClient, id: number, data: GetApiV21ShipnoticesIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdShipnoticeItemsCount
+ * @summary Count associated ship notice items
+ * @request GET:/api/v2.1/shipnotices/{id}/shipnotice_items/count
+ */
+export declare const getApiV21ShipnoticesIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesCount
+ * @summary Count ship notices
+ * @request GET:/api/v2.1/shipnotices/count
+ */
+export declare const getApiV21ShipnoticesCount: (client: HttpClient, query: GetApiV21ShipnoticesCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;

package/dist/generated/v2.1/Simulate.d.ts

@@ -0,0 +1,56 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesConsumerReturn, APIV21EntitiesOrder, APIV21EntitiesShipnotice, PostApiV21SimulateConsumerReturnsCreatePayload, PostApiV21SimulateOrdersCreatePayload, PostApiV21SimulateShipnoticesCreatePayload, PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessingPayload, PutApiV21SimulateOrdersOrderIdProcessingPayload, PutApiV21SimulateShipnoticesShipnoticeIdProcessingPayload } from "./data-contracts";
+/**
+ * @description Customer users don't have access to staff actions, so this simulates a consumer return's workflow, allowing you to process a consumer return and, optionally, finalize it.
+ *
+ * @tags simulate
+ * @name PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing
+ * @summary Simulate processing for an consumer return
+ * @request PUT:/api/v2.1/simulate/consumer_returns/{consumer_return_id}/processing
+ */
+export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, data: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessingPayload, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateConsumerReturnsCreate
+ * @summary Create a consumer return with simulated data
+ * @request POST:/api/v2.1/simulate/consumer_returns/create
+ */
+export declare const postApiV21SimulateConsumerReturnsCreate: (client: HttpClient, data: PostApiV21SimulateConsumerReturnsCreatePayload, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
+/**
+ * @description Customer users don't have access to staff actions, so this simulates a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
+ *
+ * @tags simulate
+ * @name PutApiV21SimulateShipnoticesShipnoticeIdProcessing
+ * @summary Simulate processing for an ship notice
+ * @request PUT:/api/v2.1/simulate/shipnotices/{shipnotice_id}/processing
+ */
+export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, data: PutApiV21SimulateShipnoticesShipnoticeIdProcessingPayload, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateShipnoticesCreate
+ * @summary Create a shipnotice with simulated data
+ * @request POST:/api/v2.1/simulate/shipnotices/create
+ */
+export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient, data: PostApiV21SimulateShipnoticesCreatePayload, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
+/**
+ * @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
+ *
+ * @tags simulate
+ * @name PutApiV21SimulateOrdersOrderIdProcessing
+ * @summary Simulate processing for an order
+ * @request PUT:/api/v2.1/simulate/orders/{order_id}/processing
+ */
+export declare const putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, data: PutApiV21SimulateOrdersOrderIdProcessingPayload, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateOrdersCreate
+ * @summary Create an order with simulated data
+ * @request POST:/api/v2.1/simulate/orders/create
+ */
+export declare const postApiV21SimulateOrdersCreate: (client: HttpClient, data: PostApiV21SimulateOrdersCreatePayload, params?: RequestParams) => Promise<APIV21EntitiesOrder>;

package/dist/generated/v2.1/Templates.d.ts

@@ -0,0 +1,47 @@
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesTemplate, GetApiV21TemplatesParams, PostApiV21TemplatesPayload, PutApiV21TemplatesIdPayload } from "./data-contracts";
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PostApiV21Templates
+ * @summary Create a template
+ * @request POST:/api/v2.1/templates
+ */
+export declare const postApiV21Templates: (client: HttpClient, data: PostApiV21TemplatesPayload, params?: RequestParams) => Promise<APIV21EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV21Templates
+ * @summary List all templates
+ * @request GET:/api/v2.1/templates
+ */
+export declare const getApiV21Templates: (client: HttpClient, query: GetApiV21TemplatesParams, params?: RequestParams) => Promise<APIV21EntitiesTemplate[]>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name DeleteApiV21TemplatesId
+ * @summary Destroy a template
+ * @request DELETE:/api/v2.1/templates/{id}
+ */
+export declare const deleteApiV21TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV21TemplatesId
+ * @summary Update a template
+ * @request PUT:/api/v2.1/templates/{id}
+ */
+export declare const putApiV21TemplatesId: (client: HttpClient, id: number, data: PutApiV21TemplatesIdPayload, params?: RequestParams) => Promise<APIV21EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV21TemplatesId
+ * @summary Retrieve a template
+ * @request GET:/api/v2.1/templates/{id}
+ */
+export declare const getApiV21TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesTemplate>;