@simpleapps-com/augur-api 0.2.3 → 0.2.5

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 (196) hide show
  1. package/README.md +100 -0
  2. package/dist/cjs/client.d.ts +181 -0
  3. package/dist/cjs/client.d.ts.map +1 -1
  4. package/dist/cjs/client.js +449 -0
  5. package/dist/cjs/client.js.map +1 -1
  6. package/dist/cjs/core/base-client.d.ts +104 -0
  7. package/dist/cjs/core/base-client.d.ts.map +1 -1
  8. package/dist/cjs/core/base-client.js +201 -0
  9. package/dist/cjs/core/base-client.js.map +1 -1
  10. package/dist/cjs/index.d.ts +2 -1
  11. package/dist/cjs/index.d.ts.map +1 -1
  12. package/dist/cjs/index.js +1 -1
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/services/agr-site/client.d.ts +522 -2
  15. package/dist/cjs/services/agr-site/client.d.ts.map +1 -1
  16. package/dist/cjs/services/agr-site/client.js +565 -12
  17. package/dist/cjs/services/agr-site/client.js.map +1 -1
  18. package/dist/cjs/services/items/client.d.ts +2 -2
  19. package/dist/cjs/services/items/schemas/categories.d.ts +20 -20
  20. package/dist/cjs/services/joomla/client.d.ts +644 -99
  21. package/dist/cjs/services/joomla/client.d.ts.map +1 -1
  22. package/dist/cjs/services/joomla/client.js +467 -98
  23. package/dist/cjs/services/joomla/client.js.map +1 -1
  24. package/dist/cjs/services/nexus/client.d.ts +1096 -22
  25. package/dist/cjs/services/nexus/client.d.ts.map +1 -1
  26. package/dist/cjs/services/nexus/client.js +754 -22
  27. package/dist/cjs/services/nexus/client.js.map +1 -1
  28. package/dist/cjs/services/orders/client.d.ts +3 -3
  29. package/dist/cjs/services/orders/schemas/orders.d.ts +12 -12
  30. package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +22 -22
  31. package/dist/cjs/services/p21-core/client.d.ts +627 -0
  32. package/dist/cjs/services/p21-core/client.d.ts.map +1 -0
  33. package/dist/cjs/services/p21-core/client.js +704 -0
  34. package/dist/cjs/services/p21-core/client.js.map +1 -0
  35. package/dist/cjs/services/p21-core/index.d.ts +3 -0
  36. package/dist/cjs/services/p21-core/index.d.ts.map +1 -0
  37. package/dist/cjs/services/p21-core/index.js +21 -0
  38. package/dist/cjs/services/p21-core/index.js.map +1 -0
  39. package/dist/cjs/services/p21-core/schemas/address.d.ts +88 -0
  40. package/dist/cjs/services/p21-core/schemas/address.d.ts.map +1 -0
  41. package/dist/cjs/services/p21-core/schemas/address.js +45 -0
  42. package/dist/cjs/services/p21-core/schemas/address.js.map +1 -0
  43. package/dist/cjs/services/p21-core/schemas/cash-drawer.d.ts +96 -0
  44. package/dist/cjs/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
  45. package/dist/cjs/services/p21-core/schemas/cash-drawer.js +39 -0
  46. package/dist/cjs/services/p21-core/schemas/cash-drawer.js.map +1 -0
  47. package/dist/cjs/services/p21-core/schemas/codes.d.ts +54 -0
  48. package/dist/cjs/services/p21-core/schemas/codes.d.ts.map +1 -0
  49. package/dist/cjs/services/p21-core/schemas/codes.js +25 -0
  50. package/dist/cjs/services/p21-core/schemas/codes.js.map +1 -0
  51. package/dist/cjs/services/p21-core/schemas/company.d.ts +80 -0
  52. package/dist/cjs/services/p21-core/schemas/company.d.ts.map +1 -0
  53. package/dist/cjs/services/p21-core/schemas/company.js +35 -0
  54. package/dist/cjs/services/p21-core/schemas/company.js.map +1 -0
  55. package/dist/cjs/services/p21-core/schemas/health.d.ts +46 -0
  56. package/dist/cjs/services/p21-core/schemas/health.d.ts.map +1 -0
  57. package/dist/cjs/services/p21-core/schemas/health.js +7 -0
  58. package/dist/cjs/services/p21-core/schemas/health.js.map +1 -0
  59. package/dist/cjs/services/p21-core/schemas/index.d.ts +8 -0
  60. package/dist/cjs/services/p21-core/schemas/index.d.ts.map +1 -0
  61. package/dist/cjs/services/p21-core/schemas/index.js +25 -0
  62. package/dist/cjs/services/p21-core/schemas/index.js.map +1 -0
  63. package/dist/cjs/services/p21-core/schemas/location.d.ts +84 -0
  64. package/dist/cjs/services/p21-core/schemas/location.d.ts.map +1 -0
  65. package/dist/cjs/services/p21-core/schemas/location.js +35 -0
  66. package/dist/cjs/services/p21-core/schemas/location.js.map +1 -0
  67. package/dist/cjs/services/p21-core/schemas/payment-types.d.ts +39 -0
  68. package/dist/cjs/services/p21-core/schemas/payment-types.d.ts.map +1 -0
  69. package/dist/cjs/services/p21-core/schemas/payment-types.js +26 -0
  70. package/dist/cjs/services/p21-core/schemas/payment-types.js.map +1 -0
  71. package/dist/cjs/services/p21-core/schemas.d.ts +2 -0
  72. package/dist/cjs/services/p21-core/schemas.d.ts.map +1 -0
  73. package/dist/cjs/services/p21-core/schemas.js +19 -0
  74. package/dist/cjs/services/p21-core/schemas.js.map +1 -0
  75. package/dist/cjs/services/vmi/schemas/inventory.d.ts +6 -6
  76. package/dist/cjs/services/vmi/schemas/products.d.ts +6 -6
  77. package/dist/cjs/services/vmi/schemas/restock.d.ts +12 -12
  78. package/dist/esm/client.d.ts +181 -0
  79. package/dist/esm/client.d.ts.map +1 -1
  80. package/dist/esm/client.js +449 -0
  81. package/dist/esm/client.js.map +1 -1
  82. package/dist/esm/core/base-client.d.ts +104 -0
  83. package/dist/esm/core/base-client.d.ts.map +1 -1
  84. package/dist/esm/core/base-client.js +201 -0
  85. package/dist/esm/core/base-client.js.map +1 -1
  86. package/dist/esm/index.d.ts +2 -1
  87. package/dist/esm/index.d.ts.map +1 -1
  88. package/dist/esm/index.js +1 -1
  89. package/dist/esm/index.js.map +1 -1
  90. package/dist/esm/services/agr-site/client.d.ts +522 -2
  91. package/dist/esm/services/agr-site/client.d.ts.map +1 -1
  92. package/dist/esm/services/agr-site/client.js +565 -12
  93. package/dist/esm/services/agr-site/client.js.map +1 -1
  94. package/dist/esm/services/items/client.d.ts +2 -2
  95. package/dist/esm/services/items/schemas/categories.d.ts +20 -20
  96. package/dist/esm/services/joomla/client.d.ts +644 -99
  97. package/dist/esm/services/joomla/client.d.ts.map +1 -1
  98. package/dist/esm/services/joomla/client.js +467 -98
  99. package/dist/esm/services/joomla/client.js.map +1 -1
  100. package/dist/esm/services/nexus/client.d.ts +1096 -22
  101. package/dist/esm/services/nexus/client.d.ts.map +1 -1
  102. package/dist/esm/services/nexus/client.js +754 -22
  103. package/dist/esm/services/nexus/client.js.map +1 -1
  104. package/dist/esm/services/orders/client.d.ts +3 -3
  105. package/dist/esm/services/orders/schemas/orders.d.ts +12 -12
  106. package/dist/esm/services/orders/schemas/purchase-orders.d.ts +22 -22
  107. package/dist/esm/services/p21-core/client.d.ts +627 -0
  108. package/dist/esm/services/p21-core/client.d.ts.map +1 -0
  109. package/dist/esm/services/p21-core/client.js +700 -0
  110. package/dist/esm/services/p21-core/client.js.map +1 -0
  111. package/dist/esm/services/p21-core/index.d.ts +3 -0
  112. package/dist/esm/services/p21-core/index.d.ts.map +1 -0
  113. package/dist/esm/services/p21-core/index.js +3 -0
  114. package/dist/esm/services/p21-core/index.js.map +1 -0
  115. package/dist/esm/services/p21-core/schemas/address.d.ts +88 -0
  116. package/dist/esm/services/p21-core/schemas/address.d.ts.map +1 -0
  117. package/dist/esm/services/p21-core/schemas/address.js +42 -0
  118. package/dist/esm/services/p21-core/schemas/address.js.map +1 -0
  119. package/dist/esm/services/p21-core/schemas/cash-drawer.d.ts +96 -0
  120. package/dist/esm/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
  121. package/dist/esm/services/p21-core/schemas/cash-drawer.js +36 -0
  122. package/dist/esm/services/p21-core/schemas/cash-drawer.js.map +1 -0
  123. package/dist/esm/services/p21-core/schemas/codes.d.ts +54 -0
  124. package/dist/esm/services/p21-core/schemas/codes.d.ts.map +1 -0
  125. package/dist/esm/services/p21-core/schemas/codes.js +22 -0
  126. package/dist/esm/services/p21-core/schemas/codes.js.map +1 -0
  127. package/dist/esm/services/p21-core/schemas/company.d.ts +80 -0
  128. package/dist/esm/services/p21-core/schemas/company.d.ts.map +1 -0
  129. package/dist/esm/services/p21-core/schemas/company.js +32 -0
  130. package/dist/esm/services/p21-core/schemas/company.js.map +1 -0
  131. package/dist/esm/services/p21-core/schemas/health.d.ts +46 -0
  132. package/dist/esm/services/p21-core/schemas/health.d.ts.map +1 -0
  133. package/dist/esm/services/p21-core/schemas/health.js +4 -0
  134. package/dist/esm/services/p21-core/schemas/health.js.map +1 -0
  135. package/dist/esm/services/p21-core/schemas/index.d.ts +8 -0
  136. package/dist/esm/services/p21-core/schemas/index.d.ts.map +1 -0
  137. package/dist/esm/services/p21-core/schemas/index.js +9 -0
  138. package/dist/esm/services/p21-core/schemas/index.js.map +1 -0
  139. package/dist/esm/services/p21-core/schemas/location.d.ts +84 -0
  140. package/dist/esm/services/p21-core/schemas/location.d.ts.map +1 -0
  141. package/dist/esm/services/p21-core/schemas/location.js +32 -0
  142. package/dist/esm/services/p21-core/schemas/location.js.map +1 -0
  143. package/dist/esm/services/p21-core/schemas/payment-types.d.ts +39 -0
  144. package/dist/esm/services/p21-core/schemas/payment-types.d.ts.map +1 -0
  145. package/dist/esm/services/p21-core/schemas/payment-types.js +23 -0
  146. package/dist/esm/services/p21-core/schemas/payment-types.js.map +1 -0
  147. package/dist/esm/services/p21-core/schemas.d.ts +2 -0
  148. package/dist/esm/services/p21-core/schemas.d.ts.map +1 -0
  149. package/dist/esm/services/p21-core/schemas.js +3 -0
  150. package/dist/esm/services/p21-core/schemas.js.map +1 -0
  151. package/dist/esm/services/vmi/schemas/inventory.d.ts +6 -6
  152. package/dist/esm/services/vmi/schemas/products.d.ts +6 -6
  153. package/dist/esm/services/vmi/schemas/restock.d.ts +12 -12
  154. package/dist/types/client.d.ts +181 -0
  155. package/dist/types/client.d.ts.map +1 -1
  156. package/dist/types/core/base-client.d.ts +104 -0
  157. package/dist/types/core/base-client.d.ts.map +1 -1
  158. package/dist/types/index.d.ts +2 -1
  159. package/dist/types/index.d.ts.map +1 -1
  160. package/dist/types/services/agr-site/client.d.ts +522 -2
  161. package/dist/types/services/agr-site/client.d.ts.map +1 -1
  162. package/dist/types/services/items/client.d.ts +2 -2
  163. package/dist/types/services/items/schemas/categories.d.ts +20 -20
  164. package/dist/types/services/joomla/client.d.ts +644 -99
  165. package/dist/types/services/joomla/client.d.ts.map +1 -1
  166. package/dist/types/services/nexus/client.d.ts +1096 -22
  167. package/dist/types/services/nexus/client.d.ts.map +1 -1
  168. package/dist/types/services/orders/client.d.ts +3 -3
  169. package/dist/types/services/orders/schemas/orders.d.ts +12 -12
  170. package/dist/types/services/orders/schemas/purchase-orders.d.ts +22 -22
  171. package/dist/types/services/p21-core/client.d.ts +627 -0
  172. package/dist/types/services/p21-core/client.d.ts.map +1 -0
  173. package/dist/types/services/p21-core/index.d.ts +3 -0
  174. package/dist/types/services/p21-core/index.d.ts.map +1 -0
  175. package/dist/types/services/p21-core/schemas/address.d.ts +88 -0
  176. package/dist/types/services/p21-core/schemas/address.d.ts.map +1 -0
  177. package/dist/types/services/p21-core/schemas/cash-drawer.d.ts +96 -0
  178. package/dist/types/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
  179. package/dist/types/services/p21-core/schemas/codes.d.ts +54 -0
  180. package/dist/types/services/p21-core/schemas/codes.d.ts.map +1 -0
  181. package/dist/types/services/p21-core/schemas/company.d.ts +80 -0
  182. package/dist/types/services/p21-core/schemas/company.d.ts.map +1 -0
  183. package/dist/types/services/p21-core/schemas/health.d.ts +46 -0
  184. package/dist/types/services/p21-core/schemas/health.d.ts.map +1 -0
  185. package/dist/types/services/p21-core/schemas/index.d.ts +8 -0
  186. package/dist/types/services/p21-core/schemas/index.d.ts.map +1 -0
  187. package/dist/types/services/p21-core/schemas/location.d.ts +84 -0
  188. package/dist/types/services/p21-core/schemas/location.d.ts.map +1 -0
  189. package/dist/types/services/p21-core/schemas/payment-types.d.ts +39 -0
  190. package/dist/types/services/p21-core/schemas/payment-types.d.ts.map +1 -0
  191. package/dist/types/services/p21-core/schemas.d.ts +2 -0
  192. package/dist/types/services/p21-core/schemas.d.ts.map +1 -0
  193. package/dist/types/services/vmi/schemas/inventory.d.ts +6 -6
  194. package/dist/types/services/vmi/schemas/products.d.ts +6 -6
  195. package/dist/types/services/vmi/schemas/restock.d.ts +12 -12
  196. package/package.json +1 -1
