@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
@@ -1,8 +1,35 @@
1
1
  import { BaseServiceClient } from '../../core/base-client';
2
2
  import type { HTTPClient } from '../../core/client';
3
+ import { BinTransferListParamsSchema, BinTransferCreateRequestSchema, BinTransferUpdateRequestSchema, ReceivingListParamsSchema, ReceivingCreateRequestSchema, ReceivingUpdateRequestSchema, TransferListParamsSchema, TransferCreateRequestSchema, TransferUpdateRequestSchema, PurchaseOrderReceiptListParamsSchema, PurchaseOrderReceiptCreateRequestSchema, PurchaseOrderReceiptUpdateRequestSchema, TransferReceiptListParamsSchema, TransferReceiptCreateRequestSchema, TransferReceiptUpdateRequestSchema, TransferShippingListParamsSchema, TransferShippingCreateRequestSchema, TransferShippingUpdateRequestSchema } from './schemas';
4
+ import type { z } from 'zod';
5
+ type BinTransferListParams = z.infer<typeof BinTransferListParamsSchema>;
6
+ type BinTransferCreateRequest = z.infer<typeof BinTransferCreateRequestSchema>;
7
+ type BinTransferUpdateRequest = z.infer<typeof BinTransferUpdateRequestSchema>;
8
+ type ReceivingListParams = z.infer<typeof ReceivingListParamsSchema>;
9
+ type ReceivingCreateRequest = z.infer<typeof ReceivingCreateRequestSchema>;
10
+ type ReceivingUpdateRequest = z.infer<typeof ReceivingUpdateRequestSchema>;
11
+ type TransferListParams = z.infer<typeof TransferListParamsSchema>;
12
+ type TransferCreateRequest = z.infer<typeof TransferCreateRequestSchema>;
13
+ type TransferUpdateRequest = z.infer<typeof TransferUpdateRequestSchema>;
14
+ type PurchaseOrderReceiptListParams = z.infer<typeof PurchaseOrderReceiptListParamsSchema>;
15
+ type PurchaseOrderReceiptCreateRequest = z.infer<typeof PurchaseOrderReceiptCreateRequestSchema>;
16
+ type PurchaseOrderReceiptUpdateRequest = z.infer<typeof PurchaseOrderReceiptUpdateRequestSchema>;
17
+ type TransferReceiptListParams = z.infer<typeof TransferReceiptListParamsSchema>;
18
+ type TransferReceiptCreateRequest = z.infer<typeof TransferReceiptCreateRequestSchema>;
19
+ type TransferReceiptUpdateRequest = z.infer<typeof TransferReceiptUpdateRequestSchema>;
20
+ type TransferShippingListParams = z.infer<typeof TransferShippingListParamsSchema>;
21
+ type TransferShippingCreateRequest = z.infer<typeof TransferShippingCreateRequestSchema>;
22
+ type TransferShippingUpdateRequest = z.infer<typeof TransferShippingUpdateRequestSchema>;
3
23
  /**
4
24
  * Nexus API Client
5
25
  * @description Client for interacting with Nexus microservice API endpoints for comprehensive warehouse management
26
+ * @fullPath api.nexus
27
+ * @service nexus
28
+ * @domain warehouse-management
29
+ * @discoverable true
30
+ * @searchTerms ["nexus", "warehouse management", "inventory transfers", "receiving", "bin transfers", "warehouse operations"]
31
+ * @relatedEndpoints ["api.nexus.binTransfers", "api.nexus.receivings", "api.nexus.transfers", "api.nexus.health"]
32
+ * @commonPatterns ["Warehouse management operations", "Inventory movement tracking", "Receiving and transfer processing"]
6
33
  * @example
7
34
  * ```typescript
8
35
  * import { HTTPClient } from '@augur/api-client/core';
@@ -50,6 +77,14 @@ export declare class NexusClient extends BaseServiceClient {
50
77
  /**
51
78
  * Simple health check endpoint that doesn't require authentication
52
79
  * @description Returns "pong" response for basic connectivity testing
80
+ * @fullPath api.nexus.health.ping
81
+ * @service nexus
82
+ * @domain service-monitoring
83
+ * @dataMethod N/A (simple response)
84
+ * @discoverable true
85
+ * @searchTerms ["ping", "health check", "connectivity test", "service alive", "basic health"]
86
+ * @relatedEndpoints ["api.nexus.health.check"]
87
+ * @commonPatterns ["Test service connectivity", "Basic health check", "Ping service"]
53
88
  * @returns Simple pong response
54
89
  * @throws ValidationError When response is malformed
55
90
  * @example
@@ -71,6 +106,14 @@ export declare class NexusClient extends BaseServiceClient {
71
106
  /**
72
107
  * Comprehensive health check with authentication and site validation
73
108
  * @description Validates authentication, site configuration, and service health
109
+ * @fullPath api.nexus.health.check
110
+ * @service nexus
111
+ * @domain service-monitoring
112
+ * @dataMethod N/A (returns health data)
113
+ * @discoverable true
114
+ * @searchTerms ["health check", "service health", "authentication check", "site validation", "comprehensive health"]
115
+ * @relatedEndpoints ["api.nexus.health.ping"]
116
+ * @commonPatterns ["Check service health", "Validate authentication", "Full health status"]
74
117
  * @returns Health check response with site information
75
118
  * @throws ValidationError When response is malformed
76
119
  * @example
@@ -101,6 +144,14 @@ export declare class NexusClient extends BaseServiceClient {
101
144
  /**
102
145
  * Retrieve a list of bin transfer headers with optional filtering
103
146
  * @description Returns all bin transfer headers with pagination and status filtering support
147
+ * @fullPath api.nexus.binTransfers.list
148
+ * @service nexus
149
+ * @domain warehouse-management
150
+ * @dataMethod listData
151
+ * @discoverable true
152
+ * @searchTerms ["bin transfers", "inventory movement", "warehouse transfers", "bin to bin", "list transfers"]
153
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.create"]
154
+ * @commonPatterns ["List all bin transfers", "Get transfer history", "Find transfers by status"]
104
155
  * @param params Optional filtering and pagination parameters
105
156
  * @returns Array of bin transfer headers
106
157
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -144,6 +195,14 @@ export declare class NexusClient extends BaseServiceClient {
144
195
  /**
145
196
  * Retrieve details for a specific bin transfer header
146
197
  * @description Returns complete details for a bin transfer including JSON data and properties
198
+ * @fullPath api.nexus.binTransfers.get
199
+ * @service nexus
200
+ * @domain warehouse-management
201
+ * @dataMethod getData
202
+ * @discoverable true
203
+ * @searchTerms ["get bin transfer", "transfer details", "bin transfer by id", "transfer header"]
204
+ * @relatedEndpoints ["api.nexus.binTransfers.list", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.update"]
205
+ * @commonPatterns ["Get transfer details by ID", "View specific bin transfer", "Retrieve transfer information"]
147
206
  * @param binTransferHdrUid Bin transfer header unique identifier
148
207
  * @returns Complete bin transfer details
149
208
  * @throws ValidationError When response is malformed
@@ -181,6 +240,14 @@ export declare class NexusClient extends BaseServiceClient {
181
240
  /**
182
241
  * Retrieve bin transfer status with detailed line items
183
242
  * @description Returns complete bin transfer header with associated line items for status checking
243
+ * @fullPath api.nexus.binTransfers.getBinTransferStatus
244
+ * @service nexus
245
+ * @domain warehouse-management
246
+ * @dataMethod getBinTransferStatusData
247
+ * @discoverable true
248
+ * @searchTerms ["bin transfer status", "transfer line items", "transfer progress", "bin transfer details with lines"]
249
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.list", "api.nexus.binTransfers.update"]
250
+ * @commonPatterns ["Check transfer status", "View transfer line items", "Get transfer progress"]
184
251
  * @param binTransferHdrUid Bin transfer header unique identifier
185
252
  * @returns Bin transfer with line items
186
253
  * @throws ValidationError When response is malformed
@@ -242,6 +309,14 @@ export declare class NexusClient extends BaseServiceClient {
242
309
  /**
243
310
  * Create a new bin transfer header with associated line items
244
311
  * @description Creates a bin transfer with complete transfer line items for inventory movement
312
+ * @fullPath api.nexus.binTransfers.create
313
+ * @service nexus
314
+ * @domain warehouse-management
315
+ * @dataMethod createData
316
+ * @discoverable true
317
+ * @searchTerms ["create bin transfer", "new transfer", "move inventory", "bin to bin transfer", "inventory movement"]
318
+ * @relatedEndpoints ["api.nexus.binTransfers.list", "api.nexus.binTransfers.get", "api.nexus.binTransfers.update"]
319
+ * @commonPatterns ["Create new bin transfer", "Move items between bins", "Start inventory transfer"]
245
320
  * @param transferData Complete bin transfer data including user, location, and transfer lines
246
321
  * @returns Created bin transfer header details
247
322
  * @throws ValidationError When request is invalid or response is malformed
@@ -308,6 +383,14 @@ export declare class NexusClient extends BaseServiceClient {
308
383
  /**
309
384
  * Update an existing bin transfer header
310
385
  * @description Updates bin transfer status, process codes, and additional data
386
+ * @fullPath api.nexus.binTransfers.update
387
+ * @service nexus
388
+ * @domain warehouse-management
389
+ * @dataMethod updateData
390
+ * @discoverable true
391
+ * @searchTerms ["update bin transfer", "modify transfer", "change transfer status", "update transfer"]
392
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.getBinTransferStatus", "api.nexus.binTransfers.delete"]
393
+ * @commonPatterns ["Update transfer status", "Modify bin transfer", "Change transfer details"]
311
394
  * @param binTransferHdrUid Bin transfer header unique identifier
312
395
  * @param updateData Fields to update on the bin transfer
313
396
  * @returns Updated bin transfer details
@@ -353,6 +436,14 @@ export declare class NexusClient extends BaseServiceClient {
353
436
  /**
354
437
  * Soft delete a bin transfer header
355
438
  * @description Marks a bin transfer as deleted by setting status code to 700
439
+ * @fullPath api.nexus.binTransfers.delete
440
+ * @service nexus
441
+ * @domain warehouse-management
442
+ * @dataMethod deleteData
443
+ * @discoverable true
444
+ * @searchTerms ["delete bin transfer", "remove transfer", "cancel transfer", "soft delete"]
445
+ * @relatedEndpoints ["api.nexus.binTransfers.get", "api.nexus.binTransfers.list", "api.nexus.binTransfers.update"]
446
+ * @commonPatterns ["Delete bin transfer", "Cancel transfer", "Remove transfer record"]
356
447
  * @param binTransferHdrUid Bin transfer header unique identifier
357
448
  * @returns Deleted bin transfer details with updated status
358
449
  * @throws ValidationError When response is malformed
@@ -386,6 +477,176 @@ export declare class NexusClient extends BaseServiceClient {
386
477
  total: number;
387
478
  totalResults: number;
388
479
  }>;
480
+ /**
481
+ * Retrieve a list of bin transfer headers with optional filtering (data only)
482
+ * @description Returns only the data array from bin transfer headers response
483
+ * @param params Optional filtering and pagination parameters
484
+ * @returns Array of bin transfer headers (data only)
485
+ * @throws ValidationError When parameters are invalid or response is malformed
486
+ * @example
487
+ * ```typescript
488
+ * const transfersData = await client.binTransfers.listData({ limit: 20, statusCd: 704 });
489
+ * transfersData.forEach(transfer => {
490
+ * console.log(`Transfer ${transfer.binTransferHdrUid}: Status ${transfer.statusCd}`);
491
+ * });
492
+ * ```
493
+ */
494
+ listData: (params?: BinTransferListParams) => Promise<{
495
+ requestId: string | null;
496
+ dateCreated: string;
497
+ dateLastModified: string;
498
+ statusCd: number;
499
+ updateCd: number;
500
+ processCd: number;
501
+ properties: string | null;
502
+ jsonData: string | null;
503
+ usersId: number;
504
+ locationId: number;
505
+ importState: string;
506
+ binTransferHdrUid: number;
507
+ response: string | null;
508
+ }[]>;
509
+ /**
510
+ * Retrieve details for a specific bin transfer header (data only)
511
+ * @description Returns only the data from bin transfer details response
512
+ * @param binTransferHdrUid Bin transfer header unique identifier
513
+ * @returns Bin transfer details (data only)
514
+ * @throws ValidationError When response is malformed
515
+ * @example
516
+ * ```typescript
517
+ * const transferData = await client.binTransfers.getData(12345);
518
+ * console.log('Transfer details:', transferData.jsonData);
519
+ * ```
520
+ */
521
+ getData: (binTransferHdrUid: number | string) => Promise<{
522
+ requestId: string | null;
523
+ dateCreated: string;
524
+ dateLastModified: string;
525
+ statusCd: number;
526
+ updateCd: number;
527
+ processCd: number;
528
+ properties: string | null;
529
+ jsonData: string | null;
530
+ usersId: number;
531
+ locationId: number;
532
+ importState: string;
533
+ binTransferHdrUid: number;
534
+ response: string | null;
535
+ }>;
536
+ /**
537
+ * Retrieve bin transfer status with detailed line items (data only)
538
+ * @description Returns only the data from bin transfer status response
539
+ * @param binTransferHdrUid Bin transfer header unique identifier
540
+ * @returns Bin transfer with line items (data only)
541
+ * @throws ValidationError When response is malformed
542
+ * @example
543
+ * ```typescript
544
+ * const statusData = await client.binTransfers.getBinTransferStatusData(12345);
545
+ * console.log('Transfer lines:', statusData.lines?.length || 0);
546
+ * ```
547
+ */
548
+ getBinTransferStatusData: (binTransferHdrUid: number | string) => Promise<{
549
+ requestId: string | null;
550
+ dateCreated: string;
551
+ dateLastModified: string;
552
+ statusCd: number;
553
+ updateCd: number;
554
+ processCd: number;
555
+ lines: {
556
+ dateCreated: string;
557
+ dateLastModified: string;
558
+ statusCd: number;
559
+ updateCd: number;
560
+ processCd: number;
561
+ lineNo: number;
562
+ invMastUid: number;
563
+ quantity: number | null;
564
+ itemId: string;
565
+ uom: string;
566
+ jsonData: string | null;
567
+ locationId: number | null;
568
+ toBin: string;
569
+ fromBin: string;
570
+ lot: string;
571
+ moveAvailable: string;
572
+ moveAllocations: string;
573
+ binTransferHdrUid: number;
574
+ }[];
575
+ properties: string | null;
576
+ jsonData: string | null;
577
+ usersId: number;
578
+ locationId: number;
579
+ importState: string;
580
+ binTransferHdrUid: number;
581
+ response: string | null;
582
+ }>;
583
+ /**
584
+ * Create a new bin transfer header with associated line items (data only)
585
+ * @description Returns only the data from created bin transfer response
586
+ * @param transferData Complete bin transfer data including user, location, and transfer lines
587
+ * @returns Created bin transfer header details (data only)
588
+ * @throws ValidationError When request is invalid or response is malformed
589
+ */
590
+ createData: (transferData: BinTransferCreateRequest) => Promise<{
591
+ requestId: string | null;
592
+ dateCreated: string;
593
+ dateLastModified: string;
594
+ statusCd: number;
595
+ updateCd: number;
596
+ processCd: number;
597
+ properties: string | null;
598
+ jsonData: string | null;
599
+ usersId: number;
600
+ locationId: number;
601
+ importState: string;
602
+ binTransferHdrUid: number;
603
+ response: string | null;
604
+ }>;
605
+ /**
606
+ * Update an existing bin transfer header (data only)
607
+ * @description Returns only the data from updated bin transfer response
608
+ * @param binTransferHdrUid Bin transfer header unique identifier
609
+ * @param updateData Fields to update on the bin transfer
610
+ * @returns Updated bin transfer details (data only)
611
+ * @throws ValidationError When request is invalid or response is malformed
612
+ */
613
+ updateData: (binTransferHdrUid: number | string, updateData: BinTransferUpdateRequest) => Promise<{
614
+ requestId: string | null;
615
+ dateCreated: string;
616
+ dateLastModified: string;
617
+ statusCd: number;
618
+ updateCd: number;
619
+ processCd: number;
620
+ properties: string | null;
621
+ jsonData: string | null;
622
+ usersId: number;
623
+ locationId: number;
624
+ importState: string;
625
+ binTransferHdrUid: number;
626
+ response: string | null;
627
+ }>;
628
+ /**
629
+ * Soft delete a bin transfer header (data only)
630
+ * @description Returns only the data from deleted bin transfer response
631
+ * @param binTransferHdrUid Bin transfer header unique identifier
632
+ * @returns Deleted bin transfer details (data only)
633
+ * @throws ValidationError When response is malformed
634
+ */
635
+ deleteData: (binTransferHdrUid: number | string) => Promise<{
636
+ requestId: string | null;
637
+ dateCreated: string;
638
+ dateLastModified: string;
639
+ statusCd: number;
640
+ updateCd: number;
641
+ processCd: number;
642
+ properties: string | null;
643
+ jsonData: string | null;
644
+ usersId: number;
645
+ locationId: number;
646
+ importState: string;
647
+ binTransferHdrUid: number;
648
+ response: string | null;
649
+ }>;
389
650
  };
