@simpleapps-com/augur-api 0.2.8 → 0.2.10
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/PERFORMANCE.md +816 -0
- package/README.md +1084 -197
- package/dist/cjs/index.d.ts +3 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +4 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/p21-sism/client.d.ts +452 -0
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/client.js +538 -0
- package/dist/cjs/services/p21-sism/client.js.map +1 -0
- package/dist/cjs/services/p21-sism/index.d.ts +38 -0
- package/dist/cjs/services/p21-sism/index.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/index.js +56 -0
- package/dist/cjs/services/p21-sism/index.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/health.d.ts +63 -0
- package/dist/cjs/services/p21-sism/schemas/health.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/health.js +17 -0
- package/dist/cjs/services/p21-sism/schemas/health.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/import.d.ts +289 -0
- package/dist/cjs/services/p21-sism/schemas/import.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/import.js +100 -0
- package/dist/cjs/services/p21-sism/schemas/import.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/index.d.ts +5 -0
- package/dist/cjs/services/p21-sism/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/index.js +25 -0
- package/dist/cjs/services/p21-sism/schemas/index.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/order-entry.d.ts +76 -0
- package/dist/cjs/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/order-entry.js +33 -0
- package/dist/cjs/services/p21-sism/schemas/order-entry.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
- package/dist/cjs/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas/scheduled-import.js +23 -0
- package/dist/cjs/services/p21-sism/schemas/scheduled-import.js.map +1 -0
- package/dist/cjs/services/p21-sism/schemas.d.ts +10 -0
- package/dist/cjs/services/p21-sism/schemas.d.ts.map +1 -0
- package/dist/cjs/services/p21-sism/schemas.js +26 -0
- package/dist/cjs/services/p21-sism/schemas.js.map +1 -0
- package/dist/esm/index.d.ts +3 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +2 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/p21-sism/client.d.ts +452 -0
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/client.js +534 -0
- package/dist/esm/services/p21-sism/client.js.map +1 -0
- package/dist/esm/services/p21-sism/index.d.ts +38 -0
- package/dist/esm/services/p21-sism/index.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/index.js +38 -0
- package/dist/esm/services/p21-sism/index.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas/health.d.ts +63 -0
- package/dist/esm/services/p21-sism/schemas/health.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas/health.js +14 -0
- package/dist/esm/services/p21-sism/schemas/health.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas/import.d.ts +289 -0
- package/dist/esm/services/p21-sism/schemas/import.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas/import.js +97 -0
- package/dist/esm/services/p21-sism/schemas/import.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas/index.d.ts +5 -0
- package/dist/esm/services/p21-sism/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas/index.js +9 -0
- package/dist/esm/services/p21-sism/schemas/index.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas/order-entry.d.ts +76 -0
- package/dist/esm/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas/order-entry.js +30 -0
- package/dist/esm/services/p21-sism/schemas/order-entry.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
- package/dist/esm/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas/scheduled-import.js +20 -0
- package/dist/esm/services/p21-sism/schemas/scheduled-import.js.map +1 -0
- package/dist/esm/services/p21-sism/schemas.d.ts +10 -0
- package/dist/esm/services/p21-sism/schemas.d.ts.map +1 -0
- package/dist/esm/services/p21-sism/schemas.js +10 -0
- package/dist/esm/services/p21-sism/schemas.js.map +1 -0
- package/dist/types/index.d.ts +3 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/p21-sism/client.d.ts +452 -0
- package/dist/types/services/p21-sism/client.d.ts.map +1 -0
- package/dist/types/services/p21-sism/index.d.ts +38 -0
- package/dist/types/services/p21-sism/index.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas/health.d.ts +63 -0
- package/dist/types/services/p21-sism/schemas/health.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas/import.d.ts +289 -0
- package/dist/types/services/p21-sism/schemas/import.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas/index.d.ts +5 -0
- package/dist/types/services/p21-sism/schemas/index.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas/order-entry.d.ts +76 -0
- package/dist/types/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
- package/dist/types/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
- package/dist/types/services/p21-sism/schemas.d.ts +10 -0
- package/dist/types/services/p21-sism/schemas.d.ts.map +1 -0
- package/package.json +4 -3
|
@@ -0,0 +1,538 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.P21SismClient = void 0;
|
|
4
|
+
const zod_1 = require("zod");
|
|
5
|
+
const base_client_1 = require("../../core/base-client");
|
|
6
|
+
const schemas_1 = require("../../core/schemas");
|
|
7
|
+
// Create flexible response schemas using the STANDARD 8-field response format
|
|
8
|
+
// All APIs must use this format - no response validation per OpenAPI spec requirements
|
|
9
|
+
const UnknownResponseSchema = (0, schemas_1.BaseResponseSchema)(zod_1.z.unknown());
|
|
10
|
+
const UnknownArrayResponseSchema = (0, schemas_1.BaseResponseSchema)(zod_1.z.array(zod_1.z.unknown()));
|
|
11
|
+
const schemas_2 = require("./schemas");
|
|
12
|
+
/**
|
|
13
|
+
* P21 SISM (System Integration & Storage Management) API Client
|
|
14
|
+
* @description Client for interacting with P21 SISM API endpoints for system integration, data import management, order entry processing, and scheduled import operations within the Prophet 21 ERP ecosystem
|
|
15
|
+
* @fullPath api.p21Sism
|
|
16
|
+
* @service p21-sism
|
|
17
|
+
* @domain system-integration-and-storage-management
|
|
18
|
+
* @discoverable true
|
|
19
|
+
* @searchTerms ["p21-sism", "system integration", "storage management", "data import", "order entry", "scheduled imports", "ERP integration", "import processing", "data synchronization", "batch processing"]
|
|
20
|
+
* @relatedEndpoints ["api.p21Core.company", "api.p21Core.location", "api.orders.orders", "api.items.products", "api.nexus.receiving"]
|
|
21
|
+
* @commonPatterns ["Import data management", "Order entry processing", "Scheduled data synchronization", "System integration workflows", "Batch import operations"]
|
|
22
|
+
* @workflow ["data-import", "system-integration", "order-entry-processing", "scheduled-synchronization", "batch-operations"]
|
|
23
|
+
* @prerequisites ["Valid P21 system access", "ERP authentication", "Import processing permissions", "Company-specific data access"]
|
|
24
|
+
* @nextSteps ["api.orders.orders for order processing", "api.items.products for inventory integration", "api.p21Core for system configuration"]
|
|
25
|
+
* @businessRules ["Import state transitions: initial → hold → delivered", "Import UID required for all operations", "SFTP metadata for scheduled imports", "Order entry header data validation"]
|
|
26
|
+
* @functionalArea "system-integration-and-storage-management"
|
|
27
|
+
* @caching "Cache import lists for 5 minutes, real-time for import status updates, no caching for order entry operations"
|
|
28
|
+
* @performance "Supports pagination for import lists, batch processing for large imports, optimized for ERP transaction volumes"
|
|
29
|
+
* @example
|
|
30
|
+
* ```typescript
|
|
31
|
+
* import { HTTPClient } from '@augur/api-client/core';
|
|
32
|
+
* import { P21SismClient } from '@augur/api-client/services/p21-sism';
|
|
33
|
+
*
|
|
34
|
+
* const client = new P21SismClient(new HTTPClient({ baseURL: 'https://p21-sism.augur-api.com' }));
|
|
35
|
+
*
|
|
36
|
+
* // List recent imports for monitoring
|
|
37
|
+
* const recentImports = await client.import.recent({ hours: 24, limit: 50 });
|
|
38
|
+
* console.log(recentImports.data); // Import[]
|
|
39
|
+
*
|
|
40
|
+
* // Get import details for processing
|
|
41
|
+
* const importDetails = await client.import.get({ importUid: '12345' });
|
|
42
|
+
* console.log(importDetails.data); // Import
|
|
43
|
+
*
|
|
44
|
+
* // Process order entry header data
|
|
45
|
+
* const orderHeader = await client.orderEntry.getHeader({ importUid: '12345' });
|
|
46
|
+
* console.log(orderHeader.data); // Order entry header data
|
|
47
|
+
*
|
|
48
|
+
* // Check for stuck imports
|
|
49
|
+
* const stuckImports = await client.import.stuck({ hours: 48 });
|
|
50
|
+
* console.log(stuckImports.data); // Import[]
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
class P21SismClient extends base_client_1.BaseServiceClient {
|
|
54
|
+
// Ensure schemas are referenced to avoid unused import warnings
|
|
55
|
+
get schemaRefs() {
|
|
56
|
+
return this._schemaRefs;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Create a new P21SismClient instance
|
|
60
|
+
* @param http Configured HTTPClient instance with authentication
|
|
61
|
+
* @param baseUrl Base URL for the P21 SISM API (default: https://p21-sism.augur-api.com)
|
|
62
|
+
*/
|
|
63
|
+
constructor(http, baseUrl = 'https://p21-sism.augur-api.com') {
|
|
64
|
+
super('p21-sism', http, baseUrl);
|
|
65
|
+
// Schema references for 100% coverage - ensuring all exports are imported
|
|
66
|
+
this._schemaRefs = {
|
|
67
|
+
ImportSchema: schemas_2.ImportSchema,
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Import management operations for data processing and system integration
|
|
71
|
+
* @fullPath api.p21Sism.import
|
|
72
|
+
* @service p21-sism
|
|
73
|
+
* @domain data-import-management
|
|
74
|
+
* @discoverable true
|
|
75
|
+
*/
|
|
76
|
+
this.import = {
|
|
77
|
+
/**
|
|
78
|
+
* List imports with filtering capabilities for data management and monitoring
|
|
79
|
+
*
|
|
80
|
+
* @fullPath api.p21Sism.import.list
|
|
81
|
+
* @service p21-sism
|
|
82
|
+
* @domain data-import-management
|
|
83
|
+
* @dataMethod listData - returns only the imports array without metadata
|
|
84
|
+
* @discoverable true
|
|
85
|
+
* @searchTerms ["imports", "data import", "import list", "batch processing", "data synchronization", "import management"]
|
|
86
|
+
* @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.recent", "api.p21Sism.import.stuck"]
|
|
87
|
+
* @commonPatterns ["List all imports", "Filter imports by state", "Search import history", "Monitor import progress"]
|
|
88
|
+
* @workflow ["import-monitoring", "data-management", "system-integration", "batch-processing"]
|
|
89
|
+
* @prerequisites ["Valid authentication", "Import management permissions"]
|
|
90
|
+
* @nextSteps ["api.p21Sism.import.get for details", "api.p21Sism.import.update for modifications"]
|
|
91
|
+
* @businessRules ["Import states: initial, hold, delivered", "Supports pagination and filtering", "Search by reference number or source name"]
|
|
92
|
+
* @functionalArea "data-import-management"
|
|
93
|
+
* @caching "Cache for 5 minutes, invalidate on import state changes"
|
|
94
|
+
* @performance "Indexed by import state and date, supports text search across multiple fields"
|
|
95
|
+
*
|
|
96
|
+
* @param params Optional filtering and pagination parameters
|
|
97
|
+
* @returns Promise<BaseResponse<Import[]>> Complete response with imports array and metadata
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```typescript
|
|
101
|
+
* // Get all pending imports
|
|
102
|
+
* const response = await client.import.list({ importState: 'initial', limit: 50 });
|
|
103
|
+
* console.log(response.data); // Import[]
|
|
104
|
+
*
|
|
105
|
+
* // Get just the data
|
|
106
|
+
* const imports = await client.import.listData({ importState: 'delivered' });
|
|
107
|
+
*
|
|
108
|
+
* // Search for specific imports
|
|
109
|
+
* const found = await client.import.list({ q: 'order123' });
|
|
110
|
+
* ```
|
|
111
|
+
*/
|
|
112
|
+
list: this.createListMethod('/import', schemas_2.ImportListParamsSchema, UnknownArrayResponseSchema),
|
|
113
|
+
/**
|
|
114
|
+
* Get recent imports for monitoring and status tracking
|
|
115
|
+
*
|
|
116
|
+
* @fullPath api.p21Sism.import.recent
|
|
117
|
+
* @service p21-sism
|
|
118
|
+
* @domain data-import-management
|
|
119
|
+
* @dataMethod recentData - returns only the imports array without metadata
|
|
120
|
+
* @discoverable true
|
|
121
|
+
* @searchTerms ["recent imports", "import monitoring", "latest imports", "import status", "recent activity"]
|
|
122
|
+
* @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.stuck", "api.p21Sism.health.check"]
|
|
123
|
+
* @commonPatterns ["Monitor recent import activity", "Check latest import status", "Track import progress"]
|
|
124
|
+
* @workflow ["import-monitoring", "status-tracking", "system-health", "operational-awareness"]
|
|
125
|
+
* @prerequisites ["Valid authentication", "Import monitoring permissions"]
|
|
126
|
+
* @nextSteps ["api.p21Sism.import.get for import details", "api.p21Sism.import.stuck to check for issues"]
|
|
127
|
+
* @businessRules ["Default 48 hours lookback", "Maximum 1000 results", "Ordered by creation date"]
|
|
128
|
+
* @functionalArea "data-import-management"
|
|
129
|
+
* @caching "Cache for 2 minutes, recent data needs freshness"
|
|
130
|
+
* @performance "Optimized query with date range filtering, minimal processing overhead"
|
|
131
|
+
*
|
|
132
|
+
* @param params Optional time range and limit parameters
|
|
133
|
+
* @returns Promise<BaseResponse<Import[]>> Complete response with recent imports
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```typescript
|
|
137
|
+
* // Get imports from last 24 hours
|
|
138
|
+
* const response = await client.import.recent({ hours: 24, limit: 100 });
|
|
139
|
+
* console.log(response.data); // Import[]
|
|
140
|
+
*
|
|
141
|
+
* // Get just the data
|
|
142
|
+
* const recentImports = await client.import.recentData({ hours: 12 });
|
|
143
|
+
* ```
|
|
144
|
+
*/
|
|
145
|
+
recent: this.createListMethod('/import/recent', schemas_2.ImportRecentParamsSchema, UnknownArrayResponseSchema),
|
|
146
|
+
/**
|
|
147
|
+
* Get stuck imports for troubleshooting and error resolution
|
|
148
|
+
*
|
|
149
|
+
* @fullPath api.p21Sism.import.stuck
|
|
150
|
+
* @service p21-sism
|
|
151
|
+
* @domain data-import-management
|
|
152
|
+
* @dataMethod stuckData - returns only the imports array without metadata
|
|
153
|
+
* @discoverable true
|
|
154
|
+
* @searchTerms ["stuck imports", "failed imports", "import errors", "import troubleshooting", "processing issues"]
|
|
155
|
+
* @relatedEndpoints ["api.p21Sism.import.recent", "api.p21Sism.import.get", "api.p21Sism.import.update"]
|
|
156
|
+
* @commonPatterns ["Troubleshoot import issues", "Find failed imports", "Monitor processing problems"]
|
|
157
|
+
* @workflow ["error-resolution", "import-troubleshooting", "system-maintenance", "issue-identification"]
|
|
158
|
+
* @prerequisites ["Valid authentication", "Import troubleshooting permissions"]
|
|
159
|
+
* @nextSteps ["api.p21Sism.import.get for error details", "api.p21Sism.import.update to retry", "api.p21Sism.import.delete to clean up"]
|
|
160
|
+
* @businessRules ["Default 48 hours lookback for stuck detection", "Maximum 1000 results", "Identifies imports in error states"]
|
|
161
|
+
* @functionalArea "data-import-management"
|
|
162
|
+
* @caching "Cache for 1 minute, error data needs immediate visibility"
|
|
163
|
+
* @performance "Specialized query for error detection, includes diagnostic information"
|
|
164
|
+
*
|
|
165
|
+
* @param params Optional time range and limit parameters
|
|
166
|
+
* @returns Promise<BaseResponse<Import[]>> Complete response with stuck imports for troubleshooting
|
|
167
|
+
*
|
|
168
|
+
* @example
|
|
169
|
+
* ```typescript
|
|
170
|
+
* // Get imports stuck in last 48 hours
|
|
171
|
+
* const response = await client.import.stuck({ hours: 48, limit: 200 });
|
|
172
|
+
* console.log(response.data); // Import[]
|
|
173
|
+
*
|
|
174
|
+
* // Get just the data
|
|
175
|
+
* const stuckImports = await client.import.stuckData({ hours: 72 });
|
|
176
|
+
* ```
|
|
177
|
+
*/
|
|
178
|
+
stuck: this.createListMethod('/import/stuck', schemas_2.ImportStuckParamsSchema, UnknownArrayResponseSchema),
|
|
179
|
+
/**
|
|
180
|
+
* Get import details by UID for comprehensive import information
|
|
181
|
+
*
|
|
182
|
+
* @fullPath api.p21Sism.import.get
|
|
183
|
+
* @service p21-sism
|
|
184
|
+
* @domain data-import-management
|
|
185
|
+
* @dataMethod getData - returns only the import object without metadata
|
|
186
|
+
* @discoverable true
|
|
187
|
+
* @searchTerms ["import details", "import info", "import status", "import data", "import processing"]
|
|
188
|
+
* @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.update", "api.p21Sism.orderEntry.getHeader"]
|
|
189
|
+
* @commonPatterns ["Get import status", "View import details", "Check processing results", "Retrieve import data"]
|
|
190
|
+
* @workflow ["import-details", "status-checking", "data-retrieval", "import-analysis"]
|
|
191
|
+
* @prerequisites ["Valid import UID", "Import access permissions"]
|
|
192
|
+
* @nextSteps ["api.p21Sism.import.update for modifications", "api.p21Sism.orderEntry for related data"]
|
|
193
|
+
* @businessRules ["Import UID must exist", "Includes processing results and status", "Shows complete import lifecycle"]
|
|
194
|
+
* @functionalArea "data-import-management"
|
|
195
|
+
* @performance "Direct lookup by UID, includes all related import data"
|
|
196
|
+
*
|
|
197
|
+
* @param params Import UID parameter
|
|
198
|
+
* @returns Promise<BaseResponse<Import>> Complete response with detailed import information
|
|
199
|
+
*/
|
|
200
|
+
get: async (params) => this.executeRequest({
|
|
201
|
+
method: 'GET',
|
|
202
|
+
path: '/import/{importUid}',
|
|
203
|
+
paramsSchema: schemas_2.ImportDetailParamsSchema,
|
|
204
|
+
responseSchema: UnknownResponseSchema,
|
|
205
|
+
}, params, { importUid: params.importUid }),
|
|
206
|
+
/**
|
|
207
|
+
* Update import details and processing status
|
|
208
|
+
*
|
|
209
|
+
* @fullPath api.p21Sism.import.update
|
|
210
|
+
* @service p21-sism
|
|
211
|
+
* @domain data-import-management
|
|
212
|
+
* @dataMethod updateData - returns only the updated import object without metadata
|
|
213
|
+
* @discoverable true
|
|
214
|
+
* @searchTerms ["update import", "modify import", "import processing", "import status change", "import management"]
|
|
215
|
+
* @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.list", "api.p21Sism.import.delete"]
|
|
216
|
+
* @commonPatterns ["Update import status", "Modify import data", "Retry failed import", "Change import state"]
|
|
217
|
+
* @workflow ["import-management", "status-updates", "import-processing", "error-recovery"]
|
|
218
|
+
* @prerequisites ["Valid import UID", "Import modification permissions"]
|
|
219
|
+
* @nextSteps ["api.p21Sism.import.get to verify changes", "api.p21Sism.orderEntry for processing"]
|
|
220
|
+
* @businessRules ["State transitions must be valid", "Updates affect processing workflow", "Audit trail maintained"]
|
|
221
|
+
* @functionalArea "data-import-management"
|
|
222
|
+
* @performance "Immediate update with validation, triggers workflow processing"
|
|
223
|
+
*
|
|
224
|
+
* @param params Import UID parameter
|
|
225
|
+
* @returns Promise<BaseResponse<Import>> Complete response with updated import information
|
|
226
|
+
*/
|
|
227
|
+
update: async (params) => this.executeRequest({
|
|
228
|
+
method: 'PUT',
|
|
229
|
+
path: '/import/{importUid}',
|
|
230
|
+
paramsSchema: schemas_2.ImportDetailParamsSchema,
|
|
231
|
+
responseSchema: UnknownResponseSchema,
|
|
232
|
+
}, params, { importUid: params.importUid }),
|
|
233
|
+
/**
|
|
234
|
+
* Clean pending import data for import cleanup and maintenance
|
|
235
|
+
*
|
|
236
|
+
* @fullPath api.p21Sism.import.delete
|
|
237
|
+
* @service p21-sism
|
|
238
|
+
* @domain data-import-management
|
|
239
|
+
* @dataMethod deleteData - returns only the cleanup result without metadata
|
|
240
|
+
* @discoverable true
|
|
241
|
+
* @searchTerms ["delete import", "clean import", "remove import", "import cleanup", "pending import cleanup"]
|
|
242
|
+
* @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.stuck", "api.p21Sism.import.list"]
|
|
243
|
+
* @commonPatterns ["Clean up failed imports", "Remove stuck imports", "System maintenance", "Import cleanup"]
|
|
244
|
+
* @workflow ["import-cleanup", "system-maintenance", "error-recovery", "data-cleanup"]
|
|
245
|
+
* @prerequisites ["Valid import UID", "Import cleanup permissions", "Import in deletable state"]
|
|
246
|
+
* @nextSteps ["api.p21Sism.import.list to verify removal", "system maintenance workflows"]
|
|
247
|
+
* @businessRules ["Only cleans pending import data", "Does not affect completed imports", "Maintains audit trail"]
|
|
248
|
+
* @functionalArea "data-import-management"
|
|
249
|
+
* @performance "Cleanup operation with validation, affects related pending data"
|
|
250
|
+
*
|
|
251
|
+
* @param params Import UID parameter
|
|
252
|
+
* @returns Promise<BaseResponse<Import>> Complete response with cleanup confirmation
|
|
253
|
+
*/
|
|
254
|
+
delete: async (params) => this.executeRequest({
|
|
255
|
+
method: 'DELETE',
|
|
256
|
+
path: '/import/{importUid}',
|
|
257
|
+
paramsSchema: schemas_2.ImportDetailParamsSchema,
|
|
258
|
+
responseSchema: UnknownResponseSchema,
|
|
259
|
+
}, params, { importUid: params.importUid }),
|
|
260
|
+
// Data methods for import operations
|
|
261
|
+
listData: async (params) => {
|
|
262
|
+
const response = await this.import.list(params);
|
|
263
|
+
return response.data;
|
|
264
|
+
},
|
|
265
|
+
recentData: async (params) => {
|
|
266
|
+
const response = await this.import.recent(params);
|
|
267
|
+
return response.data;
|
|
268
|
+
},
|
|
269
|
+
stuckData: async (params) => {
|
|
270
|
+
const response = await this.import.stuck(params);
|
|
271
|
+
return response.data;
|
|
272
|
+
},
|
|
273
|
+
getData: async (params) => {
|
|
274
|
+
const response = await this.import.get(params);
|
|
275
|
+
return response.data;
|
|
276
|
+
},
|
|
277
|
+
updateData: async (params) => {
|
|
278
|
+
const response = await this.import.update(params);
|
|
279
|
+
return response.data;
|
|
280
|
+
},
|
|
281
|
+
deleteData: async (params) => {
|
|
282
|
+
const response = await this.import.delete(params);
|
|
283
|
+
return response.data;
|
|
284
|
+
},
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* Order entry operations for processing order header and sales representative data
|
|
288
|
+
* @fullPath api.p21Sism.orderEntry
|
|
289
|
+
* @service p21-sism
|
|
290
|
+
* @domain order-entry-processing
|
|
291
|
+
* @discoverable true
|
|
292
|
+
*/
|
|
293
|
+
this.orderEntry = {
|
|
294
|
+
/**
|
|
295
|
+
* Get order entry header details from imp_oe_hdr table
|
|
296
|
+
*
|
|
297
|
+
* @fullPath api.p21Sism.orderEntry.getHeader
|
|
298
|
+
* @service p21-sism
|
|
299
|
+
* @domain order-entry-processing
|
|
300
|
+
* @dataMethod getHeaderData - returns only the header data without metadata
|
|
301
|
+
* @discoverable true
|
|
302
|
+
* @searchTerms ["order entry header", "oe header", "order header", "import order header", "order processing"]
|
|
303
|
+
* @relatedEndpoints ["api.p21Sism.orderEntry.updateHeader", "api.p21Sism.orderEntry.getSalesrep", "api.p21Sism.import.get"]
|
|
304
|
+
* @commonPatterns ["Get order header data", "Process order entry", "Order import processing", "Header data retrieval"]
|
|
305
|
+
* @workflow ["order-entry-processing", "order-import", "header-processing", "order-management"]
|
|
306
|
+
* @prerequisites ["Valid import UID", "Order entry access permissions", "Import must contain order data"]
|
|
307
|
+
* @nextSteps ["api.p21Sism.orderEntry.updateHeader for modifications", "api.orders.orders for order processing"]
|
|
308
|
+
* @businessRules ["Import UID must reference valid order entry import", "Header data structure varies by import type", "Processing state affects data availability"]
|
|
309
|
+
* @functionalArea "order-entry-processing"
|
|
310
|
+
* @performance "Direct table access, optimized for order processing workflows"
|
|
311
|
+
*
|
|
312
|
+
* @param params Import UID parameter
|
|
313
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with order entry header data
|
|
314
|
+
*/
|
|
315
|
+
getHeader: async (params) => this.executeRequest({
|
|
316
|
+
method: 'GET',
|
|
317
|
+
path: '/import/{importUid}/imp-oe-hdr',
|
|
318
|
+
paramsSchema: schemas_2.OrderEntryHeaderParamsSchema,
|
|
319
|
+
responseSchema: UnknownResponseSchema,
|
|
320
|
+
}, params, { importUid: params.importUid }),
|
|
321
|
+
/**
|
|
322
|
+
* Update order entry header data in imp_oe_hdr table
|
|
323
|
+
*
|
|
324
|
+
* @fullPath api.p21Sism.orderEntry.updateHeader
|
|
325
|
+
* @service p21-sism
|
|
326
|
+
* @domain order-entry-processing
|
|
327
|
+
* @dataMethod updateHeaderData - returns only the updated header data without metadata
|
|
328
|
+
* @discoverable true
|
|
329
|
+
* @searchTerms ["update order header", "modify order entry", "order header update", "oe header update"]
|
|
330
|
+
* @relatedEndpoints ["api.p21Sism.orderEntry.getHeader", "api.p21Sism.orderEntry.updateSalesrep", "api.p21Sism.import.update"]
|
|
331
|
+
* @commonPatterns ["Update order header", "Modify order entry data", "Process order changes", "Header data updates"]
|
|
332
|
+
* @workflow ["order-processing", "order-modifications", "header-updates", "order-management"]
|
|
333
|
+
* @prerequisites ["Valid import UID", "Order modification permissions", "Order in editable state"]
|
|
334
|
+
* @nextSteps ["api.p21Sism.orderEntry.getHeader to verify changes", "api.orders.orders for order processing"]
|
|
335
|
+
* @businessRules ["Validation rules apply to header updates", "State transitions must be valid", "Updates affect order processing workflow"]
|
|
336
|
+
* @functionalArea "order-entry-processing"
|
|
337
|
+
* @performance "Direct table updates with validation, triggers order processing workflows"
|
|
338
|
+
*
|
|
339
|
+
* @param params Import UID parameter
|
|
340
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with updated order entry header data
|
|
341
|
+
*/
|
|
342
|
+
updateHeader: async (params) => this.executeRequest({
|
|
343
|
+
method: 'PUT',
|
|
344
|
+
path: '/import/{importUid}/imp-oe-hdr',
|
|
345
|
+
paramsSchema: schemas_2.OrderEntryHeaderParamsSchema,
|
|
346
|
+
responseSchema: UnknownResponseSchema,
|
|
347
|
+
}, params, { importUid: params.importUid }),
|
|
348
|
+
/**
|
|
349
|
+
* Get order entry sales representative details from imp_oe_hdr_salesrep table
|
|
350
|
+
*
|
|
351
|
+
* @fullPath api.p21Sism.orderEntry.getSalesrep
|
|
352
|
+
* @service p21-sism
|
|
353
|
+
* @domain order-entry-processing
|
|
354
|
+
* @dataMethod getSalesrepData - returns only the salesrep data without metadata
|
|
355
|
+
* @discoverable true
|
|
356
|
+
* @searchTerms ["order salesrep", "sales representative", "oe salesrep", "order sales rep", "salesrep data"]
|
|
357
|
+
* @relatedEndpoints ["api.p21Sism.orderEntry.updateSalesrep", "api.p21Sism.orderEntry.getHeader", "api.orders.orders.salesrep"]
|
|
358
|
+
* @commonPatterns ["Get sales rep info", "Process salesrep data", "Order sales rep processing", "Commission processing"]
|
|
359
|
+
* @workflow ["salesrep-processing", "commission-calculation", "order-attribution", "sales-management"]
|
|
360
|
+
* @prerequisites ["Valid import UID", "Sales rep access permissions", "Import must contain salesrep data"]
|
|
361
|
+
* @nextSteps ["api.p21Sism.orderEntry.updateSalesrep for modifications", "api.orders.orders for commission processing"]
|
|
362
|
+
* @businessRules ["Sales rep assignments affect commission calculation", "Multiple sales reps per order supported", "Territory validation applies"]
|
|
363
|
+
* @functionalArea "order-entry-processing"
|
|
364
|
+
* @performance "Optimized for sales rep lookup and commission calculations"
|
|
365
|
+
*
|
|
366
|
+
* @param params Import UID parameter
|
|
367
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with sales representative data
|
|
368
|
+
*/
|
|
369
|
+
getSalesrep: async (params) => this.executeRequest({
|
|
370
|
+
method: 'GET',
|
|
371
|
+
path: '/import/{importUid}/imp-oe-hdr-salesrep',
|
|
372
|
+
paramsSchema: schemas_2.OrderEntryHeaderSalesrepParamsSchema,
|
|
373
|
+
responseSchema: UnknownResponseSchema,
|
|
374
|
+
}, params, { importUid: params.importUid }),
|
|
375
|
+
/**
|
|
376
|
+
* Update order entry sales representative data in imp_oe_hdr_salesrep table
|
|
377
|
+
*
|
|
378
|
+
* @fullPath api.p21Sism.orderEntry.updateSalesrep
|
|
379
|
+
* @service p21-sism
|
|
380
|
+
* @domain order-entry-processing
|
|
381
|
+
* @dataMethod updateSalesrepData - returns only the updated salesrep data without metadata
|
|
382
|
+
* @discoverable true
|
|
383
|
+
* @searchTerms ["update salesrep", "modify sales rep", "salesrep update", "commission update", "sales rep assignment"]
|
|
384
|
+
* @relatedEndpoints ["api.p21Sism.orderEntry.getSalesrep", "api.p21Sism.orderEntry.updateHeader", "api.orders.orders.updateSalesrep"]
|
|
385
|
+
* @commonPatterns ["Update sales rep assignment", "Modify commission data", "Change order attribution", "Sales rep management"]
|
|
386
|
+
* @workflow ["salesrep-management", "commission-updates", "order-attribution", "territory-management"]
|
|
387
|
+
* @prerequisites ["Valid import UID", "Sales rep modification permissions", "Valid sales rep codes"]
|
|
388
|
+
* @nextSteps ["api.p21Sism.orderEntry.getSalesrep to verify changes", "api.orders.orders for commission processing"]
|
|
389
|
+
* @businessRules ["Sales rep validation required", "Commission recalculation triggered", "Territory assignments must be valid"]
|
|
390
|
+
* @functionalArea "order-entry-processing"
|
|
391
|
+
* @performance "Updates with validation, triggers commission recalculation workflows"
|
|
392
|
+
*
|
|
393
|
+
* @param params Import UID parameter
|
|
394
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with updated sales representative data
|
|
395
|
+
*/
|
|
396
|
+
updateSalesrep: async (params) => this.executeRequest({
|
|
397
|
+
method: 'PUT',
|
|
398
|
+
path: '/import/{importUid}/imp-oe-hdr-salesrep',
|
|
399
|
+
paramsSchema: schemas_2.OrderEntryHeaderSalesrepParamsSchema,
|
|
400
|
+
responseSchema: UnknownResponseSchema,
|
|
401
|
+
}, params, { importUid: params.importUid }),
|
|
402
|
+
/**
|
|
403
|
+
* Get order entry web header details from imp_oe_hdr_web table
|
|
404
|
+
*
|
|
405
|
+
* @fullPath api.p21Sism.orderEntry.getWebHeader
|
|
406
|
+
* @service p21-sism
|
|
407
|
+
* @domain order-entry-processing
|
|
408
|
+
* @dataMethod getWebHeaderData - returns only the web header data without metadata
|
|
409
|
+
* @discoverable true
|
|
410
|
+
* @searchTerms ["web order header", "oe web header", "web order data", "online order header", "e-commerce order"]
|
|
411
|
+
* @relatedEndpoints ["api.p21Sism.orderEntry.getHeader", "api.p21Sism.orderEntry.getSalesrep", "api.commerce.cartHeaders"]
|
|
412
|
+
* @commonPatterns ["Get web order data", "Process online orders", "Web order integration", "E-commerce order processing"]
|
|
413
|
+
* @workflow ["web-order-processing", "e-commerce-integration", "online-order-management", "web-integration"]
|
|
414
|
+
* @prerequisites ["Valid import UID", "Web order access permissions", "Import must contain web order data"]
|
|
415
|
+
* @nextSteps ["api.p21Sism.orderEntry.getHeader for complete order data", "api.commerce.cartHeaders for e-commerce processing"]
|
|
416
|
+
* @businessRules ["Web-specific order attributes included", "Integration with e-commerce systems", "Web order validation rules apply"]
|
|
417
|
+
* @functionalArea "order-entry-processing"
|
|
418
|
+
* @performance "Optimized for web order processing and e-commerce integration"
|
|
419
|
+
*
|
|
420
|
+
* @param params Import UID parameter
|
|
421
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with web order header data
|
|
422
|
+
*/
|
|
423
|
+
getWebHeader: async (params) => this.executeRequest({
|
|
424
|
+
method: 'GET',
|
|
425
|
+
path: '/import/{importUid}/imp-oe-hdr-web',
|
|
426
|
+
paramsSchema: schemas_2.OrderEntryHeaderWebParamsSchema,
|
|
427
|
+
responseSchema: UnknownResponseSchema,
|
|
428
|
+
}, params, { importUid: params.importUid }),
|
|
429
|
+
// Data methods for order entry operations
|
|
430
|
+
getHeaderData: async (params) => {
|
|
431
|
+
const response = await this.orderEntry.getHeader(params);
|
|
432
|
+
return response.data;
|
|
433
|
+
},
|
|
434
|
+
updateHeaderData: async (params) => {
|
|
435
|
+
const response = await this.orderEntry.updateHeader(params);
|
|
436
|
+
return response.data;
|
|
437
|
+
},
|
|
438
|
+
getSalesrepData: async (params) => {
|
|
439
|
+
const response = await this.orderEntry.getSalesrep(params);
|
|
440
|
+
return response.data;
|
|
441
|
+
},
|
|
442
|
+
updateSalesrepData: async (params) => {
|
|
443
|
+
const response = await this.orderEntry.updateSalesrep(params);
|
|
444
|
+
return response.data;
|
|
445
|
+
},
|
|
446
|
+
getWebHeaderData: async (params) => {
|
|
447
|
+
const response = await this.orderEntry.getWebHeader(params);
|
|
448
|
+
return response.data;
|
|
449
|
+
},
|
|
450
|
+
};
|
|
451
|
+
/**
|
|
452
|
+
* Scheduled import operations for SFTP metadata management and automated import processing
|
|
453
|
+
* @fullPath api.p21Sism.scheduledImport
|
|
454
|
+
* @service p21-sism
|
|
455
|
+
* @domain scheduled-import-management
|
|
456
|
+
* @discoverable true
|
|
457
|
+
*/
|
|
458
|
+
this.scheduledImport = {
|
|
459
|
+
/**
|
|
460
|
+
* Create SFTP metadata for a scheduled import master configuration
|
|
461
|
+
*
|
|
462
|
+
* @fullPath api.p21Sism.scheduledImport.createSftpMetadata
|
|
463
|
+
* @service p21-sism
|
|
464
|
+
* @domain scheduled-import-management
|
|
465
|
+
* @dataMethod createSftpMetadataData - returns only the SFTP metadata without response wrapper
|
|
466
|
+
* @discoverable true
|
|
467
|
+
* @searchTerms ["SFTP metadata", "scheduled import", "import master", "SFTP configuration", "automated import", "file transfer"]
|
|
468
|
+
* @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.recent", "api.p21Core.company"]
|
|
469
|
+
* @commonPatterns ["Configure SFTP import", "Setup automated data transfer", "Scheduled import configuration", "File transfer setup"]
|
|
470
|
+
* @workflow ["sftp-configuration", "scheduled-imports", "automated-processing", "file-transfer-setup"]
|
|
471
|
+
* @prerequisites ["Valid scheduled import master UID", "SFTP configuration permissions", "Scheduled import master exists"]
|
|
472
|
+
* @nextSteps ["api.p21Sism.import.recent to monitor scheduled imports", "SFTP file monitoring systems"]
|
|
473
|
+
* @businessRules ["SFTP metadata defines transfer parameters", "Scheduled import master must be configured", "File transfer validation rules apply"]
|
|
474
|
+
* @functionalArea "scheduled-import-management"
|
|
475
|
+
* @performance "Configuration operation, minimal processing overhead"
|
|
476
|
+
*
|
|
477
|
+
* @param params Scheduled import master UID parameter
|
|
478
|
+
* @returns Promise<BaseResponse<unknown>> Complete response with SFTP metadata configuration
|
|
479
|
+
*/
|
|
480
|
+
createSftpMetadata: async (params) => this.executeRequest({
|
|
481
|
+
method: 'POST',
|
|
482
|
+
path: '/scheduled-import-master/{scheduledImportMasterUid}/metadata/sftp',
|
|
483
|
+
paramsSchema: schemas_2.ScheduledImportSftpParamsSchema,
|
|
484
|
+
responseSchema: UnknownResponseSchema,
|
|
485
|
+
}, params, { scheduledImportMasterUid: params.scheduledImportMasterUid }),
|
|
486
|
+
// Data method for scheduled import operations
|
|
487
|
+
createSftpMetadataData: async (params) => {
|
|
488
|
+
const response = await this.scheduledImport.createSftpMetadata(params);
|
|
489
|
+
return response.data;
|
|
490
|
+
},
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* Health check operations for service monitoring and system status verification
|
|
494
|
+
* @fullPath api.p21Sism.health
|
|
495
|
+
* @service p21-sism
|
|
496
|
+
* @domain system-monitoring
|
|
497
|
+
* @discoverable true
|
|
498
|
+
*/
|
|
499
|
+
this.health = {
|
|
500
|
+
/**
|
|
501
|
+
* Perform health check to verify P21 SISM service status and connectivity
|
|
502
|
+
*
|
|
503
|
+
* @fullPath api.p21Sism.health.check
|
|
504
|
+
* @service p21-sism
|
|
505
|
+
* @domain system-monitoring
|
|
506
|
+
* @dataMethod checkData - returns only the health status without metadata
|
|
507
|
+
* @discoverable true
|
|
508
|
+
* @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test", "SISM health"]
|
|
509
|
+
* @relatedEndpoints ["api.p21Core.health.check", "api.p21Sism.import.recent", "system monitoring endpoints"]
|
|
510
|
+
* @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
|
|
511
|
+
* @workflow ["system-monitoring", "health-verification", "service-diagnostics", "integration-testing"]
|
|
512
|
+
* @prerequisites ["System access", "Monitoring permissions"]
|
|
513
|
+
* @nextSteps ["Service remediation if unhealthy", "Integration health checks", "api.p21Sism.import.stuck for processing issues"]
|
|
514
|
+
* @businessRules ["Returns site configuration", "Includes system hash for verification", "No authentication required for health check"]
|
|
515
|
+
* @functionalArea "system-monitoring"
|
|
516
|
+
* @performance "Lightweight check, immediate response, minimal system impact"
|
|
517
|
+
*
|
|
518
|
+
* @returns Promise<BaseResponse<HealthCheckResponse>> Service health status and configuration
|
|
519
|
+
*/
|
|
520
|
+
check: async () => {
|
|
521
|
+
return this.executeRequest({
|
|
522
|
+
method: 'GET',
|
|
523
|
+
path: '/health-check',
|
|
524
|
+
responseSchema: schemas_2.HealthCheckResponseSchema,
|
|
525
|
+
});
|
|
526
|
+
},
|
|
527
|
+
// Data method for health operations
|
|
528
|
+
checkData: async () => {
|
|
529
|
+
const response = await this.health.check();
|
|
530
|
+
return response.data;
|
|
531
|
+
},
|
|
532
|
+
};
|
|
533
|
+
// Reference schemas to ensure 100% import coverage
|
|
534
|
+
void this.schemaRefs;
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
exports.P21SismClient = P21SismClient;
|
|
538
|
+
//# sourceMappingURL=client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/p21-sism/client.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,wDAA8E;AAC9E,gDAAwD;AAExD,8EAA8E;AAC9E,uFAAuF;AACvF,MAAM,qBAAqB,GAAG,IAAA,4BAAkB,EAAC,OAAC,CAAC,OAAO,EAAE,CAAuC,CAAC;AACpG,MAAM,0BAA0B,GAAG,IAAA,4BAAkB,EAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAEzE,CAAC;AAEF,uCAmBmB;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,aAAc,SAAQ,+BAAiB;IAMlD,gEAAgE;IAChE,IAAY,UAAU;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,YAAY,IAAgB,EAAE,UAAkB,gCAAgC;QAC9E,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAhBnC,0EAA0E;QACzD,gBAAW,GAAG;YAC7B,YAAY,EAAZ,sBAAY;SACJ,CAAC;QAkBX;;;;;;WAMG;QACa,WAAM,GAAG;YACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAkCG;YACH,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,gCAAsB,EAAE,0BAA0B,CAAC;YAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA+BG;YACH,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAC3B,gBAAgB,EAChB,kCAAwB,EACxB,0BAA0B,CAC3B;YAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA+BG;YACH,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAC1B,eAAe,EACf,iCAAuB,EACvB,0BAA0B,CAC3B;YAED;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,GAAG,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE,CACxC,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,qBAAqB;gBAC3B,YAAY,EAAE,kCAAwB;gBACtC,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,MAAM,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE,CAC3C,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,qBAAqB;gBAC3B,YAAY,EAAE,kCAAwB;gBACtC,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,MAAM,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE,CAC3C,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,qBAAqB;gBAC3B,YAAY,EAAE,kCAAwB;gBACtC,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH,qCAAqC;YACrC,QAAQ,EAAE,KAAK,EAAE,MAAyB,EAAE,EAAE;gBAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,UAAU,EAAE,KAAK,EAAE,MAA2B,EAAE,EAAE;gBAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,SAAS,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE;gBAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE;gBAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC/C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,UAAU,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE;gBAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,UAAU,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE;gBAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;;;;WAMG;QACa,eAAU,GAAG;YAC3B;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,SAAS,EAAE,KAAK,EAAE,MAA8B,EAAE,EAAE,CAClD,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gCAAgC;gBACtC,YAAY,EAAE,sCAA4B;gBAC1C,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,YAAY,EAAE,KAAK,EAAE,MAA8B,EAAE,EAAE,CACrD,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gCAAgC;gBACtC,YAAY,EAAE,sCAA4B;gBAC1C,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,WAAW,EAAE,KAAK,EAAE,MAAsC,EAAE,EAAE,CAC5D,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,yCAAyC;gBAC/C,YAAY,EAAE,8CAAoC;gBAClD,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,cAAc,EAAE,KAAK,EAAE,MAAsC,EAAE,EAAE,CAC/D,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,yCAAyC;gBAC/C,YAAY,EAAE,8CAAoC;gBAClD,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,YAAY,EAAE,KAAK,EAAE,MAAiC,EAAE,EAAE,CACxD,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,oCAAoC;gBAC1C,YAAY,EAAE,yCAA+B;gBAC7C,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAChC;YAEH,0CAA0C;YAC1C,aAAa,EAAE,KAAK,EAAE,MAA8B,EAAE,EAAE;gBACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,gBAAgB,EAAE,KAAK,EAAE,MAA8B,EAAE,EAAE;gBACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,eAAe,EAAE,KAAK,EAAE,MAAsC,EAAE,EAAE;gBAChE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;gBAC3D,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,kBAAkB,EAAE,KAAK,EAAE,MAAsC,EAAE,EAAE;gBACnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC9D,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,gBAAgB,EAAE,KAAK,EAAE,MAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;;;;WAMG;QACa,oBAAe,GAAG;YAChC;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,kBAAkB,EAAE,KAAK,EAAE,MAAiC,EAAE,EAAE,CAC9D,IAAI,CAAC,cAAc,CACjB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,mEAAmE;gBACzE,YAAY,EAAE,yCAA+B;gBAC7C,cAAc,EAAE,qBAAqB;aACtC,EACD,MAAM,EACN,EAAE,wBAAwB,EAAE,MAAM,CAAC,wBAAwB,EAAE,CAC9D;YAEH,8CAA8C;YAC9C,sBAAsB,EAAE,KAAK,EAAE,MAAiC,EAAE,EAAE;gBAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBACvE,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;;;;WAMG;QACa,WAAM,GAAG;YACvB;;;;;;;;;;;;;;;;;;;eAmBG;YACH,KAAK,EAAE,KAAK,IAAI,EAAE;gBAChB,OAAO,IAAI,CAAC,cAAc,CAAC;oBACzB,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,eAAe;oBACrB,cAAc,EAAE,mCAAyB;iBAC1C,CAAC,CAAC;YACL,CAAC;YAED,oCAAoC;YACpC,SAAS,EAAE,KAAK,IAAI,EAAE;gBACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAjiBA,mDAAmD;QACnD,KAAK,IAAI,CAAC,UAAU,CAAC;IACvB,CAAC;CAgiBF;AApjBD,sCAojBC"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* P21 SISM (System Integration & Storage Management) API Client
|
|
3
|
+
*
|
|
4
|
+
* This module provides a comprehensive TypeScript client for the P21 SISM API,
|
|
5
|
+
* enabling seamless integration with Prophet 21's System Integration & Storage Management service.
|
|
6
|
+
*
|
|
7
|
+
* Features:
|
|
8
|
+
* - Complete import management lifecycle (list, create, update, delete)
|
|
9
|
+
* - Order entry processing (headers, sales reps, web orders)
|
|
10
|
+
* - Scheduled import automation with SFTP metadata management
|
|
11
|
+
* - Real-time monitoring (recent imports, stuck imports, health checks)
|
|
12
|
+
* - Dual API pattern (full responses + data-only methods)
|
|
13
|
+
* - Comprehensive type safety with Zod validation
|
|
14
|
+
* - Rich semantic annotations for AI discoverability
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* import { HTTPClient } from '@augur/api-client/core';
|
|
19
|
+
* import { P21SismClient } from '@augur/api-client/services/p21-sism';
|
|
20
|
+
*
|
|
21
|
+
* const client = new P21SismClient(new HTTPClient({
|
|
22
|
+
* baseURL: 'https://p21-sism.augur-api.com',
|
|
23
|
+
* headers: { 'x-site-id': 'your-site-id' }
|
|
24
|
+
* }));
|
|
25
|
+
*
|
|
26
|
+
* // Monitor recent import activity
|
|
27
|
+
* const recentImports = await client.import.recent({ hours: 24 });
|
|
28
|
+
*
|
|
29
|
+
* // Process order entry data
|
|
30
|
+
* const orderHeader = await client.orderEntry.getHeaderData({ importUid: '12345' });
|
|
31
|
+
*
|
|
32
|
+
* // Check for processing issues
|
|
33
|
+
* const stuckImports = await client.import.stuckData({ hours: 48 });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
export { P21SismClient } from './client';
|
|
37
|
+
export * from './schemas';
|
|
38
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/p21-sism/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,cAAc,WAAW,CAAC"}
|