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