390
651
  /**
391
652
  * Receiving endpoints
@@ -395,6 +656,14 @@ export declare class NexusClient extends BaseServiceClient {
395
656
  /**
396
657
  * Retrieve a list of receiving documents with optional filtering
397
658
  * @description Returns receiving documents with pagination and filtering by PO number or status
659
+ * @fullPath api.nexus.receivings.list
660
+ * @service nexus
661
+ * @domain warehouse-management
662
+ * @dataMethod listData
663
+ * @discoverable true
664
+ * @searchTerms ["receiving documents", "purchase order receipts", "receiving list", "PO receipts", "inbound inventory"]
665
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.create", "api.nexus.purchaseOrderReceipts.list"]
666
+ * @commonPatterns ["List all receiving documents", "Get receiving history", "Find receipts by PO number"]
398
667
  * @param params Optional filtering and pagination parameters
399
668
  * @returns Array of receiving documents
400
669
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -439,6 +708,14 @@ export declare class NexusClient extends BaseServiceClient {
439
708
  /**
440
709
  * Retrieve details for a specific receiving document
441
710
  * @description Returns complete details for a receiving document including JSON data and properties
711
+ * @fullPath api.nexus.receivings.get
712
+ * @service nexus
713
+ * @domain warehouse-management
714
+ * @dataMethod getData
715
+ * @discoverable true
716
+ * @searchTerms ["get receiving", "receiving details", "receiving by id", "receipt details"]
717
+ * @relatedEndpoints ["api.nexus.receivings.list", "api.nexus.receivings.update", "api.nexus.purchaseOrderReceipts.get"]
718
+ * @commonPatterns ["Get receiving details by ID", "View specific receipt", "Retrieve receiving information"]
442
719
  * @param receivingUid Receiving unique identifier
443
720
  * @returns Complete receiving document details
444
721
  * @throws ValidationError When response is malformed
@@ -476,6 +753,14 @@ export declare class NexusClient extends BaseServiceClient {
476
753
  /**
477
754
  * Create a new receiving document
478
755
  * @description Creates a receiving document for purchase order receipt processing
756
+ * @fullPath api.nexus.receivings.create
757
+ * @service nexus
758
+ * @domain warehouse-management
759
+ * @dataMethod createData
760
+ * @discoverable true
761
+ * @searchTerms ["create receiving", "new receipt", "receive inventory", "PO receipt", "inbound processing"]
762
+ * @relatedEndpoints ["api.nexus.receivings.list", "api.nexus.receivings.get", "api.nexus.purchaseOrderReceipts.create"]
763
+ * @commonPatterns ["Create new receiving document", "Process PO receipt", "Start receiving process"]
479
764
  * @param receivingData Complete receiving data including PO number and optional details
480
765
  * @returns Created receiving document details
481
766
  * @throws ValidationError When request is invalid or response is malformed
@@ -522,7 +807,20 @@ export declare class NexusClient extends BaseServiceClient {
522
807
  }>;
523
808
  /**
524
809
  * Update an existing receiving document
525
- * @description Updates receiving status, process codes, and messages
810
+ * @description Updates receiving status, process codes, messages, and tracking information
811
+ * @fullPath api.nexus.receivings.update
812
+ * @service nexus
813
+ * @domain warehouse-management
814
+ * @dataMethod updateData
815
+ * @discoverable true
816
+ * @searchTerms ["update receiving", "modify receiving", "change receiving status", "update receipt", "receiving modification"]
817
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.list", "api.nexus.receivings.delete"]
818
+ * @commonPatterns ["Update receiving status", "Modify receiving details", "Change receiving properties"]
819
+ * @workflow ["receiving-processing", "status-updates", "receipt-management"]
820
+ * @prerequisites ["Valid receiving ID", "Update permissions", "Proper status transitions"]
821
+ * @nextSteps ["api.nexus.receivings.get for verification", "Related processing workflows"]
822
+ * @businessRules ["Status changes must follow valid transitions", "Updates create audit trail entries", "Some fields may be immutable"]
823
+ * @functionalArea "warehouse-management"
526
824
  * @param receivingUid Receiving unique identifier
527
825
  * @param updateData Fields to update on the receiving document
528
826
  * @returns Updated receiving details
@@ -569,6 +867,19 @@ export declare class NexusClient extends BaseServiceClient {
569
867
  /**
570
868
  * Soft delete a receiving document
571
869
  * @description Marks a receiving document as deleted by setting status code to 700
870
+ * @fullPath api.nexus.receivings.delete
871
+ * @service nexus
872
+ * @domain warehouse-management
873
+ * @dataMethod deleteData
874
+ * @discoverable true
875
+ * @searchTerms ["delete receiving", "remove receiving", "cancel receiving", "soft delete receipt"]
876
+ * @relatedEndpoints ["api.nexus.receivings.get", "api.nexus.receivings.list", "api.nexus.receivings.update"]
877
+ * @commonPatterns ["Delete receiving document", "Cancel receiving", "Remove receiving record"]
878
+ * @workflow ["receiving-cancellation", "cleanup-processes", "audit-trail-maintenance"]
879
+ * @prerequisites ["Valid receiving ID", "Delete permissions", "Receiving must be in deletable state"]
880
+ * @nextSteps ["Cleanup related documents if needed", "Update related processes"]
881
+ * @businessRules ["Soft delete preserves audit trail", "Status set to 700", "Related documents may need attention"]
882
+ * @functionalArea "warehouse-management"
572
883
  * @param receivingUid Receiving unique identifier
573
884
  * @returns Deleted receiving details with updated status
574
885
  * @throws ValidationError When response is malformed
@@ -602,6 +913,117 @@ export declare class NexusClient extends BaseServiceClient {
602
913
  total: number;
603
914
  totalResults: number;
604
915
  }>;
916
+ /**
917
+ * Retrieve a list of receiving documents with optional filtering (data only)
918
+ * @description Returns only the data array from receiving documents response
919
+ * @param params Optional filtering and pagination parameters
920
+ * @returns Array of receiving documents (data only)
921
+ * @throws ValidationError When parameters are invalid or response is malformed
922
+ */
923
+ listData: (params?: ReceivingListParams) => Promise<{
924
+ requestId: string | null;
925
+ dateCreated: string;
926
+ dateLastModified: string;
927
+ statusCd: number;
928
+ updateCd: number;
929
+ processCd: number;
930
+ properties: string | null;
931
+ jsonData: string | null;
932
+ importState: string;
933
+ receivingUid: number;
934
+ referenceNo: string | null;
935
+ poNo: number;
936
+ processMessage: string | null;
937
+ }[]>;
938
+ /**
939
+ * Retrieve details for a specific receiving document (data only)
940
+ * @description Returns only the data from receiving document details response
941
+ * @param receivingUid Receiving unique identifier
942
+ * @returns Receiving document details (data only)
943
+ * @throws ValidationError When response is malformed
944
+ */
945
+ getData: (receivingUid: number | string) => Promise<{
946
+ requestId: string | null;
947
+ dateCreated: string;
948
+ dateLastModified: string;
949
+ statusCd: number;
950
+ updateCd: number;
951
+ processCd: number;
952
+ properties: string | null;
953
+ jsonData: string | null;
954
+ importState: string;
955
+ receivingUid: number;
956
+ referenceNo: string | null;
957
+ poNo: number;
958
+ processMessage: string | null;
959
+ }>;
960
+ /**
961
+ * Create a new receiving document (data only)
962
+ * @description Returns only the data from created receiving document response
963
+ * @param receivingData Complete receiving data including PO number and optional details
964
+ * @returns Created receiving document details (data only)
965
+ * @throws ValidationError When request is invalid or response is malformed
966
+ */
967
+ createData: (receivingData: ReceivingCreateRequest) => Promise<{
968
+ requestId: string | null;
969
+ dateCreated: string;
970
+ dateLastModified: string;
971
+ statusCd: number;
972
+ updateCd: number;
973
+ processCd: number;
974
+ properties: string | null;
975
+ jsonData: string | null;
976
+ importState: string;
977
+ receivingUid: number;
978
+ referenceNo: string | null;
979
+ poNo: number;
980
+ processMessage: string | null;
981
+ }>;
982
+ /**
983
+ * Update an existing receiving document (data only)
984
+ * @description Returns only the data from updated receiving response
985
+ * @param receivingUid Receiving unique identifier
986
+ * @param updateData Fields to update on the receiving document
987
+ * @returns Updated receiving details (data only)
988
+ * @throws ValidationError When request is invalid or response is malformed
989
+ */
990
+ updateData: (receivingUid: number | string, updateData: ReceivingUpdateRequest) => Promise<{
991
+ requestId: string | null;
992
+ dateCreated: string;
993
+ dateLastModified: string;
994
+ statusCd: number;
995
+ updateCd: number;
996
+ processCd: number;
997
+ properties: string | null;
998
+ jsonData: string | null;
999
+ importState: string;
1000
+ receivingUid: number;
1001
+ referenceNo: string | null;
1002
+ poNo: number;
1003
+ processMessage: string | null;
1004
+ }>;
1005
+ /**
1006
+ * Soft delete a receiving document (data only)
1007
+ * @description Returns only the data from deleted receiving response
1008
+ * @param receivingUid Receiving unique identifier
1009
+ * @returns Deleted receiving details (data only)
1010
+ * @throws ValidationError When response is malformed
1011
+ */
1012
+ deleteData: (receivingUid: number | string) => Promise<{
1013
+ requestId: string | null;
1014
+ dateCreated: string;
1015
+ dateLastModified: string;
1016
+ statusCd: number;
1017
+ updateCd: number;
1018
+ processCd: number;
1019
+ properties: string | null;
1020
+ jsonData: string | null;
1021
+ importState: string;
1022
+ receivingUid: number;
1023
+ referenceNo: string | null;
1024
+ poNo: number;
1025
+ processMessage: string | null;
1026
+ }>;
605
1027
  };