@@ -6,6 +6,13 @@ const schemas_1 = require("./schemas");
6
6
  /**
7
7
  * Nexus API Client
8
8
  * @description Client for interacting with Nexus microservice API endpoints for comprehensive warehouse management
9
+ * @fullPath api.nexus
10
+ * @service nexus
11
+ * @domain warehouse-management
12
+ * @discoverable true
13
+ * @searchTerms ["nexus", "warehouse management", "inventory transfers", "receiving", "bin transfers", "warehouse operations"]
14
+ * @relatedEndpoints ["api.nexus.binTransfers", "api.nexus.receivings", "api.nexus.transfers", "api.nexus.health"]
15
+ * @commonPatterns ["Warehouse management operations", "Inventory movement tracking", "Receiving and transfer processing"]
9
16
  * @example
10
17
  * ```typescript
11
18
  * import { HTTPClient } from '@augur/api-client/core';
@@ -54,6 +61,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
54
61
  /**
55
62
  * Simple health check endpoint that doesn't require authentication
56
63
  * @description Returns "pong" response for basic connectivity testing
64
+ * @fullPath api.nexus.health.ping
65
+ * @service nexus
66
+ * @domain service-monitoring
67
+ * @dataMethod N/A (simple response)
68
+ * @discoverable true
69
+ * @searchTerms ["ping", "health check", "connectivity test", "service alive", "basic health"]
70
+ * @relatedEndpoints ["api.nexus.health.check"]
71
+ * @commonPatterns ["Test service connectivity", "Basic health check", "Ping service"]
57
72
  * @returns Simple pong response
58
73
  * @throws ValidationError When response is malformed
59
74
  * @example
@@ -66,6 +81,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
66
81
  /**
67
82
  * Comprehensive health check with authentication and site validation
68
83
  * @description Validates authentication, site configuration, and service health
84
+ * @fullPath api.nexus.health.check
85
+ * @service nexus
86
+ * @domain service-monitoring
87
+ * @dataMethod N/A (returns health data)
88
+ * @discoverable true
89
+ * @searchTerms ["health check", "service health", "authentication check", "site validation", "comprehensive health"]
90
+ * @relatedEndpoints ["api.nexus.health.ping"]
91
+ * @commonPatterns ["Check service health", "Validate authentication", "Full health status"]
69
92
  * @returns Health check response with site information
70
93
  * @throws ValidationError When response is malformed
71
94
  * @example
@@ -84,6 +107,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
84
107
  /**
85
108
  * Retrieve a list of bin transfer headers with optional filtering
86
109
  * @description Returns all bin transfer headers with pagination and status filtering support
110
+ * @fullPath api.nexus.binTransfers.list
111
+ * @service nexus
112
+ * @domain warehouse-management
113
+ * @dataMethod listData
114
+ * @discoverable true
115
+ * @searchTerms ["bin transfers", "inventory movement", "warehouse transfers", "bin to bin", "list transfers"]
116
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.create"]
117
+ * @commonPatterns ["List all bin transfers", "Get transfer history", "Find transfers by status"]
87
118
  * @param params Optional filtering and pagination parameters
88
119
  * @returns Array of bin transfer headers
89
120
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -99,6 +130,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
99
130
  /**
100
131
  * Retrieve details for a specific bin transfer header
101
132
  * @description Returns complete details for a bin transfer including JSON data and properties
133
+ * @fullPath api.nexus.binTransfers.get
134
+ * @service nexus
135
+ * @domain warehouse-management
136
+ * @dataMethod getData
137
+ * @discoverable true
138
+ * @searchTerms ["get bin transfer", "transfer details", "bin transfer by id", "transfer header"]
139
+ * @relatedEndpoints ["api.nexus.binTransfers.list", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.update"]
140
+ * @commonPatterns ["Get transfer details by ID", "View specific bin transfer", "Retrieve transfer information"]
102
141
  * @param binTransferHdrUid Bin transfer header unique identifier
103
142
  * @returns Complete bin transfer details
104
143
  * @throws ValidationError When response is malformed
@@ -113,6 +152,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
113
152
  /**
114
153
  * Retrieve bin transfer status with detailed line items
115
154
  * @description Returns complete bin transfer header with associated line items for status checking
155
+ * @fullPath api.nexus.binTransfers.getBinTransferStatus
156
+ * @service nexus
157
+ * @domain warehouse-management
158
+ * @dataMethod getBinTransferStatusData
159
+ * @discoverable true
160
+ * @searchTerms ["bin transfer status", "transfer line items", "transfer progress", "bin transfer details with lines"]
161
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.list", "api.nexus.binTransfers.update"]
162
+ * @commonPatterns ["Check transfer status", "View transfer line items", "Get transfer progress"]
116
163
  * @param binTransferHdrUid Bin transfer header unique identifier
117
164
  * @returns Bin transfer with line items
118
165
  * @throws ValidationError When response is malformed
@@ -131,6 +178,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
131
178
  /**
132
179
  * Create a new bin transfer header with associated line items
133
180
  * @description Creates a bin transfer with complete transfer line items for inventory movement
181
+ * @fullPath api.nexus.binTransfers.create
182
+ * @service nexus
183
+ * @domain warehouse-management
184
+ * @dataMethod createData
185
+ * @discoverable true
186
+ * @searchTerms ["create bin transfer", "new transfer", "move inventory", "bin to bin transfer", "inventory movement"]
187
+ * @relatedEndpoints ["api.nexus.binTransfers.list", "api.nexus.binTransfers.get", "api.nexus.binTransfers.update"]
188
+ * @commonPatterns ["Create new bin transfer", "Move items between bins", "Start inventory transfer"]
134
189
  * @param transferData Complete bin transfer data including user, location, and transfer lines
135
190
  * @returns Created bin transfer header details
136
191
  * @throws ValidationError When request is invalid or response is malformed
@@ -158,6 +213,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
158
213
  /**
159
214
  * Update an existing bin transfer header
160
215
  * @description Updates bin transfer status, process codes, and additional data
216
+ * @fullPath api.nexus.binTransfers.update
217
+ * @service nexus
218
+ * @domain warehouse-management
219
+ * @dataMethod updateData
220
+ * @discoverable true
221
+ * @searchTerms ["update bin transfer", "modify transfer", "change transfer status", "update transfer"]
222
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.delete"]
223
+ * @commonPatterns ["Update transfer status", "Modify bin transfer", "Change transfer details"]
161
224
  * @param binTransferHdrUid Bin transfer header unique identifier
162
225
  * @param updateData Fields to update on the bin transfer
163
226
  * @returns Updated bin transfer details
@@ -175,6 +238,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
175
238
  /**
176
239
  * Soft delete a bin transfer header
177
240
  * @description Marks a bin transfer as deleted by setting status code to 700
241
+ * @fullPath api.nexus.binTransfers.delete
242
+ * @service nexus
243
+ * @domain warehouse-management
244
+ * @dataMethod deleteData
245
+ * @discoverable true
246
+ * @searchTerms ["delete bin transfer", "remove transfer", "cancel transfer", "soft delete"]
247
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.list", "api.nexus.binTransfers.update"]
248
+ * @commonPatterns ["Delete bin transfer", "Cancel transfer", "Remove transfer record"]
178
249
  * @param binTransferHdrUid Bin transfer header unique identifier
179
250
  * @returns Deleted bin transfer details with updated status
180
251
  * @throws ValidationError When response is malformed
@@ -185,6 +256,90 @@ class NexusClient extends base_client_1.BaseServiceClient {
185
256
  * ```
186
257
  */
