@whiplashmerch/whiplash-api-client 0.4.69 → 0.4.71

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,14 +1,5 @@
1
- import { APIV21EntitiesNotificationSubscription, APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptions, PostApiV2NotificationSubscriptions, PutApiV21NotificationSubscriptions, PutApiV2NotificationSubscriptions } from "./data-contracts";
1
+ import { APIV21EntitiesNotificationSubscription, APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptions, PostApiV2NotificationSubscriptions, PutApiV21NotificationSubscriptionsId, PutApiV2NotificationSubscriptionsId } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
- /**
4
- * @description Subscribe to an e-mail, webhook, or Slack 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, ApiV2NotificationSubscriptions: PostApiV2NotificationSubscriptions, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
12
3
  /**
13
4
  * @description E-mail, webhook, and Slack notifications you have subscribed to
14
5
  *
@@ -18,6 +9,15 @@ export declare const postApiV2NotificationSubscriptions: (client: HttpClient, Ap
18
9
  * @request GET:/api/v2/notification_subscriptions
19
10
  */
20
11
  export declare const getApiV2NotificationSubscriptions: (client: HttpClient, query: GetApiV2NotificationSubscriptionsParams, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription[]>;
12
+ /**
13
+ * @description Subscribe to an e-mail, webhook, or Slack notification for a specified event
14
+ *
15
+ * @tags notifications
16
+ * @name PostApiV2NotificationSubscriptions
17
+ * @summary Create a notification subscription
18
+ * @request POST:/api/v2/notification_subscriptions
19
+ */
20
+ export declare const postApiV2NotificationSubscriptions: (client: HttpClient, postApiV2NotificationSubscriptions: PostApiV2NotificationSubscriptions, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
21
21
  /**
22
22
  * @description Get a count of notification subscriptions
23
23
  *
@@ -27,24 +27,15 @@ export declare const getApiV2NotificationSubscriptions: (client: HttpClient, que
27
27
  * @request GET:/api/v2/notification_subscriptions/count
28
28
  */
29
29
  export declare const getApiV2NotificationSubscriptionsCount: (client: HttpClient, query: GetApiV2NotificationSubscriptionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
30
- /**
31
- * @description Send yourself a test e-mail, webhook, or Slack notification
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
30
  /**
40
31
  * No description
41
32
  *
42
33
  * @tags notifications
43
- * @name DeleteApiV2NotificationSubscriptionsId
44
- * @summary Delete a notification subscription
45
- * @request DELETE:/api/v2/notification_subscriptions/{id}
34
+ * @name GetApiV2NotificationSubscriptionsId
35
+ * @summary Retrieve a notification subscription
36
+ * @request GET:/api/v2/notification_subscriptions/{id}
46
37
  */
47
- export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
38
+ export declare const getApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
48
39
  /**
49
40
  * No description
50
41
  *
@@ -53,25 +44,25 @@ export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient
53
44
  * @summary Update a notification subscription
54
45
  * @request PUT:/api/v2/notification_subscriptions/{id}
55
46
  */
56
- export declare const putApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, ApiV2NotificationSubscriptions: PutApiV2NotificationSubscriptions, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
47
+ export declare const putApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, putApiV2NotificationSubscriptionsId: PutApiV2NotificationSubscriptionsId, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
57
48
  /**
58
49
  * No description
59
50
  *
60
51
  * @tags notifications
61
- * @name GetApiV2NotificationSubscriptionsId
62
- * @summary Retrieve a notification subscription
63
- * @request GET:/api/v2/notification_subscriptions/{id}
52
+ * @name DeleteApiV2NotificationSubscriptionsId
53
+ * @summary Delete a notification subscription
54
+ * @request DELETE:/api/v2/notification_subscriptions/{id}
64
55
  */
65
- export declare const getApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
56
+ export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
66
57
  /**
67
- * @description Subscribe to an e-mail, webhook, or Slack notification for a specified event
58
+ * @description Send yourself a test e-mail, webhook, or Slack notification
68
59
  *
69
60
  * @tags notifications
70
- * @name PostApiV21NotificationSubscriptions
71
- * @summary Create a notification subscription
72
- * @request POST:/api/v2.1/notification_subscriptions
61
+ * @name GetApiV2NotificationSubscriptionsIdTest
62
+ * @summary Test a notification subscription
63
+ * @request GET:/api/v2/notification_subscriptions/{id}/test
73
64
  */
74
- export declare const postApiV21NotificationSubscriptions: (client: HttpClient, ApiV21NotificationSubscriptions: PostApiV21NotificationSubscriptions, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
65
+ export declare const getApiV2NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesNotificationSubscription>;
75
66
  /**
76
67
  * @description E-mail, webhook, and Slack notifications you have subscribed to
77
68
  *
@@ -81,6 +72,15 @@ export declare const postApiV21NotificationSubscriptions: (client: HttpClient, A
81
72
  * @request GET:/api/v2.1/notification_subscriptions
82
73
  */
83
74
  export declare const getApiV21NotificationSubscriptions: (client: HttpClient, query: GetApiV21NotificationSubscriptionsParams, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription[]>;
75
+ /**
76
+ * @description Subscribe to an e-mail, webhook, or Slack notification for a specified event
77
+ *
78
+ * @tags notifications
79
+ * @name PostApiV21NotificationSubscriptions
80
+ * @summary Create a notification subscription
81
+ * @request POST:/api/v2.1/notification_subscriptions
82
+ */
83
+ export declare const postApiV21NotificationSubscriptions: (client: HttpClient, postApiV21NotificationSubscriptions: PostApiV21NotificationSubscriptions, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
84
84
  /**
85
85
  * @description Get a count of notification subscriptions
86
86
  *
@@ -90,24 +90,15 @@ export declare const getApiV21NotificationSubscriptions: (client: HttpClient, qu
90
90
  * @request GET:/api/v2.1/notification_subscriptions/count
91
91
  */
92
92
  export declare const getApiV21NotificationSubscriptionsCount: (client: HttpClient, query: GetApiV21NotificationSubscriptionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
93
- /**
94
- * @description Send yourself a test e-mail, webhook, or Slack notification
95
- *
96
- * @tags notifications
97
- * @name GetApiV21NotificationSubscriptionsIdTest
98
- * @summary Test a notification subscription
99
- * @request GET:/api/v2.1/notification_subscriptions/{id}/test
100
- */
101
- export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
102
93
  /**
103
94
  * No description
104
95
  *
105
96
  * @tags notifications
106
- * @name DeleteApiV21NotificationSubscriptionsId
107
- * @summary Delete a notification subscription
108
- * @request DELETE:/api/v2.1/notification_subscriptions/{id}
97
+ * @name GetApiV21NotificationSubscriptionsId
98
+ * @summary Retrieve a notification subscription
99
+ * @request GET:/api/v2.1/notification_subscriptions/{id}
109
100
  */
110
- export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
101
+ export declare const getApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
111
102
  /**
112
103
  * No description
113
104
  *
@@ -116,13 +107,22 @@ export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClien
116
107
  * @summary Update a notification subscription
117
108
  * @request PUT:/api/v2.1/notification_subscriptions/{id}
118
109
  */
119
- export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, ApiV21NotificationSubscriptions: PutApiV21NotificationSubscriptions, params?: RequestParams) => Promise<void>;
110
+ export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, putApiV21NotificationSubscriptionsId: PutApiV21NotificationSubscriptionsId, params?: RequestParams) => Promise<void>;
120
111
  /**
121
112
  * No description
122
113
  *
123
114
  * @tags notifications
124
- * @name GetApiV21NotificationSubscriptionsId
125
- * @summary Retrieve a notification subscription
126
- * @request GET:/api/v2.1/notification_subscriptions/{id}
115
+ * @name DeleteApiV21NotificationSubscriptionsId
116
+ * @summary Delete a notification subscription
117
+ * @request DELETE:/api/v2.1/notification_subscriptions/{id}
127
118
  */
128
- export declare const getApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
119
+ export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
120
+ /**
121
+ * @description Send yourself a test e-mail, webhook, or Slack notification
122
+ *
123
+ * @tags notifications
124
+ * @name GetApiV21NotificationSubscriptionsIdTest
125
+ * @summary Test a notification subscription
126
+ * @request GET:/api/v2.1/notification_subscriptions/{id}/test
127
+ */
128
+ export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
@@ -1,4 +1,4 @@
1
- import { APIV21EntitiesOrderItem, APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, PutApiV21OrderItems, PutApiV21OrderItemsIdCall, PutApiV21OrderItemsIdMetaFields, PutApiV2OrderItems, PutApiV2OrderItemsIdCall, PutApiV2OrderItemsIdMetaFields } from "./data-contracts";
1
+ import { APIV21EntitiesOrderItem, APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, PutApiV21OrderItemsId, PutApiV21OrderItemsIdCallAction, PutApiV21OrderItemsIdMetaFields, PutApiV2OrderItemsId, PutApiV2OrderItemsIdCallAction, PutApiV2OrderItemsIdMetaFields } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get resource actions
@@ -10,23 +10,23 @@ import { HttpClient, RequestParams } from "./http-client";
10
10
  */
11
11
  export declare const getApiV2OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
12
  /**
13
- * @description Destroy an order item
13
+ * @description Get the meta fields for a(n) OrderItem
14
14
  *
15
15
  * @tags order_items
16
- * @name DeleteApiV2OrderItemsId
17
- * @summary Destroy an order item
18
- * @request DELETE:/api/v2/order_items/{id}
16
+ * @name GetApiV2OrderItemsIdMetaFields
17
+ * @summary List meta fields
18
+ * @request GET:/api/v2/order_items/{id}/meta_fields
19
19
  */
20
- export declare const deleteApiV2OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
20
+ export declare const getApiV2OrderItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2OrderItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
21
21
  /**
22
- * @description Update an order item
22
+ * @description Update OrderItem meta fields
23
23
  *
24
24
  * @tags order_items
25
- * @name PutApiV2OrderItemsId
26
- * @summary Update an order item
27
- * @request PUT:/api/v2/order_items/{id}
25
+ * @name PutApiV2OrderItemsIdMetaFields
26
+ * @summary Set meta fields
27
+ * @request PUT:/api/v2/order_items/{id}/meta_fields
28
28
  */
29
- export declare const putApiV2OrderItemsId: (client: HttpClient, id: number, ApiV2OrderItems: PutApiV2OrderItems, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
29
+ export declare const putApiV2OrderItemsIdMetaFields: (client: HttpClient, id: number, putApiV2OrderItemsIdMetaFields: PutApiV2OrderItemsIdMetaFields, params?: RequestParams) => Promise<void>;
30
30
  /**
31
31
  * @description Retrieve an order item
32
32
  *
@@ -37,23 +37,23 @@ export declare const putApiV2OrderItemsId: (client: HttpClient, id: number, ApiV
37
37
  */
38
38
  export declare const getApiV2OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV2OrderItemsIdParams, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
39
39
  /**
40
- * @description Update OrderItem meta fields
40
+ * @description Update an order item
41
41
  *
42
42
  * @tags order_items
43
- * @name PutApiV2OrderItemsIdMetaFields
44
- * @summary Set meta fields
45
- * @request PUT:/api/v2/order_items/{id}/meta_fields
43
+ * @name PutApiV2OrderItemsId
44
+ * @summary Update an order item
45
+ * @request PUT:/api/v2/order_items/{id}
46
46
  */
47
- export declare const putApiV2OrderItemsIdMetaFields: (client: HttpClient, id: number, ApiV2OrderItemsIdMetaFields: PutApiV2OrderItemsIdMetaFields, params?: RequestParams) => Promise<void>;
47
+ export declare const putApiV2OrderItemsId: (client: HttpClient, id: number, putApiV2OrderItemsId: PutApiV2OrderItemsId, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
48
48
  /**
49
- * @description Get the meta fields for a(n) OrderItem
49
+ * @description Destroy an order item
50
50
  *
51
51
  * @tags order_items
52
- * @name GetApiV2OrderItemsIdMetaFields
53
- * @summary List meta fields
54
- * @request GET:/api/v2/order_items/{id}/meta_fields
52
+ * @name DeleteApiV2OrderItemsId
53
+ * @summary Destroy an order item
54
+ * @request DELETE:/api/v2/order_items/{id}
55
55
  */
56
- export declare const getApiV2OrderItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2OrderItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
56
+ export declare const deleteApiV2OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
57
57
  /**
58
58
  * @description Separate an order item into a new order
59
59
  *
@@ -71,7 +71,7 @@ export declare const putApiV2OrderItemsIdSeparate: (client: HttpClient, id: numb
71
71
  * @summary Perform an action on an order_item
72
72
  * @request PUT:/api/v2/order_items/{id}/call/{action}
73
73
  */
74
- export declare const putApiV2OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV2OrderItemsIdCall: PutApiV2OrderItemsIdCall, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
74
+ export declare const putApiV2OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV2OrderItemsIdCallAction: PutApiV2OrderItemsIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
75
75
  /**
76
76
  * @description Serial numbers are scanned and saved during the packing process.
77
77
  *
@@ -91,23 +91,23 @@ export declare const getApiV2OrderItemsIdSerialNumbers: (client: HttpClient, id:
91
91
  */
92
92
  export declare const getApiV21OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
93
93
  /**
94
- * @description Destroy an order item
94
+ * @description Get the meta fields for a(n) OrderItem
95
95
  *
96
96
  * @tags order_items
97
- * @name DeleteApiV21OrderItemsId
98
- * @summary Destroy an order item
99
- * @request DELETE:/api/v2.1/order_items/{id}
97
+ * @name GetApiV21OrderItemsIdMetaFields
98
+ * @summary List meta fields
99
+ * @request GET:/api/v2.1/order_items/{id}/meta_fields
100
100
  */
101
- export declare const deleteApiV21OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
101
+ export declare const getApiV21OrderItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
102
102
  /**
103
- * @description Update an order item
103
+ * @description Update OrderItem meta fields
104
104
  *
105
105
  * @tags order_items
106
- * @name PutApiV21OrderItemsId
107
- * @summary Update an order item
108
- * @request PUT:/api/v2.1/order_items/{id}
106
+ * @name PutApiV21OrderItemsIdMetaFields
107
+ * @summary Set meta fields
108
+ * @request PUT:/api/v2.1/order_items/{id}/meta_fields
109
109
  */
110
- export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, ApiV21OrderItems: PutApiV21OrderItems, params?: RequestParams) => Promise<void>;
110
+ export declare const putApiV21OrderItemsIdMetaFields: (client: HttpClient, id: number, putApiV21OrderItemsIdMetaFields: PutApiV21OrderItemsIdMetaFields, params?: RequestParams) => Promise<void>;
111
111
  /**
112
112
  * @description Retrieve an order item
113
113
  *
@@ -118,23 +118,23 @@ export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, Api
118
118
  */
119
119
  export declare const getApiV21OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
120
120
  /**
121
- * @description Update OrderItem meta fields
121
+ * @description Update an order item
122
122
  *
123
123
  * @tags order_items
124
- * @name PutApiV21OrderItemsIdMetaFields
125
- * @summary Set meta fields
126
- * @request PUT:/api/v2.1/order_items/{id}/meta_fields
124
+ * @name PutApiV21OrderItemsId
125
+ * @summary Update an order item
126
+ * @request PUT:/api/v2.1/order_items/{id}
127
127
  */
128
- export declare const putApiV21OrderItemsIdMetaFields: (client: HttpClient, id: number, ApiV21OrderItemsIdMetaFields: PutApiV21OrderItemsIdMetaFields, params?: RequestParams) => Promise<void>;
128
+ export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, putApiV21OrderItemsId: PutApiV21OrderItemsId, params?: RequestParams) => Promise<void>;
129
129
  /**
130
- * @description Get the meta fields for a(n) OrderItem
130
+ * @description Destroy an order item
131
131
  *
132
132
  * @tags order_items
133
- * @name GetApiV21OrderItemsIdMetaFields
134
- * @summary List meta fields
135
- * @request GET:/api/v2.1/order_items/{id}/meta_fields
133
+ * @name DeleteApiV21OrderItemsId
134
+ * @summary Destroy an order item
135
+ * @request DELETE:/api/v2.1/order_items/{id}
136
136
  */
137
- export declare const getApiV21OrderItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
137
+ export declare const deleteApiV21OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
138
138
  /**
139
139
  * @description Separate an order item into a new order
140
140
  *
@@ -152,7 +152,7 @@ export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: num
152
152
  * @summary Perform an action on an order_item
153
153
  * @request PUT:/api/v2.1/order_items/{id}/call/{action}
154
154
  */
155
- export declare const putApiV21OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV21OrderItemsIdCall: PutApiV21OrderItemsIdCall, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
155
+ export declare const putApiV21OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV21OrderItemsIdCallAction: PutApiV21OrderItemsIdCallAction, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
156
156
  /**
157
157
  * @description Serial numbers are scanned and saved during the packing process.
158
158
  *