606
1028
  /**
607
1029
  * Transfer endpoints
@@ -611,6 +1033,14 @@ export declare class NexusClient extends BaseServiceClient {
611
1033
  /**
612
1034
  * Retrieve a list of transfer documents with optional filtering
613
1035
  * @description Returns transfer documents with pagination and filtering by reference number or status
1036
+ * @fullPath api.nexus.transfers.list
1037
+ * @service nexus
1038
+ * @domain warehouse-management
1039
+ * @dataMethod listData
1040
+ * @discoverable true
1041
+ * @searchTerms ["transfers", "location transfers", "inventory transfer", "warehouse transfer", "transfer documents"]
1042
+ * @relatedEndpoints ["api.nexus.transfers.get", "api.nexus.transfers.create", "api.nexus.transferReceipts.list"]
1043
+ * @commonPatterns ["List all transfers", "Get transfer history", "Find transfers by reference"]
614
1044
  * @param params Optional filtering and pagination parameters
615
1045
  * @returns Array of transfer documents
616
1046
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -653,6 +1083,14 @@ export declare class NexusClient extends BaseServiceClient {
653
1083
  /**
654
1084
  * Retrieve details for a specific transfer document
655
1085
  * @description Returns complete details for a transfer document including JSON data
1086
+ * @fullPath api.nexus.transfers.get
1087
+ * @service nexus
1088
+ * @domain warehouse-management
1089
+ * @dataMethod getData
1090
+ * @discoverable true
1091
+ * @searchTerms ["get transfer", "transfer details", "transfer by id", "transfer document"]
1092
+ * @relatedEndpoints ["api.nexus.transfers.list", "api.nexus.transfers.update", "api.nexus.transferReceipts.get"]
1093
+ * @commonPatterns ["Get transfer details by ID", "View specific transfer", "Retrieve transfer information"]
656
1094
  * @param transferUid Transfer unique identifier
657
1095
  * @returns Complete transfer document details
658
1096
  * @throws ValidationError When response is malformed
@@ -688,6 +1126,14 @@ export declare class NexusClient extends BaseServiceClient {
688
1126
  /**
689
1127
  * Create a new transfer document
690
1128
  * @description Creates a transfer document for inventory movement between locations
1129
+ * @fullPath api.nexus.transfers.create
1130
+ * @service nexus
1131
+ * @domain warehouse-management
1132
+ * @dataMethod createData
1133
+ * @discoverable true
1134
+ * @searchTerms ["create transfer", "new transfer", "location transfer", "inventory movement", "warehouse transfer"]
1135
+ * @relatedEndpoints ["api.nexus.transfers.list", "api.nexus.transfers.get", "api.nexus.transferReceipts.create"]
1136
+ * @commonPatterns ["Create new transfer", "Move inventory between locations", "Start transfer process"]
691
1137
  * @param transferData Complete transfer data including reference and location details
692
1138
  * @returns Created transfer document details
693
1139
  * @throws ValidationError When request is invalid or response is malformed
@@ -804,18 +1250,141 @@ export declare class NexusClient extends BaseServiceClient {
804
1250
  total: number;
805
1251
  totalResults: number;
806
1252
  }>;
1253
+ /**
1254
+ * Retrieve a list of transfer documents with optional filtering (data only)
1255
+ * @description Returns only the data array from transfer documents response
1256
+ * @param params Optional filtering and pagination parameters
1257
+ * @returns Array of transfer documents (data only)
1258
+ * @throws ValidationError When parameters are invalid or response is malformed
1259
+ */
1260
+ listData: (params?: TransferListParams) => Promise<{
1261
+ requestId: string | null;
1262
+ dateCreated: string;
1263
+ dateLastModified: string;
1264
+ statusCd: number;
1265
+ updateCd: number;
1266
+ processCd: number;
1267
+ jsonData: string | null;
1268
+ importState: string;
1269
+ referenceNo: string | null;
1270
+ processMessage: string | null;
1271
+ transferUid: number;
1272
+ }[]>;
1273
+ /**
1274
+ * Retrieve details for a specific transfer document (data only)
1275
+ * @description Returns only the data from transfer document details response
1276
+ * @param transferUid Transfer unique identifier
1277
+ * @returns Transfer document details (data only)
1278
+ * @throws ValidationError When response is malformed
1279
+ */
1280
+ getData: (transferUid: number | string) => Promise<{
1281
+ requestId: string | null;
1282
+ dateCreated: string;
1283
+ dateLastModified: string;
1284
+ statusCd: number;
1285
+ updateCd: number;
1286
+ processCd: number;
1287
+ jsonData: string | null;
1288
+ importState: string;
1289
+ referenceNo: string | null;
1290
+ processMessage: string | null;
1291
+ transferUid: number;
1292
+ }>;
1293
+ /**
1294
+ * Create a new transfer document (data only)
1295
+ * @description Returns only the data from created transfer document response
1296
+ * @param transferData Complete transfer data including reference and location details
1297
+ * @returns Created transfer document details (data only)
1298
+ * @throws ValidationError When request is invalid or response is malformed
1299
+ */
1300
+ createData: (transferData: TransferCreateRequest) => Promise<{
1301
+ requestId: string | null;
1302
+ dateCreated: string;
1303
+ dateLastModified: string;
1304
+ statusCd: number;
1305
+ updateCd: number;
1306
+ processCd: number;
1307
+ jsonData: string | null;
1308
+ importState: string;
1309
+ referenceNo: string | null;
1310
+ processMessage: string | null;
1311
+ transferUid: number;
1312
+ }>;
1313
+ /**
1314
+ * Update an existing transfer document (data only)
1315
+ * @description Returns only the data from updated transfer response
1316
+ * @param transferUid Transfer unique identifier
1317
+ * @param updateData Fields to update on the transfer document
1318
+ * @returns Updated transfer details (data only)
1319
+ * @throws ValidationError When request is invalid or response is malformed
1320
+ */
1321
+ updateData: (transferUid: number | string, updateData: TransferUpdateRequest) => Promise<{
1322
+ requestId: string | null;
1323
+ dateCreated: string;
1324
+ dateLastModified: string;
1325
+ statusCd: number;
1326
+ updateCd: number;
1327
+ processCd: number;
1328
+ jsonData: string | null;
1329
+ importState: string;
1330
+ referenceNo: string | null;
1331
+ processMessage: string | null;
1332
+ transferUid: number;
1333
+ }>;
1334
+ /**
1335
+ * Soft delete a transfer document (data only)
1336
+ * @description Returns only the data from deleted transfer response
1337
+ * @param transferUid Transfer unique identifier
1338
+ * @returns Deleted transfer details (data only)
1339
+ * @throws ValidationError When response is malformed
1340
+ */
1341
+ deleteData: (transferUid: number | string) => Promise<{
1342
+ requestId: string | null;
1343
+ dateCreated: string;
1344
+ dateLastModified: string;
1345
+ statusCd: number;
1346
+ updateCd: number;
1347
+ processCd: number;
1348
+ jsonData: string | null;
1349
+ importState: string;
1350
+ referenceNo: string | null;
1351
+ processMessage: string | null;
1352
+ transferUid: number;
1353
+ }>;
807
1354
  };