187
258
  delete: this.createDeleteMethod('/bin-transfer/{binTransferHdrUid}', schemas_1.BinTransferDeleteResponseSchema),
259
+ /**
260
+ * Retrieve a list of bin transfer headers with optional filtering (data only)
261
+ * @description Returns only the data array from bin transfer headers response
262
+ * @param params Optional filtering and pagination parameters
263
+ * @returns Array of bin transfer headers (data only)
264
+ * @throws ValidationError When parameters are invalid or response is malformed
265
+ * @example
266
+ * ```typescript
267
+ * const transfersData = await client.binTransfers.listData({ limit: 20, statusCd: 704 });
268
+ * transfersData.forEach(transfer => {
269
+ * console.log(`Transfer ${transfer.binTransferHdrUid}: Status ${transfer.statusCd}`);
270
+ * });
271
+ * ```
272
+ */
273
+ listData: async (params) => {
274
+ const response = await this.binTransfers.list(params);
275
+ return response.data;
276
+ },
277
+ /**
278
+ * Retrieve details for a specific bin transfer header (data only)
279
+ * @description Returns only the data from bin transfer details response
280
+ * @param binTransferHdrUid Bin transfer header unique identifier
281
+ * @returns Bin transfer details (data only)
282
+ * @throws ValidationError When response is malformed
283
+ * @example
284
+ * ```typescript
285
+ * const transferData = await client.binTransfers.getData(12345);
286
+ * console.log('Transfer details:', transferData.jsonData);
287
+ * ```
288
+ */
289
+ getData: async (binTransferHdrUid) => {
290
+ const response = await this.binTransfers.get(binTransferHdrUid);
291
+ return response.data;
292
+ },
293
+ /**
294
+ * Retrieve bin transfer status with detailed line items (data only)
295
+ * @description Returns only the data from bin transfer status response
296
+ * @param binTransferHdrUid Bin transfer header unique identifier
297
+ * @returns Bin transfer with line items (data only)
298
+ * @throws ValidationError When response is malformed
299
+ * @example
300
+ * ```typescript
301
+ * const statusData = await client.binTransfers.getBinTransferStatusData(12345);
302
+ * console.log('Transfer lines:', statusData.lines?.length || 0);
303
+ * ```
304
+ */
305
+ getBinTransferStatusData: async (binTransferHdrUid) => {
306
+ const response = await this.binTransfers.getBinTransferStatus(binTransferHdrUid);
307
+ return response.data;
308
+ },
309
+ /**
310
+ * Create a new bin transfer header with associated line items (data only)
311
+ * @description Returns only the data from created bin transfer response
312
+ * @param transferData Complete bin transfer data including user, location, and transfer lines
313
+ * @returns Created bin transfer header details (data only)
314
+ * @throws ValidationError When request is invalid or response is malformed
315
+ */
316
+ createData: async (transferData) => {
317
+ const response = await this.binTransfers.create(transferData);
318
+ return response.data;
319
+ },
320
+ /**
321
+ * Update an existing bin transfer header (data only)
322
+ * @description Returns only the data from updated bin transfer response
323
+ * @param binTransferHdrUid Bin transfer header unique identifier
324
+ * @param updateData Fields to update on the bin transfer
325
+ * @returns Updated bin transfer details (data only)
326
+ * @throws ValidationError When request is invalid or response is malformed
327
+ */
328
+ updateData: async (binTransferHdrUid, updateData) => {
329
+ const response = await this.binTransfers.update(binTransferHdrUid, updateData);
330
+ return response.data;
331
+ },
332
+ /**
333
+ * Soft delete a bin transfer header (data only)
334
+ * @description Returns only the data from deleted bin transfer response
335
+ * @param binTransferHdrUid Bin transfer header unique identifier
336
+ * @returns Deleted bin transfer details (data only)
337
+ * @throws ValidationError When response is malformed
338
+ */
339
+ deleteData: async (binTransferHdrUid) => {
340
+ const response = await this.binTransfers.delete(binTransferHdrUid);
341
+ return response.data;
342
+ },
188
343
  };
