@whiplashmerch/whiplash-api-client 0.4.76 → 0.4.78

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 (92) hide show
  1. package/dist/client.esm.js +18494 -2141
  2. package/dist/client.esm.js.map +1 -1
  3. package/dist/constants/index.d.ts +1 -0
  4. package/dist/constants/search.d.ts +9 -0
  5. package/dist/generated/AccountTransactions.d.ts +56 -0
  6. package/dist/generated/Accounts.d.ts +171 -0
  7. package/dist/generated/Allocations.d.ts +38 -0
  8. package/dist/generated/Broadcasts.d.ts +164 -0
  9. package/dist/generated/Cache.d.ts +56 -0
  10. package/dist/generated/CarrierAccounts.d.ts +191 -0
  11. package/dist/generated/Carriers.d.ts +20 -0
  12. package/dist/generated/Chromalists.d.ts +56 -0
  13. package/dist/generated/ConsumerReturns.d.ts +89 -1
  14. package/dist/generated/Currencies.d.ts +56 -0
  15. package/dist/generated/Customers.d.ts +172 -1
  16. package/dist/generated/CustomsInfos.d.ts +56 -0
  17. package/dist/generated/Dashboards.d.ts +38 -0
  18. package/dist/generated/Documents.d.ts +37 -1
  19. package/dist/generated/ExtApp.d.ts +30 -0
  20. package/dist/generated/FilterSets.d.ts +288 -0
  21. package/dist/generated/ImporterOfRecords.d.ts +92 -0
  22. package/dist/generated/Incidents.d.ts +128 -0
  23. package/dist/generated/InvoiceItems.d.ts +56 -0
  24. package/dist/generated/Invoices.d.ts +110 -0
  25. package/dist/generated/Items.d.ts +260 -1
  26. package/dist/generated/Locales.d.ts +19 -0
  27. package/dist/generated/LocationAdjustments.d.ts +65 -0
  28. package/dist/generated/LocationAudits.d.ts +162 -0
  29. package/dist/generated/LocationTransfers.d.ts +162 -0
  30. package/dist/generated/Locations.d.ts +207 -0
  31. package/dist/generated/Lots.d.ts +119 -0
  32. package/dist/generated/Manifests.d.ts +128 -0
  33. package/dist/generated/Me.d.ts +20 -0
  34. package/dist/generated/Nav.d.ts +20 -0
  35. package/dist/generated/NavItems.d.ts +20 -0
  36. package/dist/generated/OrderBatchItems.d.ts +54 -0
  37. package/dist/generated/OrderBatchRequests.d.ts +38 -0
  38. package/dist/generated/OrderBatches.d.ts +315 -0
  39. package/dist/generated/OrderDocuments.d.ts +37 -0
  40. package/dist/generated/OrderItems.d.ts +98 -1
  41. package/dist/generated/OrderTotes.d.ts +20 -0
  42. package/dist/generated/Orders.d.ts +468 -1
  43. package/dist/generated/Originators.d.ts +28 -1
  44. package/dist/generated/Packages.d.ts +205 -0
  45. package/dist/generated/Partners.d.ts +110 -0
  46. package/dist/generated/Prepacks.d.ts +11 -0
  47. package/dist/generated/ProjectTasks.d.ts +56 -0
  48. package/dist/generated/Projects.d.ts +163 -1
  49. package/dist/generated/Rates.d.ts +119 -0
  50. package/dist/generated/ReasonCodes.d.ts +20 -0
  51. package/dist/generated/ReturnAddresses.d.ts +92 -0
  52. package/dist/generated/RuleDismissals.d.ts +19 -0
  53. package/dist/generated/Rules.d.ts +155 -0
  54. package/dist/generated/Scancodes.d.ts +20 -0
  55. package/dist/generated/SerialNumbers.d.ts +56 -0
  56. package/dist/generated/ShipnoticeItems.d.ts +197 -1
  57. package/dist/generated/Shipnotices.d.ts +242 -1
  58. package/dist/generated/ShippingAliases.d.ts +119 -0
  59. package/dist/generated/ShippingBlacklistedMethods.d.ts +110 -0
  60. package/dist/generated/ShippingMethodMarkups.d.ts +11 -0
  61. package/dist/generated/ShippingMethods.d.ts +110 -0
  62. package/dist/generated/Shops.d.ts +47 -0
  63. package/dist/generated/Stats.d.ts +54 -0
  64. package/dist/generated/SurchargeMarkups.d.ts +56 -0
  65. package/dist/generated/TemplateTypes.d.ts +20 -0
  66. package/dist/generated/Templates.d.ts +82 -1
  67. package/dist/generated/Transactions.d.ts +11 -0
  68. package/dist/generated/TransportationMarkups.d.ts +56 -0
  69. package/dist/generated/Users.d.ts +245 -0
  70. package/dist/generated/Utilities.d.ts +38 -0
  71. package/dist/generated/WarehouseFeatures.d.ts +110 -0
  72. package/dist/generated/Warehouses.d.ts +245 -0
  73. package/dist/generated/Wholesales.d.ts +56 -0
  74. package/dist/generated/data-contracts.d.ts +20237 -4725
  75. package/dist/generated/index.d.ts +57 -0
  76. package/dist/index.d.ts +3 -0
  77. package/dist/mocks/customer.d.ts +2 -0
  78. package/dist/mocks/index.d.ts +4 -0
  79. package/dist/mocks/nav.d.ts +2 -0
  80. package/dist/mocks/user.d.ts +2 -0
  81. package/dist/mocks/warehouse.d.ts +2 -0
  82. package/dist/utils/errorHandler.d.ts +2 -0
  83. package/dist/utils/index.d.ts +9 -0
  84. package/dist/utils/nav.d.ts +9 -0
  85. package/dist/utils/orderBatch.d.ts +19 -0
  86. package/dist/utils/orders.d.ts +54 -0
  87. package/dist/utils/pusher.d.ts +25 -0
  88. package/dist/utils/rules.d.ts +8 -0
  89. package/dist/utils/user.d.ts +19 -0
  90. package/dist/utils/utilities.d.ts +8 -0
  91. package/dist/utils/warehouse.d.ts +26 -0
  92. package/package.json +1 -1
