@whiplashmerch/whiplash-api-client 0.0.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.
- package/dist/client.esm.js +7391 -0
- package/dist/client.esm.js.map +1 -0
- package/dist/generated/http-client.d.ts +41 -0
- package/dist/generated/index.d.ts +2 -0
- package/dist/generated/v2/BundleItems.d.ts +29 -0
- package/dist/generated/v2/ConsumerReturns.d.ts +110 -0
- package/dist/generated/v2/Customers.d.ts +47 -0
- package/dist/generated/v2/Documents.d.ts +38 -0
- package/dist/generated/v2/Items.d.ts +245 -0
- package/dist/generated/v2/MetaKeys.d.ts +56 -0
- package/dist/generated/v2/NotificationEvents.d.ts +20 -0
- package/dist/generated/v2/NotificationSubscriptions.d.ts +65 -0
- package/dist/generated/v2/OrderDocuments.d.ts +11 -0
- package/dist/generated/v2/OrderItems.d.ts +83 -0
- package/dist/generated/v2/Orders.d.ts +182 -0
- package/dist/generated/v2/Originators.d.ts +11 -0
- package/dist/generated/v2/Public.d.ts +17 -0
- package/dist/generated/v2/ScancodeAliases.d.ts +10 -0
- package/dist/generated/v2/Scancodes.d.ts +10 -0
- package/dist/generated/v2/ShipnoticeItems.d.ts +65 -0
- package/dist/generated/v2/Shipnotices.d.ts +155 -0
- package/dist/generated/v2/Simulate.d.ts +56 -0
- package/dist/generated/v2/Templates.d.ts +47 -0
- package/dist/generated/v2/data-contracts.d.ts +6511 -0
- package/dist/generated/v2/index.d.ts +20 -0
- package/dist/generated/v2.1/BundleItems.d.ts +29 -0
- package/dist/generated/v2.1/ConsumerReturns.d.ts +110 -0
- package/dist/generated/v2.1/Customers.d.ts +47 -0
- package/dist/generated/v2.1/Documents.d.ts +38 -0
- package/dist/generated/v2.1/Items.d.ts +245 -0
- package/dist/generated/v2.1/MetaKeys.d.ts +56 -0
- package/dist/generated/v2.1/NotificationEvents.d.ts +20 -0
- package/dist/generated/v2.1/NotificationSubscriptions.d.ts +65 -0
- package/dist/generated/v2.1/OrderDocuments.d.ts +11 -0
- package/dist/generated/v2.1/OrderItems.d.ts +83 -0
- package/dist/generated/v2.1/Orders.d.ts +182 -0
- package/dist/generated/v2.1/Originators.d.ts +11 -0
- package/dist/generated/v2.1/Public.d.ts +17 -0
- package/dist/generated/v2.1/ScancodeAliases.d.ts +10 -0
- package/dist/generated/v2.1/ShipnoticeItems.d.ts +65 -0
- package/dist/generated/v2.1/Shipnotices.d.ts +155 -0
- package/dist/generated/v2.1/Simulate.d.ts +56 -0
- package/dist/generated/v2.1/Templates.d.ts +47 -0
- package/dist/generated/v2.1/data-contracts.d.ts +6499 -0
- package/dist/generated/v2.1/index.d.ts +19 -0
- package/dist/index.d.ts +1 -0
- package/generated/http-client.ts +142 -0
- package/generated/index.ts +2 -0
- package/generated/v2/BundleItems.ts +67 -0
- package/generated/v2/ConsumerReturns.ts +265 -0
- package/generated/v2/Customers.ts +113 -0
- package/generated/v2/Documents.ts +86 -0
- package/generated/v2/Items.ts +556 -0
- package/generated/v2/MetaKeys.ts +130 -0
- package/generated/v2/NotificationEvents.ts +55 -0
- package/generated/v2/NotificationSubscriptions.ts +157 -0
- package/generated/v2/OrderDocuments.ts +30 -0
- package/generated/v2/OrderItems.ts +189 -0
- package/generated/v2/Orders.ts +436 -0
- package/generated/v2/Originators.ts +35 -0
- package/generated/v2/Public.ts +41 -0
- package/generated/v2/ScancodeAliases.ts +34 -0
- package/generated/v2/Scancodes.ts +30 -0
- package/generated/v2/ShipnoticeItems.ts +152 -0
- package/generated/v2/Shipnotices.ts +367 -0
- package/generated/v2/Simulate.ts +160 -0
- package/generated/v2/Templates.ts +110 -0
- package/generated/v2/data-contracts.ts +6647 -0
- package/generated/v2/index.ts +20 -0
- package/generated/v2.1/BundleItems.ts +67 -0
- package/generated/v2.1/ConsumerReturns.ts +267 -0
- package/generated/v2.1/Customers.ts +113 -0
- package/generated/v2.1/Documents.ts +90 -0
- package/generated/v2.1/Items.ts +563 -0
- package/generated/v2.1/MetaKeys.ts +132 -0
- package/generated/v2.1/NotificationEvents.ts +55 -0
- package/generated/v2.1/NotificationSubscriptions.ts +161 -0
- package/generated/v2.1/OrderDocuments.ts +30 -0
- package/generated/v2.1/OrderItems.ts +189 -0
- package/generated/v2.1/Orders.ts +439 -0
- package/generated/v2.1/Originators.ts +35 -0
- package/generated/v2.1/Public.ts +41 -0
- package/generated/v2.1/ScancodeAliases.ts +34 -0
- package/generated/v2.1/ShipnoticeItems.ts +152 -0
- package/generated/v2.1/Shipnotices.ts +369 -0
- package/generated/v2.1/Simulate.ts +160 -0
- package/generated/v2.1/Templates.ts +114 -0
- package/generated/v2.1/data-contracts.ts +6635 -0
- package/generated/v2.1/index.ts +19 -0
- package/index.ts +1 -0
- package/package.json +23 -0
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesConsumerReturn, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdMetaFieldsPayload, GetApiV2ConsumerReturnsParams, PostApiV2ConsumerReturnsBulkPayload, PostApiV2ConsumerReturnsPayload, PutApiV2ConsumerReturnsIdPayload, PutApiV2ConsumerReturnsOriginatorOriginatorIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags originators
|
|
7
|
+
* @name DeleteApiV2ConsumerReturnsOriginatorOriginatorId
|
|
8
|
+
* @summary Destroy a consumer return
|
|
9
|
+
* @request DELETE:/api/v2/consumer_returns/originator/{originator_id}
|
|
10
|
+
*/
|
|
11
|
+
export declare const deleteApiV2ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags originators
|
|
16
|
+
* @name PutApiV2ConsumerReturnsOriginatorOriginatorId
|
|
17
|
+
* @summary Update a consumer return
|
|
18
|
+
* @request PUT:/api/v2/consumer_returns/originator/{originator_id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const putApiV2ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV2ConsumerReturnsOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags originators
|
|
25
|
+
* @name GetApiV2ConsumerReturnsOriginatorOriginatorId
|
|
26
|
+
* @summary Retrieve a consumer return
|
|
27
|
+
* @request GET:/api/v2/consumer_returns/originator/{originator_id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Update Shop meta fields
|
|
32
|
+
*
|
|
33
|
+
* @tags consumer_returns
|
|
34
|
+
* @name PutApiV2ConsumerReturnsIdMetaFields
|
|
35
|
+
* @summary Set meta fields
|
|
36
|
+
* @request PUT:/api/v2/consumer_returns/{id}/meta_fields
|
|
37
|
+
*/
|
|
38
|
+
export declare const putApiV2ConsumerReturnsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Get the meta fields for a(n) Shop
|
|
41
|
+
*
|
|
42
|
+
* @tags consumer_returns
|
|
43
|
+
* @name GetApiV2ConsumerReturnsIdMetaFields
|
|
44
|
+
* @summary List meta fields
|
|
45
|
+
* @request GET:/api/v2/consumer_returns/{id}/meta_fields
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2ConsumerReturnsIdMetaFields: (client: HttpClient, id: number, data: GetApiV2ConsumerReturnsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags consumer_returns
|
|
52
|
+
* @name DeleteApiV2ConsumerReturnsId
|
|
53
|
+
* @summary Destroy a consumer return
|
|
54
|
+
* @request DELETE:/api/v2/consumer_returns/{id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const deleteApiV2ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags consumer_returns
|
|
61
|
+
* @name PutApiV2ConsumerReturnsId
|
|
62
|
+
* @summary Update a consumer return
|
|
63
|
+
* @request PUT:/api/v2/consumer_returns/{id}
|
|
64
|
+
*/
|
|
65
|
+
export declare const putApiV2ConsumerReturnsId: (client: HttpClient, id: number, data: PutApiV2ConsumerReturnsIdPayload, params?: RequestParams) => Promise<void>;
|
|
66
|
+
/**
|
|
67
|
+
* No description
|
|
68
|
+
*
|
|
69
|
+
* @tags consumer_returns
|
|
70
|
+
* @name GetApiV2ConsumerReturnsId
|
|
71
|
+
* @summary Retrieve a consumer return
|
|
72
|
+
* @request GET:/api/v2/consumer_returns/{id}
|
|
73
|
+
*/
|
|
74
|
+
export declare const getApiV2ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
75
|
+
/**
|
|
76
|
+
* No description
|
|
77
|
+
*
|
|
78
|
+
* @tags consumer_returns
|
|
79
|
+
* @name PostApiV2ConsumerReturns
|
|
80
|
+
* @summary Create a consumer return
|
|
81
|
+
* @request POST:/api/v2/consumer_returns
|
|
82
|
+
*/
|
|
83
|
+
export declare const postApiV2ConsumerReturns: (client: HttpClient, data: PostApiV2ConsumerReturnsPayload, params?: RequestParams) => Promise<void>;
|
|
84
|
+
/**
|
|
85
|
+
* No description
|
|
86
|
+
*
|
|
87
|
+
* @tags consumer_returns
|
|
88
|
+
* @name GetApiV2ConsumerReturns
|
|
89
|
+
* @summary List all consumer returns
|
|
90
|
+
* @request GET:/api/v2/consumer_returns
|
|
91
|
+
*/
|
|
92
|
+
export declare const getApiV2ConsumerReturns: (client: HttpClient, query: GetApiV2ConsumerReturnsParams, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn[]>;
|
|
93
|
+
/**
|
|
94
|
+
* No description
|
|
95
|
+
*
|
|
96
|
+
* @tags consumer_returns
|
|
97
|
+
* @name GetApiV2ConsumerReturnsCount
|
|
98
|
+
* @summary Count consumer returns
|
|
99
|
+
* @request GET:/api/v2/consumer_returns/count
|
|
100
|
+
*/
|
|
101
|
+
export declare const getApiV2ConsumerReturnsCount: (client: HttpClient, query: GetApiV2ConsumerReturnsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
102
|
+
/**
|
|
103
|
+
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
|
|
104
|
+
*
|
|
105
|
+
* @tags consumer_returns
|
|
106
|
+
* @name PostApiV2ConsumerReturnsBulk
|
|
107
|
+
* @summary Create consumer_returns in bulk
|
|
108
|
+
* @request POST:/api/v2/consumer_returns/bulk
|
|
109
|
+
*/
|
|
110
|
+
export declare const postApiV2ConsumerReturnsBulk: (client: HttpClient, data: PostApiV2ConsumerReturnsBulkPayload, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesCustomer, GetApiV2CustomersCountParams, GetApiV2CustomersParams, PutApiV2CustomersIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags customers
|
|
7
|
+
* @name GetApiV2CustomersCount
|
|
8
|
+
* @summary Count customers
|
|
9
|
+
* @request GET:/api/v2/customers/count
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2CustomersCount: (client: HttpClient, query: GetApiV2CustomersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags customers
|
|
16
|
+
* @name GetApiV2Customers
|
|
17
|
+
* @summary List all customers
|
|
18
|
+
* @request GET:/api/v2/customers
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2Customers: (client: HttpClient, query: GetApiV2CustomersParams, params?: RequestParams) => Promise<APIV2EntitiesCustomer[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Get resource actions
|
|
23
|
+
*
|
|
24
|
+
* @tags customers
|
|
25
|
+
* @name GetApiV2CustomersActions
|
|
26
|
+
* @summary List actions you can peform
|
|
27
|
+
* @request GET:/api/v2/customers/actions
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2CustomersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Update your customers' information and preferences
|
|
32
|
+
*
|
|
33
|
+
* @tags customers
|
|
34
|
+
* @name PutApiV2CustomersId
|
|
35
|
+
* @summary Update a customer
|
|
36
|
+
* @request PUT:/api/v2/customers/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const putApiV2CustomersId: (client: HttpClient, id: number, data: PutApiV2CustomersIdPayload, params?: RequestParams) => Promise<APIV2EntitiesCustomer>;
|
|
39
|
+
/**
|
|
40
|
+
* No description
|
|
41
|
+
*
|
|
42
|
+
* @tags customers
|
|
43
|
+
* @name GetApiV2CustomersId
|
|
44
|
+
* @summary Retrieve a customer
|
|
45
|
+
* @request GET:/api/v2/customers/{id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2CustomersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCustomer>;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesDocument, GetApiV2DocumentsParams, PostApiV2DocumentsPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags documents
|
|
7
|
+
* @name PostApiV2Documents
|
|
8
|
+
* @summary Create a document
|
|
9
|
+
* @request POST:/api/v2/documents
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2Documents: (client: HttpClient, data: PostApiV2DocumentsPayload, params?: RequestParams) => Promise<APIV2EntitiesDocument>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags documents
|
|
16
|
+
* @name GetApiV2Documents
|
|
17
|
+
* @summary List all documents
|
|
18
|
+
* @request GET:/api/v2/documents
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2Documents: (client: HttpClient, query: GetApiV2DocumentsParams, params?: RequestParams) => Promise<APIV2EntitiesDocument[]>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags documents
|
|
25
|
+
* @name DeleteApiV2DocumentsId
|
|
26
|
+
* @summary Destroy an document
|
|
27
|
+
* @request DELETE:/api/v2/documents/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const deleteApiV2DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesDocument>;
|
|
30
|
+
/**
|
|
31
|
+
* No description
|
|
32
|
+
*
|
|
33
|
+
* @tags documents
|
|
34
|
+
* @name GetApiV2DocumentsId
|
|
35
|
+
* @summary Retrieve a document
|
|
36
|
+
* @request GET:/api/v2/documents/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesDocument>;
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesBundleItem, APIV2EntitiesCount, APIV2EntitiesItem, APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesScancodeAlias, APIV2EntitiesShipnoticeItem, APIV2EntitiesTransaction, GetApiV2ItemsCountParams, GetApiV2ItemsIdMetaFieldsPayload, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodeAliasesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams, GetApiV2ItemsParams, PostApiV2ItemsIdBundleItemsPayload, PostApiV2ItemsPayload, PutApiV2ItemsIdPayload, PutApiV2ItemsOriginatorOriginatorIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags items
|
|
7
|
+
* @name PostApiV2Items
|
|
8
|
+
* @summary Create an item
|
|
9
|
+
* @request POST:/api/v2/items
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2Items: (client: HttpClient, data: PostApiV2ItemsPayload, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags items
|
|
16
|
+
* @name GetApiV2Items
|
|
17
|
+
* @summary List all items
|
|
18
|
+
* @request GET:/api/v2/items
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2Items: (client: HttpClient, query: GetApiV2ItemsParams, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Get resource actions
|
|
23
|
+
*
|
|
24
|
+
* @tags items
|
|
25
|
+
* @name GetApiV2ItemsActions
|
|
26
|
+
* @summary List actions you can peform
|
|
27
|
+
* @request GET:/api/v2/items/actions
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description An item may have many alternate scancodes
|
|
32
|
+
*
|
|
33
|
+
* @tags originators
|
|
34
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdScancodeAliases
|
|
35
|
+
* @summary List all scancodes associated with this item
|
|
36
|
+
* @request GET:/api/v2/items/originator/{originator_id}/scancode_aliases
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdScancodeAliases: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams, params?: RequestParams) => Promise<APIV2EntitiesScancodeAlias[]>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
41
|
+
*
|
|
42
|
+
* @tags originators
|
|
43
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdWarehouseQuantities
|
|
44
|
+
* @summary Item stock by warehouse
|
|
45
|
+
* @request GET:/api/v2/items/originator/{originator_id}/warehouse_quantities
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags originators
|
|
52
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdBundleItems
|
|
53
|
+
* @summary List all bundle items containing this item
|
|
54
|
+
* @request GET:/api/v2/items/originator/{originator_id}/bundle_items
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags originators
|
|
61
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdInBundles
|
|
62
|
+
* @summary List all instances of this item in bundles
|
|
63
|
+
* @request GET:/api/v2/items/originator/{originator_id}/in_bundles
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
|
|
66
|
+
/**
|
|
67
|
+
* @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
|
|
68
|
+
*
|
|
69
|
+
* @tags originators
|
|
70
|
+
* @name DeleteApiV2ItemsOriginatorOriginatorId
|
|
71
|
+
* @summary Archive an item
|
|
72
|
+
* @request DELETE:/api/v2/items/originator/{originator_id}
|
|
73
|
+
*/
|
|
74
|
+
export declare const deleteApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
75
|
+
/**
|
|
76
|
+
* No description
|
|
77
|
+
*
|
|
78
|
+
* @tags originators
|
|
79
|
+
* @name PutApiV2ItemsOriginatorOriginatorId
|
|
80
|
+
* @summary Update an item
|
|
81
|
+
* @request PUT:/api/v2/items/originator/{originator_id}
|
|
82
|
+
*/
|
|
83
|
+
export declare const putApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV2ItemsOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
|
|
84
|
+
/**
|
|
85
|
+
* No description
|
|
86
|
+
*
|
|
87
|
+
* @tags originators
|
|
88
|
+
* @name GetApiV2ItemsOriginatorOriginatorId
|
|
89
|
+
* @summary Retrieve an item
|
|
90
|
+
* @request GET:/api/v2/items/originator/{originator_id}
|
|
91
|
+
*/
|
|
92
|
+
export declare const getApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
|
|
93
|
+
/**
|
|
94
|
+
* @description Update Shop meta fields
|
|
95
|
+
*
|
|
96
|
+
* @tags items
|
|
97
|
+
* @name PutApiV2ItemsIdMetaFields
|
|
98
|
+
* @summary Set meta fields
|
|
99
|
+
* @request PUT:/api/v2/items/{id}/meta_fields
|
|
100
|
+
*/
|
|
101
|
+
export declare const putApiV2ItemsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
102
|
+
/**
|
|
103
|
+
* @description Get the meta fields for a(n) Shop
|
|
104
|
+
*
|
|
105
|
+
* @tags items
|
|
106
|
+
* @name GetApiV2ItemsIdMetaFields
|
|
107
|
+
* @summary List meta fields
|
|
108
|
+
* @request GET:/api/v2/items/{id}/meta_fields
|
|
109
|
+
*/
|
|
110
|
+
export declare const getApiV2ItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV2ItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
111
|
+
/**
|
|
112
|
+
* @description An item may have many alternate scancodes
|
|
113
|
+
*
|
|
114
|
+
* @tags items
|
|
115
|
+
* @name GetApiV2ItemsIdScancodeAliases
|
|
116
|
+
* @summary List all scancodes associated with this item
|
|
117
|
+
* @request GET:/api/v2/items/{id}/scancode_aliases
|
|
118
|
+
*/
|
|
119
|
+
export declare const getApiV2ItemsIdScancodeAliases: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodeAliasesParams, params?: RequestParams) => Promise<APIV2EntitiesScancodeAlias[]>;
|
|
120
|
+
/**
|
|
121
|
+
* @description Retrieve the quantity of this item in each warehouse in which it has stock
|
|
122
|
+
*
|
|
123
|
+
* @tags items
|
|
124
|
+
* @name GetApiV2ItemsIdWarehouseQuantities
|
|
125
|
+
* @summary Item stock by warehouse
|
|
126
|
+
* @request GET:/api/v2/items/{id}/warehouse_quantities
|
|
127
|
+
*/
|
|
128
|
+
export declare const getApiV2ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
|
|
129
|
+
/**
|
|
130
|
+
* No description
|
|
131
|
+
*
|
|
132
|
+
* @tags items
|
|
133
|
+
* @name GetApiV2ItemsIdBundleItems
|
|
134
|
+
* @summary List all bundle items containing this item
|
|
135
|
+
* @request GET:/api/v2/items/{id}/bundle_items
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV2ItemsIdBundleItems: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
|
|
138
|
+
/**
|
|
139
|
+
* @description A Bundle is an Item representing a set of Items to be grouped and shipped together. Creating Product Bundles is useful when you sell a set of items, but you also sell the items individually. Creating a bundle allows us to keep the inventory flexible so we can ship the constituent items as they are sold individually, or as a set. In most cases, it's simplest to use Whiplash bundles as a replacement for your e-commerce platform's bundle feature / plugin.
|
|
140
|
+
*
|
|
141
|
+
* @tags items
|
|
142
|
+
* @name PostApiV2ItemsIdBundleItems
|
|
143
|
+
* @summary Add an item to an bundle
|
|
144
|
+
* @request POST:/api/v2/items/{id}/bundle_items
|
|
145
|
+
*/
|
|
146
|
+
export declare const postApiV2ItemsIdBundleItems: (client: HttpClient, id: number, data: PostApiV2ItemsIdBundleItemsPayload, params?: RequestParams) => Promise<void>;
|
|
147
|
+
/**
|
|
148
|
+
* No description
|
|
149
|
+
*
|
|
150
|
+
* @tags items
|
|
151
|
+
* @name GetApiV2ItemsIdInBundles
|
|
152
|
+
* @summary List all instances of this item in bundles
|
|
153
|
+
* @request GET:/api/v2/items/{id}/in_bundles
|
|
154
|
+
*/
|
|
155
|
+
export declare const getApiV2ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
|
|
156
|
+
/**
|
|
157
|
+
* @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
|
|
158
|
+
*
|
|
159
|
+
* @tags items
|
|
160
|
+
* @name DeleteApiV2ItemsId
|
|
161
|
+
* @summary Archive an item
|
|
162
|
+
* @request DELETE:/api/v2/items/{id}
|
|
163
|
+
*/
|
|
164
|
+
export declare const deleteApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
165
|
+
/**
|
|
166
|
+
* No description
|
|
167
|
+
*
|
|
168
|
+
* @tags items
|
|
169
|
+
* @name PutApiV2ItemsId
|
|
170
|
+
* @summary Update an item
|
|
171
|
+
* @request PUT:/api/v2/items/{id}
|
|
172
|
+
*/
|
|
173
|
+
export declare const putApiV2ItemsId: (client: HttpClient, id: number, data: PutApiV2ItemsIdPayload, params?: RequestParams) => Promise<void>;
|
|
174
|
+
/**
|
|
175
|
+
* No description
|
|
176
|
+
*
|
|
177
|
+
* @tags items
|
|
178
|
+
* @name GetApiV2ItemsId
|
|
179
|
+
* @summary Retrieve an item
|
|
180
|
+
* @request GET:/api/v2/items/{id}
|
|
181
|
+
*/
|
|
182
|
+
export declare const getApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
|
|
183
|
+
/**
|
|
184
|
+
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
185
|
+
*
|
|
186
|
+
* @tags items
|
|
187
|
+
* @name GetApiV2ItemsIdOriginators
|
|
188
|
+
* @summary List associated originators
|
|
189
|
+
* @request GET:/api/v2/items/{id}/originators
|
|
190
|
+
*/
|
|
191
|
+
export declare const getApiV2ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
192
|
+
/**
|
|
193
|
+
* No description
|
|
194
|
+
*
|
|
195
|
+
* @tags items
|
|
196
|
+
* @name GetApiV2ItemsCount
|
|
197
|
+
* @summary Count items
|
|
198
|
+
* @request GET:/api/v2/items/count
|
|
199
|
+
*/
|
|
200
|
+
export declare const getApiV2ItemsCount: (client: HttpClient, query: GetApiV2ItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
201
|
+
/**
|
|
202
|
+
* @description Actions can be performed UPON an item. They don't necessarily update the item itself. You can see which actions are available to you at /items/actions
|
|
203
|
+
*
|
|
204
|
+
* @tags items
|
|
205
|
+
* @name PutApiV2ItemsIdCallAction
|
|
206
|
+
* @summary Perform an action on an item
|
|
207
|
+
* @request PUT:/api/v2/items/{id}/call/{action}
|
|
208
|
+
*/
|
|
209
|
+
export declare const putApiV2ItemsIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<void>;
|
|
210
|
+
/**
|
|
211
|
+
* No description
|
|
212
|
+
*
|
|
213
|
+
* @tags items
|
|
214
|
+
* @name GetApiV2ItemsIdShipnoticeItemsCount
|
|
215
|
+
* @summary Count associated ship notice items
|
|
216
|
+
* @request GET:/api/v2/items/{id}/shipnotice_items/count
|
|
217
|
+
*/
|
|
218
|
+
export declare const getApiV2ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
219
|
+
/**
|
|
220
|
+
* No description
|
|
221
|
+
*
|
|
222
|
+
* @tags items
|
|
223
|
+
* @name GetApiV2ItemsIdShipnoticeItems
|
|
224
|
+
* @summary List associated ship notice items
|
|
225
|
+
* @request GET:/api/v2/items/{id}/shipnotice_items
|
|
226
|
+
*/
|
|
227
|
+
export declare const getApiV2ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem[]>;
|
|
228
|
+
/**
|
|
229
|
+
* @description Returns count of item transactions
|
|
230
|
+
*
|
|
231
|
+
* @tags items
|
|
232
|
+
* @name GetApiV2ItemsIdTransactionsCount
|
|
233
|
+
* @summary Count the transactions in an item's history
|
|
234
|
+
* @request GET:/api/v2/items/{id}/transactions/count
|
|
235
|
+
*/
|
|
236
|
+
export declare const getApiV2ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
237
|
+
/**
|
|
238
|
+
* @description Get all transactions for an item
|
|
239
|
+
*
|
|
240
|
+
* @tags items
|
|
241
|
+
* @name GetApiV2ItemsIdTransactions
|
|
242
|
+
* @summary List an item's history
|
|
243
|
+
* @request GET:/api/v2/items/{id}/transactions
|
|
244
|
+
*/
|
|
245
|
+
export declare const getApiV2ItemsIdTransactions: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdTransactionsParams, params?: RequestParams) => Promise<APIV2EntitiesTransaction[]>;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesMetaKey, GetApiV2MetaKeysCountParams, GetApiV2MetaKeysParams, PostApiV2MetaKeysPayload, PutApiV2MetaKeysIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Create a meta_key
|
|
5
|
+
*
|
|
6
|
+
* @tags meta_keys
|
|
7
|
+
* @name PostApiV2MetaKeys
|
|
8
|
+
* @summary Create a meta_key
|
|
9
|
+
* @request POST:/api/v2/meta_keys
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2MetaKeys: (client: HttpClient, data: PostApiV2MetaKeysPayload, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Get a list of meta_keys
|
|
14
|
+
*
|
|
15
|
+
* @tags meta_keys
|
|
16
|
+
* @name GetApiV2MetaKeys
|
|
17
|
+
* @summary List all meta keys
|
|
18
|
+
* @request GET:/api/v2/meta_keys
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2MetaKeys: (client: HttpClient, query: GetApiV2MetaKeysParams, params?: RequestParams) => Promise<APIV2EntitiesMetaKey[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Returns count of meta_keys
|
|
23
|
+
*
|
|
24
|
+
* @tags meta_keys
|
|
25
|
+
* @name GetApiV2MetaKeysCount
|
|
26
|
+
* @summary Count meta keys
|
|
27
|
+
* @request GET:/api/v2/meta_keys/count
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2MetaKeysCount: (client: HttpClient, query: GetApiV2MetaKeysCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Destroy a meta_key
|
|
32
|
+
*
|
|
33
|
+
* @tags meta_keys
|
|
34
|
+
* @name DeleteApiV2MetaKeysId
|
|
35
|
+
* @summary Delete a meta_key
|
|
36
|
+
* @request DELETE:/api/v2/meta_keys/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const deleteApiV2MetaKeysId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Update a meta_key
|
|
41
|
+
*
|
|
42
|
+
* @tags meta_keys
|
|
43
|
+
* @name PutApiV2MetaKeysId
|
|
44
|
+
* @summary Update a meta_key
|
|
45
|
+
* @request PUT:/api/v2/meta_keys/{id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const putApiV2MetaKeysId: (client: HttpClient, id: number, data: PutApiV2MetaKeysIdPayload, params?: RequestParams) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Get a meta_key
|
|
50
|
+
*
|
|
51
|
+
* @tags meta_keys
|
|
52
|
+
* @name GetApiV2MetaKeysId
|
|
53
|
+
* @summary Retrieve a meta key
|
|
54
|
+
* @request GET:/api/v2/meta_keys/{id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2MetaKeysId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesMetaKey>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesNotificationEvent, GetApiV2NotificationEventsParams } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description There are a wide variety of events you may subscribe to, and we add new ones periodically. You can grab a complete list at any time.
|
|
5
|
+
*
|
|
6
|
+
* @tags notifications
|
|
7
|
+
* @name GetApiV2NotificationEvents
|
|
8
|
+
* @summary List all notification events
|
|
9
|
+
* @request GET:/api/v2/notification_events
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2NotificationEvents: (client: HttpClient, query: GetApiV2NotificationEventsParams, params?: RequestParams) => Promise<APIV2EntitiesNotificationEvent[]>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags notifications
|
|
16
|
+
* @name GetApiV2NotificationEventsId
|
|
17
|
+
* @summary Retrieve a notification event
|
|
18
|
+
* @request GET:/api/v2/notification_events/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2NotificationEventsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationEvent>;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesNotificationSubscription, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV2NotificationSubscriptionsPayload, PutApiV2NotificationSubscriptionsIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Subscribe to an e-mail, web hook, or sms notification for a specified event
|
|
5
|
+
*
|
|
6
|
+
* @tags notifications
|
|
7
|
+
* @name PostApiV2NotificationSubscriptions
|
|
8
|
+
* @summary Create a notification subscription
|
|
9
|
+
* @request POST:/api/v2/notification_subscriptions
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2NotificationSubscriptions: (client: HttpClient, data: PostApiV2NotificationSubscriptionsPayload, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
|
|
12
|
+
/**
|
|
13
|
+
* @description E-mail, web hook, and sms notifications you have subscribed to
|
|
14
|
+
*
|
|
15
|
+
* @tags notifications
|
|
16
|
+
* @name GetApiV2NotificationSubscriptions
|
|
17
|
+
* @summary List all notification subscriptions
|
|
18
|
+
* @request GET:/api/v2/notification_subscriptions
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2NotificationSubscriptions: (client: HttpClient, query: GetApiV2NotificationSubscriptionsParams, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Get a count of notification subscriptions
|
|
23
|
+
*
|
|
24
|
+
* @tags notifications
|
|
25
|
+
* @name GetApiV2NotificationSubscriptionsCount
|
|
26
|
+
* @summary Count notification subscriptions
|
|
27
|
+
* @request GET:/api/v2/notification_subscriptions/count
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2NotificationSubscriptionsCount: (client: HttpClient, query: GetApiV2NotificationSubscriptionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Send yourself a test e-mail, web hook, or sms message
|
|
32
|
+
*
|
|
33
|
+
* @tags notifications
|
|
34
|
+
* @name GetApiV2NotificationSubscriptionsIdTest
|
|
35
|
+
* @summary Test a notification subscription
|
|
36
|
+
* @request GET:/api/v2/notification_subscriptions/{id}/test
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
|
|
39
|
+
/**
|
|
40
|
+
* No description
|
|
41
|
+
*
|
|
42
|
+
* @tags notifications
|
|
43
|
+
* @name DeleteApiV2NotificationSubscriptionsId
|
|
44
|
+
* @summary Delete a notification subscription
|
|
45
|
+
* @request DELETE:/api/v2/notification_subscriptions/{id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags notifications
|
|
52
|
+
* @name PutApiV2NotificationSubscriptionsId
|
|
53
|
+
* @summary Update a notification subscription
|
|
54
|
+
* @request PUT:/api/v2/notification_subscriptions/{id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const putApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, data: PutApiV2NotificationSubscriptionsIdPayload, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags notifications
|
|
61
|
+
* @name GetApiV2NotificationSubscriptionsId
|
|
62
|
+
* @summary Retrieve a notification subscription
|
|
63
|
+
* @request GET:/api/v2/notification_subscriptions/{id}
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesOrderDocument } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Remove an order document from an order
|
|
5
|
+
*
|
|
6
|
+
* @tags orders
|
|
7
|
+
* @name DeleteApiV2OrderDocumentsId
|
|
8
|
+
* @summary Delete an order document
|
|
9
|
+
* @request DELETE:/api/v2/order_documents/{id}
|
|
10
|
+
*/
|
|
11
|
+
export declare const deleteApiV2OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument>;
|