189
344
  /**
190
345
  * Receiving endpoints
@@ -194,6 +349,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
194
349
  /**
195
350
  * Retrieve a list of receiving documents with optional filtering
196
351
  * @description Returns receiving documents with pagination and filtering by PO number or status
352
+ * @fullPath api.nexus.receivings.list
353
+ * @service nexus
354
+ * @domain warehouse-management
355
+ * @dataMethod listData
356
+ * @discoverable true
357
+ * @searchTerms ["receiving documents", "purchase order receipts", "receiving list", "PO receipts", "inbound inventory"]
358
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.create", "api.nexus.purchaseOrderReceipts.list"]
359
+ * @commonPatterns ["List all receiving documents", "Get receiving history", "Find receipts by PO number"]
197
360
  * @param params Optional filtering and pagination parameters
198
361
  * @returns Array of receiving documents
199
362
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -209,6 +372,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
209
372
  /**
210
373
  * Retrieve details for a specific receiving document
211
374
  * @description Returns complete details for a receiving document including JSON data and properties
375
+ * @fullPath api.nexus.receivings.get
376
+ * @service nexus
377
+ * @domain warehouse-management
378
+ * @dataMethod getData
379
+ * @discoverable true
380
+ * @searchTerms ["get receiving", "receiving details", "receiving by id", "receipt details"]
381
+ * @relatedEndpoints ["api.nexus.receivings.list", "api.nexus.receivings.update", "api.nexus.purchaseOrderReceipts.get"]
382
+ * @commonPatterns ["Get receiving details by ID", "View specific receipt", "Retrieve receiving information"]
212
383
  * @param receivingUid Receiving unique identifier
213
384
  * @returns Complete receiving document details
214
385
  * @throws ValidationError When response is malformed
@@ -223,6 +394,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
223
394
  /**
224
395
  * Create a new receiving document
225
396
  * @description Creates a receiving document for purchase order receipt processing
397
+ * @fullPath api.nexus.receivings.create
398
+ * @service nexus
399
+ * @domain warehouse-management
400
+ * @dataMethod createData
401
+ * @discoverable true
402
+ * @searchTerms ["create receiving", "new receipt", "receive inventory", "PO receipt", "inbound processing"]
403
+ * @relatedEndpoints ["api.nexus.receivings.list", "api.nexus.receivings.get", "api.nexus.purchaseOrderReceipts.create"]
404
+ * @commonPatterns ["Create new receiving document", "Process PO receipt", "Start receiving process"]
226
405
  * @param receivingData Complete receiving data including PO number and optional details
227
406
  * @returns Created receiving document details
228
407
  * @throws ValidationError When request is invalid or response is malformed
@@ -240,7 +419,20 @@ class NexusClient extends base_client_1.BaseServiceClient {
240
419
  create: this.createCreateMethod('/receiving', schemas_1.ReceivingCreateRequestSchema, schemas_1.ReceivingCreateResponseSchema),
241
420
  /**
242
421
  * Update an existing receiving document
243
- * @description Updates receiving status, process codes, and messages
422
+ * @description Updates receiving status, process codes, messages, and tracking information
423
+ * @fullPath api.nexus.receivings.update
424
+ * @service nexus
425
+ * @domain warehouse-management
426
+ * @dataMethod updateData
427
+ * @discoverable true
428
+ * @searchTerms ["update receiving", "modify receiving", "change receiving status", "update receipt", "receiving modification"]
429
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.list", "api.nexus.receivings.delete"]
430
+ * @commonPatterns ["Update receiving status", "Modify receiving details", "Change receiving properties"]
431
+ * @workflow ["receiving-processing", "status-updates", "receipt-management"]
432
+ * @prerequisites ["Valid receiving ID", "Update permissions", "Proper status transitions"]
433
+ * @nextSteps ["api.nexus.receivings.get for verification", "Related processing workflows"]
434
+ * @businessRules ["Status changes must follow valid transitions", "Updates create audit trail entries", "Some fields may be immutable"]
435
+ * @functionalArea "warehouse-management"
244
436
  * @param receivingUid Receiving unique identifier
245
437
  * @param updateData Fields to update on the receiving document
246
438
  * @returns Updated receiving details
@@ -259,6 +451,19 @@ class NexusClient extends base_client_1.BaseServiceClient {
259
451
  /**
260
452
  * Soft delete a receiving document
261
453
  * @description Marks a receiving document as deleted by setting status code to 700
454
+ * @fullPath api.nexus.receivings.delete
455
+ * @service nexus
456
+ * @domain warehouse-management
457
+ * @dataMethod deleteData
458
+ * @discoverable true
459
+ * @searchTerms ["delete receiving", "remove receiving", "cancel receiving", "soft delete receipt"]
460
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.list", "api.nexus.receivings.update"]
461
+ * @commonPatterns ["Delete receiving document", "Cancel receiving", "Remove receiving record"]
462
+ * @workflow ["receiving-cancellation", "cleanup-processes", "audit-trail-maintenance"]
463
+ * @prerequisites ["Valid receiving ID", "Delete permissions", "Receiving must be in deletable state"]
464
+ * @nextSteps ["Cleanup related documents if needed", "Update related processes"]
465
+ * @businessRules ["Soft delete preserves audit trail", "Status set to 700", "Related documents may need attention"]
466
+ * @functionalArea "warehouse-management"
262
467
  * @param receivingUid Receiving unique identifier
263
468
  * @returns Deleted receiving details with updated status
264
469
  * @throws ValidationError When response is malformed
@@ -269,6 +474,62 @@ class NexusClient extends base_client_1.BaseServiceClient {
269
474
  * ```
270
475
  */
271
476
  delete: this.createDeleteMethod('/receiving/{receivingUid}', schemas_1.ReceivingDeleteResponseSchema),
477
+ /**
478
+ * Retrieve a list of receiving documents with optional filtering (data only)
479
+ * @description Returns only the data array from receiving documents response
480
+ * @param params Optional filtering and pagination parameters
481
+ * @returns Array of receiving documents (data only)
482
+ * @throws ValidationError When parameters are invalid or response is malformed
483
+ */
484
+ listData: async (params) => {
485
+ const response = await this.receivings.list(params);
486
+ return response.data;
487
+ },
488
+ /**
489
+ * Retrieve details for a specific receiving document (data only)
490
+ * @description Returns only the data from receiving document details response
491
+ * @param receivingUid Receiving unique identifier
492
+ * @returns Receiving document details (data only)
493
+ * @throws ValidationError When response is malformed
494
+ */
495
+ getData: async (receivingUid) => {
496
+ const response = await this.receivings.get(receivingUid);
497
+ return response.data;
498
+ },
499
+ /**
500
+ * Create a new receiving document (data only)
501
+ * @description Returns only the data from created receiving document response
502
+ * @param receivingData Complete receiving data including PO number and optional details
503
+ * @returns Created receiving document details (data only)
504
+ * @throws ValidationError When request is invalid or response is malformed
505
+ */
506
+ createData: async (receivingData) => {
507
+ const response = await this.receivings.create(receivingData);
508
+ return response.data;
509
+ },
510
+ /**
511
+ * Update an existing receiving document (data only)
512
+ * @description Returns only the data from updated receiving response
513
+ * @param receivingUid Receiving unique identifier
514
+ * @param updateData Fields to update on the receiving document
515
+ * @returns Updated receiving details (data only)
516
+ * @throws ValidationError When request is invalid or response is malformed
517
+ */
518
+ updateData: async (receivingUid, updateData) => {
519
+ const response = await this.receivings.update(receivingUid, updateData);
520
+ return response.data;
521
+ },
522
+ /**
523
+ * Soft delete a receiving document (data only)
524
+ * @description Returns only the data from deleted receiving response
525
+ * @param receivingUid Receiving unique identifier
526
+ * @returns Deleted receiving details (data only)
527
+ * @throws ValidationError When response is malformed
528
+ */
529
+ deleteData: async (receivingUid) => {
530
+ const response = await this.receivings.delete(receivingUid);
531
+ return response.data;
532
+ },
272
533
  };
