@simpleapps-com/augur-api 0.2.2 → 0.2.4

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 (339) hide show
  1. package/dist/cjs/client.d.ts +181 -0
  2. package/dist/cjs/client.d.ts.map +1 -1
  3. package/dist/cjs/client.js +449 -0
  4. package/dist/cjs/client.js.map +1 -1
  5. package/dist/cjs/core/base-client.d.ts +106 -2
  6. package/dist/cjs/core/base-client.d.ts.map +1 -1
  7. package/dist/cjs/core/base-client.js +201 -0
  8. package/dist/cjs/core/base-client.js.map +1 -1
  9. package/dist/cjs/core/common-schemas.d.ts +30 -30
  10. package/dist/cjs/core/common-schemas.d.ts.map +1 -1
  11. package/dist/cjs/core/common-schemas.js +3 -2
  12. package/dist/cjs/core/common-schemas.js.map +1 -1
  13. package/dist/cjs/core/schema-factories.d.ts +32 -32
  14. package/dist/cjs/core/schema-utils.d.ts +1115 -0
  15. package/dist/cjs/core/schema-utils.d.ts.map +1 -1
  16. package/dist/cjs/core/schema-utils.js +169 -1
  17. package/dist/cjs/core/schema-utils.js.map +1 -1
  18. package/dist/cjs/core/schemas.d.ts +12 -12
  19. package/dist/cjs/core/schemas.d.ts.map +1 -1
  20. package/dist/cjs/core/schemas.js +9 -2
  21. package/dist/cjs/core/schemas.js.map +1 -1
  22. package/dist/cjs/index.d.ts +2 -1
  23. package/dist/cjs/index.d.ts.map +1 -1
  24. package/dist/cjs/index.js +1 -1
  25. package/dist/cjs/index.js.map +1 -1
  26. package/dist/cjs/services/agr-site/client.d.ts +2 -2
  27. package/dist/cjs/services/agr-site/schemas/health.d.ts +6 -6
  28. package/dist/cjs/services/commerce/client.d.ts +18 -18
  29. package/dist/cjs/services/commerce/schemas/cart.d.ts +30 -30
  30. package/dist/cjs/services/commerce/schemas/checkout.d.ts +42 -42
  31. package/dist/cjs/services/commerce/schemas/health.d.ts +6 -6
  32. package/dist/cjs/services/commerce/schemas/recommendations.d.ts +6 -6
  33. package/dist/cjs/services/customers/client.d.ts +42 -42
  34. package/dist/cjs/services/customers/schemas/addresses.d.ts +18 -18
  35. package/dist/cjs/services/customers/schemas/contacts.d.ts +24 -24
  36. package/dist/cjs/services/customers/schemas/customers.d.ts +42 -42
  37. package/dist/cjs/services/customers/schemas/health.d.ts +6 -6
  38. package/dist/cjs/services/customers/schemas/invoices.d.ts +12 -12
  39. package/dist/cjs/services/customers/schemas/orders.d.ts +18 -18
  40. package/dist/cjs/services/customers/schemas/purchased-items.d.ts +6 -6
  41. package/dist/cjs/services/customers/schemas/quotes.d.ts +12 -12
  42. package/dist/cjs/services/items/client.d.ts +72 -72
  43. package/dist/cjs/services/items/schemas/alternateCode.d.ts +6 -6
  44. package/dist/cjs/services/items/schemas/alternateCode.d.ts.map +1 -1
  45. package/dist/cjs/services/items/schemas/alternateCode.js +3 -2
  46. package/dist/cjs/services/items/schemas/alternateCode.js.map +1 -1
  47. package/dist/cjs/services/items/schemas/attributeGroups.d.ts +12 -12
  48. package/dist/cjs/services/items/schemas/attributeGroups.d.ts.map +1 -1
  49. package/dist/cjs/services/items/schemas/attributeGroups.js +3 -2
  50. package/dist/cjs/services/items/schemas/attributeGroups.js.map +1 -1
  51. package/dist/cjs/services/items/schemas/attributes.d.ts +30 -30
  52. package/dist/cjs/services/items/schemas/brands.d.ts +12 -12
  53. package/dist/cjs/services/items/schemas/brands.d.ts.map +1 -1
  54. package/dist/cjs/services/items/schemas/brands.js +3 -2
  55. package/dist/cjs/services/items/schemas/brands.js.map +1 -1
  56. package/dist/cjs/services/items/schemas/categories.d.ts +68 -68
  57. package/dist/cjs/services/items/schemas/health.d.ts +12 -12
  58. package/dist/cjs/services/items/schemas/invLoc.d.ts +6 -6
  59. package/dist/cjs/services/items/schemas/products.d.ts +48 -48
  60. package/dist/cjs/services/items/schemas/products.d.ts.map +1 -1
  61. package/dist/cjs/services/items/schemas/products.js +5 -4
  62. package/dist/cjs/services/items/schemas/products.js.map +1 -1
  63. package/dist/cjs/services/joomla/client.d.ts +664 -119
  64. package/dist/cjs/services/joomla/client.d.ts.map +1 -1
  65. package/dist/cjs/services/joomla/client.js +467 -98
  66. package/dist/cjs/services/joomla/client.js.map +1 -1
  67. package/dist/cjs/services/joomla/schemas/content.d.ts +24 -24
  68. package/dist/cjs/services/joomla/schemas/groups.d.ts +24 -24
  69. package/dist/cjs/services/joomla/schemas/health.d.ts +12 -12
  70. package/dist/cjs/services/joomla/schemas/users.d.ts +48 -48
  71. package/dist/cjs/services/legacy/client.d.ts +12 -12
  72. package/dist/cjs/services/legacy/schemas/health.d.ts +6 -6
  73. package/dist/cjs/services/legacy/schemas/inventory.d.ts +36 -36
  74. package/dist/cjs/services/legacy/schemas/orders.d.ts +12 -12
  75. package/dist/cjs/services/legacy/schemas/states.d.ts +12 -12
  76. package/dist/cjs/services/nexus/client.d.ts +1206 -130
  77. package/dist/cjs/services/nexus/client.d.ts.map +1 -1
  78. package/dist/cjs/services/nexus/client.js +762 -28
  79. package/dist/cjs/services/nexus/client.js.map +1 -1
  80. package/dist/cjs/services/nexus/schemas/bin-transfers.d.ts +74 -74
  81. package/dist/cjs/services/nexus/schemas/bin-transfers.d.ts.map +1 -1
  82. package/dist/cjs/services/nexus/schemas/bin-transfers.js +25 -7
  83. package/dist/cjs/services/nexus/schemas/bin-transfers.js.map +1 -1
  84. package/dist/cjs/services/nexus/schemas/common.d.ts +3 -2
  85. package/dist/cjs/services/nexus/schemas/common.d.ts.map +1 -1
  86. package/dist/cjs/services/nexus/schemas/common.js +4 -2
  87. package/dist/cjs/services/nexus/schemas/common.js.map +1 -1
  88. package/dist/cjs/services/nexus/schemas/health.d.ts +12 -12
  89. package/dist/cjs/services/nexus/schemas/receiving.d.ts +108 -108
  90. package/dist/cjs/services/nexus/schemas/transfers.d.ts +162 -162
  91. package/dist/cjs/services/open-search/client.d.ts +19 -19
  92. package/dist/cjs/services/open-search/schemas/attributes.d.ts +8 -8
  93. package/dist/cjs/services/open-search/schemas/health.d.ts +12 -12
  94. package/dist/cjs/services/open-search/schemas/items.d.ts +24 -24
  95. package/dist/cjs/services/open-search/schemas/search.d.ts +8 -8
  96. package/dist/cjs/services/orders/client.d.ts +23 -23
  97. package/dist/cjs/services/orders/schemas/health.d.ts +6 -6
  98. package/dist/cjs/services/orders/schemas/invoices.d.ts +6 -6
  99. package/dist/cjs/services/orders/schemas/orders.d.ts +24 -24
  100. package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +46 -46
  101. package/dist/cjs/services/orders/schemas/salesrep.d.ts +12 -12
  102. package/dist/cjs/services/p21-pim/client.d.ts +22 -22
  103. package/dist/cjs/services/p21-pim/schemas/ai-suggestions.d.ts +18 -18
  104. package/dist/cjs/services/p21-pim/schemas/health.d.ts +6 -6
  105. package/dist/cjs/services/p21-pim/schemas/inventory.d.ts +24 -24
  106. package/dist/cjs/services/p21-pim/schemas/podcasts.d.ts +12 -12
  107. package/dist/cjs/services/payments/client.d.ts +18 -18
  108. package/dist/cjs/services/payments/schemas/element.d.ts +6 -6
  109. package/dist/cjs/services/payments/schemas/health.d.ts +12 -12
  110. package/dist/cjs/services/payments/schemas/unified.d.ts +36 -36
  111. package/dist/cjs/services/pricing/client.d.ts +8 -8
  112. package/dist/cjs/services/pricing/schemas/health.d.ts +12 -12
  113. package/dist/cjs/services/pricing/schemas/job-pricing.d.ts +24 -24
  114. package/dist/cjs/services/pricing/schemas/pricing.d.ts +6 -6
  115. package/dist/cjs/services/pricing/schemas/tax.d.ts +6 -6
  116. package/dist/cjs/services/vmi/client.d.ts +50 -50
  117. package/dist/cjs/services/vmi/schemas/health.d.ts +12 -12
  118. package/dist/cjs/services/vmi/schemas/inventory.d.ts +12 -12
  119. package/dist/cjs/services/vmi/schemas/products.d.ts +36 -36
  120. package/dist/cjs/services/vmi/schemas/profiles.d.ts +24 -24
  121. package/dist/cjs/services/vmi/schemas/restock.d.ts +30 -30
  122. package/dist/cjs/services/vmi/schemas/warehouse.d.ts +36 -36
  123. package/dist/esm/client.d.ts +181 -0
  124. package/dist/esm/client.d.ts.map +1 -1
  125. package/dist/esm/client.js +449 -0
  126. package/dist/esm/client.js.map +1 -1
  127. package/dist/esm/core/base-client.d.ts +106 -2
  128. package/dist/esm/core/base-client.d.ts.map +1 -1
  129. package/dist/esm/core/base-client.js +201 -0
  130. package/dist/esm/core/base-client.js.map +1 -1
  131. package/dist/esm/core/common-schemas.d.ts +30 -30
  132. package/dist/esm/core/common-schemas.d.ts.map +1 -1
  133. package/dist/esm/core/common-schemas.js +3 -2
  134. package/dist/esm/core/common-schemas.js.map +1 -1
  135. package/dist/esm/core/schema-factories.d.ts +32 -32
  136. package/dist/esm/core/schema-utils.d.ts +1115 -0
  137. package/dist/esm/core/schema-utils.d.ts.map +1 -1
  138. package/dist/esm/core/schema-utils.js +167 -0
  139. package/dist/esm/core/schema-utils.js.map +1 -1
  140. package/dist/esm/core/schemas.d.ts +12 -12
  141. package/dist/esm/core/schemas.d.ts.map +1 -1
  142. package/dist/esm/core/schemas.js +9 -2
  143. package/dist/esm/core/schemas.js.map +1 -1
  144. package/dist/esm/index.d.ts +2 -1
  145. package/dist/esm/index.d.ts.map +1 -1
  146. package/dist/esm/index.js +1 -1
  147. package/dist/esm/index.js.map +1 -1
  148. package/dist/esm/services/agr-site/client.d.ts +2 -2
  149. package/dist/esm/services/agr-site/schemas/health.d.ts +6 -6
  150. package/dist/esm/services/commerce/client.d.ts +18 -18
  151. package/dist/esm/services/commerce/schemas/cart.d.ts +30 -30
  152. package/dist/esm/services/commerce/schemas/checkout.d.ts +42 -42
  153. package/dist/esm/services/commerce/schemas/health.d.ts +6 -6
  154. package/dist/esm/services/commerce/schemas/recommendations.d.ts +6 -6
  155. package/dist/esm/services/customers/client.d.ts +42 -42
  156. package/dist/esm/services/customers/schemas/addresses.d.ts +18 -18
  157. package/dist/esm/services/customers/schemas/contacts.d.ts +24 -24
  158. package/dist/esm/services/customers/schemas/customers.d.ts +42 -42
  159. package/dist/esm/services/customers/schemas/health.d.ts +6 -6
  160. package/dist/esm/services/customers/schemas/invoices.d.ts +12 -12
  161. package/dist/esm/services/customers/schemas/orders.d.ts +18 -18
  162. package/dist/esm/services/customers/schemas/purchased-items.d.ts +6 -6
  163. package/dist/esm/services/customers/schemas/quotes.d.ts +12 -12
  164. package/dist/esm/services/items/client.d.ts +72 -72
  165. package/dist/esm/services/items/schemas/alternateCode.d.ts +6 -6
  166. package/dist/esm/services/items/schemas/alternateCode.d.ts.map +1 -1
  167. package/dist/esm/services/items/schemas/alternateCode.js +3 -2
  168. package/dist/esm/services/items/schemas/alternateCode.js.map +1 -1
  169. package/dist/esm/services/items/schemas/attributeGroups.d.ts +12 -12
  170. package/dist/esm/services/items/schemas/attributeGroups.d.ts.map +1 -1
  171. package/dist/esm/services/items/schemas/attributeGroups.js +3 -2
  172. package/dist/esm/services/items/schemas/attributeGroups.js.map +1 -1
  173. package/dist/esm/services/items/schemas/attributes.d.ts +30 -30
  174. package/dist/esm/services/items/schemas/brands.d.ts +12 -12
  175. package/dist/esm/services/items/schemas/brands.d.ts.map +1 -1
  176. package/dist/esm/services/items/schemas/brands.js +3 -2
  177. package/dist/esm/services/items/schemas/brands.js.map +1 -1
  178. package/dist/esm/services/items/schemas/categories.d.ts +68 -68
  179. package/dist/esm/services/items/schemas/health.d.ts +12 -12
  180. package/dist/esm/services/items/schemas/invLoc.d.ts +6 -6
  181. package/dist/esm/services/items/schemas/products.d.ts +48 -48
  182. package/dist/esm/services/items/schemas/products.d.ts.map +1 -1
  183. package/dist/esm/services/items/schemas/products.js +5 -4
  184. package/dist/esm/services/items/schemas/products.js.map +1 -1
  185. package/dist/esm/services/joomla/client.d.ts +664 -119
  186. package/dist/esm/services/joomla/client.d.ts.map +1 -1
  187. package/dist/esm/services/joomla/client.js +467 -98
  188. package/dist/esm/services/joomla/client.js.map +1 -1
  189. package/dist/esm/services/joomla/schemas/content.d.ts +24 -24
  190. package/dist/esm/services/joomla/schemas/groups.d.ts +24 -24
  191. package/dist/esm/services/joomla/schemas/health.d.ts +12 -12
  192. package/dist/esm/services/joomla/schemas/users.d.ts +48 -48
  193. package/dist/esm/services/legacy/client.d.ts +12 -12
  194. package/dist/esm/services/legacy/schemas/health.d.ts +6 -6
  195. package/dist/esm/services/legacy/schemas/inventory.d.ts +36 -36
  196. package/dist/esm/services/legacy/schemas/orders.d.ts +12 -12
  197. package/dist/esm/services/legacy/schemas/states.d.ts +12 -12
  198. package/dist/esm/services/nexus/client.d.ts +1206 -130
  199. package/dist/esm/services/nexus/client.d.ts.map +1 -1
  200. package/dist/esm/services/nexus/client.js +762 -28
  201. package/dist/esm/services/nexus/client.js.map +1 -1
  202. package/dist/esm/services/nexus/schemas/bin-transfers.d.ts +74 -74
  203. package/dist/esm/services/nexus/schemas/bin-transfers.d.ts.map +1 -1
  204. package/dist/esm/services/nexus/schemas/bin-transfers.js +25 -7
  205. package/dist/esm/services/nexus/schemas/bin-transfers.js.map +1 -1
  206. package/dist/esm/services/nexus/schemas/common.d.ts +3 -2
  207. package/dist/esm/services/nexus/schemas/common.d.ts.map +1 -1
  208. package/dist/esm/services/nexus/schemas/common.js +4 -2
  209. package/dist/esm/services/nexus/schemas/common.js.map +1 -1
  210. package/dist/esm/services/nexus/schemas/health.d.ts +12 -12
  211. package/dist/esm/services/nexus/schemas/receiving.d.ts +108 -108
  212. package/dist/esm/services/nexus/schemas/transfers.d.ts +162 -162
  213. package/dist/esm/services/open-search/client.d.ts +19 -19
  214. package/dist/esm/services/open-search/schemas/attributes.d.ts +8 -8
  215. package/dist/esm/services/open-search/schemas/health.d.ts +12 -12
  216. package/dist/esm/services/open-search/schemas/items.d.ts +24 -24
  217. package/dist/esm/services/open-search/schemas/search.d.ts +8 -8
  218. package/dist/esm/services/orders/client.d.ts +23 -23
  219. package/dist/esm/services/orders/schemas/health.d.ts +6 -6
  220. package/dist/esm/services/orders/schemas/invoices.d.ts +6 -6
  221. package/dist/esm/services/orders/schemas/orders.d.ts +24 -24
  222. package/dist/esm/services/orders/schemas/purchase-orders.d.ts +46 -46
  223. package/dist/esm/services/orders/schemas/salesrep.d.ts +12 -12
  224. package/dist/esm/services/p21-pim/client.d.ts +22 -22
  225. package/dist/esm/services/p21-pim/schemas/ai-suggestions.d.ts +18 -18
  226. package/dist/esm/services/p21-pim/schemas/health.d.ts +6 -6
  227. package/dist/esm/services/p21-pim/schemas/inventory.d.ts +24 -24
  228. package/dist/esm/services/p21-pim/schemas/podcasts.d.ts +12 -12
  229. package/dist/esm/services/payments/client.d.ts +18 -18
  230. package/dist/esm/services/payments/schemas/element.d.ts +6 -6
  231. package/dist/esm/services/payments/schemas/health.d.ts +12 -12
  232. package/dist/esm/services/payments/schemas/unified.d.ts +36 -36
  233. package/dist/esm/services/pricing/client.d.ts +8 -8
  234. package/dist/esm/services/pricing/schemas/health.d.ts +12 -12
  235. package/dist/esm/services/pricing/schemas/job-pricing.d.ts +24 -24
  236. package/dist/esm/services/pricing/schemas/pricing.d.ts +6 -6
  237. package/dist/esm/services/pricing/schemas/tax.d.ts +6 -6
  238. package/dist/esm/services/vmi/client.d.ts +50 -50
  239. package/dist/esm/services/vmi/schemas/health.d.ts +12 -12
  240. package/dist/esm/services/vmi/schemas/inventory.d.ts +12 -12
  241. package/dist/esm/services/vmi/schemas/products.d.ts +36 -36
  242. package/dist/esm/services/vmi/schemas/profiles.d.ts +24 -24
  243. package/dist/esm/services/vmi/schemas/restock.d.ts +30 -30
  244. package/dist/esm/services/vmi/schemas/warehouse.d.ts +36 -36
  245. package/dist/types/client.d.ts +181 -0
  246. package/dist/types/client.d.ts.map +1 -1
  247. package/dist/types/core/base-client.d.ts +106 -2
  248. package/dist/types/core/base-client.d.ts.map +1 -1
  249. package/dist/types/core/common-schemas.d.ts +30 -30
  250. package/dist/types/core/common-schemas.d.ts.map +1 -1
  251. package/dist/types/core/schema-factories.d.ts +32 -32
  252. package/dist/types/core/schema-utils.d.ts +1115 -0
  253. package/dist/types/core/schema-utils.d.ts.map +1 -1
  254. package/dist/types/core/schemas.d.ts +12 -12
  255. package/dist/types/core/schemas.d.ts.map +1 -1
  256. package/dist/types/index.d.ts +2 -1
  257. package/dist/types/index.d.ts.map +1 -1
  258. package/dist/types/services/agr-site/client.d.ts +2 -2
  259. package/dist/types/services/agr-site/schemas/health.d.ts +6 -6
  260. package/dist/types/services/commerce/client.d.ts +18 -18
  261. package/dist/types/services/commerce/schemas/cart.d.ts +30 -30
  262. package/dist/types/services/commerce/schemas/checkout.d.ts +42 -42
  263. package/dist/types/services/commerce/schemas/health.d.ts +6 -6
  264. package/dist/types/services/commerce/schemas/recommendations.d.ts +6 -6
  265. package/dist/types/services/customers/client.d.ts +42 -42
  266. package/dist/types/services/customers/schemas/addresses.d.ts +18 -18
  267. package/dist/types/services/customers/schemas/contacts.d.ts +24 -24
  268. package/dist/types/services/customers/schemas/customers.d.ts +42 -42
  269. package/dist/types/services/customers/schemas/health.d.ts +6 -6
  270. package/dist/types/services/customers/schemas/invoices.d.ts +12 -12
  271. package/dist/types/services/customers/schemas/orders.d.ts +18 -18
  272. package/dist/types/services/customers/schemas/purchased-items.d.ts +6 -6
  273. package/dist/types/services/customers/schemas/quotes.d.ts +12 -12
  274. package/dist/types/services/items/client.d.ts +72 -72
  275. package/dist/types/services/items/schemas/alternateCode.d.ts +6 -6
  276. package/dist/types/services/items/schemas/alternateCode.d.ts.map +1 -1
  277. package/dist/types/services/items/schemas/attributeGroups.d.ts +12 -12
  278. package/dist/types/services/items/schemas/attributeGroups.d.ts.map +1 -1
  279. package/dist/types/services/items/schemas/attributes.d.ts +30 -30
  280. package/dist/types/services/items/schemas/brands.d.ts +12 -12
  281. package/dist/types/services/items/schemas/brands.d.ts.map +1 -1
  282. package/dist/types/services/items/schemas/categories.d.ts +68 -68
  283. package/dist/types/services/items/schemas/health.d.ts +12 -12
  284. package/dist/types/services/items/schemas/invLoc.d.ts +6 -6
  285. package/dist/types/services/items/schemas/products.d.ts +48 -48
  286. package/dist/types/services/items/schemas/products.d.ts.map +1 -1
  287. package/dist/types/services/joomla/client.d.ts +664 -119
  288. package/dist/types/services/joomla/client.d.ts.map +1 -1
  289. package/dist/types/services/joomla/schemas/content.d.ts +24 -24
  290. package/dist/types/services/joomla/schemas/groups.d.ts +24 -24
  291. package/dist/types/services/joomla/schemas/health.d.ts +12 -12
  292. package/dist/types/services/joomla/schemas/users.d.ts +48 -48
  293. package/dist/types/services/legacy/client.d.ts +12 -12
  294. package/dist/types/services/legacy/schemas/health.d.ts +6 -6
  295. package/dist/types/services/legacy/schemas/inventory.d.ts +36 -36
  296. package/dist/types/services/legacy/schemas/orders.d.ts +12 -12
  297. package/dist/types/services/legacy/schemas/states.d.ts +12 -12
  298. package/dist/types/services/nexus/client.d.ts +1206 -130
  299. package/dist/types/services/nexus/client.d.ts.map +1 -1
  300. package/dist/types/services/nexus/schemas/bin-transfers.d.ts +74 -74
  301. package/dist/types/services/nexus/schemas/bin-transfers.d.ts.map +1 -1
  302. package/dist/types/services/nexus/schemas/common.d.ts +3 -2
  303. package/dist/types/services/nexus/schemas/common.d.ts.map +1 -1
  304. package/dist/types/services/nexus/schemas/health.d.ts +12 -12
  305. package/dist/types/services/nexus/schemas/receiving.d.ts +108 -108
  306. package/dist/types/services/nexus/schemas/transfers.d.ts +162 -162
  307. package/dist/types/services/open-search/client.d.ts +19 -19
  308. package/dist/types/services/open-search/schemas/attributes.d.ts +8 -8
  309. package/dist/types/services/open-search/schemas/health.d.ts +12 -12
  310. package/dist/types/services/open-search/schemas/items.d.ts +24 -24
  311. package/dist/types/services/open-search/schemas/search.d.ts +8 -8
  312. package/dist/types/services/orders/client.d.ts +23 -23
  313. package/dist/types/services/orders/schemas/health.d.ts +6 -6
  314. package/dist/types/services/orders/schemas/invoices.d.ts +6 -6
  315. package/dist/types/services/orders/schemas/orders.d.ts +24 -24
  316. package/dist/types/services/orders/schemas/purchase-orders.d.ts +46 -46
  317. package/dist/types/services/orders/schemas/salesrep.d.ts +12 -12
  318. package/dist/types/services/p21-pim/client.d.ts +22 -22
  319. package/dist/types/services/p21-pim/schemas/ai-suggestions.d.ts +18 -18
  320. package/dist/types/services/p21-pim/schemas/health.d.ts +6 -6
  321. package/dist/types/services/p21-pim/schemas/inventory.d.ts +24 -24
  322. package/dist/types/services/p21-pim/schemas/podcasts.d.ts +12 -12
  323. package/dist/types/services/payments/client.d.ts +18 -18
  324. package/dist/types/services/payments/schemas/element.d.ts +6 -6
  325. package/dist/types/services/payments/schemas/health.d.ts +12 -12
  326. package/dist/types/services/payments/schemas/unified.d.ts +36 -36
  327. package/dist/types/services/pricing/client.d.ts +8 -8
  328. package/dist/types/services/pricing/schemas/health.d.ts +12 -12
  329. package/dist/types/services/pricing/schemas/job-pricing.d.ts +24 -24
  330. package/dist/types/services/pricing/schemas/pricing.d.ts +6 -6
  331. package/dist/types/services/pricing/schemas/tax.d.ts +6 -6
  332. package/dist/types/services/vmi/client.d.ts +50 -50
  333. package/dist/types/services/vmi/schemas/health.d.ts +12 -12
  334. package/dist/types/services/vmi/schemas/inventory.d.ts +12 -12
  335. package/dist/types/services/vmi/schemas/products.d.ts +36 -36
  336. package/dist/types/services/vmi/schemas/profiles.d.ts +24 -24
  337. package/dist/types/services/vmi/schemas/restock.d.ts +30 -30
  338. package/dist/types/services/vmi/schemas/warehouse.d.ts +36 -36
  339. 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
