@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.
Files changed (91) hide show
  1. package/dist/client.esm.js +7391 -0
  2. package/dist/client.esm.js.map +1 -0
  3. package/dist/generated/http-client.d.ts +41 -0
  4. package/dist/generated/index.d.ts +2 -0
  5. package/dist/generated/v2/BundleItems.d.ts +29 -0
  6. package/dist/generated/v2/ConsumerReturns.d.ts +110 -0
  7. package/dist/generated/v2/Customers.d.ts +47 -0
  8. package/dist/generated/v2/Documents.d.ts +38 -0
  9. package/dist/generated/v2/Items.d.ts +245 -0
  10. package/dist/generated/v2/MetaKeys.d.ts +56 -0
  11. package/dist/generated/v2/NotificationEvents.d.ts +20 -0
  12. package/dist/generated/v2/NotificationSubscriptions.d.ts +65 -0
  13. package/dist/generated/v2/OrderDocuments.d.ts +11 -0
  14. package/dist/generated/v2/OrderItems.d.ts +83 -0
  15. package/dist/generated/v2/Orders.d.ts +182 -0
  16. package/dist/generated/v2/Originators.d.ts +11 -0
  17. package/dist/generated/v2/Public.d.ts +17 -0
  18. package/dist/generated/v2/ScancodeAliases.d.ts +10 -0
  19. package/dist/generated/v2/Scancodes.d.ts +10 -0
  20. package/dist/generated/v2/ShipnoticeItems.d.ts +65 -0
  21. package/dist/generated/v2/Shipnotices.d.ts +155 -0
  22. package/dist/generated/v2/Simulate.d.ts +56 -0
  23. package/dist/generated/v2/Templates.d.ts +47 -0
  24. package/dist/generated/v2/data-contracts.d.ts +6511 -0
  25. package/dist/generated/v2/index.d.ts +20 -0
  26. package/dist/generated/v2.1/BundleItems.d.ts +29 -0
  27. package/dist/generated/v2.1/ConsumerReturns.d.ts +110 -0
  28. package/dist/generated/v2.1/Customers.d.ts +47 -0
  29. package/dist/generated/v2.1/Documents.d.ts +38 -0
  30. package/dist/generated/v2.1/Items.d.ts +245 -0
  31. package/dist/generated/v2.1/MetaKeys.d.ts +56 -0
  32. package/dist/generated/v2.1/NotificationEvents.d.ts +20 -0
  33. package/dist/generated/v2.1/NotificationSubscriptions.d.ts +65 -0
  34. package/dist/generated/v2.1/OrderDocuments.d.ts +11 -0
  35. package/dist/generated/v2.1/OrderItems.d.ts +83 -0
  36. package/dist/generated/v2.1/Orders.d.ts +182 -0
  37. package/dist/generated/v2.1/Originators.d.ts +11 -0
  38. package/dist/generated/v2.1/Public.d.ts +17 -0
  39. package/dist/generated/v2.1/ScancodeAliases.d.ts +10 -0
  40. package/dist/generated/v2.1/ShipnoticeItems.d.ts +65 -0
  41. package/dist/generated/v2.1/Shipnotices.d.ts +155 -0
  42. package/dist/generated/v2.1/Simulate.d.ts +56 -0
  43. package/dist/generated/v2.1/Templates.d.ts +47 -0
  44. package/dist/generated/v2.1/data-contracts.d.ts +6499 -0
  45. package/dist/generated/v2.1/index.d.ts +19 -0
  46. package/dist/index.d.ts +1 -0
  47. package/generated/http-client.ts +142 -0
  48. package/generated/index.ts +2 -0
  49. package/generated/v2/BundleItems.ts +67 -0
  50. package/generated/v2/ConsumerReturns.ts +265 -0
  51. package/generated/v2/Customers.ts +113 -0
  52. package/generated/v2/Documents.ts +86 -0
  53. package/generated/v2/Items.ts +556 -0
  54. package/generated/v2/MetaKeys.ts +130 -0
  55. package/generated/v2/NotificationEvents.ts +55 -0
  56. package/generated/v2/NotificationSubscriptions.ts +157 -0
  57. package/generated/v2/OrderDocuments.ts +30 -0
  58. package/generated/v2/OrderItems.ts +189 -0
  59. package/generated/v2/Orders.ts +436 -0
  60. package/generated/v2/Originators.ts +35 -0
  61. package/generated/v2/Public.ts +41 -0
  62. package/generated/v2/ScancodeAliases.ts +34 -0
  63. package/generated/v2/Scancodes.ts +30 -0
  64. package/generated/v2/ShipnoticeItems.ts +152 -0
  65. package/generated/v2/Shipnotices.ts +367 -0
  66. package/generated/v2/Simulate.ts +160 -0
  67. package/generated/v2/Templates.ts +110 -0
  68. package/generated/v2/data-contracts.ts +6647 -0
  69. package/generated/v2/index.ts +20 -0
  70. package/generated/v2.1/BundleItems.ts +67 -0
  71. package/generated/v2.1/ConsumerReturns.ts +267 -0
  72. package/generated/v2.1/Customers.ts +113 -0
  73. package/generated/v2.1/Documents.ts +90 -0
  74. package/generated/v2.1/Items.ts +563 -0
  75. package/generated/v2.1/MetaKeys.ts +132 -0
  76. package/generated/v2.1/NotificationEvents.ts +55 -0
  77. package/generated/v2.1/NotificationSubscriptions.ts +161 -0
  78. package/generated/v2.1/OrderDocuments.ts +30 -0
  79. package/generated/v2.1/OrderItems.ts +189 -0
  80. package/generated/v2.1/Orders.ts +439 -0
  81. package/generated/v2.1/Originators.ts +35 -0
  82. package/generated/v2.1/Public.ts +41 -0
  83. package/generated/v2.1/ScancodeAliases.ts +34 -0
  84. package/generated/v2.1/ShipnoticeItems.ts +152 -0
  85. package/generated/v2.1/Shipnotices.ts +369 -0
  86. package/generated/v2.1/Simulate.ts +160 -0
  87. package/generated/v2.1/Templates.ts +114 -0
  88. package/generated/v2.1/data-contracts.ts +6635 -0
  89. package/generated/v2.1/index.ts +19 -0
  90. package/index.ts +1 -0
  91. package/package.json +23 -0