273
534
  /**
274
535
  * Transfer endpoints
@@ -278,6 +539,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
278
539
  /**
279
540
  * Retrieve a list of transfer documents with optional filtering
280
541
  * @description Returns transfer documents with pagination and filtering by reference number or status
542
+ * @fullPath api.nexus.transfers.list
543
+ * @service nexus
544
+ * @domain warehouse-management
545
+ * @dataMethod listData
546
+ * @discoverable true
547
+ * @searchTerms ["transfers", "location transfers", "inventory transfer", "warehouse transfer", "transfer documents"]
548
+ * @relatedEndpoints ["api.nexus.transfers.get", "api.nexus.transfers.create", "api.nexus.transferReceipts.list"]
549
+ * @commonPatterns ["List all transfers", "Get transfer history", "Find transfers by reference"]
281
550
  * @param params Optional filtering and pagination parameters
282
551
  * @returns Array of transfer documents
283
552
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -293,6 +562,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
293
562
  /**
294
563
  * Retrieve details for a specific transfer document
295
564
  * @description Returns complete details for a transfer document including JSON data
565
+ * @fullPath api.nexus.transfers.get
566
+ * @service nexus
567
+ * @domain warehouse-management
568
+ * @dataMethod getData
569
+ * @discoverable true
570
+ * @searchTerms ["get transfer", "transfer details", "transfer by id", "transfer document"]
571
+ * @relatedEndpoints ["api.nexus.transfers.list", "api.nexus.transfers.update", "api.nexus.transferReceipts.get"]
572
+ * @commonPatterns ["Get transfer details by ID", "View specific transfer", "Retrieve transfer information"]
296
573
  * @param transferUid Transfer unique identifier
297
574
  * @returns Complete transfer document details
298
575
  * @throws ValidationError When response is malformed
@@ -307,6 +584,14 @@ class NexusClient extends base_client_1.BaseServiceClient {
307
584
  /**
308
585
  * Create a new transfer document
309
586
  * @description Creates a transfer document for inventory movement between locations
587
+ * @fullPath api.nexus.transfers.create
588
+ * @service nexus
589
+ * @domain warehouse-management
590
+ * @dataMethod createData
591
+ * @discoverable true
592
+ * @searchTerms ["create transfer", "new transfer", "location transfer", "inventory movement", "warehouse transfer"]
593
+ * @relatedEndpoints ["api.nexus.transfers.list", "api.nexus.transfers.get", "api.nexus.transferReceipts.create"]
594
+ * @commonPatterns ["Create new transfer", "Move inventory between locations", "Start transfer process"]
310
595
  * @param transferData Complete transfer data including reference and location details
311
596
  * @returns Created transfer document details
312
597
  * @throws ValidationError When request is invalid or response is malformed
@@ -350,81 +635,358 @@ class NexusClient extends base_client_1.BaseServiceClient {
350
635
  * ```
351
636
  */
352
637
  delete: this.createDeleteMethod('/transfer/{transferUid}', schemas_1.TransferDeleteResponseSchema),
638
+ /**
639
+ * Retrieve a list of transfer documents with optional filtering (data only)
640
+ * @description Returns only the data array from transfer documents response
641
+ * @param params Optional filtering and pagination parameters
642
+ * @returns Array of transfer documents (data only)
643
+ * @throws ValidationError When parameters are invalid or response is malformed
644
+ */
645
+ listData: async (params) => {
646
+ const response = await this.transfers.list(params);
647
+ return response.data;
648
+ },
649
+ /**
650
+ * Retrieve details for a specific transfer document (data only)
651
+ * @description Returns only the data from transfer document details response
652
+ * @param transferUid Transfer unique identifier
653
+ * @returns Transfer document details (data only)
654
+ * @throws ValidationError When response is malformed
655
+ */
656
+ getData: async (transferUid) => {
657
+ const response = await this.transfers.get(transferUid);
658
+ return response.data;
659
+ },
660
+ /**
661
+ * Create a new transfer document (data only)
662
+ * @description Returns only the data from created transfer document response
663
+ * @param transferData Complete transfer data including reference and location details
664
+ * @returns Created transfer document details (data only)
665
+ * @throws ValidationError When request is invalid or response is malformed
666
+ */
667
+ createData: async (transferData) => {
668
+ const response = await this.transfers.create(transferData);
669
+ return response.data;
670
+ },
671
+ /**
672
+ * Update an existing transfer document (data only)
673
+ * @description Returns only the data from updated transfer response
674
+ * @param transferUid Transfer unique identifier
675
+ * @param updateData Fields to update on the transfer document
676
+ * @returns Updated transfer details (data only)
677
+ * @throws ValidationError When request is invalid or response is malformed
678
+ */
679
+ updateData: async (transferUid, updateData) => {
680
+ const response = await this.transfers.update(transferUid, updateData);
681
+ return response.data;
682
+ },
683
+ /**
684
+ * Soft delete a transfer document (data only)
685
+ * @description Returns only the data from deleted transfer response
686
+ * @param transferUid Transfer unique identifier
687
+ * @returns Deleted transfer details (data only)
688
+ * @throws ValidationError When response is malformed
689
+ */
690
+ deleteData: async (transferUid) => {
691
+ const response = await this.transfers.delete(transferUid);
692
+ return response.data;
693
+ },
353
694
  };
354
695
  /**
355
696
  * Purchase Order Receipt endpoints
356
- * @description Methods for managing purchase order receipt documents
697
+ * @description Methods for managing purchase order receipt documents for comprehensive receipt tracking and processing
357
698
  */
