@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,83 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV2OrderItemsIdMetaFieldsPayload, GetApiV2OrderItemsIdParams, PutApiV2OrderItemsIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get resource actions
|
|
5
|
+
*
|
|
6
|
+
* @tags order_items
|
|
7
|
+
* @name GetApiV2OrderItemsActions
|
|
8
|
+
* @summary List actions you can peform
|
|
9
|
+
* @request GET:/api/v2/order_items/actions
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Destroy an order item
|
|
14
|
+
*
|
|
15
|
+
* @tags order_items
|
|
16
|
+
* @name DeleteApiV2OrderItemsId
|
|
17
|
+
* @summary Destroy an order item
|
|
18
|
+
* @request DELETE:/api/v2/order_items/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const deleteApiV2OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Update an order item
|
|
23
|
+
*
|
|
24
|
+
* @tags order_items
|
|
25
|
+
* @name PutApiV2OrderItemsId
|
|
26
|
+
* @summary Update an order item
|
|
27
|
+
* @request PUT:/api/v2/order_items/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const putApiV2OrderItemsId: (client: HttpClient, id: number, data: PutApiV2OrderItemsIdPayload, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Retrieve an order item
|
|
32
|
+
*
|
|
33
|
+
* @tags order_items
|
|
34
|
+
* @name GetApiV2OrderItemsId
|
|
35
|
+
* @summary Retrieve an order item
|
|
36
|
+
* @request GET:/api/v2/order_items/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV2OrderItemsIdParams, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Update Shop meta fields
|
|
41
|
+
*
|
|
42
|
+
* @tags order_items
|
|
43
|
+
* @name PutApiV2OrderItemsIdMetaFields
|
|
44
|
+
* @summary Set meta fields
|
|
45
|
+
* @request PUT:/api/v2/order_items/{id}/meta_fields
|
|
46
|
+
*/
|
|
47
|
+
export declare const putApiV2OrderItemsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Get the meta fields for a(n) Shop
|
|
50
|
+
*
|
|
51
|
+
* @tags order_items
|
|
52
|
+
* @name GetApiV2OrderItemsIdMetaFields
|
|
53
|
+
* @summary List meta fields
|
|
54
|
+
* @request GET:/api/v2/order_items/{id}/meta_fields
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2OrderItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV2OrderItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
57
|
+
/**
|
|
58
|
+
* @description Separate an order item into a new order
|
|
59
|
+
*
|
|
60
|
+
* @tags order_items
|
|
61
|
+
* @name PutApiV2OrderItemsIdSeparate
|
|
62
|
+
* @summary Separate an order item
|
|
63
|
+
* @request PUT:/api/v2/order_items/{id}/separate
|
|
64
|
+
*/
|
|
65
|
+
export declare const putApiV2OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
|
|
66
|
+
/**
|
|
67
|
+
* @description Perform an action on an order_item
|
|
68
|
+
*
|
|
69
|
+
* @tags order_items
|
|
70
|
+
* @name PutApiV2OrderItemsIdCallAction
|
|
71
|
+
* @summary Perform an action on an order_item
|
|
72
|
+
* @request PUT:/api/v2/order_items/{id}/call/{action}
|
|
73
|
+
*/
|
|
74
|
+
export declare const putApiV2OrderItemsIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
|
|
75
|
+
/**
|
|
76
|
+
* @description Serial numbers are scanned and saved during the packing process.
|
|
77
|
+
*
|
|
78
|
+
* @tags order_items
|
|
79
|
+
* @name GetApiV2OrderItemsIdSerialNumbers
|
|
80
|
+
* @summary List all serial numbers associated with an order item
|
|
81
|
+
* @request GET:/api/v2/order_items/{id}/serial_numbers
|
|
82
|
+
*/
|
|
83
|
+
export declare const getApiV2OrderItemsIdSerialNumbers: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber[]>;
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesResult, APIV2EntitiesSerialNumber, GetApiV2OrdersCountParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdMetaFieldsPayload, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersParams, PostApiV2OrdersBulkPayload, PostApiV2OrdersIdOrderDocumentsPayload, PostApiV2OrdersIdOrderItemsPayload, PostApiV2OrdersPayload, PutApiV2OrdersIdPayload, PutApiV2OrdersOriginatorOriginatorIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags orders
|
|
7
|
+
* @name PostApiV2Orders
|
|
8
|
+
* @summary Create an order
|
|
9
|
+
* @request POST:/api/v2/orders
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2Orders: (client: HttpClient, data: PostApiV2OrdersPayload, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags orders
|
|
16
|
+
* @name GetApiV2Orders
|
|
17
|
+
* @summary List all orders
|
|
18
|
+
* @request GET:/api/v2/orders
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2Orders: (client: HttpClient, query: GetApiV2OrdersParams, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags orders
|
|
25
|
+
* @name GetApiV2OrdersCount
|
|
26
|
+
* @summary Count orders
|
|
27
|
+
* @request GET:/api/v2/orders/count
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2OrdersCount: (client: HttpClient, query: GetApiV2OrdersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
|
|
32
|
+
*
|
|
33
|
+
* @tags orders
|
|
34
|
+
* @name PostApiV2OrdersBulk
|
|
35
|
+
* @summary Create consumer_returns in bulk
|
|
36
|
+
* @request POST:/api/v2/orders/bulk
|
|
37
|
+
*/
|
|
38
|
+
export declare const postApiV2OrdersBulk: (client: HttpClient, data: PostApiV2OrdersBulkPayload, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Get resource actions
|
|
41
|
+
*
|
|
42
|
+
* @tags orders
|
|
43
|
+
* @name GetApiV2OrdersActions
|
|
44
|
+
* @summary List actions you can peform
|
|
45
|
+
* @request GET:/api/v2/orders/actions
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags originators
|
|
52
|
+
* @name PutApiV2OrdersOriginatorOriginatorId
|
|
53
|
+
* @summary Update an order
|
|
54
|
+
* @request PUT:/api/v2/orders/originator/{originator_id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const putApiV2OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV2OrdersOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags originators
|
|
61
|
+
* @name GetApiV2OrdersOriginatorOriginatorId
|
|
62
|
+
* @summary Retrieve an order
|
|
63
|
+
* @request GET:/api/v2/orders/originator/{originator_id}
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
66
|
+
/**
|
|
67
|
+
* No description
|
|
68
|
+
*
|
|
69
|
+
* @tags orders
|
|
70
|
+
* @name GetApiV2OrdersIdEventsCount
|
|
71
|
+
* @summary Count order's events
|
|
72
|
+
* @request GET:/api/v2/orders/{id}/events/count
|
|
73
|
+
*/
|
|
74
|
+
export declare const getApiV2OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
75
|
+
/**
|
|
76
|
+
* No description
|
|
77
|
+
*
|
|
78
|
+
* @tags orders
|
|
79
|
+
* @name GetApiV2OrdersIdEvents
|
|
80
|
+
* @summary Retrieve the history for an order
|
|
81
|
+
* @request GET:/api/v2/orders/{id}/events
|
|
82
|
+
*/
|
|
83
|
+
export declare const getApiV2OrdersIdEvents: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdEventsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderEvent[]>;
|
|
84
|
+
/**
|
|
85
|
+
* No description
|
|
86
|
+
*
|
|
87
|
+
* @tags orders
|
|
88
|
+
* @name PutApiV2OrdersId
|
|
89
|
+
* @summary Update an order
|
|
90
|
+
* @request PUT:/api/v2/orders/{id}
|
|
91
|
+
*/
|
|
92
|
+
export declare const putApiV2OrdersId: (client: HttpClient, id: number, data: PutApiV2OrdersIdPayload, params?: RequestParams) => Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* No description
|
|
95
|
+
*
|
|
96
|
+
* @tags orders
|
|
97
|
+
* @name GetApiV2OrdersId
|
|
98
|
+
* @summary Retrieve an order
|
|
99
|
+
* @request GET:/api/v2/orders/{id}
|
|
100
|
+
*/
|
|
101
|
+
export declare const getApiV2OrdersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
102
|
+
/**
|
|
103
|
+
* @description Update Shop meta fields
|
|
104
|
+
*
|
|
105
|
+
* @tags orders
|
|
106
|
+
* @name PutApiV2OrdersIdMetaFields
|
|
107
|
+
* @summary Set meta fields
|
|
108
|
+
* @request PUT:/api/v2/orders/{id}/meta_fields
|
|
109
|
+
*/
|
|
110
|
+
export declare const putApiV2OrdersIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* @description Get the meta fields for a(n) Shop
|
|
113
|
+
*
|
|
114
|
+
* @tags orders
|
|
115
|
+
* @name GetApiV2OrdersIdMetaFields
|
|
116
|
+
* @summary List meta fields
|
|
117
|
+
* @request GET:/api/v2/orders/{id}/meta_fields
|
|
118
|
+
*/
|
|
119
|
+
export declare const getApiV2OrdersIdMetaFields: (client: HttpClient, id: number, data: GetApiV2OrdersIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
120
|
+
/**
|
|
121
|
+
* @description OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.
|
|
122
|
+
*
|
|
123
|
+
* @tags orders
|
|
124
|
+
* @name PostApiV2OrdersIdOrderDocuments
|
|
125
|
+
* @summary Create an order document for an order
|
|
126
|
+
* @request POST:/api/v2/orders/{id}/order_documents
|
|
127
|
+
*/
|
|
128
|
+
export declare const postApiV2OrdersIdOrderDocuments: (client: HttpClient, id: number, data: PostApiV2OrdersIdOrderDocumentsPayload, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Retrieve all order documents for an order
|
|
131
|
+
*
|
|
132
|
+
* @tags orders
|
|
133
|
+
* @name GetApiV2OrdersIdOrderDocuments
|
|
134
|
+
* @summary List all order documents for an order
|
|
135
|
+
* @request GET:/api/v2/orders/{id}/order_documents
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV2OrdersIdOrderDocuments: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderDocumentsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument[]>;
|
|
138
|
+
/**
|
|
139
|
+
* @description Create an order item
|
|
140
|
+
*
|
|
141
|
+
* @tags orders
|
|
142
|
+
* @name PostApiV2OrdersIdOrderItems
|
|
143
|
+
* @summary Create an order item
|
|
144
|
+
* @request POST:/api/v2/orders/{id}/order_items
|
|
145
|
+
*/
|
|
146
|
+
export declare const postApiV2OrdersIdOrderItems: (client: HttpClient, id: number, data: PostApiV2OrdersIdOrderItemsPayload, params?: RequestParams) => Promise<void>;
|
|
147
|
+
/**
|
|
148
|
+
* @description Retrieve all order items for an order
|
|
149
|
+
*
|
|
150
|
+
* @tags orders
|
|
151
|
+
* @name GetApiV2OrdersIdOrderItems
|
|
152
|
+
* @summary List all order items for an order
|
|
153
|
+
* @request GET:/api/v2/orders/{id}/order_items
|
|
154
|
+
*/
|
|
155
|
+
export declare const getApiV2OrdersIdOrderItems: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderItem[]>;
|
|
156
|
+
/**
|
|
157
|
+
* No description
|
|
158
|
+
*
|
|
159
|
+
* @tags orders
|
|
160
|
+
* @name GetApiV2OrdersIdOrderItemsCount
|
|
161
|
+
* @summary Count order items
|
|
162
|
+
* @request GET:/api/v2/orders/{id}/order_items/count
|
|
163
|
+
*/
|
|
164
|
+
export declare const getApiV2OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
165
|
+
/**
|
|
166
|
+
* @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
|
|
167
|
+
*
|
|
168
|
+
* @tags orders
|
|
169
|
+
* @name PutApiV2OrdersIdCallAction
|
|
170
|
+
* @summary Perform an action on an order
|
|
171
|
+
* @request PUT:/api/v2/orders/{id}/call/{action}
|
|
172
|
+
*/
|
|
173
|
+
export declare const putApiV2OrdersIdCallAction: (client: HttpClient, id: number, action: number, params?: RequestParams) => Promise<void>;
|
|
174
|
+
/**
|
|
175
|
+
* @description Serial numbers are scanned and saved during the packing process.
|
|
176
|
+
*
|
|
177
|
+
* @tags orders
|
|
178
|
+
* @name GetApiV2OrdersIdSerialNumbers
|
|
179
|
+
* @summary List all serial numbers associated with an order item
|
|
180
|
+
* @request GET:/api/v2/orders/{id}/serial_numbers
|
|
181
|
+
*/
|
|
182
|
+
export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber[]>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesOriginator, GetApiV2OriginatorsParams } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags originators
|
|
7
|
+
* @name GetApiV2Originators
|
|
8
|
+
* @summary List originators
|
|
9
|
+
* @request GET:/api/v2/originators
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2Originators: (client: HttpClient, query: GetApiV2OriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
/**
|
|
3
|
+
* No description
|
|
4
|
+
*
|
|
5
|
+
* @tags public
|
|
6
|
+
* @name GetApiV2PublicStatus
|
|
7
|
+
* @request GET:/api/v2/public/status
|
|
8
|
+
*/
|
|
9
|
+
export declare const getApiV2PublicStatus: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
10
|
+
/**
|
|
11
|
+
* No description
|
|
12
|
+
*
|
|
13
|
+
* @tags public
|
|
14
|
+
* @name GetApiV2PublicCarrierStatus
|
|
15
|
+
* @request GET:/api/v2/public/carrier_status
|
|
16
|
+
*/
|
|
17
|
+
export declare const getApiV2PublicCarrierStatus: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesScancode, GetApiV2ScancodeAliasesParams } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get all scancode_aliases
|
|
5
|
+
*
|
|
6
|
+
* @tags scancode_aliases
|
|
7
|
+
* @name GetApiV2ScancodeAliases
|
|
8
|
+
* @request GET:/api/v2/scancode_aliases
|
|
9
|
+
*/
|
|
10
|
+
export declare const getApiV2ScancodeAliases: (client: HttpClient, query: GetApiV2ScancodeAliasesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesScancode, GetApiV2ScancodesParams } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get all scancodes
|
|
5
|
+
*
|
|
6
|
+
* @tags scancodes
|
|
7
|
+
* @name GetApiV2Scancodes
|
|
8
|
+
* @request GET:/api/v2/scancodes
|
|
9
|
+
*/
|
|
10
|
+
export declare const getApiV2Scancodes: (client: HttpClient, query: GetApiV2ScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesShipnoticeItem, GetApiV2ShipnoticeItemsCountParams, GetApiV2ShipnoticeItemsIdMetaFieldsPayload, PutApiV2ShipnoticeItemsIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get resource actions
|
|
5
|
+
*
|
|
6
|
+
* @tags shipnotice_items
|
|
7
|
+
* @name GetApiV2ShipnoticeItemsActions
|
|
8
|
+
* @summary List actions you can peform
|
|
9
|
+
* @request GET:/api/v2/shipnotice_items/actions
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2ShipnoticeItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags shipnotice_items
|
|
16
|
+
* @name DeleteApiV2ShipnoticeItemsId
|
|
17
|
+
* @summary Destroy a shipnotice item
|
|
18
|
+
* @request DELETE:/api/v2/shipnotice_items/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const deleteApiV2ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags shipnotice_items
|
|
25
|
+
* @name PutApiV2ShipnoticeItemsId
|
|
26
|
+
* @summary Update a ship notice item
|
|
27
|
+
* @request PUT:/api/v2/shipnotice_items/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const putApiV2ShipnoticeItemsId: (client: HttpClient, id: number, data: PutApiV2ShipnoticeItemsIdPayload, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
|
|
30
|
+
/**
|
|
31
|
+
* No description
|
|
32
|
+
*
|
|
33
|
+
* @tags shipnotice_items
|
|
34
|
+
* @name GetApiV2ShipnoticeItemsId
|
|
35
|
+
* @summary Retrieve a ship notice item
|
|
36
|
+
* @request GET:/api/v2/shipnotice_items/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Update Shop meta fields
|
|
41
|
+
*
|
|
42
|
+
* @tags shipnotice_items
|
|
43
|
+
* @name PutApiV2ShipnoticeItemsIdMetaFields
|
|
44
|
+
* @summary Set meta fields
|
|
45
|
+
* @request PUT:/api/v2/shipnotice_items/{id}/meta_fields
|
|
46
|
+
*/
|
|
47
|
+
export declare const putApiV2ShipnoticeItemsIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Get the meta fields for a(n) Shop
|
|
50
|
+
*
|
|
51
|
+
* @tags shipnotice_items
|
|
52
|
+
* @name GetApiV2ShipnoticeItemsIdMetaFields
|
|
53
|
+
* @summary List meta fields
|
|
54
|
+
* @request GET:/api/v2/shipnotice_items/{id}/meta_fields
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2ShipnoticeItemsIdMetaFields: (client: HttpClient, id: number, data: GetApiV2ShipnoticeItemsIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags shipnotice_items
|
|
61
|
+
* @name GetApiV2ShipnoticeItemsCount
|
|
62
|
+
* @summary Count ship notice items
|
|
63
|
+
* @request GET:/api/v2/shipnotice_items/count
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2ShipnoticeItemsCount: (client: HttpClient, query: GetApiV2ShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShipnotice, APIV2EntitiesShipnoticeItem, GetApiV2ShipnoticesCountParams, GetApiV2ShipnoticesIdMetaFieldsPayload, GetApiV2ShipnoticesIdShipnoticeItemsCountParams, GetApiV2ShipnoticesIdShipnoticeItemsParams, GetApiV2ShipnoticesParams, PostApiV2ShipnoticesBulkPayload, PostApiV2ShipnoticesIdShipnoticeItemsPayload, PostApiV2ShipnoticesPayload, PutApiV2ShipnoticesIdPayload, PutApiV2ShipnoticesOriginatorOriginatorIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags shipnotices
|
|
7
|
+
* @name PostApiV2Shipnotices
|
|
8
|
+
* @summary Create a ship notice
|
|
9
|
+
* @request POST:/api/v2/shipnotices
|
|
10
|
+
*/
|
|
11
|
+
export declare const postApiV2Shipnotices: (client: HttpClient, data: PostApiV2ShipnoticesPayload, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags shipnotices
|
|
16
|
+
* @name GetApiV2Shipnotices
|
|
17
|
+
* @summary List all ship notices
|
|
18
|
+
* @request GET:/api/v2/shipnotices
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2Shipnotices: (client: HttpClient, query: GetApiV2ShipnoticesParams, params?: RequestParams) => Promise<APIV2EntitiesShipnotice[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
|
|
23
|
+
*
|
|
24
|
+
* @tags shipnotices
|
|
25
|
+
* @name PostApiV2ShipnoticesBulk
|
|
26
|
+
* @summary Create consumer_returns in bulk
|
|
27
|
+
* @request POST:/api/v2/shipnotices/bulk
|
|
28
|
+
*/
|
|
29
|
+
export declare const postApiV2ShipnoticesBulk: (client: HttpClient, data: PostApiV2ShipnoticesBulkPayload, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Get resource actions
|
|
32
|
+
*
|
|
33
|
+
* @tags shipnotices
|
|
34
|
+
* @name GetApiV2ShipnoticesActions
|
|
35
|
+
* @summary List actions you can peform
|
|
36
|
+
* @request GET:/api/v2/shipnotices/actions
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV2ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* No description
|
|
41
|
+
*
|
|
42
|
+
* @tags originators
|
|
43
|
+
* @name DeleteApiV2ShipnoticesOriginatorOriginatorId
|
|
44
|
+
* @summary Destroy a ship notice
|
|
45
|
+
* @request DELETE:/api/v2/shipnotices/originator/{originator_id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
48
|
+
/**
|
|
49
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
50
|
+
*
|
|
51
|
+
* @tags originators
|
|
52
|
+
* @name PutApiV2ShipnoticesOriginatorOriginatorId
|
|
53
|
+
* @summary Update a ship notice
|
|
54
|
+
* @request PUT:/api/v2/shipnotices/originator/{originator_id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const putApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, data: PutApiV2ShipnoticesOriginatorOriginatorIdPayload, params?: RequestParams) => Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags originators
|
|
61
|
+
* @name GetApiV2ShipnoticesOriginatorOriginatorId
|
|
62
|
+
* @summary Retrieve a ship notice
|
|
63
|
+
* @request GET:/api/v2/shipnotices/originator/{originator_id}
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
66
|
+
/**
|
|
67
|
+
* No description
|
|
68
|
+
*
|
|
69
|
+
* @tags shipnotices
|
|
70
|
+
* @name GetApiV2ShipnoticesIdOrdersWaiting
|
|
71
|
+
* @summary Count orders waiting for stock in a ship notice
|
|
72
|
+
* @request GET:/api/v2/shipnotices/{id}/orders_waiting
|
|
73
|
+
*/
|
|
74
|
+
export declare const getApiV2ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
75
|
+
/**
|
|
76
|
+
* No description
|
|
77
|
+
*
|
|
78
|
+
* @tags shipnotices
|
|
79
|
+
* @name DeleteApiV2ShipnoticesId
|
|
80
|
+
* @summary Destroy a ship notice
|
|
81
|
+
* @request DELETE:/api/v2/shipnotices/{id}
|
|
82
|
+
*/
|
|
83
|
+
export declare const deleteApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
84
|
+
/**
|
|
85
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
86
|
+
*
|
|
87
|
+
* @tags shipnotices
|
|
88
|
+
* @name PutApiV2ShipnoticesId
|
|
89
|
+
* @summary Update a ship notice
|
|
90
|
+
* @request PUT:/api/v2/shipnotices/{id}
|
|
91
|
+
*/
|
|
92
|
+
export declare const putApiV2ShipnoticesId: (client: HttpClient, id: number, data: PutApiV2ShipnoticesIdPayload, params?: RequestParams) => Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* No description
|
|
95
|
+
*
|
|
96
|
+
* @tags shipnotices
|
|
97
|
+
* @name GetApiV2ShipnoticesId
|
|
98
|
+
* @summary Retrieve a ship notice
|
|
99
|
+
* @request GET:/api/v2/shipnotices/{id}
|
|
100
|
+
*/
|
|
101
|
+
export declare const getApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
102
|
+
/**
|
|
103
|
+
* No description
|
|
104
|
+
*
|
|
105
|
+
* @tags shipnotices
|
|
106
|
+
* @name PostApiV2ShipnoticesIdShipnoticeItems
|
|
107
|
+
* @summary Create a ship notice item
|
|
108
|
+
* @request POST:/api/v2/shipnotices/{id}/shipnotice_items
|
|
109
|
+
*/
|
|
110
|
+
export declare const postApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, data: PostApiV2ShipnoticesIdShipnoticeItemsPayload, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
|
|
111
|
+
/**
|
|
112
|
+
* No description
|
|
113
|
+
*
|
|
114
|
+
* @tags shipnotices
|
|
115
|
+
* @name GetApiV2ShipnoticesIdShipnoticeItems
|
|
116
|
+
* @summary List associated ship notice items
|
|
117
|
+
* @request GET:/api/v2/shipnotices/{id}/shipnotice_items
|
|
118
|
+
*/
|
|
119
|
+
export declare const getApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem[]>;
|
|
120
|
+
/**
|
|
121
|
+
* @description Update Shop meta fields
|
|
122
|
+
*
|
|
123
|
+
* @tags shipnotices
|
|
124
|
+
* @name PutApiV2ShipnoticesIdMetaFields
|
|
125
|
+
* @summary Set meta fields
|
|
126
|
+
* @request PUT:/api/v2/shipnotices/{id}/meta_fields
|
|
127
|
+
*/
|
|
128
|
+
export declare const putApiV2ShipnoticesIdMetaFields: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Get the meta fields for a(n) Shop
|
|
131
|
+
*
|
|
132
|
+
* @tags shipnotices
|
|
133
|
+
* @name GetApiV2ShipnoticesIdMetaFields
|
|
134
|
+
* @summary List meta fields
|
|
135
|
+
* @request GET:/api/v2/shipnotices/{id}/meta_fields
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV2ShipnoticesIdMetaFields: (client: HttpClient, id: number, data: GetApiV2ShipnoticesIdMetaFieldsPayload, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
138
|
+
/**
|
|
139
|
+
* No description
|
|
140
|
+
*
|
|
141
|
+
* @tags shipnotices
|
|
142
|
+
* @name GetApiV2ShipnoticesIdShipnoticeItemsCount
|
|
143
|
+
* @summary Count associated ship notice items
|
|
144
|
+
* @request GET:/api/v2/shipnotices/{id}/shipnotice_items/count
|
|
145
|
+
*/
|
|
146
|
+
export declare const getApiV2ShipnoticesIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
147
|
+
/**
|
|
148
|
+
* No description
|
|
149
|
+
*
|
|
150
|
+
* @tags shipnotices
|
|
151
|
+
* @name GetApiV2ShipnoticesCount
|
|
152
|
+
* @summary Count ship notices
|
|
153
|
+
* @request GET:/api/v2/shipnotices/count
|
|
154
|
+
*/
|
|
155
|
+
export declare const getApiV2ShipnoticesCount: (client: HttpClient, query: GetApiV2ShipnoticesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesConsumerReturn, APIV2EntitiesOrder, APIV2EntitiesShipnotice, PostApiV2SimulateConsumerReturnsCreatePayload, PostApiV2SimulateOrdersCreatePayload, PostApiV2SimulateShipnoticesCreatePayload, PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingPayload, PutApiV2SimulateOrdersOrderIdProcessingPayload, PutApiV2SimulateShipnoticesShipnoticeIdProcessingPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* @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.
|
|
5
|
+
*
|
|
6
|
+
* @tags simulate
|
|
7
|
+
* @name PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
|
|
8
|
+
* @summary Simulate processing for an consumer return
|
|
9
|
+
* @request PUT:/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
|
|
10
|
+
*/
|
|
11
|
+
export declare const putApiV2SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, data: PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingPayload, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags simulate
|
|
16
|
+
* @name PostApiV2SimulateConsumerReturnsCreate
|
|
17
|
+
* @summary Create a consumer return with simulated data
|
|
18
|
+
* @request POST:/api/v2/simulate/consumer_returns/create
|
|
19
|
+
*/
|
|
20
|
+
export declare const postApiV2SimulateConsumerReturnsCreate: (client: HttpClient, data: PostApiV2SimulateConsumerReturnsCreatePayload, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
21
|
+
/**
|
|
22
|
+
* @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.
|
|
23
|
+
*
|
|
24
|
+
* @tags simulate
|
|
25
|
+
* @name PutApiV2SimulateShipnoticesShipnoticeIdProcessing
|
|
26
|
+
* @summary Simulate processing for an ship notice
|
|
27
|
+
* @request PUT:/api/v2/simulate/shipnotices/{shipnotice_id}/processing
|
|
28
|
+
*/
|
|
29
|
+
export declare const putApiV2SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, data: PutApiV2SimulateShipnoticesShipnoticeIdProcessingPayload, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
30
|
+
/**
|
|
31
|
+
* No description
|
|
32
|
+
*
|
|
33
|
+
* @tags simulate
|
|
34
|
+
* @name PostApiV2SimulateShipnoticesCreate
|
|
35
|
+
* @summary Create a shipnotice with simulated data
|
|
36
|
+
* @request POST:/api/v2/simulate/shipnotices/create
|
|
37
|
+
*/
|
|
38
|
+
export declare const postApiV2SimulateShipnoticesCreate: (client: HttpClient, data: PostApiV2SimulateShipnoticesCreatePayload, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
|
|
41
|
+
*
|
|
42
|
+
* @tags simulate
|
|
43
|
+
* @name PutApiV2SimulateOrdersOrderIdProcessing
|
|
44
|
+
* @summary Simulate processing for an order
|
|
45
|
+
* @request PUT:/api/v2/simulate/orders/{order_id}/processing
|
|
46
|
+
*/
|
|
47
|
+
export declare const putApiV2SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, data: PutApiV2SimulateOrdersOrderIdProcessingPayload, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags simulate
|
|
52
|
+
* @name PostApiV2SimulateOrdersCreate
|
|
53
|
+
* @summary Create an order with simulated data
|
|
54
|
+
* @request POST:/api/v2/simulate/orders/create
|
|
55
|
+
*/
|
|
56
|
+
export declare const postApiV2SimulateOrdersCreate: (client: HttpClient, data: PostApiV2SimulateOrdersCreatePayload, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { HttpClient, RequestParams } from "./../http-client";
|
|
2
|
+
import { APIV2EntitiesTemplate, GetApiV2TemplatesParams, PostApiV2TemplatesPayload, PutApiV2TemplatesIdPayload } from "./data-contracts";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags templates
|
|
7
|
+
* @name DeleteApiV2TemplatesId
|
|
8
|
+
* @summary Destroy a template
|
|
9
|
+
* @request DELETE:/api/v2/templates/{id}
|
|
10
|
+
*/
|
|
11
|
+
export declare const deleteApiV2TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags templates
|
|
16
|
+
* @name PutApiV2TemplatesId
|
|
17
|
+
* @summary Update a template
|
|
18
|
+
* @request PUT:/api/v2/templates/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const putApiV2TemplatesId: (client: HttpClient, id: number, data: PutApiV2TemplatesIdPayload, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags templates
|
|
25
|
+
* @name GetApiV2TemplatesId
|
|
26
|
+
* @summary Retrieve a template
|
|
27
|
+
* @request GET:/api/v2/templates/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
|
|
30
|
+
/**
|
|
31
|
+
* No description
|
|
32
|
+
*
|
|
33
|
+
* @tags templates
|
|
34
|
+
* @name PostApiV2Templates
|
|
35
|
+
* @summary Create a template
|
|
36
|
+
* @request POST:/api/v2/templates
|
|
37
|
+
*/
|
|
38
|
+
export declare const postApiV2Templates: (client: HttpClient, data: PostApiV2TemplatesPayload, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
|
|
39
|
+
/**
|
|
40
|
+
* No description
|
|
41
|
+
*
|
|
42
|
+
* @tags templates
|
|
43
|
+
* @name GetApiV2Templates
|
|
44
|
+
* @summary List all templates
|
|
45
|
+
* @request GET:/api/v2/templates
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2Templates: (client: HttpClient, query: GetApiV2TemplatesParams, params?: RequestParams) => Promise<APIV2EntitiesTemplate[]>;
|