@@ -0,0 +1,20 @@
1
+ export * from './BundleItems';
2
+ export * from './ConsumerReturns';
3
+ export * from './Customers';
4
+ export * from './Documents';
5
+ export * from './Items';
6
+ export * from './MetaKeys';
7
+ export * from './NotificationEvents';
8
+ export * from './NotificationSubscriptions';
9
+ export * from './OrderDocuments';
10
+ export * from './OrderItems';
11
+ export * from './Orders';
12
+ export * from './Originators';
13
+ export * from './Public';
14
+ export * from './ScancodeAliases';
15
+ export * from './Scancodes';
16
+ export * from './ShipnoticeItems';
17
+ export * from './Shipnotices';
18
+ export * from './Simulate';
19
+ export * from './Templates';
20
+ export * from './data-contracts';
@@ -0,0 +1,29 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesBundleItem, PutApiV21BundleItemsIdPayload } from "./data-contracts";
3
+ /**
4
+ * @description This removes the item from the bundle, but does not affect the item in any other way.
5
+ *
6
+ * @tags items
7
+ * @name DeleteApiV21BundleItemsId
8
+ * @summary Destroy a bundle item
9
+ * @request DELETE:/api/v2.1/bundle_items/{id}
10
+ */
11
+ export declare const deleteApiV21BundleItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags items
16
+ * @name PutApiV21BundleItemsId
17
+ * @summary Update a bundle item's quantity
18
+ * @request PUT:/api/v2.1/bundle_items/{id}
19
+ */
20
+ export declare const putApiV21BundleItemsId: (client: HttpClient, id: number, data: PutApiV21BundleItemsIdPayload, params?: RequestParams) => Promise<void>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags items
25
+ * @name GetApiV21BundleItemsId
26
+ * @summary Retrieve a bundle item
27
+ * @request GET:/api/v2.1/bundle_items/{id}
28
+ */
29
+ export declare const getApiV21BundleItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesBundleItem>;
@@ -0,0 +1,110 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesConsumerReturn, APIV21EntitiesCount, APIV21EntitiesMetaFields, APIV21EntitiesPostResponse, APIV21EntitiesResult, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdMetaFieldsPayload, GetApiV21ConsumerReturnsParams, PostApiV21ConsumerReturnsBulkPayload, PostApiV21ConsumerReturnsPayload, PutApiV21ConsumerReturnsIdPayload, PutApiV21ConsumerReturnsOriginatorOriginatorIdPayload } from "./data-contracts";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags originators
7
+ * @name DeleteApiV21ConsumerReturnsOriginatorOriginatorId
8
+ * @summary Destroy a consumer return
9
+ * @request DELETE:/api/v2.1/consumer_returns/originator/{originator_id}
10
+ */
11
+ export declare const deleteApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags originators
16
+ * @name PutApiV21ConsumerReturnsOriginatorOriginatorId
17
+ * @summary Update a consumer return
18
+ * @request PUT:/api/v2.1/consumer_returns/originator/{originator_id}
19
+ */
20
+ export declare const putApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV21ConsumerReturnsOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags originators
25
+ * @name GetApiV21ConsumerReturnsOriginatorOriginatorId
26
+ * @summary Retrieve a consumer return
27
+ * @request GET:/api/v2.1/consumer_returns/originator/{originator_id}
28
+ */
29
+ export declare const getApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
30
+ /**
31
+ * @description Update Shop meta fields
32
+ *
33
+ * @tags consumer_returns
34
+ * @name PutApiV21ConsumerReturnsIdMetaFields
35
+ * @summary Set meta fields
36
+ * @request PUT:/api/v2.1/consumer_returns/{id}/meta_fields
37
+ */
38
+ export declare const putApiV21ConsumerReturnsIdMetaFields: (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 GetApiV21ConsumerReturnsIdMetaFields
44
+ * @summary List meta fields
45
+ * @request GET:/api/v2.1/consumer_returns/{id}/meta_fields
46
+ */
47
+ export declare const getApiV21ConsumerReturnsIdMetaFields: (client: HttpClient, id: number, data: GetApiV21ConsumerReturnsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags consumer_returns
52
+ * @name DeleteApiV21ConsumerReturnsId
53
+ * @summary Destroy a consumer return
54
+ * @request DELETE:/api/v2.1/consumer_returns/{id}
55
+ */
56
+ export declare const deleteApiV21ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags consumer_returns
61
+ * @name PutApiV21ConsumerReturnsId
62
+ * @summary Update a consumer return
63
+ * @request PUT:/api/v2.1/consumer_returns/{id}
64
+ */
65
+ export declare const putApiV21ConsumerReturnsId: (client: HttpClient, id: number, data: PutApiV21ConsumerReturnsIdPayload, params?: RequestParams) => Promise<void>;
66
+ /**
67
+ * No description
68
+ *
69
+ * @tags consumer_returns
70
+ * @name GetApiV21ConsumerReturnsId
71
+ * @summary Retrieve a consumer return
72
+ * @request GET:/api/v2.1/consumer_returns/{id}
73
+ */
74
+ export declare const getApiV21ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
75
+ /**
76
+ * No description
77
+ *
78
+ * @tags consumer_returns
79
+ * @name PostApiV21ConsumerReturns
80
+ * @summary Create a consumer return
81
+ * @request POST:/api/v2.1/consumer_returns
82
+ */
83
+ export declare const postApiV21ConsumerReturns: (client: HttpClient, data: PostApiV21ConsumerReturnsPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
84
+ /**
85
+ * No description
86
+ *
87
+ * @tags consumer_returns
88
+ * @name GetApiV21ConsumerReturns
89
+ * @summary List all consumer returns
90
+ * @request GET:/api/v2.1/consumer_returns
91
+ */
92
+ export declare const getApiV21ConsumerReturns: (client: HttpClient, query: GetApiV21ConsumerReturnsParams, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn[]>;
93
+ /**
94
+ * No description
95
+ *
96
+ * @tags consumer_returns
97
+ * @name GetApiV21ConsumerReturnsCount
98
+ * @summary Count consumer returns
99
+ * @request GET:/api/v2.1/consumer_returns/count
100
+ */
101
+ export declare const getApiV21ConsumerReturnsCount: (client: HttpClient, query: GetApiV21ConsumerReturnsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
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 PostApiV21ConsumerReturnsBulk
107
+ * @summary Create consumer_returns in bulk
108
+ * @request POST:/api/v2.1/consumer_returns/bulk
109
+ */
110
+ export declare const postApiV21ConsumerReturnsBulk: (client: HttpClient, data: PostApiV21ConsumerReturnsBulkPayload, params?: RequestParams) => Promise<APIV21EntitiesResult>;
@@ -0,0 +1,47 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesCount, APIV21EntitiesCustomer, GetApiV21CustomersCountParams, GetApiV21CustomersParams, PutApiV21CustomersIdPayload } from "./data-contracts";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags customers
7
+ * @name GetApiV21CustomersCount
8
+ * @summary Count customers
9
+ * @request GET:/api/v2.1/customers/count
10
+ */
11
+ export declare const getApiV21CustomersCount: (client: HttpClient, query: GetApiV21CustomersCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags customers
16
+ * @name GetApiV21Customers
17
+ * @summary List all customers
18
+ * @request GET:/api/v2.1/customers
19
+ */
20
+ export declare const getApiV21Customers: (client: HttpClient, query: GetApiV21CustomersParams, params?: RequestParams) => Promise<APIV21EntitiesCustomer[]>;
21
+ /**
22
+ * @description Get resource actions
23
+ *
24
+ * @tags customers
25
+ * @name GetApiV21CustomersActions
26
+ * @summary List actions you can peform
27
+ * @request GET:/api/v2.1/customers/actions
28
+ */
29
+ export declare const getApiV21CustomersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
30
+ /**
31
+ * @description Update your customers' information and preferences
32
+ *
33
+ * @tags customers
34
+ * @name PutApiV21CustomersId
35
+ * @summary Update a customer
36
+ * @request PUT:/api/v2.1/customers/{id}
37
+ */
38
+ export declare const putApiV21CustomersId: (client: HttpClient, id: number, data: PutApiV21CustomersIdPayload, params?: RequestParams) => Promise<APIV21EntitiesCustomer>;
39
+ /**
40
+ * No description
41
+ *
42
+ * @tags customers
43
+ * @name GetApiV21CustomersId
44
+ * @summary Retrieve a customer
45
+ * @request GET:/api/v2.1/customers/{id}
46
+ */
47
+ export declare const getApiV21CustomersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCustomer>;
@@ -0,0 +1,38 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesDocument, GetApiV21DocumentsParams, PostApiV21DocumentsPayload } from "./data-contracts";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags documents
7
+ * @name PostApiV21Documents
8
+ * @summary Create a document
9
+ * @request POST:/api/v2.1/documents
10
+ */
11
+ export declare const postApiV21Documents: (client: HttpClient, data: PostApiV21DocumentsPayload, params?: RequestParams) => Promise<APIV21EntitiesDocument>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags documents
16
+ * @name GetApiV21Documents
17
+ * @summary List all documents
18
+ * @request GET:/api/v2.1/documents
19
+ */
20
+ export declare const getApiV21Documents: (client: HttpClient, query: GetApiV21DocumentsParams, params?: RequestParams) => Promise<APIV21EntitiesDocument[]>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags documents
25
+ * @name DeleteApiV21DocumentsId
26
+ * @summary Destroy an document
27
+ * @request DELETE:/api/v2.1/documents/{id}
28
+ */
29
+ export declare const deleteApiV21DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesDocument>;
30
+ /**
31
+ * No description
32
+ *
33
+ * @tags documents
34
+ * @name GetApiV21DocumentsId
35
+ * @summary Retrieve a document
36
+ * @request GET:/api/v2.1/documents/{id}
37
+ */
38
+ export declare const getApiV21DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesDocument>;
@@ -0,0 +1,245 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesBundleItem, APIV21EntitiesCount, APIV21EntitiesItem, APIV21EntitiesItemWarehouseQuantity, APIV21EntitiesMetaFields, APIV21EntitiesOriginator, APIV21EntitiesPostResponse, APIV21EntitiesScancodeAlias, APIV21EntitiesShipnoticeItem, APIV21EntitiesTransaction, GetApiV21ItemsCountParams, GetApiV21ItemsIdMetaFieldsPayload, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodeAliasesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams, GetApiV21ItemsParams, PostApiV21ItemsIdBundleItemsPayload, PostApiV21ItemsPayload, PutApiV21ItemsIdPayload, PutApiV21ItemsOriginatorOriginatorIdPayload } from "./data-contracts";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags items
7
+ * @name PostApiV21Items
8
+ * @summary Create an item
9
+ * @request POST:/api/v2.1/items
10
+ */
11
+ export declare const postApiV21Items: (client: HttpClient, data: PostApiV21ItemsPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags items
16
+ * @name GetApiV21Items
17
+ * @summary List all items
18
+ * @request GET:/api/v2.1/items
19
+ */
20
+ export declare const getApiV21Items: (client: HttpClient, query: GetApiV21ItemsParams, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
21
+ /**
22
+ * @description Get resource actions
23
+ *
24
+ * @tags items
25
+ * @name GetApiV21ItemsActions
26
+ * @summary List actions you can peform
27
+ * @request GET:/api/v2.1/items/actions
28
+ */
29
+ export declare const getApiV21ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
30
+ /**
31
+ * @description An item may have many alternate scancodes
32
+ *
33
+ * @tags originators
34
+ * @name GetApiV21ItemsOriginatorOriginatorIdScancodeAliases
35
+ * @summary List all scancodes associated with this item
36
+ * @request GET:/api/v2.1/items/originator/{originator_id}/scancode_aliases
37
+ */
38
+ export declare const getApiV21ItemsOriginatorOriginatorIdScancodeAliases: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams, params?: RequestParams) => Promise<APIV21EntitiesScancodeAlias[]>;
39
+ /**
40
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
41
+ *
42
+ * @tags originators
43
+ * @name GetApiV21ItemsOriginatorOriginatorIdWarehouseQuantities
44
+ * @summary Item stock by warehouse
45
+ * @request GET:/api/v2.1/items/originator/{originator_id}/warehouse_quantities
46
+ */
47
+ export declare const getApiV21ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItemWarehouseQuantity>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags originators
52
+ * @name GetApiV21ItemsOriginatorOriginatorIdBundleItems
53
+ * @summary List all bundle items containing this item
54
+ * @request GET:/api/v2.1/items/originator/{originator_id}/bundle_items
55
+ */
56
+ export declare const getApiV21ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesBundleItem[]>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags originators
61
+ * @name GetApiV21ItemsOriginatorOriginatorIdInBundles
62
+ * @summary List all instances of this item in bundles
63
+ * @request GET:/api/v2.1/items/originator/{originator_id}/in_bundles
64
+ */
65
+ export declare const getApiV21ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
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 DeleteApiV21ItemsOriginatorOriginatorId
71
+ * @summary Archive an item
72
+ * @request DELETE:/api/v2.1/items/originator/{originator_id}
73
+ */
74
+ export declare const deleteApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
75
+ /**
76
+ * No description
77
+ *
78
+ * @tags originators
79
+ * @name PutApiV21ItemsOriginatorOriginatorId
80
+ * @summary Update an item
81
+ * @request PUT:/api/v2.1/items/originator/{originator_id}
82
+ */
83
+ export declare const putApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV21ItemsOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
84
+ /**
85
+ * No description
86
+ *
87
+ * @tags originators
88
+ * @name GetApiV21ItemsOriginatorOriginatorId
89
+ * @summary Retrieve an item
90
+ * @request GET:/api/v2.1/items/originator/{originator_id}
91
+ */
92
+ export declare const getApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
93
+ /**
94
+ * @description Update Shop meta fields
95
+ *
96
+ * @tags items
97
+ * @name PutApiV21ItemsIdMetaFields
98
+ * @summary Set meta fields
99
+ * @request PUT:/api/v2.1/items/{id}/meta_fields
100
+ */
101
+ export declare const putApiV21ItemsIdMetaFields: (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 GetApiV21ItemsIdMetaFields
107
+ * @summary List meta fields
108
+ * @request GET:/api/v2.1/items/{id}/meta_fields
109
+ */
110
+ export declare const getApiV21ItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV21ItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV21EntitiesMetaFields>;
111
+ /**
112
+ * @description An item may have many alternate scancodes
113
+ *
114
+ * @tags items
115
+ * @name GetApiV21ItemsIdScancodeAliases
116
+ * @summary List all scancodes associated with this item
117
+ * @request GET:/api/v2.1/items/{id}/scancode_aliases
118
+ */
119
+ export declare const getApiV21ItemsIdScancodeAliases: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodeAliasesParams, params?: RequestParams) => Promise<APIV21EntitiesScancodeAlias[]>;
120
+ /**
121
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
122
+ *
123
+ * @tags items
124
+ * @name GetApiV21ItemsIdWarehouseQuantities
125
+ * @summary Item stock by warehouse
126
+ * @request GET:/api/v2.1/items/{id}/warehouse_quantities
127
+ */
128
+ export declare const getApiV21ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItemWarehouseQuantity>;
129
+ /**
130
+ * No description
131
+ *
132
+ * @tags items
133
+ * @name GetApiV21ItemsIdBundleItems
134
+ * @summary List all bundle items containing this item
135
+ * @request GET:/api/v2.1/items/{id}/bundle_items
136
+ */
137
+ export declare const getApiV21ItemsIdBundleItems: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesBundleItem[]>;
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 PostApiV21ItemsIdBundleItems
143
+ * @summary Add an item to an bundle
144
+ * @request POST:/api/v2.1/items/{id}/bundle_items
145
+ */
146
+ export declare const postApiV21ItemsIdBundleItems: (client: HttpClient, id: number, data: PostApiV21ItemsIdBundleItemsPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
147
+ /**
148
+ * No description
149
+ *
150
+ * @tags items
151
+ * @name GetApiV21ItemsIdInBundles
152
+ * @summary List all instances of this item in bundles
153
+ * @request GET:/api/v2.1/items/{id}/in_bundles
154
+ */
155
+ export declare const getApiV21ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
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 DeleteApiV21ItemsId
161
+ * @summary Archive an item
162
+ * @request DELETE:/api/v2.1/items/{id}
163
+ */
164
+ export declare const deleteApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
165
+ /**
166
+ * No description
167
+ *
168
+ * @tags items
169
+ * @name PutApiV21ItemsId
170
+ * @summary Update an item
171
+ * @request PUT:/api/v2.1/items/{id}
172
+ */
173
+ export declare const putApiV21ItemsId: (client: HttpClient, id: number, data: PutApiV21ItemsIdPayload, params?: RequestParams) => Promise<void>;
174
+ /**
175
+ * No description
176
+ *
177
+ * @tags items
178
+ * @name GetApiV21ItemsId
179
+ * @summary Retrieve an item
180
+ * @request GET:/api/v2.1/items/{id}
181
+ */
182
+ export declare const getApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
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 GetApiV21ItemsIdOriginators
188
+ * @summary List associated originators
189
+ * @request GET:/api/v2.1/items/{id}/originators
190
+ */
191
+ export declare const getApiV21ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV21EntitiesOriginator>;
192
+ /**
193
+ * No description
194
+ *
195
+ * @tags items
196
+ * @name GetApiV21ItemsCount
197
+ * @summary Count items
198
+ * @request GET:/api/v2.1/items/count
199
+ */
200
+ export declare const getApiV21ItemsCount: (client: HttpClient, query: GetApiV21ItemsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
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 PutApiV21ItemsIdCallAction
206
+ * @summary Perform an action on an item
207
+ * @request PUT:/api/v2.1/items/{id}/call/{action}
208
+ */
209
+ export declare const putApiV21ItemsIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<void>;
210
+ /**
211
+ * No description
212
+ *
213
+ * @tags items
214
+ * @name GetApiV21ItemsIdShipnoticeItemsCount
215
+ * @summary Count associated ship notice items
216
+ * @request GET:/api/v2.1/items/{id}/shipnotice_items/count
217
+ */
218
+ export declare const getApiV21ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
219
+ /**
220
+ * No description
221
+ *
222
+ * @tags items
223
+ * @name GetApiV21ItemsIdShipnoticeItems
224
+ * @summary List associated ship notice items
225
+ * @request GET:/api/v2.1/items/{id}/shipnotice_items
226
+ */
227
+ export declare const getApiV21ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
228
+ /**
229
+ * @description Returns count of item transactions
230
+ *
231
+ * @tags items
232
+ * @name GetApiV21ItemsIdTransactionsCount
233
+ * @summary Count the transactions in an item's history
234
+ * @request GET:/api/v2.1/items/{id}/transactions/count
235
+ */
236
+ export declare const getApiV21ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
237
+ /**
238
+ * @description Get all transactions for an item
239
+ *
240
+ * @tags items
241
+ * @name GetApiV21ItemsIdTransactions
242
+ * @summary List an item's history
243
+ * @request GET:/api/v2.1/items/{id}/transactions
244
+ */
245
+ export declare const getApiV21ItemsIdTransactions: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdTransactionsParams, params?: RequestParams) => Promise<APIV21EntitiesTransaction[]>;
@@ -0,0 +1,56 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesCount, APIV21EntitiesMetaKey, APIV21EntitiesPostResponse, GetApiV21MetaKeysCountParams, GetApiV21MetaKeysParams, PostApiV21MetaKeysPayload, PutApiV21MetaKeysIdPayload } from "./data-contracts";
3
+ /**
4
+ * @description Create a meta_key
5
+ *
6
+ * @tags meta_keys
7
+ * @name PostApiV21MetaKeys
8
+ * @summary Create a meta_key
9
+ * @request POST:/api/v2.1/meta_keys
10
+ */
11
+ export declare const postApiV21MetaKeys: (client: HttpClient, data: PostApiV21MetaKeysPayload, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
12
+ /**
13
+ * @description Get a list of meta_keys
14
+ *
15
+ * @tags meta_keys
16
+ * @name GetApiV21MetaKeys
17
+ * @summary List all meta keys
18
+ * @request GET:/api/v2.1/meta_keys
19
+ */
20
+ export declare const getApiV21MetaKeys: (client: HttpClient, query: GetApiV21MetaKeysParams, params?: RequestParams) => Promise<APIV21EntitiesMetaKey[]>;
21
+ /**
22
+ * @description Returns count of meta_keys
23
+ *
24
+ * @tags meta_keys
25
+ * @name GetApiV21MetaKeysCount
26
+ * @summary Count meta keys
27
+ * @request GET:/api/v2.1/meta_keys/count
28
+ */
29
+ export declare const getApiV21MetaKeysCount: (client: HttpClient, query: GetApiV21MetaKeysCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
30
+ /**
31
+ * @description Destroy a meta_key
32
+ *
33
+ * @tags meta_keys
34
+ * @name DeleteApiV21MetaKeysId
35
+ * @summary Delete a meta_key
36
+ * @request DELETE:/api/v2.1/meta_keys/{id}
37
+ */
38
+ export declare const deleteApiV21MetaKeysId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
39
+ /**
40
+ * @description Update a meta_key
41
+ *
42
+ * @tags meta_keys
43
+ * @name PutApiV21MetaKeysId
44
+ * @summary Update a meta_key
45
+ * @request PUT:/api/v2.1/meta_keys/{id}
46
+ */
47
+ export declare const putApiV21MetaKeysId: (client: HttpClient, id: number, data: PutApiV21MetaKeysIdPayload, params?: RequestParams) => Promise<void>;
48
+ /**
49
+ * @description Get a meta_key
50
+ *
51
+ * @tags meta_keys
52
+ * @name GetApiV21MetaKeysId
53
+ * @summary Retrieve a meta key
54
+ * @request GET:/api/v2.1/meta_keys/{id}
55
+ */
56
+ export declare const getApiV21MetaKeysId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesMetaKey>;
@@ -0,0 +1,20 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesNotificationEvent, GetApiV21NotificationEventsParams } 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 GetApiV21NotificationEvents
8
+ * @summary List all notification events
9
+ * @request GET:/api/v2.1/notification_events
10
+ */
11
+ export declare const getApiV21NotificationEvents: (client: HttpClient, query: GetApiV21NotificationEventsParams, params?: RequestParams) => Promise<APIV21EntitiesNotificationEvent[]>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags notifications
16
+ * @name GetApiV21NotificationEventsId
17
+ * @summary Retrieve a notification event
18
+ * @request GET:/api/v2.1/notification_events/{id}
19
+ */
20
+ export declare const getApiV21NotificationEventsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationEvent>;
@@ -0,0 +1,65 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesCount, APIV21EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, PostApiV21NotificationSubscriptionsPayload, PutApiV21NotificationSubscriptionsIdPayload } 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 PostApiV21NotificationSubscriptions
8
+ * @summary Create a notification subscription
9
+ * @request POST:/api/v2.1/notification_subscriptions
10
+ */
11
+ export declare const postApiV21NotificationSubscriptions: (client: HttpClient, data: PostApiV21NotificationSubscriptionsPayload, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
12
+ /**
13
+ * @description E-mail, web hook, and sms notifications you have subscribed to
14
+ *
15
+ * @tags notifications
16
+ * @name GetApiV21NotificationSubscriptions
17
+ * @summary List all notification subscriptions
18
+ * @request GET:/api/v2.1/notification_subscriptions
19
+ */
20
+ export declare const getApiV21NotificationSubscriptions: (client: HttpClient, query: GetApiV21NotificationSubscriptionsParams, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription[]>;
21
+ /**
22
+ * @description Get a count of notification subscriptions
23
+ *
24
+ * @tags notifications
25
+ * @name GetApiV21NotificationSubscriptionsCount
26
+ * @summary Count notification subscriptions
27
+ * @request GET:/api/v2.1/notification_subscriptions/count
28
+ */
29
+ export declare const getApiV21NotificationSubscriptionsCount: (client: HttpClient, query: GetApiV21NotificationSubscriptionsCountParams, params?: RequestParams) => Promise<APIV21EntitiesCount>;
30
+ /**
31
+ * @description Send yourself a test e-mail, web hook, or sms message
32
+ *
33
+ * @tags notifications
34
+ * @name GetApiV21NotificationSubscriptionsIdTest
35
+ * @summary Test a notification subscription
36
+ * @request GET:/api/v2.1/notification_subscriptions/{id}/test
37
+ */
38
+ export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
39
+ /**
40
+ * No description
41
+ *
42
+ * @tags notifications
43
+ * @name DeleteApiV21NotificationSubscriptionsId
44
+ * @summary Delete a notification subscription
45
+ * @request DELETE:/api/v2.1/notification_subscriptions/{id}
46
+ */
47
+ export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags notifications
52
+ * @name PutApiV21NotificationSubscriptionsId
53
+ * @summary Update a notification subscription
54
+ * @request PUT:/api/v2.1/notification_subscriptions/{id}
55
+ */
56
+ export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, data: PutApiV21NotificationSubscriptionsIdPayload, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags notifications
61
+ * @name GetApiV21NotificationSubscriptionsId
62
+ * @summary Retrieve a notification subscription
63
+ * @request GET:/api/v2.1/notification_subscriptions/{id}
64
+ */
65
+ export declare const getApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
@@ -0,0 +1,11 @@
1
+ import { HttpClient, RequestParams } from "./../http-client";
2
+ import { APIV21EntitiesOrderDocument } from "./data-contracts";
3
+ /**
4
+ * @description Remove an order document from an order
5
+ *
6
+ * @tags orders
7
+ * @name DeleteApiV21OrderDocumentsId
8
+ * @summary Delete an order document
9
+ * @request DELETE:/api/v2.1/order_documents/{id}
10
+ */
11
+ export declare const deleteApiV21OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrderDocument>;