808
1355
  /**
809
1356
  * Purchase Order Receipt endpoints
810
- * @description Methods for managing purchase order receipt documents
1357
+ * @description Methods for managing purchase order receipt documents for comprehensive receipt tracking and processing
811
1358
  */
812
1359
  purchaseOrderReceipts: {
813
1360
  /**
814
- * Retrieve a list of purchase order receipt documents
815
- * @description Returns purchase order receipts with pagination and filtering support
1361
+ * Retrieve a list of purchase order receipt documents with optional filtering
1362
+ * @description Returns purchase order receipts with pagination and filtering by PO number, status, or receipt date
1363
+ * @fullPath api.nexus.purchaseOrderReceipts.list
1364
+ * @service nexus
1365
+ * @domain warehouse-management
1366
+ * @dataMethod listData
1367
+ * @discoverable true
1368
+ * @searchTerms ["purchase order receipts", "PO receipts", "receipt documents", "receiving receipts", "purchase receipts"]
1369
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.create", "api.nexus.receivings.list"]
1370
+ * @commonPatterns ["List all PO receipts", "Get receipt history", "Find receipts by PO number"]
1371
+ * @workflow ["purchase-order-processing", "receiving-workflow", "receipt-management"]
1372
+ * @prerequisites ["Valid authentication token", "Warehouse management permissions"]
1373
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for details", "api.nexus.purchaseOrderReceipts.update for modifications"]
1374
+ * @businessRules ["Receipts tied to specific PO numbers", "Status codes indicate processing stage", "Pagination required for large datasets"]
1375
+ * @functionalArea "purchase-order-and-receipt-management"
1376
+ * @caching "Cache for 10 minutes, invalidate on receipt changes"
1377
+ * @performance "Supports filtering by PO number for faster searches"
816
1378
  * @param params Optional filtering and pagination parameters
817
1379
  * @returns Array of purchase order receipt documents
818
1380
  * @throws ValidationError When parameters are invalid or response is malformed
1381
+ * @example
1382
+ * ```typescript
1383
+ * const receipts = await client.purchaseOrderReceipts.list({ limit: 30, poNo: 67890 });
1384
+ * receipts.data.forEach(receipt => {
1385
+ * console.log(`Receipt ${receipt.purchaseOrderReceiptUid}: PO ${receipt.poNo}`);
1386
+ * });
1387
+ * ```
819
1388
  */
820
1389
  list: (params?: {
821
1390
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -846,11 +1415,30 @@ export declare class NexusClient extends BaseServiceClient {
846
1415
  totalResults: number;
847
1416
  }>;
848
1417
  /**
849
- * Retrieve details for a specific purchase order receipt
850
- * @description Returns complete details for a purchase order receipt document
1418
+ * Retrieve details for a specific purchase order receipt document
1419
+ * @description Returns complete details for a purchase order receipt including JSON data and tracking information
1420
+ * @fullPath api.nexus.purchaseOrderReceipts.get
1421
+ * @service nexus
1422
+ * @domain warehouse-management
1423
+ * @dataMethod getData
1424
+ * @discoverable true
1425
+ * @searchTerms ["get PO receipt", "receipt details", "purchase order receipt by id", "receipt document"]
1426
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.update", "api.nexus.receivings.get"]
1427
+ * @commonPatterns ["Get receipt details by ID", "View specific PO receipt", "Retrieve receipt information"]
1428
+ * @workflow ["receipt-verification", "purchase-order-processing", "audit-trail"]
1429
+ * @prerequisites ["Valid receipt ID", "Read permissions for receipts"]
1430
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.update for modifications", "api.nexus.receivings.get for receiving details"]
1431
+ * @businessRules ["Receipt must exist and be accessible", "Includes complete audit trail"]
1432
+ * @functionalArea "purchase-order-and-receipt-management"
851
1433
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
852
1434
  * @returns Complete purchase order receipt details
853
1435
  * @throws ValidationError When response is malformed
1436
+ * @example
1437
+ * ```typescript
1438
+ * const receipt = await client.purchaseOrderReceipts.get(98765);
1439
+ * console.log('Receipt details:', receipt.data.jsonData);
1440
+ * console.log('PO Number:', receipt.data.poNo);
1441
+ * ```
854
1442
  */
855
1443
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
856
1444
  params: Record<string, unknown> | unknown[];
@@ -876,10 +1464,32 @@ export declare class NexusClient extends BaseServiceClient {
876
1464
  }>;
877
1465
  /**
878
1466
  * Create a new purchase order receipt document
879
- * @description Creates a purchase order receipt document for tracking
1467
+ * @description Creates a purchase order receipt document for comprehensive tracking and audit trail
1468
+ * @fullPath api.nexus.purchaseOrderReceipts.create
1469
+ * @service nexus
1470
+ * @domain warehouse-management
1471
+ * @dataMethod createData
1472
+ * @discoverable true
1473
+ * @searchTerms ["create PO receipt", "new receipt", "purchase order receipt", "receipt creation", "document receipt"]
1474
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.get", "api.nexus.receivings.create"]
1475
+ * @commonPatterns ["Create new PO receipt", "Document receipt process", "Start receipt tracking"]
1476
+ * @workflow ["receipt-creation", "purchase-order-processing", "document-generation"]
1477
+ * @prerequisites ["Valid PO information", "Receipt creation permissions", "Required receipt data"]
1478
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for verification", "api.nexus.purchaseOrderReceipts.update for status changes"]
1479
+ * @businessRules ["Must include valid PO reference", "Receipt data structure must be valid", "Creates audit trail entry"]
1480
+ * @functionalArea "purchase-order-and-receipt-management"
880
1481
  * @param receiptData Complete purchase order receipt data
881
1482
  * @returns Created purchase order receipt details
882
1483
  * @throws ValidationError When request is invalid or response is malformed
1484
+ * @example
1485
+ * ```typescript
1486
+ * const receipt = await client.purchaseOrderReceipts.create({
1487
+ * poNo: 67890,
1488
+ * referenceNo: 'RECEIPT001',
1489
+ * jsonData: JSON.stringify({ items: [{ itemId: 'ITEM001', receivedQty: 50 }] }),
1490
+ * properties: JSON.stringify({ supplier: 'ABC Supply', receiptDate: '2024-01-15' })
1491
+ * });
1492
+ * ```
883
1493
  */
884
1494
  create: (data: {
885
1495
  requestId?: string | undefined;
@@ -909,12 +1519,33 @@ export declare class NexusClient extends BaseServiceClient {
909
1519
  totalResults: number;
910
1520
  }>;
911
1521
  /**
912
- * Update an existing purchase order receipt
913
- * @description Updates purchase order receipt status and properties
1522
+ * Update an existing purchase order receipt document
1523
+ * @description Updates purchase order receipt status, properties, and tracking information
1524
+ * @fullPath api.nexus.purchaseOrderReceipts.update
1525
+ * @service nexus
1526
+ * @domain warehouse-management
1527
+ * @dataMethod updateData
1528
+ * @discoverable true
1529
+ * @searchTerms ["update PO receipt", "modify receipt", "change receipt status", "update receipt", "receipt modification"]
1530
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.delete"]
1531
+ * @commonPatterns ["Update receipt status", "Modify receipt details", "Change receipt properties"]
1532
+ * @workflow ["receipt-processing", "status-updates", "audit-trail-maintenance"]
1533
+ * @prerequisites ["Valid receipt ID", "Update permissions", "Proper status transitions"]
1534
+ * @nextSteps ["api.nexus.purchaseOrderReceipts.get for verification", "Related processing workflows"]
1535
+ * @businessRules ["Status changes must follow valid transitions", "Updates create audit trail entries", "Some fields may be immutable"]
1536
+ * @functionalArea "purchase-order-and-receipt-management"
914
1537
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
915
1538
  * @param updateData Fields to update on the purchase order receipt
916
1539
  * @returns Updated purchase order receipt details
917
1540
  * @throws ValidationError When request is invalid or response is malformed
1541
+ * @example
1542
+ * ```typescript
1543
+ * const updated = await client.purchaseOrderReceipts.update(98766, {
1544
+ * statusCd: 705,
1545
+ * processCd: 705,
1546
+ * properties: JSON.stringify({ notes: 'Receipt processed successfully' })
1547
+ * });
1548
+ * ```
918
1549
  */
919
1550
  update: (id: string | number, data: {
920
1551
  statusCd?: number | undefined;
@@ -944,11 +1575,29 @@ export declare class NexusClient extends BaseServiceClient {
944
1575
  totalResults: number;
945
1576
  }>;
946
1577
  /**
947
- * Soft delete a purchase order receipt
948
- * @description Marks a purchase order receipt as deleted
1578
+ * Soft delete a purchase order receipt document
1579
+ * @description Marks a purchase order receipt as deleted by setting status code to 700
1580
+ * @fullPath api.nexus.purchaseOrderReceipts.delete
1581
+ * @service nexus
1582
+ * @domain warehouse-management
1583
+ * @dataMethod deleteData
1584
+ * @discoverable true
1585
+ * @searchTerms ["delete PO receipt", "remove receipt", "cancel receipt", "soft delete receipt"]
1586
+ * @relatedEndpoints ["api.nexus.purchaseOrderReceipts.get", "api.nexus.purchaseOrderReceipts.list", "api.nexus.purchaseOrderReceipts.update"]
1587
+ * @commonPatterns ["Delete receipt document", "Cancel receipt", "Remove receipt record"]
1588
+ * @workflow ["receipt-cancellation", "cleanup-processes", "audit-trail-maintenance"]
1589
+ * @prerequisites ["Valid receipt ID", "Delete permissions", "Receipt must be in deletable state"]
1590
+ * @nextSteps ["Cleanup related documents if needed", "Update related processes"]
1591
+ * @businessRules ["Soft delete preserves audit trail", "Status set to 700", "Related documents may need attention"]
1592
+ * @functionalArea "purchase-order-and-receipt-management"
949
1593
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
950
1594
  * @returns Deleted purchase order receipt details with updated status
951
1595
  * @throws ValidationError When response is malformed
1596
+ * @example
1597
+ * ```typescript
1598
+ * const deleted = await client.purchaseOrderReceipts.delete(98766);
1599
+ * console.log('Receipt deleted, status:', deleted.data.statusCd); // Should be 700
1600
+ * ```
952
1601
  */
953
1602
  delete: (id: string | number) => Promise<{
954
1603
  params: Record<string, unknown> | unknown[];
@@ -972,18 +1621,141 @@ export declare class NexusClient extends BaseServiceClient {
972
1621
  total: number;
973
1622
  totalResults: number;
974
1623
  }>;
1624
+ /**
1625
+ * Retrieve a list of purchase order receipt documents (data only)
1626
+ * @description Returns only the data array from purchase order receipts response
1627
+ * @param params Optional filtering and pagination parameters
1628
+ * @returns Array of purchase order receipt documents (data only)
1629
+ * @throws ValidationError When parameters are invalid or response is malformed
1630
+ */
1631
+ listData: (params?: PurchaseOrderReceiptListParams) => Promise<{
1632
+ requestId: string | null;
1633
+ dateCreated: string;
1634
+ dateLastModified: string;
1635
+ statusCd: number;
1636
+ updateCd: number;
1637
+ processCd: number;
1638
+ jsonData: string | null;
1639
+ importState: string;
1640
+ referenceNo: string | null;
1641
+ processMessage: string | null;
1642
+ purchaseOrderReceiptUid: number;
1643
+ }[]>;
1644
+ /**
1645
+ * Retrieve details for a specific purchase order receipt (data only)
1646
+ * @description Returns only the data from purchase order receipt details response
1647
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
1648
+ * @returns Purchase order receipt details (data only)
1649
+ * @throws ValidationError When response is malformed
1650
+ */
1651
+ getData: (purchaseOrderReceiptUid: number | string) => Promise<{
1652
+ requestId: string | null;
1653
+ dateCreated: string;
1654
+ dateLastModified: string;
1655
+ statusCd: number;
1656
+ updateCd: number;
1657
+ processCd: number;
1658
+ jsonData: string | null;
1659
+ importState: string;
1660
+ referenceNo: string | null;
1661
+ processMessage: string | null;
1662
+ purchaseOrderReceiptUid: number;
1663
+ }>;
1664
+ /**
1665
+ * Create a new purchase order receipt document (data only)
1666
+ * @description Returns only the data from created purchase order receipt response
1667
+ * @param receiptData Complete purchase order receipt data
1668
+ * @returns Created purchase order receipt details (data only)
1669
+ * @throws ValidationError When request is invalid or response is malformed
1670
+ */
1671
+ createData: (receiptData: PurchaseOrderReceiptCreateRequest) => Promise<{
1672
+ requestId: string | null;
1673
+ dateCreated: string;
1674
+ dateLastModified: string;
1675
+ statusCd: number;
1676
+ updateCd: number;
1677
+ processCd: number;
1678
+ jsonData: string | null;
1679
+ importState: string;
1680
+ referenceNo: string | null;
1681
+ processMessage: string | null;
1682
+ purchaseOrderReceiptUid: number;
1683
+ }>;
1684
+ /**
1685
+ * Update an existing purchase order receipt (data only)
1686
+ * @description Returns only the data from updated purchase order receipt response
1687
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
1688
+ * @param updateData Fields to update on the purchase order receipt
1689
+ * @returns Updated purchase order receipt details (data only)
1690
+ * @throws ValidationError When request is invalid or response is malformed
1691
+ */
1692
+ updateData: (purchaseOrderReceiptUid: number | string, updateData: PurchaseOrderReceiptUpdateRequest) => Promise<{
1693
+ requestId: string | null;
1694
+ dateCreated: string;
1695
+ dateLastModified: string;
1696
+ statusCd: number;
1697
+ updateCd: number;
1698
+ processCd: number;
1699
+ jsonData: string | null;
1700
+ importState: string;
1701
+ referenceNo: string | null;
1702
+ processMessage: string | null;
1703
+ purchaseOrderReceiptUid: number;
1704
+ }>;
1705
+ /**
1706
+ * Soft delete a purchase order receipt (data only)
1707
+ * @description Returns only the data from deleted purchase order receipt response
1708
+ * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
1709
+ * @returns Deleted purchase order receipt details (data only)
1710
+ * @throws ValidationError When response is malformed
1711
+ */
1712
+ deleteData: (purchaseOrderReceiptUid: number | string) => Promise<{
1713
+ requestId: string | null;
1714
+ dateCreated: string;
1715
+ dateLastModified: string;
1716
+ statusCd: number;
1717
+ updateCd: number;
1718
+ processCd: number;
1719
+ jsonData: string | null;
1720
+ importState: string;
1721
+ referenceNo: string | null;
1722
+ processMessage: string | null;
1723
+ purchaseOrderReceiptUid: number;
1724
+ }>;
975
1725
  };
976
1726
  /**
977
1727
  * Transfer Receipt endpoints
978
- * @description Methods for managing transfer receipt documents
1728
+ * @description Methods for managing transfer receipt documents for comprehensive transfer tracking and confirmation
979
1729
  */
980
1730
  transferReceipts: {
981
1731
  /**
982
- * Retrieve a list of transfer receipt documents
983
- * @description Returns transfer receipts with pagination and filtering support
1732
+ * Retrieve a list of transfer receipt documents with optional filtering
1733
+ * @description Returns transfer receipts with pagination and filtering by transfer number, status, or receipt date
1734
+ * @fullPath api.nexus.transferReceipts.list
1735
+ * @service nexus
1736
+ * @domain warehouse-management
1737
+ * @dataMethod listData
1738
+ * @discoverable true
1739
+ * @searchTerms ["transfer receipts", "receipt documents", "transfer confirmations", "receipt list", "transfer receiving"]
1740
+ * @relatedEndpoints ["api.nexus.transferReceipts.get", "api.nexus.transferReceipts.create", "api.nexus.transfers.list"]
1741
+ * @commonPatterns ["List all transfer receipts", "Get receipt history", "Find receipts by transfer"]
1742
+ * @workflow ["transfer-receiving", "receipt-management", "transfer-completion"]
1743
+ * @prerequisites ["Valid authentication token", "Transfer receipt access permissions"]
1744
+ * @nextSteps ["api.nexus.transferReceipts.get for details", "api.nexus.transferReceipts.update for modifications"]
1745
+ * @businessRules ["Receipts confirm transfer completion", "Status codes track receipt progress", "Pagination for large datasets"]
1746
+ * @functionalArea "transfer-and-receipt-management"
1747
+ * @caching "Cache for 15 minutes, invalidate on receipt changes"
1748
+ * @performance "Supports filtering by transfer ID for faster searches"
984
1749
  * @param params Optional filtering and pagination parameters
985
1750
  * @returns Array of transfer receipt documents
986
1751
  * @throws ValidationError When parameters are invalid or response is malformed
1752
+ * @example
1753
+ * ```typescript
1754
+ * const receipts = await client.transferReceipts.list({ limit: 25, transferUid: 12345 });
1755
+ * receipts.data.forEach(receipt => {
1756
+ * console.log(`Receipt ${receipt.transferReceiptUid}: Transfer ${receipt.transferUid}`);
1757
+ * });
1758
+ * ```
987
1759
  */
988
1760
  list: (params?: {
989
1761
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -1014,11 +1786,30 @@ export declare class NexusClient extends BaseServiceClient {
1014
1786
  totalResults: number;
1015
1787
  }>;
1016
1788
  /**
1017
- * Retrieve details for a specific transfer receipt
1018
- * @description Returns complete details for a transfer receipt document
1789
+ * Retrieve details for a specific transfer receipt document
1790
+ * @description Returns complete details for a transfer receipt including JSON data and confirmation information
1791
+ * @fullPath api.nexus.transferReceipts.get
1792
+ * @service nexus
1793
+ * @domain warehouse-management
1794
+ * @dataMethod getData
1795
+ * @discoverable true
1796
+ * @searchTerms ["get transfer receipt", "receipt details", "transfer receipt by id", "receipt document"]
1797
+ * @relatedEndpoints ["api.nexus.transferReceipts.list", "api.nexus.transferReceipts.update", "api.nexus.transfers.get"]
1798
+ * @commonPatterns ["Get receipt details by ID", "View specific transfer receipt", "Retrieve receipt information"]
1799
+ * @workflow ["receipt-verification", "transfer-confirmation", "audit-review"]
1800
+ * @prerequisites ["Valid receipt ID", "Read permissions for transfer receipts"]
1801
+ * @nextSteps ["api.nexus.transferReceipts.update for modifications", "api.nexus.transfers.get for transfer details"]
1802
+ * @businessRules ["Receipt must exist and be accessible", "Includes complete transfer confirmation data"]
1803
+ * @functionalArea "transfer-and-receipt-management"
1019
1804
  * @param transferReceiptUid Transfer receipt unique identifier
1020
1805
  * @returns Complete transfer receipt details
1021
1806
  * @throws ValidationError When response is malformed
1807
+ * @example
1808
+ * ```typescript
1809
+ * const receipt = await client.transferReceipts.get(54321);
1810
+ * console.log('Receipt details:', receipt.data.jsonData);
1811
+ * console.log('Transfer ID:', receipt.data.transferUid);
1812
+ * ```
1022
1813
  */
1023
1814
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
1024
1815
  params: Record<string, unknown> | unknown[];
@@ -1044,10 +1835,32 @@ export declare class NexusClient extends BaseServiceClient {
1044
1835
  }>;
1045
1836
  /**
1046
1837
  * Create a new transfer receipt document
1047
- * @description Creates a transfer receipt document for tracking
1838
+ * @description Creates a transfer receipt document for comprehensive tracking and confirmation of transfer completion
1839
+ * @fullPath api.nexus.transferReceipts.create
1840
+ * @service nexus
1841
+ * @domain warehouse-management
1842
+ * @dataMethod createData
1843
+ * @discoverable true
1844
+ * @searchTerms ["create transfer receipt", "new receipt", "transfer confirmation", "receipt creation", "confirm transfer"]
1845
+ * @relatedEndpoints ["api.nexus.transferReceipts.list", "api.nexus.transferReceipts.get", "api.nexus.transfers.get"]
1846
+ * @commonPatterns ["Create new transfer receipt", "Confirm transfer completion", "Start receipt tracking"]
1847
+ * @workflow ["receipt-creation", "transfer-confirmation", "completion-processing"]
1848
+ * @prerequisites ["Valid transfer information", "Receipt creation permissions", "Transfer in receivable state"]
1849
+ * @nextSteps ["api.nexus.transferReceipts.get for verification", "api.nexus.transferReceipts.update for status changes"]
1850
+ * @businessRules ["Must reference valid transfer", "Receipt data structure must be valid", "Creates completion audit trail"]
1851
+ * @functionalArea "transfer-and-receipt-management"
1048
1852
  * @param receiptData Complete transfer receipt data
1049
1853
  * @returns Created transfer receipt details
1050
1854
  * @throws ValidationError When request is invalid or response is malformed
1855
+ * @example
1856
+ * ```typescript
1857
+ * const receipt = await client.transferReceipts.create({
1858
+ * transferUid: 12345,
1859
+ * referenceNo: 'TR_RECEIPT001',
1860
+ * jsonData: JSON.stringify({ receivedItems: [{ itemId: 'ITEM001', receivedQty: 25 }] }),
1861
+ * properties: JSON.stringify({ receivedBy: 'John Doe', receiptDate: '2024-01-20' })
1862
+ * });
1863
+ * ```
1051
1864
  */
1052
1865
  create: (data: {
1053
1866
  requestId?: string | undefined;
@@ -1140,18 +1953,141 @@ export declare class NexusClient extends BaseServiceClient {
1140
1953
  total: number;
1141
1954
  totalResults: number;
1142
1955
  }>;
1956
+ /**
1957
+ * Retrieve a list of transfer receipt documents (data only)
1958
+ * @description Returns only the data array from transfer receipts response
1959
+ * @param params Optional filtering and pagination parameters
1960
+ * @returns Array of transfer receipt documents (data only)
1961
+ * @throws ValidationError When parameters are invalid or response is malformed
1962
+ */
1963
+ listData: (params?: TransferReceiptListParams) => Promise<{
1964
+ requestId: string | null;
1965
+ dateCreated: string;
1966
+ dateLastModified: string;
1967
+ statusCd: number;
1968
+ updateCd: number;
1969
+ processCd: number;
1970
+ jsonData: string | null;
1971
+ importState: string;
1972
+ referenceNo: string | null;
1973
+ processMessage: string | null;
1974
+ transferReceiptUid: number;
1975
+ }[]>;
1976
+ /**
1977
+ * Retrieve details for a specific transfer receipt (data only)
1978
+ * @description Returns only the data from transfer receipt details response
1979
+ * @param transferReceiptUid Transfer receipt unique identifier
1980
+ * @returns Transfer receipt details (data only)
1981
+ * @throws ValidationError When response is malformed
1982
+ */
1983
+ getData: (transferReceiptUid: number | string) => Promise<{
1984
+ requestId: string | null;
1985
+ dateCreated: string;
1986
+ dateLastModified: string;
1987
+ statusCd: number;
1988
+ updateCd: number;
1989
+ processCd: number;
1990
+ jsonData: string | null;
1991
+ importState: string;
1992
+ referenceNo: string | null;
1993
+ processMessage: string | null;
1994
+ transferReceiptUid: number;
1995
+ }>;
1996
+ /**
1997
+ * Create a new transfer receipt document (data only)
1998
+ * @description Returns only the data from created transfer receipt response
1999
+ * @param receiptData Complete transfer receipt data
2000
+ * @returns Created transfer receipt details (data only)
2001
+ * @throws ValidationError When request is invalid or response is malformed
2002
+ */
2003
+ createData: (receiptData: TransferReceiptCreateRequest) => Promise<{
2004
+ requestId: string | null;
2005
+ dateCreated: string;
2006
+ dateLastModified: string;
2007
+ statusCd: number;
2008
+ updateCd: number;
2009
+ processCd: number;
2010
+ jsonData: string | null;
2011
+ importState: string;
2012
+ referenceNo: string | null;
2013
+ processMessage: string | null;
2014
+ transferReceiptUid: number;
2015
+ }>;
2016
+ /**
2017
+ * Update an existing transfer receipt (data only)
2018
+ * @description Returns only the data from updated transfer receipt response
2019
+ * @param transferReceiptUid Transfer receipt unique identifier
2020
+ * @param updateData Fields to update on the transfer receipt
2021
+ * @returns Updated transfer receipt details (data only)
2022
+ * @throws ValidationError When request is invalid or response is malformed
2023
+ */
2024
+ updateData: (transferReceiptUid: number | string, updateData: TransferReceiptUpdateRequest) => Promise<{
2025
+ requestId: string | null;
2026
+ dateCreated: string;
2027
+ dateLastModified: string;
2028
+ statusCd: number;
2029
+ updateCd: number;
2030
+ processCd: number;
2031
+ jsonData: string | null;
2032
+ importState: string;
2033
+ referenceNo: string | null;
2034
+ processMessage: string | null;
2035
+ transferReceiptUid: number;
2036
+ }>;
2037
+ /**
2038
+ * Soft delete a transfer receipt (data only)
2039
+ * @description Returns only the data from deleted transfer receipt response
2040
+ * @param transferReceiptUid Transfer receipt unique identifier
2041
+ * @returns Deleted transfer receipt details (data only)
2042
+ * @throws ValidationError When response is malformed
2043
+ */
2044
+ deleteData: (transferReceiptUid: number | string) => Promise<{
2045
+ requestId: string | null;
2046
+ dateCreated: string;
2047
+ dateLastModified: string;
2048
+ statusCd: number;
2049
+ updateCd: number;
2050
+ processCd: number;
2051
+ jsonData: string | null;
2052
+ importState: string;
2053
+ referenceNo: string | null;
2054
+ processMessage: string | null;
2055
+ transferReceiptUid: number;
2056
+ }>;
1143
2057
  };
1144
2058
  /**
1145
2059
  * Transfer Shipping endpoints
1146
- * @description Methods for managing transfer shipping documents
2060
+ * @description Methods for managing transfer shipping documents for comprehensive outbound transfer tracking and logistics
1147
2061
  */
1148
2062
  transferShippings: {
1149
2063
  /**
1150
- * Retrieve a list of transfer shipping documents
1151
- * @description Returns transfer shippings with pagination and filtering support
2064
+ * Retrieve a list of transfer shipping documents with optional filtering
2065
+ * @description Returns transfer shipping documents with pagination and filtering by shipping reference, status, or shipping date
2066
+ * @fullPath api.nexus.transferShippings.list
2067
+ * @service nexus
2068
+ * @domain warehouse-management
2069
+ * @dataMethod listData
2070
+ * @discoverable true
2071
+ * @searchTerms ["transfer shipping", "shipping documents", "outbound transfers", "shipping list", "transfer logistics"]
2072
+ * @relatedEndpoints ["api.nexus.transferShippings.get", "api.nexus.transferShippings.create", "api.nexus.transfers.list"]
2073
+ * @commonPatterns ["List all transfer shipments", "Get shipping history", "Find shipments by reference"]
2074
+ * @workflow ["outbound-shipping", "transfer-logistics", "shipping-management"]
2075
+ * @prerequisites ["Valid authentication token", "Transfer shipping access permissions"]
2076
+ * @nextSteps ["api.nexus.transferShippings.get for details", "api.nexus.transferShippings.update for tracking updates"]
2077
+ * @businessRules ["Shipping documents track outbound transfers", "Status codes indicate shipping progress", "Pagination for large datasets"]
2078
+ * @functionalArea "transfer-and-shipping-management"
2079
+ * @caching "Cache for 20 minutes, invalidate on shipping changes"
2080
+ * @performance "Supports filtering by transfer receipt ID for faster searches"
1152
2081
  * @param params Optional filtering and pagination parameters
1153
2082
  * @returns Array of transfer shipping documents
1154
2083
  * @throws ValidationError When parameters are invalid or response is malformed
2084
+ * @example
2085
+ * ```typescript
2086
+ * const shipments = await client.transferShippings.list({ limit: 30, statusCd: 704 });
2087
+ * shipments.data.forEach(shipment => {
2088
+ * console.log(`Shipment ${shipment.transferShippingUid}: Receipt ${shipment.transferReceiptUid}`);
2089
+ * });
2090
+ * ```
1155
2091
  */
1156
2092
  list: (params?: {
1157
2093
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -1183,7 +2119,20 @@ export declare class NexusClient extends BaseServiceClient {
1183
2119
  }>;
1184
2120
  /**
1185
2121
  * Retrieve details for a specific transfer shipping document
1186
- * @description Returns complete details for a transfer shipping document
2122
+ * @description Returns complete details for a transfer shipping document including JSON data and tracking information
2123
+ * @fullPath api.nexus.transferShippings.get
2124
+ * @service nexus
2125
+ * @domain warehouse-management
2126
+ * @dataMethod getData
2127
+ * @discoverable true
2128
+ * @searchTerms ["get transfer shipping", "shipping details", "transfer shipping by id", "shipping document", "outbound tracking"]
2129
+ * @relatedEndpoints ["api.nexus.transferShippings.list", "api.nexus.transferShippings.update", "api.nexus.transferReceipts.get"]
2130
+ * @commonPatterns ["Get shipping details by ID", "View specific transfer shipment", "Retrieve shipping information"]
2131
+ * @workflow ["shipping-tracking", "outbound-verification", "logistics-review"]
2132
+ * @prerequisites ["Valid transfer receipt ID", "Read permissions for transfer shipping"]
2133
+ * @nextSteps ["api.nexus.transferShippings.update for tracking updates", "Related logistics processes"]
2134
+ * @businessRules ["Shipping document must exist and be accessible", "Includes complete tracking and logistics data"]
2135
+ * @functionalArea "transfer-and-shipping-management"
1187
2136
  * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
1188
2137
  * @returns Complete transfer shipping details
1189
2138
  * @throws ValidationError When response is malformed
@@ -1191,6 +2140,7 @@ export declare class NexusClient extends BaseServiceClient {
1191
2140
  * ```typescript
1192
2141
  * const shipping = await client.transferShippings.get(12345);
1193
2142
  * console.log('Shipping details:', shipping.data.jsonData);
2143
+ * console.log('Tracking info:', shipping.data.properties);
1194
2144
  * ```
1195
2145
  */
1196
2146
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
@@ -1217,10 +2167,32 @@ export declare class NexusClient extends BaseServiceClient {
1217
2167
  }>;
1218
2168
  /**
1219
2169
  * Create a new transfer shipping document
1220
- * @description Creates a transfer shipping document for tracking
2170
+ * @description Creates a transfer shipping document for comprehensive outbound tracking and logistics management
2171
+ * @fullPath api.nexus.transferShippings.create
2172
+ * @service nexus
2173
+ * @domain warehouse-management
2174
+ * @dataMethod createData
2175
+ * @discoverable true
2176
+ * @searchTerms ["create transfer shipping", "new shipping", "outbound transfer", "shipping creation", "transfer logistics"]
2177
+ * @relatedEndpoints ["api.nexus.transferShippings.list", "api.nexus.transferShippings.get", "api.nexus.transferReceipts.get"]
2178
+ * @commonPatterns ["Create new transfer shipment", "Start outbound transfer", "Begin shipping process"]
2179
+ * @workflow ["shipping-initiation", "outbound-processing", "logistics-creation"]
2180
+ * @prerequisites ["Valid transfer receipt information", "Shipping creation permissions", "Transfer ready for shipment"]
2181
+ * @nextSteps ["api.nexus.transferShippings.get for verification", "api.nexus.transferShippings.update for tracking updates"]
2182
+ * @businessRules ["Must reference valid transfer receipt", "Shipping data structure must be valid", "Creates logistics audit trail"]
2183
+ * @functionalArea "transfer-and-shipping-management"
1221
2184
  * @param shippingData Complete transfer shipping data
1222
2185
  * @returns Created transfer shipping details
1223
2186
  * @throws ValidationError When request is invalid or response is malformed
2187
+ * @example
2188
+ * ```typescript
2189
+ * const shipping = await client.transferShippings.create({
2190
+ * transferReceiptUid: 54321,
2191
+ * referenceNo: 'SHIP001',
2192
+ * jsonData: JSON.stringify({ carrier: 'FedEx', trackingNumber: 'TRK123456' }),
2193
+ * properties: JSON.stringify({ shippedBy: 'Warehouse A', shippingDate: '2024-01-25' })
2194
+ * });
2195
+ * ```
1224
2196
  */
1225
2197
  create: (data: {
1226
2198
  requestId?: string | undefined;
@@ -1313,6 +2285,108 @@ export declare class NexusClient extends BaseServiceClient {
1313
2285
  total: number;
1314
2286
  totalResults: number;
1315
2287
  }>;
2288
+ /**
2289
+ * Retrieve a list of transfer shipping documents (data only)
2290
+ * @description Returns only the data array from transfer shippings response
2291
+ * @param params Optional filtering and pagination parameters
2292
+ * @returns Array of transfer shipping documents (data only)
2293
+ * @throws ValidationError When parameters are invalid or response is malformed
2294
+ */
2295
+ listData: (params?: TransferShippingListParams) => Promise<{
2296
+ requestId: string | null;
2297
+ dateCreated: string;
2298
+ dateLastModified: string;
2299
+ statusCd: number;
2300
+ updateCd: number;
2301
+ processCd: number;
2302
+ jsonData: string | null;
2303
+ importState: string;
2304
+ referenceNo: string | null;
2305
+ processMessage: string | null;
2306
+ transferReceiptUid: number;
2307
+ }[]>;
2308
+ /**
2309
+ * Retrieve details for a specific transfer shipping document (data only)
2310
+ * @description Returns only the data from transfer shipping details response
2311
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
2312
+ * @returns Transfer shipping details (data only)
2313
+ * @throws ValidationError When response is malformed
2314
+ */
2315
+ getData: (transferReceiptUid: number | string) => Promise<{
2316
+ requestId: string | null;
2317
+ dateCreated: string;
2318
+ dateLastModified: string;
2319
+ statusCd: number;
2320
+ updateCd: number;
2321
+ processCd: number;
2322
+ jsonData: string | null;
2323
+ importState: string;
2324
+ referenceNo: string | null;
2325
+ processMessage: string | null;
2326
+ transferReceiptUid: number;
2327
+ }>;
2328
+ /**
2329
+ * Create a new transfer shipping document (data only)
2330
+ * @description Returns only the data from created transfer shipping response
2331
+ * @param shippingData Complete transfer shipping data
2332
+ * @returns Created transfer shipping details (data only)
2333
+ * @throws ValidationError When request is invalid or response is malformed
2334
+ */
2335
+ createData: (shippingData: TransferShippingCreateRequest) => Promise<{
2336
+ requestId: string | null;
2337
+ dateCreated: string;
2338
+ dateLastModified: string;
2339
+ statusCd: number;
2340
+ updateCd: number;
2341
+ processCd: number;
2342
+ jsonData: string | null;
2343
+ importState: string;
2344
+ referenceNo: string | null;
2345
+ processMessage: string | null;
2346
+ transferReceiptUid: number;
2347
+ }>;
2348
+ /**
2349
+ * Update an existing transfer shipping document (data only)
2350
+ * @description Returns only the data from updated transfer shipping response
2351
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
2352
+ * @param updateData Fields to update on the transfer shipping
2353
+ * @returns Updated transfer shipping details (data only)
2354
+ * @throws ValidationError When request is invalid or response is malformed
2355
+ */
2356
+ updateData: (transferReceiptUid: number | string, updateData: TransferShippingUpdateRequest) => Promise<{
2357
+ requestId: string | null;
2358
+ dateCreated: string;
2359
+ dateLastModified: string;
2360
+ statusCd: number;
2361
+ updateCd: number;
2362
+ processCd: number;
2363
+ jsonData: string | null;
2364
+ importState: string;
2365
+ referenceNo: string | null;
2366
+ processMessage: string | null;
2367
+ transferReceiptUid: number;
2368
+ }>;
2369
+ /**
2370
+ * Soft delete a transfer shipping document (data only)
2371
+ * @description Returns only the data from deleted transfer shipping response
2372
+ * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
2373
+ * @returns Deleted transfer shipping details (data only)
2374
+ * @throws ValidationError When response is malformed
2375
+ */
2376
+ deleteData: (transferReceiptUid: number | string) => Promise<{
2377
+ requestId: string | null;
2378
+ dateCreated: string;
2379
+ dateLastModified: string;
2380
+ statusCd: number;
2381
+ updateCd: number;
2382
+ processCd: number;
2383
+ jsonData: string | null;
2384
+ importState: string;
2385
+ referenceNo: string | null;
2386
+ processMessage: string | null;
2387
+ transferReceiptUid: number;
2388
+ }>;
1316
2389
  };
1317
2390
  }
2391
+ export {};
1318
2392
  //# sourceMappingURL=client.d.ts.map