358
699
  this.purchaseOrderReceipts = {
359
700
  /**
360
- * Retrieve a list of purchase order receipt documents
361
- * @description Returns purchase order receipts with pagination and filtering support
701
+ * Retrieve a list of purchase order receipt documents with optional filtering
702
+ * @description Returns purchase order receipts with pagination and filtering by PO number, status, or receipt date
703
+ * @fullPath api.nexus.purchaseOrderReceipts.list
704
+ * @service nexus
705
+ * @domain warehouse-management
706
+ * @dataMethod listData
707
+ * @discoverable true
708
+ * @searchTerms ["purchase order receipts", "PO receipts", "receipt documents", "receiving receipts", "purchase receipts"]
709
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.create", "api.nexus.receivings.list"]
710
+ * @commonPatterns ["List all PO receipts", "Get receipt history", "Find receipts by PO number"]
711
+ * @workflow ["purchase-order-processing", "receiving-workflow", "receipt-management"]
712
+ * @prerequisites ["Valid authentication token", "Warehouse management permissions"]
713
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for details", "api.nexus.purchaseOrderReceipts.update for modifications"]
714
+ * @businessRules ["Receipts tied to specific PO numbers", "Status codes indicate processing stage", "Pagination required for large datasets"]
715
+ * @functionalArea "purchase-order-and-receipt-management"
716
+ * @caching "Cache for 10 minutes, invalidate on receipt changes"
717
+ * @performance "Supports filtering by PO number for faster searches"
362
718
  * @param params Optional filtering and pagination parameters
363
719
  * @returns Array of purchase order receipt documents
364
720
  * @throws ValidationError When parameters are invalid or response is malformed
721
+ * @example
722
+ * ```typescript
723
+ * const receipts = await client.purchaseOrderReceipts.list({ limit: 30, poNo: 67890 });
724
+ * receipts.data.forEach(receipt => {
725
+ * console.log(`Receipt ${receipt.purchaseOrderReceiptUid}: PO ${receipt.poNo}`);
726
+ * });
727
+ * ```
365
728
  */
366
729
  list: this.createListMethod('/purchase-order-receipt', schemas_1.PurchaseOrderReceiptListParamsSchema, schemas_1.PurchaseOrderReceiptListResponseSchema),
367
730
  /**
368
- * Retrieve details for a specific purchase order receipt
369
- * @description Returns complete details for a purchase order receipt document
731
+ * Retrieve details for a specific purchase order receipt document
732
+ * @description Returns complete details for a purchase order receipt including JSON data and tracking information
733
+ * @fullPath api.nexus.purchaseOrderReceipts.get
734
+ * @service nexus
735
+ * @domain warehouse-management
736
+ * @dataMethod getData
737
+ * @discoverable true
738
+ * @searchTerms ["get PO receipt", "receipt details", "purchase order receipt by id", "receipt document"]
739
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.update", "api.nexus.receivings.get"]
740
+ * @commonPatterns ["Get receipt details by ID", "View specific PO receipt", "Retrieve receipt information"]
741
+ * @workflow ["receipt-verification", "purchase-order-processing", "audit-trail"]
742
+ * @prerequisites ["Valid receipt ID", "Read permissions for receipts"]
743
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.update for modifications", "api.nexus.receivings.get for receiving details"]
744
+ * @businessRules ["Receipt must exist and be accessible", "Includes complete audit trail"]
745
+ * @functionalArea "purchase-order-and-receipt-management"
370
746
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
371
747
  * @returns Complete purchase order receipt details
372
748
  * @throws ValidationError When response is malformed
749
+ * @example
750
+ * ```typescript
751
+ * const receipt = await client.purchaseOrderReceipts.get(98765);
752
+ * console.log('Receipt details:', receipt.data.jsonData);
753
+ * console.log('PO Number:', receipt.data.poNo);
754
+ * ```
373
755
  */
374
756
  get: this.createGetMethod('/purchase-order-receipt/{purchaseOrderReceiptUid}', schemas_1.PurchaseOrderReceiptGetResponseSchema),
375
757
  /**
376
758
  * Create a new purchase order receipt document
377
- * @description Creates a purchase order receipt document for tracking
759
+ * @description Creates a purchase order receipt document for comprehensive tracking and audit trail
760
+ * @fullPath api.nexus.purchaseOrderReceipts.create
761
+ * @service nexus
762
+ * @domain warehouse-management
763
+ * @dataMethod createData
764
+ * @discoverable true
765
+ * @searchTerms ["create PO receipt", "new receipt", "purchase order receipt", "receipt creation", "document receipt"]
766
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.get", "api.nexus.receivings.create"]
767
+ * @commonPatterns ["Create new PO receipt", "Document receipt process", "Start receipt tracking"]
768
+ * @workflow ["receipt-creation", "purchase-order-processing", "document-generation"]
769
+ * @prerequisites ["Valid PO information", "Receipt creation permissions", "Required receipt data"]
770
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for verification", "api.nexus.purchaseOrderReceipts.update for status changes"]
771
+ * @businessRules ["Must include valid PO reference", "Receipt data structure must be valid", "Creates audit trail entry"]
772
+ * @functionalArea "purchase-order-and-receipt-management"
378
773
  * @param receiptData Complete purchase order receipt data
379
774
  * @returns Created purchase order receipt details
380
775
  * @throws ValidationError When request is invalid or response is malformed
776
+ * @example
777
+ * ```typescript
778
+ * const receipt = await client.purchaseOrderReceipts.create({
779
+ * poNo: 67890,
780
+ * referenceNo: 'RECEIPT001',
781
+ * jsonData: JSON.stringify({ items: [{ itemId: 'ITEM001', receivedQty: 50 }] }),
782
+ * properties: JSON.stringify({ supplier: 'ABC Supply', receiptDate: '2024-01-15' })
783
+ * });
784
+ * ```
381
785
  */
382
786
  create: this.createCreateMethod('/purchase-order-receipt', schemas_1.PurchaseOrderReceiptCreateRequestSchema, schemas_1.PurchaseOrderReceiptCreateResponseSchema),
383
787
  /**
384
- * Update an existing purchase order receipt
385
- * @description Updates purchase order receipt status and properties
788
+ * Update an existing purchase order receipt document
789
+ * @description Updates purchase order receipt status, properties, and tracking information
790
+ * @fullPath api.nexus.purchaseOrderReceipts.update
791
+ * @service nexus
792
+ * @domain warehouse-management
793
+ * @dataMethod updateData
794
+ * @discoverable true
795
+ * @searchTerms ["update PO receipt", "modify receipt", "change receipt status", "update receipt", "receipt modification"]
796
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.delete"]
797
+ * @commonPatterns ["Update receipt status", "Modify receipt details", "Change receipt properties"]
798
+ * @workflow ["receipt-processing", "status-updates", "audit-trail-maintenance"]
799
+ * @prerequisites ["Valid receipt ID", "Update permissions", "Proper status transitions"]
800
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for verification", "Related processing workflows"]
801
+ * @businessRules ["Status changes must follow valid transitions", "Updates create audit trail entries", "Some fields may be immutable"]
802
+ * @functionalArea "purchase-order-and-receipt-management"
386
803
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
387
804
  * @param updateData Fields to update on the purchase order receipt
388
805
  * @returns Updated purchase order receipt details
389
806
  * @throws ValidationError When request is invalid or response is malformed
807
+ * @example
808
+ * ```typescript
809
+ * const updated = await client.purchaseOrderReceipts.update(98766, {
810
+ * statusCd: 705,
811
+ * processCd: 705,
812
+ * properties: JSON.stringify({ notes: 'Receipt processed successfully' })
813
+ * });
814
+ * ```
390
815
  */
391
816
  update: this.createUpdateMethod('/purchase-order-receipt/{purchaseOrderReceiptUid}', schemas_1.PurchaseOrderReceiptUpdateRequestSchema, schemas_1.PurchaseOrderReceiptUpdateResponseSchema),
392
817
  /**
393
- * Soft delete a purchase order receipt
394
- * @description Marks a purchase order receipt as deleted
818
+ * Soft delete a purchase order receipt document
819
+ * @description Marks a purchase order receipt as deleted by setting status code to 700
820
+ * @fullPath api.nexus.purchaseOrderReceipts.delete
821
+ * @service nexus
822
+ * @domain warehouse-management
823
+ * @dataMethod deleteData
824
+ * @discoverable true
825
+ * @searchTerms ["delete PO receipt", "remove receipt", "cancel receipt", "soft delete receipt"]
826
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.update"]
827
+ * @commonPatterns ["Delete receipt document", "Cancel receipt", "Remove receipt record"]
828
+ * @workflow ["receipt-cancellation", "cleanup-processes", "audit-trail-maintenance"]
829
+ * @prerequisites ["Valid receipt ID", "Delete permissions", "Receipt must be in deletable state"]
830
+ * @nextSteps ["Cleanup related documents if needed", "Update related processes"]
831
+ * @businessRules ["Soft delete preserves audit trail", "Status set to 700", "Related documents may need attention"]
832
+ * @functionalArea "purchase-order-and-receipt-management"
395
833
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
396
834
  * @returns Deleted purchase order receipt details with updated status
397
835
  * @throws ValidationError When response is malformed
836
+ * @example
837
+ * ```typescript
838
+ * const deleted = await client.purchaseOrderReceipts.delete(98766);
839
+ * console.log('Receipt deleted, status:', deleted.data.statusCd); // Should be 700
840
+ * ```
398
841
  */
399
842
  delete: this.createDeleteMethod('/purchase-order-receipt/{purchaseOrderReceiptUid}', schemas_1.PurchaseOrderReceiptDeleteResponseSchema),
843
+ /**
844
+ * Retrieve a list of purchase order receipt documents (data only)
845
+ * @description Returns only the data array from purchase order receipts response
846
+ * @param params Optional filtering and pagination parameters
847
+ * @returns Array of purchase order receipt documents (data only)
848
+ * @throws ValidationError When parameters are invalid or response is malformed
849
+ */
850
+ listData: async (params) => {
851
+ const response = await this.purchaseOrderReceipts.list(params);
852
+ return response.data;
853
+ },
854
+ /**
855
+ * Retrieve details for a specific purchase order receipt (data only)
856
+ * @description Returns only the data from purchase order receipt details response
857
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
858
+ * @returns Purchase order receipt details (data only)
859
+ * @throws ValidationError When response is malformed
860
+ */
861
+ getData: async (purchaseOrderReceiptUid) => {
862
+ const response = await this.purchaseOrderReceipts.get(purchaseOrderReceiptUid);
863
+ return response.data;
864
+ },
865
+ /**
866
+ * Create a new purchase order receipt document (data only)
867
+ * @description Returns only the data from created purchase order receipt response
868
+ * @param receiptData Complete purchase order receipt data
869
+ * @returns Created purchase order receipt details (data only)
870
+ * @throws ValidationError When request is invalid or response is malformed
871
+ */
872
+ createData: async (receiptData) => {
873
+ const response = await this.purchaseOrderReceipts.create(receiptData);
874
+ return response.data;
875
+ },
876
+ /**
877
+ * Update an existing purchase order receipt (data only)
878
+ * @description Returns only the data from updated purchase order receipt response
879
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
880
+ * @param updateData Fields to update on the purchase order receipt
881
+ * @returns Updated purchase order receipt details (data only)
882
+ * @throws ValidationError When request is invalid or response is malformed
883
+ */
884
+ updateData: async (purchaseOrderReceiptUid, updateData) => {
885
+ const response = await this.purchaseOrderReceipts.update(purchaseOrderReceiptUid, updateData);
886
+ return response.data;
887
+ },
888
+ /**
889
+ * Soft delete a purchase order receipt (data only)
890
+ * @description Returns only the data from deleted purchase order receipt response
891
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
892
+ * @returns Deleted purchase order receipt details (data only)
893
+ * @throws ValidationError When response is malformed
894
+ */
895
+ deleteData: async (purchaseOrderReceiptUid) => {
896
+ const response = await this.purchaseOrderReceipts.delete(purchaseOrderReceiptUid);
897
+ return response.data;
898
+ },
400
899
  };
401
900
  /**
402
901
  * Transfer Receipt endpoints
403
- * @description Methods for managing transfer receipt documents
902
+ * @description Methods for managing transfer receipt documents for comprehensive transfer tracking and confirmation
404
903
  */