@@ -0,0 +1,20 @@
1
+ import { APIV2EntitiesReasonCode, GetApiV2ReasonCodesParams } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * @description Get a list of reason codes
5
+ *
6
+ * @tags reason_codes
7
+ * @name GetApiV2ReasonCodes
8
+ * @summary List reason codes
9
+ * @request GET:/api/v2/reason_codes
10
+ */
11
+ export declare const getApiV2ReasonCodes: (client: HttpClient, query: GetApiV2ReasonCodesParams, params?: RequestParams) => Promise<APIV2EntitiesReasonCode[]>;
12
+ /**
13
+ * @description Get a reason code
14
+ *
15
+ * @tags reason_codes
16
+ * @name GetApiV2ReasonCodesId
17
+ * @summary Retrieve a reason code
18
+ * @request GET:/api/v2/reason_codes/{id}
19
+ */
20
+ export declare const getApiV2ReasonCodesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesReasonCode>;
@@ -0,0 +1,92 @@
1
+ import { APIV2EntitiesReturnAddress, GetApiV21ReturnAddressesParams, GetApiV2ReturnAddressesParams, PostApiV21ReturnAddresses, PostApiV2ReturnAddresses, PutApiV21ReturnAddressesId, PutApiV2ReturnAddressesId } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * @description Get a return addresses list
5
+ *
6
+ * @tags return_addresses
7
+ * @name GetApiV2ReturnAddresses
8
+ * @summary Lists return addresses
9
+ * @request GET:/api/v2/return_addresses
10
+ */
11
+ export declare const getApiV2ReturnAddresses: (client: HttpClient, query: GetApiV2ReturnAddressesParams, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress[]>;
12
+ /**
13
+ * @description Create a return address
14
+ *
15
+ * @tags return_addresses
16
+ * @name PostApiV2ReturnAddresses
17
+ * @summary Create a return address
18
+ * @request POST:/api/v2/return_addresses
19
+ */
20
+ export declare const postApiV2ReturnAddresses: (client: HttpClient, postApiV2ReturnAddresses: PostApiV2ReturnAddresses, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
21
+ /**
22
+ * @description Get a return address
23
+ *
24
+ * @tags return_addresses
25
+ * @name GetApiV2ReturnAddressesId
26
+ * @summary Retrive a return address
27
+ * @request GET:/api/v2/return_addresses/{id}
28
+ */
29
+ export declare const getApiV2ReturnAddressesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
30
+ /**
31
+ * @description Update a return address
32
+ *
33
+ * @tags return_addresses
34
+ * @name PutApiV2ReturnAddressesId
35
+ * @summary Update a return address
36
+ * @request PUT:/api/v2/return_addresses/{id}
37
+ */
38
+ export declare const putApiV2ReturnAddressesId: (client: HttpClient, id: number, putApiV2ReturnAddressesId: PutApiV2ReturnAddressesId, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
39
+ /**
40
+ * @description Destroy a return address
41
+ *
42
+ * @tags return_addresses
43
+ * @name DeleteApiV2ReturnAddressesId
44
+ * @summary Destroy a return address
45
+ * @request DELETE:/api/v2/return_addresses/{id}
46
+ */
47
+ export declare const deleteApiV2ReturnAddressesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
48
+ /**
49
+ * @description Get a return addresses list
50
+ *
51
+ * @tags return_addresses
52
+ * @name GetApiV21ReturnAddresses
53
+ * @summary Lists return addresses
54
+ * @request GET:/api/v2.1/return_addresses
55
+ */
56
+ export declare const getApiV21ReturnAddresses: (client: HttpClient, query: GetApiV21ReturnAddressesParams, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress[]>;
57
+ /**
58
+ * @description Create a return address
59
+ *
60
+ * @tags return_addresses
61
+ * @name PostApiV21ReturnAddresses
62
+ * @summary Create a return address
63
+ * @request POST:/api/v2.1/return_addresses
64
+ */
65
+ export declare const postApiV21ReturnAddresses: (client: HttpClient, postApiV21ReturnAddresses: PostApiV21ReturnAddresses, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
66
+ /**
67
+ * @description Get a return address
68
+ *
69
+ * @tags return_addresses
70
+ * @name GetApiV21ReturnAddressesId
71
+ * @summary Retrive a return address
72
+ * @request GET:/api/v2.1/return_addresses/{id}
73
+ */
74
+ export declare const getApiV21ReturnAddressesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
75
+ /**
76
+ * @description Update a return address
77
+ *
78
+ * @tags return_addresses
79
+ * @name PutApiV21ReturnAddressesId
80
+ * @summary Update a return address
81
+ * @request PUT:/api/v2.1/return_addresses/{id}
82
+ */
83
+ export declare const putApiV21ReturnAddressesId: (client: HttpClient, id: number, putApiV21ReturnAddressesId: PutApiV21ReturnAddressesId, params?: RequestParams) => Promise<APIV2EntitiesReturnAddress>;
84
+ /**
85
+ * @description Destroy a return address
86
+ *
87
+ * @tags return_addresses
88
+ * @name DeleteApiV21ReturnAddressesId
89
+ * @summary Destroy a return address
90
+ * @request DELETE:/api/v2.1/return_addresses/{id}
91
+ */
92
+ export declare const deleteApiV21ReturnAddressesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
@@ -0,0 +1,19 @@
1
+ import { HttpClient, RequestParams } from "./http-client";
2
+ /**
3
+ * No description
4
+ *
5
+ * @tags rule_dismissals
6
+ * @name DeleteApiV2RuleDismissalsId
7
+ * @summary Destroy a rule dismissal
8
+ * @request DELETE:/api/v2/rule_dismissals/{id}
9
+ */
10
+ export declare const deleteApiV2RuleDismissalsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
11
+ /**
12
+ * No description
13
+ *
14
+ * @tags rule_dismissals
15
+ * @name DeleteApiV21RuleDismissalsId
16
+ * @summary Destroy a rule dismissal
17
+ * @request DELETE:/api/v2.1/rule_dismissals/{id}
18
+ */
19
+ export declare const deleteApiV21RuleDismissalsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
@@ -0,0 +1,155 @@
1
+ import { APIV21EntitiesOrder, APIV21EntitiesPostResponse, APIV21EntitiesRule, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesOrder, APIV2EntitiesRule, GetApiV21RulesCountParams, GetApiV21RulesParams, GetApiV2RulesCountParams, GetApiV2RulesParams, PostApiV21Rules, PostApiV2Rules, PutApiV21RulesId, PutApiV21RulesIdCallAction, PutApiV2RulesId, PutApiV2RulesIdCallAction } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags rules
7
+ * @name GetApiV2RulesIdAudits
8
+ * @summary Retrieve audit info for users
9
+ * @request GET:/api/v2/rules/{id}/audits
10
+ */
11
+ export declare const getApiV2RulesIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags rules
16
+ * @name GetApiV2RulesId
17
+ * @summary Retrieve a rule
18
+ * @request GET:/api/v2/rules/{id}
19
+ */
20
+ export declare const getApiV2RulesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesRule>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags rules
25
+ * @name PutApiV2RulesId
26
+ * @summary Update a rule
27
+ * @request PUT:/api/v2/rules/{id}
28
+ */
29
+ export declare const putApiV2RulesId: (client: HttpClient, id: number, putApiV2RulesId: PutApiV2RulesId, params?: RequestParams) => Promise<APIV2EntitiesRule>;
30
+ /**
31
+ * No description
32
+ *
33
+ * @tags rules
34
+ * @name DeleteApiV2RulesId
35
+ * @summary Destroy a rule
36
+ * @request DELETE:/api/v2/rules/{id}
37
+ */
38
+ export declare const deleteApiV2RulesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
39
+ /**
40
+ * No description
41
+ *
42
+ * @tags rules
43
+ * @name GetApiV2RulesIdHistory
44
+ * @summary Retrieve the order history
45
+ * @request GET:/api/v2/rules/{id}/history
46
+ */
47
+ export declare const getApiV2RulesIdHistory: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
48
+ /**
49
+ * @description Get a list of rules
50
+ *
51
+ * @tags rules
52
+ * @name GetApiV2Rules
53
+ * @summary List all rules
54
+ * @request GET:/api/v2/rules
55
+ */
56
+ export declare const getApiV2Rules: (client: HttpClient, query: GetApiV2RulesParams, params?: RequestParams) => Promise<APIV2EntitiesRule[]>;
57
+ /**
58
+ * @description Create a rule
59
+ *
60
+ * @tags rules
61
+ * @name PostApiV2Rules
62
+ * @summary Create a rule
63
+ * @request POST:/api/v2/rules
64
+ */
65
+ export declare const postApiV2Rules: (client: HttpClient, postApiV2Rules: PostApiV2Rules, params?: RequestParams) => Promise<APIV2EntitiesRule>;
66
+ /**
67
+ * @description Returns count of rules
68
+ *
69
+ * @tags rules
70
+ * @name GetApiV2RulesCount
71
+ * @summary Count rules
72
+ * @request GET:/api/v2/rules/count
73
+ */
74
+ export declare const getApiV2RulesCount: (client: HttpClient, query: GetApiV2RulesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
75
+ /**
76
+ * No description
77
+ *
78
+ * @tags rules
79
+ * @name PutApiV2RulesIdCallAction
80
+ * @summary Perform an action on a rule
81
+ * @request PUT:/api/v2/rules/{id}/call/{action}
82
+ */
83
+ export declare const putApiV2RulesIdCallAction: (client: HttpClient, action: string, id: number, putApiV2RulesIdCallAction: PutApiV2RulesIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesRule>;
84
+ /**
85
+ * @description Get a list of rules
86
+ *
87
+ * @tags rules
88
+ * @name GetApiV21Rules
89
+ * @summary List all rules
90
+ * @request GET:/api/v2.1/rules
91
+ */
92
+ export declare const getApiV21Rules: (client: HttpClient, query: GetApiV21RulesParams, params?: RequestParams) => Promise<APIV21EntitiesRule[]>;
93
+ /**
94
+ * @description Create a rule
95
+ *
96
+ * @tags rules
97
+ * @name PostApiV21Rules
98
+ * @summary Create a rule
99
+ * @request POST:/api/v2.1/rules
100
+ */
101
+ export declare const postApiV21Rules: (client: HttpClient, postApiV21Rules: PostApiV21Rules, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
102
+ /**
103
+ * @description Returns count of rules
104
+ *
105
+ * @tags rules
106
+ * @name GetApiV21RulesCount
107
+ * @summary Count rules
108
+ * @request GET:/api/v2.1/rules/count
109
+ */
110
+ export declare const getApiV21RulesCount: (client: HttpClient, query: GetApiV21RulesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
111
+ /**
112
+ * No description
113
+ *
114
+ * @tags rules
115
+ * @name GetApiV21RulesId
116
+ * @summary Retrieve a rule
117
+ * @request GET:/api/v2.1/rules/{id}
118
+ */
119
+ export declare const getApiV21RulesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesRule>;
120
+ /**
121
+ * No description
122
+ *
123
+ * @tags rules
124
+ * @name PutApiV21RulesId
125
+ * @summary Update a rule
126
+ * @request PUT:/api/v2.1/rules/{id}
127
+ */
128
+ export declare const putApiV21RulesId: (client: HttpClient, id: number, putApiV21RulesId: PutApiV21RulesId, params?: RequestParams) => Promise<void>;
129
+ /**
130
+ * No description
131
+ *
132
+ * @tags rules
133
+ * @name DeleteApiV21RulesId
134
+ * @summary Destroy a rule
135
+ * @request DELETE:/api/v2.1/rules/{id}
136
+ */
137
+ export declare const deleteApiV21RulesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
138
+ /**
139
+ * No description
140
+ *
141
+ * @tags rules
142
+ * @name GetApiV21RulesIdHistory
143
+ * @summary Retrieve the order history
144
+ * @request GET:/api/v2.1/rules/{id}/history
145
+ */
146
+ export declare const getApiV21RulesIdHistory: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
147
+ /**
148
+ * No description
149
+ *
150
+ * @tags rules
151
+ * @name PutApiV21RulesIdCallAction
152
+ * @summary Perform an action on a rule
153
+ * @request PUT:/api/v2.1/rules/{id}/call/{action}
154
+ */
155
+ export declare const putApiV21RulesIdCallAction: (client: HttpClient, action: string, id: number, putApiV21RulesIdCallAction: PutApiV21RulesIdCallAction, params?: RequestParams) => Promise<void>;
@@ -0,0 +1,20 @@
1
+ import { APIV2EntitiesScancode, GetApiV2ScancodesParams, PutApiV2ScancodesId } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags items
7
+ * @name GetApiV2Scancodes
8
+ * @summary List all scancodes
9
+ * @request GET:/api/v2/scancodes
10
+ */
11
+ export declare const getApiV2Scancodes: (client: HttpClient, query: GetApiV2ScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags items
16
+ * @name PutApiV2ScancodesId
17
+ * @summary Update a scancode
18
+ * @request PUT:/api/v2/scancodes/{id}
19
+ */
20
+ export declare const putApiV2ScancodesId: (client: HttpClient, id: number, putApiV2ScancodesId: PutApiV2ScancodesId, params?: RequestParams) => Promise<APIV2EntitiesScancode>;
@@ -0,0 +1,56 @@
1
+ import { APIV2EntitiesSerialNumber, GetApiV21SerialNumbersParams, GetApiV2SerialNumbersParams, PutApiV21SerialNumbersIdCallAction, PutApiV2SerialNumbersIdCallAction } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * @description Get resource actions
5
+ *
6
+ * @tags serial_numbers
7
+ * @name GetApiV2SerialNumbersActions
8
+ * @summary List actions you can perform
9
+ * @request GET:/api/v2/serial_numbers/actions
10
+ */
11
+ export declare const getApiV2SerialNumbersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
+ /**
13
+ * @description Get all serial_numbers
14
+ *
15
+ * @tags serial_numbers
16
+ * @name GetApiV2SerialNumbers
17
+ * @summary List all serial numbers
18
+ * @request GET:/api/v2/serial_numbers
19
+ */
20
+ export declare const getApiV2SerialNumbers: (client: HttpClient, query: GetApiV2SerialNumbersParams, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber[]>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags serial_numbers
25
+ * @name PutApiV2SerialNumbersIdCallAction
26
+ * @summary Perform an action on a serial number
27
+ * @request PUT:/api/v2/serial_numbers/{id}/call/{action}
28
+ */
29
+ export declare const putApiV2SerialNumbersIdCallAction: (client: HttpClient, action: string, id: number, putApiV2SerialNumbersIdCallAction: PutApiV2SerialNumbersIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber>;
30
+ /**
31
+ * @description Get resource actions
32
+ *
33
+ * @tags serial_numbers
34
+ * @name GetApiV21SerialNumbersActions
35
+ * @summary List actions you can perform
36
+ * @request GET:/api/v2.1/serial_numbers/actions
37
+ */
38
+ export declare const getApiV21SerialNumbersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
39
+ /**
40
+ * @description Get all serial_numbers
41
+ *
42
+ * @tags serial_numbers
43
+ * @name GetApiV21SerialNumbers
44
+ * @summary List all serial numbers
45
+ * @request GET:/api/v2.1/serial_numbers
46
+ */
47
+ export declare const getApiV21SerialNumbers: (client: HttpClient, query: GetApiV21SerialNumbersParams, params?: RequestParams) => Promise<APIV2EntitiesSerialNumber[]>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags serial_numbers
52
+ * @name PutApiV21SerialNumbersIdCallAction
53
+ * @summary Perform an action on a serial number
54
+ * @request PUT:/api/v2.1/serial_numbers/{id}/call/{action}
55
+ */
56
+ export declare const putApiV21SerialNumbersIdCallAction: (client: HttpClient, action: string, id: number, putApiV21SerialNumbersIdCallAction: PutApiV21SerialNumbersIdCallAction, params?: RequestParams) => Promise<void>;
@@ -1,4 +1,4 @@
1
- import { APIV21EntitiesShipnoticeItem, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticeItemsCountParams, GetApiV21ShipnoticeItemsIdMetaFieldsParams, GetApiV2ShipnoticeItemsCountParams, GetApiV2ShipnoticeItemsIdMetaFieldsParams, PutApiV21ShipnoticeItemsId, PutApiV21ShipnoticeItemsIdMetaFields, PutApiV2ShipnoticeItemsId, PutApiV2ShipnoticeItemsIdMetaFields } from "./data-contracts";
1
+ import { APIV21EntitiesAllocation, APIV21EntitiesLocation, APIV21EntitiesShipnoticeItem, APIV2EntitiesAllocation, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesLocation, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesShipnoticeItem, APIV2EntitiesSidekiqBatch, APIV2EntitiesTag, DeleteApiV2ShipnoticeItemsIdTagsParams, GetApiV21ShipnoticeItemsAggregateParams, GetApiV21ShipnoticeItemsCountParams, GetApiV21ShipnoticeItemsIdAllocationsParams, GetApiV21ShipnoticeItemsIdLocationsParams, GetApiV21ShipnoticeItemsIdMetaFieldsParams, GetApiV21ShipnoticeItemsIdReceivedParams, GetApiV21ShipnoticeItemsParams, GetApiV2ShipnoticeItemsAggregateParams, GetApiV2ShipnoticeItemsCountParams, GetApiV2ShipnoticeItemsIdAllocationsParams, GetApiV2ShipnoticeItemsIdLocationsParams, GetApiV2ShipnoticeItemsIdMetaFieldsParams, GetApiV2ShipnoticeItemsIdReceivedParams, GetApiV2ShipnoticeItemsIdTagsParams, GetApiV2ShipnoticeItemsParams, PostApiV2ShipnoticeItemsIdTags, PutApiV21ShipnoticeItemsId, PutApiV21ShipnoticeItemsIdCallAction, PutApiV21ShipnoticeItemsIdCallAsyncAction, PutApiV21ShipnoticeItemsIdMetaFields, PutApiV21ShipnoticeItemsIdReceive, PutApiV2ShipnoticeItemsId, PutApiV2ShipnoticeItemsIdCallAction, PutApiV2ShipnoticeItemsIdCallAsyncAction, PutApiV2ShipnoticeItemsIdMetaFields, PutApiV2ShipnoticeItemsIdReceive } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get resource actions
@@ -9,6 +9,50 @@ import { HttpClient, RequestParams } from "./http-client";
9
9
  * @request GET:/api/v2/shipnotice_items/actions
10
10
  */
11
11
  export declare const getApiV2ShipnoticeItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
+ /**
13
+ * No description
14
+ *
15
+ * @tags shipnotice_items
16
+ * @name GetApiV2ShipnoticeItems
17
+ * @summary List all ship notice items
18
+ * @request GET:/api/v2/shipnotice_items
19
+ */
20
+ export declare const getApiV2ShipnoticeItems: (client: HttpClient, query: GetApiV2ShipnoticeItemsParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem[]>;
21
+ /**
22
+ * @description Returns aggregated shipnotice_items
23
+ *
24
+ * @tags shipnotice_items
25
+ * @name GetApiV2ShipnoticeItemsAggregate
26
+ * @request GET:/api/v2/shipnotice_items/aggregate
27
+ */
28
+ export declare const getApiV2ShipnoticeItemsAggregate: (client: HttpClient, query: GetApiV2ShipnoticeItemsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
29
+ /**
30
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
31
+ *
32
+ * @tags shipnotice_items
33
+ * @name GetApiV2ShipnoticeItemsIdOriginator
34
+ * @summary Retrieve the associated originator
35
+ * @request GET:/api/v2/shipnotice_items/{id}/originator
36
+ */
37
+ export declare const getApiV2ShipnoticeItemsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
38
+ /**
39
+ * No description
40
+ *
41
+ * @tags shipnotice_items
42
+ * @name GetApiV2ShipnoticeItemsIdAudits
43
+ * @summary Retrieve audit info for users
44
+ * @request GET:/api/v2/shipnotice_items/{id}/audits
45
+ */
46
+ export declare const getApiV2ShipnoticeItemsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
47
+ /**
48
+ * @description Get all allocations for a shipnotice_item
49
+ *
50
+ * @tags shipnotice_items
51
+ * @name GetApiV2ShipnoticeItemsIdAllocations
52
+ * @summary List allocations for a shipnotice_item
53
+ * @request GET:/api/v2/shipnotice_items/{id}/allocations
54
+ */
55
+ export declare const getApiV2ShipnoticeItemsIdAllocations: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticeItemsIdAllocationsParams, params?: RequestParams) => Promise<APIV2EntitiesAllocation[]>;
12
56
  /**
13
57
  * @description Get the meta fields for a(n) ShipnoticeItem
14
58
  *
@@ -54,6 +98,60 @@ export declare const putApiV2ShipnoticeItemsId: (client: HttpClient, id: number,
54
98
  * @request DELETE:/api/v2/shipnotice_items/{id}
55
99
  */
56
100
  export declare const deleteApiV2ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
101
+ /**
102
+ * No description
103
+ *
104
+ * @tags shipnotice_items
105
+ * @name PutApiV2ShipnoticeItemsIdReceive
106
+ * @summary Receive a ship notice item
107
+ * @request PUT:/api/v2/shipnotice_items/{id}/receive
108
+ */
109
+ export declare const putApiV2ShipnoticeItemsIdReceive: (client: HttpClient, id: number, putApiV2ShipnoticeItemsIdReceive: PutApiV2ShipnoticeItemsIdReceive, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
110
+ /**
111
+ * No description
112
+ *
113
+ * @tags shipnotice_items
114
+ * @name GetApiV2ShipnoticeItemsIdLocations
115
+ * @summary List valid receiving locations for an item
116
+ * @request GET:/api/v2/shipnotice_items/{id}/locations
117
+ */
118
+ export declare const getApiV2ShipnoticeItemsIdLocations: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticeItemsIdLocationsParams, params?: RequestParams) => Promise<APIV2EntitiesLocation[]>;
119
+ /**
120
+ * No description
121
+ *
122
+ * @tags shipnotice_items
123
+ * @name GetApiV2ShipnoticeItemsIdReceived
124
+ * @summary List receipts for a shipnotice item
125
+ * @request GET:/api/v2/shipnotice_items/{id}/received
126
+ */
127
+ export declare const getApiV2ShipnoticeItemsIdReceived: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticeItemsIdReceivedParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
128
+ /**
129
+ * No description
130
+ *
131
+ * @tags shipnotice_items
132
+ * @name GetApiV2ShipnoticeItemsIdTags
133
+ * @summary Get tags for a resource
134
+ * @request GET:/api/v2/shipnotice_items/{id}/tags
135
+ */
136
+ export declare const getApiV2ShipnoticeItemsIdTags: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticeItemsIdTagsParams, params?: RequestParams) => Promise<APIV2EntitiesTag>;
137
+ /**
138
+ * No description
139
+ *
140
+ * @tags shipnotice_items
141
+ * @name PostApiV2ShipnoticeItemsIdTags
142
+ * @summary Add tag(s) for a resource
143
+ * @request POST:/api/v2/shipnotice_items/{id}/tags
144
+ */
145
+ export declare const postApiV2ShipnoticeItemsIdTags: (client: HttpClient, id: number, postApiV2ShipnoticeItemsIdTags: PostApiV2ShipnoticeItemsIdTags, params?: RequestParams) => Promise<APIV2EntitiesTag>;
146
+ /**
147
+ * No description
148
+ *
149
+ * @tags shipnotice_items
150
+ * @name DeleteApiV2ShipnoticeItemsIdTags
151
+ * @summary Remove all tags for a resource
152
+ * @request DELETE:/api/v2/shipnotice_items/{id}/tags
153
+ */
154
+ export declare const deleteApiV2ShipnoticeItemsIdTags: (client: HttpClient, { id, ...query }: DeleteApiV2ShipnoticeItemsIdTagsParams, params?: RequestParams) => Promise<void>;
57
155
  /**
58
156
  * No description
59
157
  *
@@ -63,6 +161,24 @@ export declare const deleteApiV2ShipnoticeItemsId: (client: HttpClient, id: numb
63
161
  * @request GET:/api/v2/shipnotice_items/count
64
162
  */
65
163
  export declare const getApiV2ShipnoticeItemsCount: (client: HttpClient, query: GetApiV2ShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
164
+ /**
165
+ * No description
166
+ *
167
+ * @tags shipnotice_items
168
+ * @name PutApiV2ShipnoticeItemsIdCallAction
169
+ * @summary Perform an action on an shipnotice_item
170
+ * @request PUT:/api/v2/shipnotice_items/{id}/call/{action}
171
+ */
172
+ export declare const putApiV2ShipnoticeItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV2ShipnoticeItemsIdCallAction: PutApiV2ShipnoticeItemsIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
173
+ /**
174
+ * No description
175
+ *
176
+ * @tags shipnotice_items
177
+ * @name PutApiV2ShipnoticeItemsIdCallAsyncAction
178
+ * @summary Perform an action on an shipnotice_item asynchronously
179
+ * @request PUT:/api/v2/shipnotice_items/{id}/call_async/{action}
180
+ */
181
+ export declare const putApiV2ShipnoticeItemsIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV2ShipnoticeItemsIdCallAsyncAction: PutApiV2ShipnoticeItemsIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
66
182
  /**
67
183
  * @description Get resource actions
68
184
  *
@@ -72,6 +188,41 @@ export declare const getApiV2ShipnoticeItemsCount: (client: HttpClient, query: G
72
188
  * @request GET:/api/v2.1/shipnotice_items/actions
73
189
  */
74
190
  export declare const getApiV21ShipnoticeItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
191
+ /**
192
+ * No description
193
+ *
194
+ * @tags shipnotice_items
195
+ * @name GetApiV21ShipnoticeItems
196
+ * @summary List all ship notice items
197
+ * @request GET:/api/v2.1/shipnotice_items
198
+ */
199
+ export declare const getApiV21ShipnoticeItems: (client: HttpClient, query: GetApiV21ShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
200
+ /**
201
+ * @description Returns aggregated shipnotice_items
202
+ *
203
+ * @tags shipnotice_items
204
+ * @name GetApiV21ShipnoticeItemsAggregate
205
+ * @request GET:/api/v2.1/shipnotice_items/aggregate
206
+ */
207
+ export declare const getApiV21ShipnoticeItemsAggregate: (client: HttpClient, query: GetApiV21ShipnoticeItemsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
208
+ /**
209
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
210
+ *
211
+ * @tags shipnotice_items
212
+ * @name GetApiV21ShipnoticeItemsIdOriginator
213
+ * @summary Retrieve the associated originator
214
+ * @request GET:/api/v2.1/shipnotice_items/{id}/originator
215
+ */
216
+ export declare const getApiV21ShipnoticeItemsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
217
+ /**
218
+ * @description Get all allocations for a shipnotice_item
219
+ *
220
+ * @tags shipnotice_items
221
+ * @name GetApiV21ShipnoticeItemsIdAllocations
222
+ * @summary List allocations for a shipnotice_item
223
+ * @request GET:/api/v2.1/shipnotice_items/{id}/allocations
224
+ */
225
+ export declare const getApiV21ShipnoticeItemsIdAllocations: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticeItemsIdAllocationsParams, params?: RequestParams) => Promise<APIV21EntitiesAllocation[]>;
75
226
  /**
76
227
  * @description Get the meta fields for a(n) ShipnoticeItem
77
228
  *
@@ -117,6 +268,33 @@ export declare const putApiV21ShipnoticeItemsId: (client: HttpClient, id: number
117
268
  * @request DELETE:/api/v2.1/shipnotice_items/{id}
118
269
  */
119
270
  export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
271
+ /**
272
+ * No description
273
+ *
274
+ * @tags shipnotice_items
275
+ * @name PutApiV21ShipnoticeItemsIdReceive
276
+ * @summary Receive a ship notice item
277
+ * @request PUT:/api/v2.1/shipnotice_items/{id}/receive
278
+ */
279
+ export declare const putApiV21ShipnoticeItemsIdReceive: (client: HttpClient, id: number, putApiV21ShipnoticeItemsIdReceive: PutApiV21ShipnoticeItemsIdReceive, params?: RequestParams) => Promise<void>;
280
+ /**
281
+ * No description
282
+ *
283
+ * @tags shipnotice_items
284
+ * @name GetApiV21ShipnoticeItemsIdLocations
285
+ * @summary List valid receiving locations for an item
286
+ * @request GET:/api/v2.1/shipnotice_items/{id}/locations
287
+ */
288
+ export declare const getApiV21ShipnoticeItemsIdLocations: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticeItemsIdLocationsParams, params?: RequestParams) => Promise<APIV21EntitiesLocation[]>;
289
+ /**
290
+ * No description
291
+ *
292
+ * @tags shipnotice_items
293
+ * @name GetApiV21ShipnoticeItemsIdReceived
294
+ * @summary List receipts for a shipnotice item
295
+ * @request GET:/api/v2.1/shipnotice_items/{id}/received
296
+ */
297
+ export declare const getApiV21ShipnoticeItemsIdReceived: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticeItemsIdReceivedParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
120
298
  /**
121
299
  * No description
122
300
  *
@@ -126,3 +304,21 @@ export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: num
126
304
  * @request GET:/api/v2.1/shipnotice_items/count
127
305
  */
128
306
  export declare const getApiV21ShipnoticeItemsCount: (client: HttpClient, query: GetApiV21ShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
307
+ /**
308
+ * No description
309
+ *
310
+ * @tags shipnotice_items
311
+ * @name PutApiV21ShipnoticeItemsIdCallAction
312
+ * @summary Perform an action on an shipnotice_item
313
+ * @request PUT:/api/v2.1/shipnotice_items/{id}/call/{action}
314
+ */
315
+ export declare const putApiV21ShipnoticeItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV21ShipnoticeItemsIdCallAction: PutApiV21ShipnoticeItemsIdCallAction, params?: RequestParams) => Promise<void>;
316
+ /**
317
+ * No description
318
+ *
319
+ * @tags shipnotice_items
320
+ * @name PutApiV21ShipnoticeItemsIdCallAsyncAction
321
+ * @summary Perform an action on an shipnotice_item asynchronously
322
+ * @request PUT:/api/v2.1/shipnotice_items/{id}/call_async/{action}
323
+ */
324
+ export declare const putApiV21ShipnoticeItemsIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV21ShipnoticeItemsIdCallAsyncAction: PutApiV21ShipnoticeItemsIdCallAsyncAction, params?: RequestParams) => Promise<void>;