@@ -59,9 +94,9 @@ export declare class NexusClient extends BaseServiceClient {
59
94
  * ```
60
95
  */
61
96
  ping: () => Promise<{
62
- params: Record<string, unknown>;
97
+ params: Record<string, unknown> | unknown[];
63
98
  data: "pong";
64
- options: Record<string, unknown>;
99
+ options: Record<string, unknown> | unknown[];
65
100
  status: number;
66
101
  message: string;
67
102
  count: number;
@@ -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
@@ -80,12 +123,12 @@ export declare class NexusClient extends BaseServiceClient {
80
123
  * ```
81
124
  */
82
125
  check: () => Promise<{
83
- params: Record<string, unknown>;
126
+ params: Record<string, unknown> | unknown[];
84
127
  data: {
85
128
  siteHash: string;
86
129
  siteId: string;
87
130
  };
88
- options: Record<string, unknown>;
131
+ options: Record<string, unknown> | unknown[];
89
132
  status: number;
90
133
  message: string;
91
134
  count: number;
@@ -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
@@ -118,8 +169,9 @@ export declare class NexusClient extends BaseServiceClient {
118
169
  offset?: number | undefined;
119
170
  statusCd?: number | undefined;
120
171
  } | undefined) => Promise<{
121
- params: Record<string, unknown>;
172
+ params: Record<string, unknown> | unknown[];
122
173
  data: {
174
+ requestId: string | null;
123
175
  dateCreated: string;
124
176
  dateLastModified: string;
125
177
  statusCd: number;
@@ -130,11 +182,10 @@ export declare class NexusClient extends BaseServiceClient {
130
182
  usersId: number;
131
183
  locationId: number;
132
184
  importState: string;
133
- requestId: string | null;
134
185
  binTransferHdrUid: number;
135
186
  response: string | null;
136
187
  }[];
137
- options: Record<string, unknown>;
188
+ options: Record<string, unknown> | unknown[];
138
189
  status: number;
139
190
  message: string;
140
191
  count: number;
@@ -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
@@ -155,8 +214,9 @@ export declare class NexusClient extends BaseServiceClient {
155
214
  * ```
156
215
  */
157
216
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
158
- params: Record<string, unknown>;
217
+ params: Record<string, unknown> | unknown[];
159
218
  data: {
219
+ requestId: string | null;
160
220
  dateCreated: string;
161
221
  dateLastModified: string;
162
222
  statusCd: number;
@@ -167,11 +227,10 @@ export declare class NexusClient extends BaseServiceClient {
167
227
  usersId: number;
168
228
  locationId: number;
169
229
  importState: string;
170
- requestId: string | null;
171
230
  binTransferHdrUid: number;
172
231
  response: string | null;
173
232
  };
174
- options: Record<string, unknown>;
233
+ options: Record<string, unknown> | unknown[];
175
234
  status: number;
176
235
  message: string;
177
236
  count: number;
@@ -181,21 +240,32 @@ 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
187
254
  * @example
188
255
  * ```typescript
189
- * const status = await client.binTransfers.getBinTransferStatusWithLines(12345);
190
- * console.log('Transfer lines:', status.data.lines.length);
191
- * status.data.lines.forEach(line => {
192
- * console.log(`Line ${line.lineNo}: ${line.itemId} from ${line.fromBin} to ${line.toBin}`);
193
- * });
256
+ * const status = await client.binTransfers.getBinTransferStatus(12345);
257
+ * console.log('Transfer lines:', status.data.lines?.length || 0);
258
+ * if (status.data.lines) {
259
+ * status.data.lines.forEach(line => {
260
+ * console.log(`Line ${line.lineNo}: ${line.itemId} from ${line.fromBin} to ${line.toBin}`);
261
+ * });
262
+ * }
194
263
  * ```
195
264
  */
196
- getBinTransferStatusWithLines: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
197
- params: Record<string, unknown>;
265
+ getBinTransferStatus: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
266
+ params: Record<string, unknown> | unknown[];
198
267
  data: {
268
+ requestId: string | null;
199
269
  dateCreated: string;
200
270
  dateLastModified: string;
201
271
  statusCd: number;
@@ -226,11 +296,10 @@ export declare class NexusClient extends BaseServiceClient {
226
296
  usersId: number;
227
297
  locationId: number;
228
298
  importState: string;
229
- requestId: string | null;
230
299
  binTransferHdrUid: number;
231
300
  response: string | null;
232
301
  };
233
- options: Record<string, unknown>;
302
+ options: Record<string, unknown> | unknown[];
234
303
  status: number;
235
304
  message: string;
236
305
  count: number;
@@ -240,6 +309,14 @@ export declare class NexusClient extends BaseServiceClient {
240
309
  /**
241
310
  * Create a new bin transfer header with associated line items
242
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"]
243
320
  * @param transferData Complete bin transfer data including user, location, and transfer lines
244
321
  * @returns Created bin transfer header details
245
322
  * @throws ValidationError When request is invalid or response is malformed
@@ -280,8 +357,9 @@ export declare class NexusClient extends BaseServiceClient {
280
357
  locationId: number;
281
358
  requestId?: string | undefined;
282
359
  }) => Promise<{
283
- params: Record<string, unknown>;
360
+ params: Record<string, unknown> | unknown[];
284
361
  data: {
362
+ requestId: string | null;
285
363
  dateCreated: string;
286
364
  dateLastModified: string;
287
365
  statusCd: number;
@@ -292,11 +370,10 @@ export declare class NexusClient extends BaseServiceClient {
292
370
  usersId: number;
293
371
  locationId: number;
294
372
  importState: string;
295
- requestId: string | null;
296
373
  binTransferHdrUid: number;
297
374
  response: string | null;
298
375
  };
299
- options: Record<string, unknown>;
376
+ options: Record<string, unknown> | unknown[];
300
377
  status: number;
301
378
  message: string;
302
379
  count: number;
@@ -306,6 +383,14 @@ export declare class NexusClient extends BaseServiceClient {
306
383
  /**
307
384
  * Update an existing bin transfer header
308
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"]
309
394
  * @param binTransferHdrUid Bin transfer header unique identifier
310
395
  * @param updateData Fields to update on the bin transfer
311
396
  * @returns Updated bin transfer details
@@ -325,8 +410,9 @@ export declare class NexusClient extends BaseServiceClient {
325
410
  properties?: string | undefined;
326
411
  jsonData?: string | undefined;
327
412
  }) => Promise<{
328
- params: Record<string, unknown>;
413
+ params: Record<string, unknown> | unknown[];
329
414
  data: {
415
+ requestId: string | null;
330
416
  dateCreated: string;
331
417
  dateLastModified: string;
332
418
  statusCd: number;
@@ -337,11 +423,10 @@ export declare class NexusClient extends BaseServiceClient {
337
423
  usersId: number;
338
424
  locationId: number;
339
425
  importState: string;
340
- requestId: string | null;
341
426
  binTransferHdrUid: number;
342
427
  response: string | null;
343
428
  };
344
- options: Record<string, unknown>;
429
+ options: Record<string, unknown> | unknown[];
345
430
  status: number;
346
431
  message: string;
347
432
  count: number;
@@ -351,6 +436,14 @@ export declare class NexusClient extends BaseServiceClient {
351
436
  /**
352
437
  * Soft delete a bin transfer header
353
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"]
354
447
  * @param binTransferHdrUid Bin transfer header unique identifier
355
448
  * @returns Deleted bin transfer details with updated status
356
449
  * @throws ValidationError When response is malformed
@@ -361,8 +454,9 @@ export declare class NexusClient extends BaseServiceClient {
361
454
  * ```
362
455
  */
363
456
  delete: (id: string | number) => Promise<{
364
- params: Record<string, unknown>;
457
+ params: Record<string, unknown> | unknown[];
365
458
  data: {
459
+ requestId: string | null;
366
460
  dateCreated: string;
367
461
  dateLastModified: string;
368
462
  statusCd: number;
@@ -373,17 +467,186 @@ export declare class NexusClient extends BaseServiceClient {
373
467
  usersId: number;
374
468
  locationId: number;
375
469
  importState: string;
376
- requestId: string | null;
377
470
  binTransferHdrUid: number;
378
471
  response: string | null;
379
472
  };
380
- options: Record<string, unknown>;
473
+ options: Record<string, unknown> | unknown[];
381
474
  status: number;
382
475
  message: string;
383
476
  count: number;
384
477
  total: number;
385
478
  totalResults: number;
386
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
+ }>;
387
650
  };
388
651
  /**
389
652
  * Receiving endpoints
@@ -393,6 +656,14 @@ export declare class NexusClient extends BaseServiceClient {
393
656
  /**
394
657
  * Retrieve a list of receiving documents with optional filtering
395
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"]
396
667
  * @param params Optional filtering and pagination parameters
397
668
  * @returns Array of receiving documents
398
669
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -411,8 +682,9 @@ export declare class NexusClient extends BaseServiceClient {
411
682
  statusCd?: number | undefined;
412
683
  poNo?: number | undefined;
413
684
  } | undefined) => Promise<{
414
- params: Record<string, unknown>;
685
+ params: Record<string, unknown> | unknown[];
415
686
  data: {
687
+ requestId: string | null;
416
688
  dateCreated: string;
417
689
  dateLastModified: string;
418
690
  statusCd: number;
@@ -421,13 +693,12 @@ export declare class NexusClient extends BaseServiceClient {
421
693
  properties: string | null;
422
694
  jsonData: string | null;
423
695
  importState: string;
424
- requestId: string | null;
425
696
  receivingUid: number;
426
697
  referenceNo: string | null;
427
698
  poNo: number;
428
699
  processMessage: string | null;
429
700
  }[];
430
- options: Record<string, unknown>;
701
+ options: Record<string, unknown> | unknown[];
431
702
  status: number;
432
703
  message: string;
433
704
  count: number;
@@ -437,6 +708,14 @@ export declare class NexusClient extends BaseServiceClient {
437
708
  /**
438
709
  * Retrieve details for a specific receiving document
439
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"]
440
719
  * @param receivingUid Receiving unique identifier
441
720
  * @returns Complete receiving document details
442
721
  * @throws ValidationError When response is malformed
@@ -448,8 +727,9 @@ export declare class NexusClient extends BaseServiceClient {
448
727
  * ```
449
728
  */
450
729
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
451
- params: Record<string, unknown>;
730
+ params: Record<string, unknown> | unknown[];
452
731
  data: {
732
+ requestId: string | null;
453
733
  dateCreated: string;
454
734
  dateLastModified: string;
455
735
  statusCd: number;
@@ -458,13 +738,12 @@ export declare class NexusClient extends BaseServiceClient {
458
738
  properties: string | null;
459
739
  jsonData: string | null;
460
740
  importState: string;
461
- requestId: string | null;
462
741
  receivingUid: number;
463
742
  referenceNo: string | null;
464
743
  poNo: number;
465
744
  processMessage: string | null;
466
745
  };
467
- options: Record<string, unknown>;
746
+ options: Record<string, unknown> | unknown[];
468
747
  status: number;
469
748
  message: string;
470
749
  count: number;
@@ -474,6 +753,14 @@ export declare class NexusClient extends BaseServiceClient {
474
753
  /**
475
754
  * Create a new receiving document
476
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"]
477
764
  * @param receivingData Complete receiving data including PO number and optional details
478
765
  * @returns Created receiving document details
479
766
  * @throws ValidationError When request is invalid or response is malformed
@@ -490,13 +777,14 @@ export declare class NexusClient extends BaseServiceClient {
490
777
  */
491
778
  create: (data: {
492
779
  poNo: number;
780
+ requestId?: string | undefined;
493
781
  properties?: string | undefined;
494
782
  jsonData?: string | undefined;
495
- requestId?: string | undefined;
496
783
  referenceNo?: string | undefined;
497
784
  }) => Promise<{
498
- params: Record<string, unknown>;
785
+ params: Record<string, unknown> | unknown[];
499
786
  data: {
787
+ requestId: string | null;
500
788
  dateCreated: string;
501
789
  dateLastModified: string;
502
790
  statusCd: number;
@@ -505,13 +793,12 @@ export declare class NexusClient extends BaseServiceClient {
505
793
  properties: string | null;
506
794
  jsonData: string | null;
507
795
  importState: string;
508
- requestId: string | null;
509
796
  receivingUid: number;
510
797
  referenceNo: string | null;
511
798
  poNo: number;
512
799
  processMessage: string | null;
513
800
  };
514
- options: Record<string, unknown>;
801
+ options: Record<string, unknown> | unknown[];
515
802
  status: number;
516
803
  message: string;
517
804
  count: number;
@@ -520,7 +807,20 @@ export declare class NexusClient extends BaseServiceClient {
520
807
  }>;
521
808
  /**
522
809
  * Update an existing receiving document
523
- * @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"
524
824
  * @param receivingUid Receiving unique identifier
525
825
  * @param updateData Fields to update on the receiving document
526
826
  * @returns Updated receiving details
@@ -541,8 +841,9 @@ export declare class NexusClient extends BaseServiceClient {
541
841
  jsonData?: string | undefined;
542
842
  processMessage?: string | undefined;
543
843
  }) => Promise<{
544
- params: Record<string, unknown>;
844
+ params: Record<string, unknown> | unknown[];
545
845
  data: {
846
+ requestId: string | null;
546
847
  dateCreated: string;
547
848
  dateLastModified: string;
548
849
  statusCd: number;
@@ -551,13 +852,12 @@ export declare class NexusClient extends BaseServiceClient {
551
852
  properties: string | null;
552
853
  jsonData: string | null;
553
854
  importState: string;
554
- requestId: string | null;
555
855
  receivingUid: number;
556
856
  referenceNo: string | null;
557
857
  poNo: number;
558
858
  processMessage: string | null;
559
859
  };
560
- options: Record<string, unknown>;
860
+ options: Record<string, unknown> | unknown[];
561
861
  status: number;
562
862
  message: string;
563
863
  count: number;
@@ -567,6 +867,19 @@ export declare class NexusClient extends BaseServiceClient {
567
867
  /**
568
868
  * Soft delete a receiving document
569
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"
570
883
  * @param receivingUid Receiving unique identifier
571
884
  * @returns Deleted receiving details with updated status
572
885
  * @throws ValidationError When response is malformed
@@ -577,8 +890,9 @@ export declare class NexusClient extends BaseServiceClient {
577
890
  * ```
578
891
  */
579
892
  delete: (id: string | number) => Promise<{
580
- params: Record<string, unknown>;
893
+ params: Record<string, unknown> | unknown[];
581
894
  data: {
895
+ requestId: string | null;
582
896
  dateCreated: string;
583
897
  dateLastModified: string;
584
898
  statusCd: number;
@@ -587,19 +901,129 @@ export declare class NexusClient extends BaseServiceClient {
587
901
  properties: string | null;
588
902
  jsonData: string | null;
589
903
  importState: string;
590
- requestId: string | null;
591
904
  receivingUid: number;
592
905
  referenceNo: string | null;
593
906
  poNo: number;
594
907
  processMessage: string | null;
595
908
  };
596
- options: Record<string, unknown>;
909
+ options: Record<string, unknown> | unknown[];
597
910
  status: number;
598
911
  message: string;
599
912
  count: number;
600
913
  total: number;
601
914
  totalResults: number;
602
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
+ }>;
603
1027
  };
604
1028
  /**
605
1029
  * Transfer endpoints
@@ -609,6 +1033,14 @@ export declare class NexusClient extends BaseServiceClient {
609
1033
  /**
610
1034
  * Retrieve a list of transfer documents with optional filtering
611
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"]
612
1044
  * @param params Optional filtering and pagination parameters
613
1045
  * @returns Array of transfer documents
614
1046
  * @throws ValidationError When parameters are invalid or response is malformed
@@ -627,8 +1059,9 @@ export declare class NexusClient extends BaseServiceClient {
627
1059
  statusCd?: number | undefined;
628
1060
  referenceNo?: string | undefined;
629
1061
  } | undefined) => Promise<{
630
- params: Record<string, unknown>;
1062
+ params: Record<string, unknown> | unknown[];
631
1063
  data: {
1064
+ requestId: string | null;
632
1065
  dateCreated: string;
633
1066
  dateLastModified: string;
634
1067
  statusCd: number;
@@ -636,12 +1069,11 @@ export declare class NexusClient extends BaseServiceClient {
636
1069
  processCd: number;
637
1070
  jsonData: string | null;
638
1071
  importState: string;
639
- requestId: string | null;
640
1072
  referenceNo: string | null;
641
1073
  processMessage: string | null;
642
1074
  transferUid: number;
643
1075
  }[];
644
- options: Record<string, unknown>;
1076
+ options: Record<string, unknown> | unknown[];
645
1077
  status: number;
646
1078
  message: string;
647
1079
  count: number;
@@ -651,6 +1083,14 @@ export declare class NexusClient extends BaseServiceClient {
651
1083
  /**
652
1084
  * Retrieve details for a specific transfer document
653
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"]
654
1094
  * @param transferUid Transfer unique identifier
655
1095
  * @returns Complete transfer document details
656
1096
  * @throws ValidationError When response is malformed
@@ -662,8 +1102,9 @@ export declare class NexusClient extends BaseServiceClient {
662
1102
  * ```
663
1103
  */
664
1104
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
665
- params: Record<string, unknown>;
1105
+ params: Record<string, unknown> | unknown[];
666
1106
  data: {
1107
+ requestId: string | null;
667
1108
  dateCreated: string;
668
1109
  dateLastModified: string;
669
1110
  statusCd: number;
@@ -671,12 +1112,11 @@ export declare class NexusClient extends BaseServiceClient {
671
1112
  processCd: number;
672
1113
  jsonData: string | null;
673
1114
  importState: string;
674
- requestId: string | null;
675
1115
  referenceNo: string | null;
676
1116
  processMessage: string | null;
677
1117
  transferUid: number;
678
1118
  };
679
- options: Record<string, unknown>;
1119
+ options: Record<string, unknown> | unknown[];
680
1120
  status: number;
681
1121
  message: string;
682
1122
  count: number;
@@ -686,6 +1126,14 @@ export declare class NexusClient extends BaseServiceClient {
686
1126
  /**
687
1127
  * Create a new transfer document
688
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"]
689
1137
  * @param transferData Complete transfer data including reference and location details
690
1138
  * @returns Created transfer document details
691
1139
  * @throws ValidationError When request is invalid or response is malformed
@@ -700,13 +1148,14 @@ export declare class NexusClient extends BaseServiceClient {
700
1148
  * ```
701
1149
  */
702
1150
  create: (data: {
703
- jsonData?: string | undefined;
704
1151
  requestId?: string | undefined;
1152
+ jsonData?: string | undefined;
705
1153
  referenceNo?: string | undefined;
706
1154
  processMessage?: string | undefined;
707
1155
  }) => Promise<{
708
- params: Record<string, unknown>;
1156
+ params: Record<string, unknown> | unknown[];
709
1157
  data: {
1158
+ requestId: string | null;
710
1159
  dateCreated: string;
711
1160
  dateLastModified: string;
712
1161
  statusCd: number;
@@ -714,12 +1163,11 @@ export declare class NexusClient extends BaseServiceClient {
714
1163
  processCd: number;
715
1164
  jsonData: string | null;
716
1165
  importState: string;
717
- requestId: string | null;
718
1166
  referenceNo: string | null;
719
1167
  processMessage: string | null;
720
1168
  transferUid: number;
721
1169
  };
722
- options: Record<string, unknown>;
1170
+ options: Record<string, unknown> | unknown[];
723
1171
  status: number;
724
1172
  message: string;
725
1173
  count: number;
@@ -747,8 +1195,9 @@ export declare class NexusClient extends BaseServiceClient {
747
1195
  jsonData?: string | undefined;
748
1196
  processMessage?: string | undefined;
749
1197
  }) => Promise<{
750
- params: Record<string, unknown>;
1198
+ params: Record<string, unknown> | unknown[];
751
1199
  data: {
1200
+ requestId: string | null;
752
1201
  dateCreated: string;
753
1202
  dateLastModified: string;
754
1203
  statusCd: number;
@@ -756,12 +1205,11 @@ export declare class NexusClient extends BaseServiceClient {
756
1205
  processCd: number;
757
1206
  jsonData: string | null;
758
1207
  importState: string;
759
- requestId: string | null;
760
1208
  referenceNo: string | null;
761
1209
  processMessage: string | null;
762
1210
  transferUid: number;
763
1211
  };
764
- options: Record<string, unknown>;
1212
+ options: Record<string, unknown> | unknown[];
765
1213
  status: number;
766
1214
  message: string;
767
1215
  count: number;
@@ -781,8 +1229,9 @@ export declare class NexusClient extends BaseServiceClient {
781
1229
  * ```
782
1230
  */
783
1231
  delete: (id: string | number) => Promise<{
784
- params: Record<string, unknown>;
1232
+ params: Record<string, unknown> | unknown[];
785
1233
  data: {
1234
+ requestId: string | null;
786
1235
  dateCreated: string;
787
1236
  dateLastModified: string;
788
1237
  statusCd: number;
@@ -790,30 +1239,152 @@ export declare class NexusClient extends BaseServiceClient {
790
1239
  processCd: number;
791
1240
  jsonData: string | null;
792
1241
  importState: string;
793
- requestId: string | null;
794
1242
  referenceNo: string | null;
795
1243
  processMessage: string | null;
796
1244
  transferUid: number;
797
1245
  };
798
- options: Record<string, unknown>;
1246
+ options: Record<string, unknown> | unknown[];
799
1247
  status: number;
800
1248
  message: string;
801
1249
  count: number;
802
1250
  total: number;
803
1251
  totalResults: number;
804
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
+ }>;
805
1354
  };
806
1355
  /**
807
1356
  * Purchase Order Receipt endpoints
808
- * @description Methods for managing purchase order receipt documents
1357
+ * @description Methods for managing purchase order receipt documents for comprehensive receipt tracking and processing
809
1358
  */
810
1359
  purchaseOrderReceipts: {
811
1360
  /**
812
- * Retrieve a list of purchase order receipt documents
813
- * @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"
814
1378
  * @param params Optional filtering and pagination parameters
815
1379
  * @returns Array of purchase order receipt documents
816
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
+ * ```
817
1388
  */
818
1389
  list: (params?: {
819
1390
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -822,8 +1393,9 @@ export declare class NexusClient extends BaseServiceClient {
822
1393
  statusCd?: number | undefined;
823
1394
  referenceNo?: string | undefined;
824
1395
  } | undefined) => Promise<{
825
- params: Record<string, unknown>;
1396
+ params: Record<string, unknown> | unknown[];
826
1397
  data: {
1398
+ requestId: string | null;
827
1399
  dateCreated: string;
828
1400
  dateLastModified: string;
829
1401
  statusCd: number;
@@ -831,12 +1403,11 @@ export declare class NexusClient extends BaseServiceClient {
831
1403
  processCd: number;
832
1404
  jsonData: string | null;
833
1405
  importState: string;
834
- requestId: string | null;
835
1406
  referenceNo: string | null;
836
1407
  processMessage: string | null;
837
1408
  purchaseOrderReceiptUid: number;
838
1409
  }[];
839
- options: Record<string, unknown>;
1410
+ options: Record<string, unknown> | unknown[];
840
1411
  status: number;
841
1412
  message: string;
842
1413
  count: number;
@@ -844,15 +1415,35 @@ export declare class NexusClient extends BaseServiceClient {
844
1415
  totalResults: number;
845
1416
  }>;
846
1417
  /**
847
- * Retrieve details for a specific purchase order receipt
848
- * @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"
849
1433
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
850
1434
  * @returns Complete purchase order receipt details
851
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
+ * ```
852
1442
  */
853
1443
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
854
- params: Record<string, unknown>;
1444
+ params: Record<string, unknown> | unknown[];
855
1445
  data: {
1446
+ requestId: string | null;
856
1447
  dateCreated: string;
857
1448
  dateLastModified: string;
858
1449
  statusCd: number;
@@ -860,12 +1451,11 @@ export declare class NexusClient extends BaseServiceClient {
860
1451
  processCd: number;
861
1452
  jsonData: string | null;
862
1453
  importState: string;
863
- requestId: string | null;
864
1454
  referenceNo: string | null;
865
1455
  processMessage: string | null;
866
1456
  purchaseOrderReceiptUid: number;
867
1457
  };
868
- options: Record<string, unknown>;
1458
+ options: Record<string, unknown> | unknown[];
869
1459
  status: number;
870
1460
  message: string;
871
1461
  count: number;
@@ -874,19 +1464,42 @@ export declare class NexusClient extends BaseServiceClient {
874
1464
  }>;
875
1465
  /**
876
1466
  * Create a new purchase order receipt document
877
- * @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"
878
1481
  * @param receiptData Complete purchase order receipt data
879
1482
  * @returns Created purchase order receipt details
880
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
+ * ```
881
1493
  */
882
1494
  create: (data: {
1495
+ requestId?: string | undefined;
883
1496
  properties?: string | undefined;
884
1497
  jsonData?: string | undefined;
885
- requestId?: string | undefined;
886
1498
  referenceNo?: string | undefined;
887
1499
  }) => Promise<{
888
- params: Record<string, unknown>;
1500
+ params: Record<string, unknown> | unknown[];
889
1501
  data: {
1502
+ requestId: string | null;
890
1503
  dateCreated: string;
891
1504
  dateLastModified: string;
892
1505
  statusCd: number;
@@ -894,12 +1507,11 @@ export declare class NexusClient extends BaseServiceClient {
894
1507
  processCd: number;
895
1508
  jsonData: string | null;
896
1509
  importState: string;
897
- requestId: string | null;
898
1510
  referenceNo: string | null;
899
1511
  processMessage: string | null;
900
1512
  purchaseOrderReceiptUid: number;
901
1513
  };
902
- options: Record<string, unknown>;
1514
+ options: Record<string, unknown> | unknown[];
903
1515
  status: number;
904
1516
  message: string;
905
1517
  count: number;
@@ -907,12 +1519,33 @@ export declare class NexusClient extends BaseServiceClient {
907
1519
  totalResults: number;
908
1520
  }>;
909
1521
  /**
910
- * Update an existing purchase order receipt
911
- * @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"
912
1537
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
913
1538
  * @param updateData Fields to update on the purchase order receipt
914
1539
  * @returns Updated purchase order receipt details
915
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
+ * ```
916
1549
  */
917
1550
  update: (id: string | number, data: {
918
1551
  statusCd?: number | undefined;
@@ -920,8 +1553,9 @@ export declare class NexusClient extends BaseServiceClient {
920
1553
  properties?: string | undefined;
921
1554
  jsonData?: string | undefined;
922
1555
  }) => Promise<{
923
- params: Record<string, unknown>;
1556
+ params: Record<string, unknown> | unknown[];
924
1557
  data: {
1558
+ requestId: string | null;
925
1559
  dateCreated: string;
926
1560
  dateLastModified: string;
927
1561
  statusCd: number;
@@ -929,12 +1563,11 @@ export declare class NexusClient extends BaseServiceClient {
929
1563
  processCd: number;
930
1564
  jsonData: string | null;
931
1565
  importState: string;
932
- requestId: string | null;
933
1566
  referenceNo: string | null;
934
1567
  processMessage: string | null;
935
1568
  purchaseOrderReceiptUid: number;
936
1569
  };
937
- options: Record<string, unknown>;
1570
+ options: Record<string, unknown> | unknown[];
938
1571
  status: number;
939
1572
  message: string;
940
1573
  count: number;
@@ -942,15 +1575,34 @@ export declare class NexusClient extends BaseServiceClient {
942
1575
  totalResults: number;
943
1576
  }>;
944
1577
  /**
945
- * Soft delete a purchase order receipt
946
- * @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"
947
1593
  * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
948
1594
  * @returns Deleted purchase order receipt details with updated status
949
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
+ * ```
950
1601
  */
951
1602
  delete: (id: string | number) => Promise<{
952
- params: Record<string, unknown>;
1603
+ params: Record<string, unknown> | unknown[];
953
1604
  data: {
1605
+ requestId: string | null;
954
1606
  dateCreated: string;
955
1607
  dateLastModified: string;
956
1608
  statusCd: number;
@@ -958,30 +1610,152 @@ export declare class NexusClient extends BaseServiceClient {
958
1610
  processCd: number;
959
1611
  jsonData: string | null;
960
1612
  importState: string;
961
- requestId: string | null;
962
1613
  referenceNo: string | null;
963
1614
  processMessage: string | null;
964
1615
  purchaseOrderReceiptUid: number;
965
1616
  };
966
- options: Record<string, unknown>;
1617
+ options: Record<string, unknown> | unknown[];
967
1618
  status: number;
968
1619
  message: string;
969
1620
  count: number;
970
1621
  total: number;
971
1622
  totalResults: number;
972
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
+ }>;
973
1725
  };
974
1726
  /**
975
1727
  * Transfer Receipt endpoints
976
- * @description Methods for managing transfer receipt documents
1728
+ * @description Methods for managing transfer receipt documents for comprehensive transfer tracking and confirmation
977
1729
  */
978
1730
  transferReceipts: {
979
1731
  /**
980
- * Retrieve a list of transfer receipt documents
981
- * @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"
982
1749
  * @param params Optional filtering and pagination parameters
983
1750
  * @returns Array of transfer receipt documents
984
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
+ * ```
985
1759
  */
986
1760
  list: (params?: {
987
1761
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -990,8 +1764,9 @@ export declare class NexusClient extends BaseServiceClient {
990
1764
  statusCd?: number | undefined;
991
1765
  referenceNo?: string | undefined;
992
1766
  } | undefined) => Promise<{
993
- params: Record<string, unknown>;
1767
+ params: Record<string, unknown> | unknown[];
994
1768
  data: {
1769
+ requestId: string | null;
995
1770
  dateCreated: string;
996
1771
  dateLastModified: string;
997
1772
  statusCd: number;
@@ -999,12 +1774,11 @@ export declare class NexusClient extends BaseServiceClient {
999
1774
  processCd: number;
1000
1775
  jsonData: string | null;
1001
1776
  importState: string;
1002
- requestId: string | null;
1003
1777
  referenceNo: string | null;
1004
1778
  processMessage: string | null;
1005
1779
  transferReceiptUid: number;
1006
1780
  }[];
1007
- options: Record<string, unknown>;
1781
+ options: Record<string, unknown> | unknown[];
1008
1782
  status: number;
1009
1783
  message: string;
1010
1784
  count: number;
@@ -1012,15 +1786,35 @@ export declare class NexusClient extends BaseServiceClient {
1012
1786
  totalResults: number;
1013
1787
  }>;
1014
1788
  /**
1015
- * Retrieve details for a specific transfer receipt
1016
- * @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"
1017
1804
  * @param transferReceiptUid Transfer receipt unique identifier
1018
1805
  * @returns Complete transfer receipt details
1019
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
+ * ```
1020
1813
  */
1021
1814
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
1022
- params: Record<string, unknown>;
1815
+ params: Record<string, unknown> | unknown[];
1023
1816
  data: {
1817
+ requestId: string | null;
1024
1818
  dateCreated: string;
1025
1819
  dateLastModified: string;
1026
1820
  statusCd: number;
@@ -1028,12 +1822,11 @@ export declare class NexusClient extends BaseServiceClient {
1028
1822
  processCd: number;
1029
1823
  jsonData: string | null;
1030
1824
  importState: string;
1031
- requestId: string | null;
1032
1825
  referenceNo: string | null;
1033
1826
  processMessage: string | null;
1034
1827
  transferReceiptUid: number;
1035
1828
  };
1036
- options: Record<string, unknown>;
1829
+ options: Record<string, unknown> | unknown[];
1037
1830
  status: number;
1038
1831
  message: string;
1039
1832
  count: number;
@@ -1042,19 +1835,42 @@ export declare class NexusClient extends BaseServiceClient {
1042
1835
  }>;
1043
1836
  /**
1044
1837
  * Create a new transfer receipt document
1045
- * @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"
1046
1852
  * @param receiptData Complete transfer receipt data
1047
1853
  * @returns Created transfer receipt details
1048
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
+ * ```
1049
1864
  */
1050
1865
  create: (data: {
1866
+ requestId?: string | undefined;
1051
1867
  properties?: string | undefined;
1052
1868
  jsonData?: string | undefined;
1053
- requestId?: string | undefined;
1054
1869
  referenceNo?: string | undefined;
1055
1870
  }) => Promise<{
1056
- params: Record<string, unknown>;
1871
+ params: Record<string, unknown> | unknown[];
1057
1872
  data: {
1873
+ requestId: string | null;
1058
1874
  dateCreated: string;
1059
1875
  dateLastModified: string;
1060
1876
  statusCd: number;
@@ -1062,12 +1878,11 @@ export declare class NexusClient extends BaseServiceClient {
1062
1878
  processCd: number;
1063
1879
  jsonData: string | null;
1064
1880
  importState: string;
1065
- requestId: string | null;
1066
1881
  referenceNo: string | null;
1067
1882
  processMessage: string | null;
1068
1883
  transferReceiptUid: number;
1069
1884
  };
1070
- options: Record<string, unknown>;
1885
+ options: Record<string, unknown> | unknown[];
1071
1886
  status: number;
1072
1887
  message: string;
1073
1888
  count: number;
@@ -1088,8 +1903,9 @@ export declare class NexusClient extends BaseServiceClient {
1088
1903
  properties?: string | undefined;
1089
1904
  jsonData?: string | undefined;
1090
1905
  }) => Promise<{
1091
- params: Record<string, unknown>;
1906
+ params: Record<string, unknown> | unknown[];
1092
1907
  data: {
1908
+ requestId: string | null;
1093
1909
  dateCreated: string;
1094
1910
  dateLastModified: string;
1095
1911
  statusCd: number;
@@ -1097,12 +1913,11 @@ export declare class NexusClient extends BaseServiceClient {
1097
1913
  processCd: number;
1098
1914
  jsonData: string | null;
1099
1915
  importState: string;
1100
- requestId: string | null;
1101
1916
  referenceNo: string | null;
1102
1917
  processMessage: string | null;
1103
1918
  transferReceiptUid: number;
1104
1919
  };
1105
- options: Record<string, unknown>;
1920
+ options: Record<string, unknown> | unknown[];
1106
1921
  status: number;
1107
1922
  message: string;
1108
1923
  count: number;
@@ -1117,8 +1932,9 @@ export declare class NexusClient extends BaseServiceClient {
1117
1932
  * @throws ValidationError When response is malformed
1118
1933
  */
1119
1934
  delete: (id: string | number) => Promise<{
1120
- params: Record<string, unknown>;
1935
+ params: Record<string, unknown> | unknown[];
1121
1936
  data: {
1937
+ requestId: string | null;
1122
1938
  dateCreated: string;
1123
1939
  dateLastModified: string;
1124
1940
  statusCd: number;
@@ -1126,30 +1942,152 @@ export declare class NexusClient extends BaseServiceClient {
1126
1942
  processCd: number;
1127
1943
  jsonData: string | null;
1128
1944
  importState: string;
1129
- requestId: string | null;
1130
1945
  referenceNo: string | null;
1131
1946
  processMessage: string | null;
1132
1947
  transferReceiptUid: number;
1133
1948
  };
1134
- options: Record<string, unknown>;
1949
+ options: Record<string, unknown> | unknown[];
1135
1950
  status: number;
1136
1951
  message: string;
1137
1952
  count: number;
1138
1953
  total: number;
1139
1954
  totalResults: number;
1140
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
+ }>;
1141
2057
  };
1142
2058
  /**
1143
2059
  * Transfer Shipping endpoints
1144
- * @description Methods for managing transfer shipping documents
2060
+ * @description Methods for managing transfer shipping documents for comprehensive outbound transfer tracking and logistics
1145
2061
  */
1146
2062
  transferShippings: {
1147
2063
  /**
1148
- * Retrieve a list of transfer shipping documents
1149
- * @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"
1150
2081
  * @param params Optional filtering and pagination parameters
1151
2082
  * @returns Array of transfer shipping documents
1152
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
+ * ```
1153
2091
  */
1154
2092
  list: (params?: {
1155
2093
  edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
@@ -1158,8 +2096,9 @@ export declare class NexusClient extends BaseServiceClient {
1158
2096
  statusCd?: number | undefined;
1159
2097
  referenceNo?: string | undefined;
1160
2098
  } | undefined) => Promise<{
1161
- params: Record<string, unknown>;
2099
+ params: Record<string, unknown> | unknown[];
1162
2100
  data: {
2101
+ requestId: string | null;
1163
2102
  dateCreated: string;
1164
2103
  dateLastModified: string;
1165
2104
  statusCd: number;
@@ -1167,12 +2106,11 @@ export declare class NexusClient extends BaseServiceClient {
1167
2106
  processCd: number;
1168
2107
  jsonData: string | null;
1169
2108
  importState: string;
1170
- requestId: string | null;
1171
2109
  referenceNo: string | null;
1172
2110
  processMessage: string | null;
1173
2111
  transferReceiptUid: number;
1174
2112
  }[];
1175
- options: Record<string, unknown>;
2113
+ options: Record<string, unknown> | unknown[];
1176
2114
  status: number;
1177
2115
  message: string;
1178
2116
  count: number;
@@ -1181,7 +2119,20 @@ export declare class NexusClient extends BaseServiceClient {
1181
2119
  }>;
1182
2120
  /**
1183
2121
  * Retrieve details for a specific transfer shipping document
1184
- * @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"
1185
2136
  * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
1186
2137
  * @returns Complete transfer shipping details
1187
2138
  * @throws ValidationError When response is malformed
@@ -1189,11 +2140,13 @@ export declare class NexusClient extends BaseServiceClient {
1189
2140
  * ```typescript
1190
2141
  * const shipping = await client.transferShippings.get(12345);
1191
2142
  * console.log('Shipping details:', shipping.data.jsonData);
2143
+ * console.log('Tracking info:', shipping.data.properties);
1192
2144
  * ```
1193
2145
  */
1194
2146
  get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
1195
- params: Record<string, unknown>;
2147
+ params: Record<string, unknown> | unknown[];
1196
2148
  data: {
2149
+ requestId: string | null;
1197
2150
  dateCreated: string;
1198
2151
  dateLastModified: string;
1199
2152
  statusCd: number;
@@ -1201,12 +2154,11 @@ export declare class NexusClient extends BaseServiceClient {
1201
2154
  processCd: number;
1202
2155
  jsonData: string | null;
1203
2156
  importState: string;
1204
- requestId: string | null;
1205
2157
  referenceNo: string | null;
1206
2158
  processMessage: string | null;
1207
2159
  transferReceiptUid: number;
1208
2160
  };
1209
- options: Record<string, unknown>;
2161
+ options: Record<string, unknown> | unknown[];
1210
2162
  status: number;
1211
2163
  message: string;
1212
2164
  count: number;
@@ -1215,19 +2167,42 @@ export declare class NexusClient extends BaseServiceClient {
1215
2167
  }>;
1216
2168
  /**
1217
2169
  * Create a new transfer shipping document
1218
- * @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"
1219
2184
  * @param shippingData Complete transfer shipping data
1220
2185
  * @returns Created transfer shipping details
1221
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
+ * ```
1222
2196
  */
1223
2197
  create: (data: {
2198
+ requestId?: string | undefined;
1224
2199
  properties?: string | undefined;
1225
2200
  jsonData?: string | undefined;
1226
- requestId?: string | undefined;
1227
2201
  referenceNo?: string | undefined;
1228
2202
  }) => Promise<{
1229
- params: Record<string, unknown>;
2203
+ params: Record<string, unknown> | unknown[];
1230
2204
  data: {
2205
+ requestId: string | null;
1231
2206
  dateCreated: string;
1232
2207
  dateLastModified: string;
1233
2208
  statusCd: number;
@@ -1235,12 +2210,11 @@ export declare class NexusClient extends BaseServiceClient {
1235
2210
  processCd: number;
1236
2211
  jsonData: string | null;
1237
2212
  importState: string;
1238
- requestId: string | null;
1239
2213
  referenceNo: string | null;
1240
2214
  processMessage: string | null;
1241
2215
  transferReceiptUid: number;
1242
2216
  };
1243
- options: Record<string, unknown>;
2217
+ options: Record<string, unknown> | unknown[];
1244
2218
  status: number;
1245
2219
  message: string;
1246
2220
  count: number;
@@ -1261,8 +2235,9 @@ export declare class NexusClient extends BaseServiceClient {
1261
2235
  properties?: string | undefined;
1262
2236
  jsonData?: string | undefined;
1263
2237
  }) => Promise<{
1264
- params: Record<string, unknown>;
2238
+ params: Record<string, unknown> | unknown[];
1265
2239
  data: {
2240
+ requestId: string | null;
1266
2241
  dateCreated: string;
1267
2242
  dateLastModified: string;
1268
2243
  statusCd: number;
@@ -1270,12 +2245,11 @@ export declare class NexusClient extends BaseServiceClient {
1270
2245
  processCd: number;
1271
2246
  jsonData: string | null;
1272
2247
  importState: string;
1273
- requestId: string | null;
1274
2248
  referenceNo: string | null;
1275
2249
  processMessage: string | null;
1276
2250
  transferReceiptUid: number;
1277
2251
  };
1278
- options: Record<string, unknown>;
2252
+ options: Record<string, unknown> | unknown[];
1279
2253
  status: number;
1280
2254
  message: string;
1281
2255
  count: number;
@@ -1290,8 +2264,9 @@ export declare class NexusClient extends BaseServiceClient {
1290
2264
  * @throws ValidationError When response is malformed
1291
2265
  */
1292
2266
  delete: (id: string | number) => Promise<{
1293
- params: Record<string, unknown>;
2267
+ params: Record<string, unknown> | unknown[];
1294
2268
  data: {
2269
+ requestId: string | null;
1295
2270
  dateCreated: string;
1296
2271
  dateLastModified: string;
1297
2272
  statusCd: number;
@@ -1299,18 +2274,119 @@ export declare class NexusClient extends BaseServiceClient {
1299
2274
  processCd: number;
1300
2275
  jsonData: string | null;
1301
2276
  importState: string;
1302
- requestId: string | null;
1303
2277
  referenceNo: string | null;
1304
2278
  processMessage: string | null;
1305
2279
  transferReceiptUid: number;
1306
2280
  };
1307
- options: Record<string, unknown>;
2281
+ options: Record<string, unknown> | unknown[];
1308
2282
  status: number;
1309
2283
  message: string;
1310
2284
  count: number;
1311
2285
  total: number;
1312
2286
  totalResults: number;
1313
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
+ }>;
1314
2389
  };
1315
2390
  }
2391
+ export {};
1316
2392
  //# sourceMappingURL=client.d.ts.map