405
904
  this.transferReceipts = {
406
905
  /**
407
- * Retrieve a list of transfer receipt documents
408
- * @description Returns transfer receipts with pagination and filtering support
906
+ * Retrieve a list of transfer receipt documents with optional filtering
907
+ * @description Returns transfer receipts with pagination and filtering by transfer number, status, or receipt date
908
+ * @fullPath api.nexus.transferReceipts.list
909
+ * @service nexus
910
+ * @domain warehouse-management
911
+ * @dataMethod listData
912
+ * @discoverable true
913
+ * @searchTerms ["transfer receipts", "receipt documents", "transfer confirmations", "receipt list", "transfer receiving"]
914
+ * @relatedEndpoints ["api.nexus.transferReceipts.get", "api.nexus.transferReceipts.create", "api.nexus.transfers.list"]
915
+ * @commonPatterns ["List all transfer receipts", "Get receipt history", "Find receipts by transfer"]
916
+ * @workflow ["transfer-receiving", "receipt-management", "transfer-completion"]
917
+ * @prerequisites ["Valid authentication token", "Transfer receipt access permissions"]
918
+ * @nextSteps ["api.nexus.transferReceipts.get for details", "api.nexus.transferReceipts.update for modifications"]
919
+ * @businessRules ["Receipts confirm transfer completion", "Status codes track receipt progress", "Pagination for large datasets"]
920
+ * @functionalArea "transfer-and-receipt-management"
921
+ * @caching "Cache for 15 minutes, invalidate on receipt changes"
922
+ * @performance "Supports filtering by transfer ID for faster searches"
409
923
  * @param params Optional filtering and pagination parameters
410
924
  * @returns Array of transfer receipt documents
411
925
  * @throws ValidationError When parameters are invalid or response is malformed
926
+ * @example
927
+ * ```typescript
928
+ * const receipts = await client.transferReceipts.list({ limit: 25, transferUid: 12345 });
929
+ * receipts.data.forEach(receipt => {
930
+ * console.log(`Receipt ${receipt.transferReceiptUid}: Transfer ${receipt.transferUid}`);
931
+ * });
932
+ * ```
412
933
  */
413
934
  list: this.createListMethod('/transfer-receipt', schemas_1.TransferReceiptListParamsSchema, schemas_1.TransferReceiptListResponseSchema),
414
935
  /**
415
- * Retrieve details for a specific transfer receipt
416
- * @description Returns complete details for a transfer receipt document
936
+ * Retrieve details for a specific transfer receipt document
937
+ * @description Returns complete details for a transfer receipt including JSON data and confirmation information
938
+ * @fullPath api.nexus.transferReceipts.get
939
+ * @service nexus
940
+ * @domain warehouse-management
941
+ * @dataMethod getData
942
+ * @discoverable true
943
+ * @searchTerms ["get transfer receipt", "receipt details", "transfer receipt by id", "receipt document"]
944
+ * @relatedEndpoints ["api.nexus.transferReceipts.list", "api.nexus.transferReceipts.update", "api.nexus.transfers.get"]
945
+ * @commonPatterns ["Get receipt details by ID", "View specific transfer receipt", "Retrieve receipt information"]
946
+ * @workflow ["receipt-verification", "transfer-confirmation", "audit-review"]
947
+ * @prerequisites ["Valid receipt ID", "Read permissions for transfer receipts"]
948
+ * @nextSteps ["api.nexus.transferReceipts.update for modifications", "api.nexus.transfers.get for transfer details"]
949
+ * @businessRules ["Receipt must exist and be accessible", "Includes complete transfer confirmation data"]
950
+ * @functionalArea "transfer-and-receipt-management"
417
951
  * @param transferReceiptUid Transfer receipt unique identifier
418
952
  * @returns Complete transfer receipt details
419
953
  * @throws ValidationError When response is malformed
954
+ * @example
955
+ * ```typescript
956
+ * const receipt = await client.transferReceipts.get(54321);
957
+ * console.log('Receipt details:', receipt.data.jsonData);
958
+ * console.log('Transfer ID:', receipt.data.transferUid);
959
+ * ```
420
960
  */
421
961
  get: this.createGetMethod('/transfer-receipt/{transferReceiptUid}', schemas_1.TransferReceiptGetResponseSchema),
422
962
  /**
423
963
  * Create a new transfer receipt document
424
- * @description Creates a transfer receipt document for tracking
964
+ * @description Creates a transfer receipt document for comprehensive tracking and confirmation of transfer completion
965
+ * @fullPath api.nexus.transferReceipts.create
966
+ * @service nexus
967
+ * @domain warehouse-management
968
+ * @dataMethod createData
969
+ * @discoverable true
970
+ * @searchTerms ["create transfer receipt", "new receipt", "transfer confirmation", "receipt creation", "confirm transfer"]
971
+ * @relatedEndpoints ["api.nexus.transferReceipts.list", "api.nexus.transferReceipts.get", "api.nexus.transfers.get"]
972
+ * @commonPatterns ["Create new transfer receipt", "Confirm transfer completion", "Start receipt tracking"]
973
+ * @workflow ["receipt-creation", "transfer-confirmation", "completion-processing"]
974
+ * @prerequisites ["Valid transfer information", "Receipt creation permissions", "Transfer in receivable state"]
975
+ * @nextSteps ["api.nexus.transferReceipts.get for verification", "api.nexus.transferReceipts.update for status changes"]
976
+ * @businessRules ["Must reference valid transfer", "Receipt data structure must be valid", "Creates completion audit trail"]
977
+ * @functionalArea "transfer-and-receipt-management"
425
978
  * @param receiptData Complete transfer receipt data
426
979
  * @returns Created transfer receipt details
427
980
  * @throws ValidationError When request is invalid or response is malformed
981
+ * @example
982
+ * ```typescript
983
+ * const receipt = await client.transferReceipts.create({
984
+ * transferUid: 12345,
985
+ * referenceNo: 'TR_RECEIPT001',
986
+ * jsonData: JSON.stringify({ receivedItems: [{ itemId: 'ITEM001', receivedQty: 25 }] }),
987
+ * properties: JSON.stringify({ receivedBy: 'John Doe', receiptDate: '2024-01-20' })
988
+ * });
989
+ * ```
428
990
  */
429
991
  create: this.createCreateMethod('/transfer-receipt', schemas_1.TransferReceiptCreateRequestSchema, schemas_1.TransferReceiptCreateResponseSchema),
430
992
  /**
@@ -444,23 +1006,114 @@ class NexusClient extends base_client_1.BaseServiceClient {
444
1006
  * @throws ValidationError When response is malformed
445
1007
  */
446
1008
  delete: this.createDeleteMethod('/transfer-receipt/{transferReceiptUid}', schemas_1.TransferReceiptDeleteResponseSchema),
1009
+ /**
1010
+ * Retrieve a list of transfer receipt documents (data only)
1011
+ * @description Returns only the data array from transfer receipts response
1012
+ * @param params Optional filtering and pagination parameters
1013
+ * @returns Array of transfer receipt documents (data only)
1014
+ * @throws ValidationError When parameters are invalid or response is malformed
1015
+ */
1016
+ listData: async (params) => {
1017
+ const response = await this.transferReceipts.list(params);
1018
+ return response.data;
1019
+ },
1020
+ /**
1021
+ * Retrieve details for a specific transfer receipt (data only)
1022
+ * @description Returns only the data from transfer receipt details response
1023
+ * @param transferReceiptUid Transfer receipt unique identifier
1024
+ * @returns Transfer receipt details (data only)
1025
+ * @throws ValidationError When response is malformed
1026
+ */
1027
+ getData: async (transferReceiptUid) => {
1028
+ const response = await this.transferReceipts.get(transferReceiptUid);
1029
+ return response.data;
1030
+ },
1031
+ /**
1032
+ * Create a new transfer receipt document (data only)
1033
+ * @description Returns only the data from created transfer receipt response
1034
+ * @param receiptData Complete transfer receipt data
1035
+ * @returns Created transfer receipt details (data only)
1036
+ * @throws ValidationError When request is invalid or response is malformed
1037
+ */
1038
+ createData: async (receiptData) => {
1039
+ const response = await this.transferReceipts.create(receiptData);
1040
+ return response.data;
1041
+ },
1042
+ /**
1043
+ * Update an existing transfer receipt (data only)
1044
+ * @description Returns only the data from updated transfer receipt response
1045
+ * @param transferReceiptUid Transfer receipt unique identifier
1046
+ * @param updateData Fields to update on the transfer receipt
1047
+ * @returns Updated transfer receipt details (data only)
1048
+ * @throws ValidationError When request is invalid or response is malformed
1049
+ */
1050
+ updateData: async (transferReceiptUid, updateData) => {
1051
+ const response = await this.transferReceipts.update(transferReceiptUid, updateData);
1052
+ return response.data;
1053
+ },
1054
+ /**
1055
+ * Soft delete a transfer receipt (data only)
1056
+ * @description Returns only the data from deleted transfer receipt response
1057
+ * @param transferReceiptUid Transfer receipt unique identifier
1058
+ * @returns Deleted transfer receipt details (data only)
1059
+ * @throws ValidationError When response is malformed
1060
+ */
1061
+ deleteData: async (transferReceiptUid) => {
1062
+ const response = await this.transferReceipts.delete(transferReceiptUid);
1063
+ return response.data;
1064
+ },
447
1065
  };
448
1066
  /**
449
1067
  * Transfer Shipping endpoints
450
- * @description Methods for managing transfer shipping documents
1068
+ * @description Methods for managing transfer shipping documents for comprehensive outbound transfer tracking and logistics
451
1069
  */
452
1070
  this.transferShippings = {
453
1071
  /**
454
- * Retrieve a list of transfer shipping documents
455
- * @description Returns transfer shippings with pagination and filtering support
1072
+ * Retrieve a list of transfer shipping documents with optional filtering
1073
+ * @description Returns transfer shipping documents with pagination and filtering by shipping reference, status, or shipping date
1074
+ * @fullPath api.nexus.transferShippings.list
1075
+ * @service nexus
1076
+ * @domain warehouse-management
1077
+ * @dataMethod listData
1078
+ * @discoverable true
1079
+ * @searchTerms ["transfer shipping", "shipping documents", "outbound transfers", "shipping list", "transfer logistics"]
1080
+ * @relatedEndpoints ["api.nexus.transferShippings.get", "api.nexus.transferShippings.create", "api.nexus.transfers.list"]
1081
+ * @commonPatterns ["List all transfer shipments", "Get shipping history", "Find shipments by reference"]
1082
+ * @workflow ["outbound-shipping", "transfer-logistics", "shipping-management"]
1083
+ * @prerequisites ["Valid authentication token", "Transfer shipping access permissions"]
1084
+ * @nextSteps ["api.nexus.transferShippings.get for details", "api.nexus.transferShippings.update for tracking updates"]
1085
+ * @businessRules ["Shipping documents track outbound transfers", "Status codes indicate shipping progress", "Pagination for large datasets"]
1086
+ * @functionalArea "transfer-and-shipping-management"
1087
+ * @caching "Cache for 20 minutes, invalidate on shipping changes"
1088
+ * @performance "Supports filtering by transfer receipt ID for faster searches"
456
1089
  * @param params Optional filtering and pagination parameters
457
1090
  * @returns Array of transfer shipping documents
458
1091
  * @throws ValidationError When parameters are invalid or response is malformed
1092
+ * @example
1093
+ * ```typescript
1094
+ * const shipments = await client.transferShippings.list({ limit: 30, statusCd: 704 });
1095
+ * shipments.data.forEach(shipment => {
1096
+ * console.log(`Shipment ${shipment.transferShippingUid}: Receipt ${shipment.transferReceiptUid}`);
1097
+ * });
1098
+ * ```
459
1099
  */
460
1100
  list: this.createListMethod('/transfer-shipping', schemas_1.TransferShippingListParamsSchema, schemas_1.TransferShippingListResponseSchema),
461
1101
  /**
462
1102
  * Retrieve details for a specific transfer shipping document
463
- * @description Returns complete details for a transfer shipping document
1103
+ * @description Returns complete details for a transfer shipping document including JSON data and tracking information
1104
+ * @fullPath api.nexus.transferShippings.get
1105
+ * @service nexus
1106
+ * @domain warehouse-management
1107
+ * @dataMethod getData
1108
+ * @discoverable true
1109
+ * @searchTerms ["get transfer shipping", "shipping details", "transfer shipping by id", "shipping document", "outbound tracking"]
1110
+ * @relatedEndpoints ["api.nexus.transferShippings.list", "api.nexus.transferShippings.update", "api.nexus.transferReceipts.get"]
1111
+ * @commonPatterns ["Get shipping details by ID", "View specific transfer shipment", "Retrieve shipping information"]
1112
+ * @workflow ["shipping-tracking", "outbound-verification", "logistics-review"]
1113
+ * @prerequisites ["Valid transfer receipt ID", "Read permissions for transfer shipping"]
1114
+ * @nextSteps ["api.nexus.transferShippings.update for tracking updates", "Related logistics processes"]
1115
+ * @businessRules ["Shipping document must exist and be accessible", "Includes complete tracking and logistics data"]
1116
+ * @functionalArea "transfer-and-shipping-management"
464
1117
  * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
465
1118
  * @returns Complete transfer shipping details
466
1119
  * @throws ValidationError When response is malformed
@@ -468,15 +1121,38 @@ class NexusClient extends base_client_1.BaseServiceClient {
468
1121
  * ```typescript
469
1122
  * const shipping = await client.transferShippings.get(12345);
470
1123
  * console.log('Shipping details:', shipping.data.jsonData);
1124
+ * console.log('Tracking info:', shipping.data.properties);
471
1125
  * ```
472
1126
  */
473
1127
  get: this.createGetMethod('/transfer-shipping/{transferReceiptUid}', schemas_1.TransferShippingGetResponseSchema),
474
1128
  /**
475
1129
  * Create a new transfer shipping document
476
- * @description Creates a transfer shipping document for tracking
1130
+ * @description Creates a transfer shipping document for comprehensive outbound tracking and logistics management
1131
+ * @fullPath api.nexus.transferShippings.create
1132
+ * @service nexus
1133
+ * @domain warehouse-management
1134
+ * @dataMethod createData
1135
+ * @discoverable true
1136
+ * @searchTerms ["create transfer shipping", "new shipping", "outbound transfer", "shipping creation", "transfer logistics"]
1137
+ * @relatedEndpoints ["api.nexus.transferShippings.list", "api.nexus.transferShippings.get", "api.nexus.transferReceipts.get"]
1138
+ * @commonPatterns ["Create new transfer shipment", "Start outbound transfer", "Begin shipping process"]
1139
+ * @workflow ["shipping-initiation", "outbound-processing", "logistics-creation"]
1140
+ * @prerequisites ["Valid transfer receipt information", "Shipping creation permissions", "Transfer ready for shipment"]
1141
+ * @nextSteps ["api.nexus.transferShippings.get for verification", "api.nexus.transferShippings.update for tracking updates"]
1142
+ * @businessRules ["Must reference valid transfer receipt", "Shipping data structure must be valid", "Creates logistics audit trail"]
1143
+ * @functionalArea "transfer-and-shipping-management"
477
1144
  * @param shippingData Complete transfer shipping data
478
1145
  * @returns Created transfer shipping details
479
1146
  * @throws ValidationError When request is invalid or response is malformed
1147
+ * @example
1148
+ * ```typescript
1149
+ * const shipping = await client.transferShippings.create({
1150
+ * transferReceiptUid: 54321,
1151
+ * referenceNo: 'SHIP001',
1152
+ * jsonData: JSON.stringify({ carrier: 'FedEx', trackingNumber: 'TRK123456' }),
1153
+ * properties: JSON.stringify({ shippedBy: 'Warehouse A', shippingDate: '2024-01-25' })
1154
+ * });
1155
+ * ```
480
1156
  */
481
1157
  create: this.createCreateMethod('/transfer-shipping', schemas_1.TransferShippingCreateRequestSchema, schemas_1.TransferShippingCreateResponseSchema),
482
1158
  /**
@@ -496,6 +1172,62 @@ class NexusClient extends base_client_1.BaseServiceClient {
496
1172
  * @throws ValidationError When response is malformed
497
1173
  */
498
1174
  delete: this.createDeleteMethod('/transfer-shipping/{transferReceiptUid}', schemas_1.TransferShippingDeleteResponseSchema),
1175
+ /**
1176
+ * Retrieve a list of transfer shipping documents (data only)
1177
+ * @description Returns only the data array from transfer shippings response
1178
+ * @param params Optional filtering and pagination parameters
1179
+ * @returns Array of transfer shipping documents (data only)
1180
+ * @throws ValidationError When parameters are invalid or response is malformed
1181
+ */
1182
+ listData: async (params) => {
1183
+ const response = await this.transferShippings.list(params);
1184
+ return response.data;
1185
+ },
1186
+ /**
1187
+ * Retrieve details for a specific transfer shipping document (data only)
1188
+ * @description Returns only the data from transfer shipping details response
1189
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
1190
+ * @returns Transfer shipping details (data only)
1191
+ * @throws ValidationError When response is malformed
1192
+ */
1193
+ getData: async (transferReceiptUid) => {
1194
+ const response = await this.transferShippings.get(transferReceiptUid);
1195
+ return response.data;
1196
+ },
1197
+ /**
1198
+ * Create a new transfer shipping document (data only)
1199
+ * @description Returns only the data from created transfer shipping response
1200
+ * @param shippingData Complete transfer shipping data
1201
+ * @returns Created transfer shipping details (data only)
1202
+ * @throws ValidationError When request is invalid or response is malformed
1203
+ */
1204
+ createData: async (shippingData) => {
1205
+ const response = await this.transferShippings.create(shippingData);
1206
+ return response.data;
1207
+ },
1208
+ /**
1209
+ * Update an existing transfer shipping document (data only)
1210
+ * @description Returns only the data from updated transfer shipping response
1211
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
1212
+ * @param updateData Fields to update on the transfer shipping
1213
+ * @returns Updated transfer shipping details (data only)
1214
+ * @throws ValidationError When request is invalid or response is malformed
1215
+ */
1216
+ updateData: async (transferReceiptUid, updateData) => {
1217
+ const response = await this.transferShippings.update(transferReceiptUid, updateData);
1218
+ return response.data;
1219
+ },
1220
+ /**
1221
+ * Soft delete a transfer shipping document (data only)
1222
+ * @description Returns only the data from deleted transfer shipping response
1223
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
1224
+ * @returns Deleted transfer shipping details (data only)
1225
+ * @throws ValidationError When response is malformed
1226
+ */
1227
+ deleteData: async (transferReceiptUid) => {
1228
+ const response = await this.transferShippings.delete(transferReceiptUid);
1229
+ return response.data;
1230
+ },
499
1231
  };
500
1232
  }
501
1233
  }