@simpleapps-com/augur-api 0.2.7 → 0.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/API-DISCOVERY.md +206 -83
  2. package/QUICKSTART.md +232 -135
  3. package/README.md +368 -97
  4. package/dist/cjs/index.d.ts +3 -1
  5. package/dist/cjs/index.d.ts.map +1 -1
  6. package/dist/cjs/index.js +4 -2
  7. package/dist/cjs/index.js.map +1 -1
  8. package/dist/cjs/services/commerce/client.d.ts +222 -18
  9. package/dist/cjs/services/commerce/client.d.ts.map +1 -1
  10. package/dist/cjs/services/commerce/client.js +156 -17
  11. package/dist/cjs/services/commerce/client.js.map +1 -1
  12. package/dist/cjs/services/p21-sism/client.d.ts +452 -0
  13. package/dist/cjs/services/p21-sism/client.d.ts.map +1 -0
  14. package/dist/cjs/services/p21-sism/client.js +538 -0
  15. package/dist/cjs/services/p21-sism/client.js.map +1 -0
  16. package/dist/cjs/services/p21-sism/index.d.ts +38 -0
  17. package/dist/cjs/services/p21-sism/index.d.ts.map +1 -0
  18. package/dist/cjs/services/p21-sism/index.js +56 -0
  19. package/dist/cjs/services/p21-sism/index.js.map +1 -0
  20. package/dist/cjs/services/p21-sism/schemas/health.d.ts +63 -0
  21. package/dist/cjs/services/p21-sism/schemas/health.d.ts.map +1 -0
  22. package/dist/cjs/services/p21-sism/schemas/health.js +17 -0
  23. package/dist/cjs/services/p21-sism/schemas/health.js.map +1 -0
  24. package/dist/cjs/services/p21-sism/schemas/import.d.ts +289 -0
  25. package/dist/cjs/services/p21-sism/schemas/import.d.ts.map +1 -0
  26. package/dist/cjs/services/p21-sism/schemas/import.js +100 -0
  27. package/dist/cjs/services/p21-sism/schemas/import.js.map +1 -0
  28. package/dist/cjs/services/p21-sism/schemas/index.d.ts +5 -0
  29. package/dist/cjs/services/p21-sism/schemas/index.d.ts.map +1 -0
  30. package/dist/cjs/services/p21-sism/schemas/index.js +25 -0
  31. package/dist/cjs/services/p21-sism/schemas/index.js.map +1 -0
  32. package/dist/cjs/services/p21-sism/schemas/order-entry.d.ts +76 -0
  33. package/dist/cjs/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
  34. package/dist/cjs/services/p21-sism/schemas/order-entry.js +33 -0
  35. package/dist/cjs/services/p21-sism/schemas/order-entry.js.map +1 -0
  36. package/dist/cjs/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
  37. package/dist/cjs/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
  38. package/dist/cjs/services/p21-sism/schemas/scheduled-import.js +23 -0
  39. package/dist/cjs/services/p21-sism/schemas/scheduled-import.js.map +1 -0
  40. package/dist/cjs/services/p21-sism/schemas.d.ts +10 -0
  41. package/dist/cjs/services/p21-sism/schemas.d.ts.map +1 -0
  42. package/dist/cjs/services/p21-sism/schemas.js +26 -0
  43. package/dist/cjs/services/p21-sism/schemas.js.map +1 -0
  44. package/dist/esm/index.d.ts +3 -1
  45. package/dist/esm/index.d.ts.map +1 -1
  46. package/dist/esm/index.js +2 -1
  47. package/dist/esm/index.js.map +1 -1
  48. package/dist/esm/services/commerce/client.d.ts +222 -18
  49. package/dist/esm/services/commerce/client.d.ts.map +1 -1
  50. package/dist/esm/services/commerce/client.js +156 -17
  51. package/dist/esm/services/commerce/client.js.map +1 -1
  52. package/dist/esm/services/p21-sism/client.d.ts +452 -0
  53. package/dist/esm/services/p21-sism/client.d.ts.map +1 -0
  54. package/dist/esm/services/p21-sism/client.js +534 -0
  55. package/dist/esm/services/p21-sism/client.js.map +1 -0
  56. package/dist/esm/services/p21-sism/index.d.ts +38 -0
  57. package/dist/esm/services/p21-sism/index.d.ts.map +1 -0
  58. package/dist/esm/services/p21-sism/index.js +38 -0
  59. package/dist/esm/services/p21-sism/index.js.map +1 -0
  60. package/dist/esm/services/p21-sism/schemas/health.d.ts +63 -0
  61. package/dist/esm/services/p21-sism/schemas/health.d.ts.map +1 -0
  62. package/dist/esm/services/p21-sism/schemas/health.js +14 -0
  63. package/dist/esm/services/p21-sism/schemas/health.js.map +1 -0
  64. package/dist/esm/services/p21-sism/schemas/import.d.ts +289 -0
  65. package/dist/esm/services/p21-sism/schemas/import.d.ts.map +1 -0
  66. package/dist/esm/services/p21-sism/schemas/import.js +97 -0
  67. package/dist/esm/services/p21-sism/schemas/import.js.map +1 -0
  68. package/dist/esm/services/p21-sism/schemas/index.d.ts +5 -0
  69. package/dist/esm/services/p21-sism/schemas/index.d.ts.map +1 -0
  70. package/dist/esm/services/p21-sism/schemas/index.js +9 -0
  71. package/dist/esm/services/p21-sism/schemas/index.js.map +1 -0
  72. package/dist/esm/services/p21-sism/schemas/order-entry.d.ts +76 -0
  73. package/dist/esm/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
  74. package/dist/esm/services/p21-sism/schemas/order-entry.js +30 -0
  75. package/dist/esm/services/p21-sism/schemas/order-entry.js.map +1 -0
  76. package/dist/esm/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
  77. package/dist/esm/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
  78. package/dist/esm/services/p21-sism/schemas/scheduled-import.js +20 -0
  79. package/dist/esm/services/p21-sism/schemas/scheduled-import.js.map +1 -0
  80. package/dist/esm/services/p21-sism/schemas.d.ts +10 -0
  81. package/dist/esm/services/p21-sism/schemas.d.ts.map +1 -0
  82. package/dist/esm/services/p21-sism/schemas.js +10 -0
  83. package/dist/esm/services/p21-sism/schemas.js.map +1 -0
  84. package/dist/types/index.d.ts +3 -1
  85. package/dist/types/index.d.ts.map +1 -1
  86. package/dist/types/services/commerce/client.d.ts +222 -18
  87. package/dist/types/services/commerce/client.d.ts.map +1 -1
  88. package/dist/types/services/p21-sism/client.d.ts +452 -0
  89. package/dist/types/services/p21-sism/client.d.ts.map +1 -0
  90. package/dist/types/services/p21-sism/index.d.ts +38 -0
  91. package/dist/types/services/p21-sism/index.d.ts.map +1 -0
  92. package/dist/types/services/p21-sism/schemas/health.d.ts +63 -0
  93. package/dist/types/services/p21-sism/schemas/health.d.ts.map +1 -0
  94. package/dist/types/services/p21-sism/schemas/import.d.ts +289 -0
  95. package/dist/types/services/p21-sism/schemas/import.d.ts.map +1 -0
  96. package/dist/types/services/p21-sism/schemas/index.d.ts +5 -0
  97. package/dist/types/services/p21-sism/schemas/index.d.ts.map +1 -0
  98. package/dist/types/services/p21-sism/schemas/order-entry.d.ts +76 -0
  99. package/dist/types/services/p21-sism/schemas/order-entry.d.ts.map +1 -0
  100. package/dist/types/services/p21-sism/schemas/scheduled-import.d.ts +54 -0
  101. package/dist/types/services/p21-sism/schemas/scheduled-import.d.ts.map +1 -0
  102. package/dist/types/services/p21-sism/schemas.d.ts +10 -0
  103. package/dist/types/services/p21-sism/schemas.d.ts.map +1 -0
  104. package/package.json +1 -1
@@ -0,0 +1,452 @@
1
+ import { HTTPClient } from '../../core/client';
2
+ import { BaseServiceClient, type BaseResponse } from '../../core/base-client';
3
+ import { type ImportListParams, type ImportRecentParams, type ImportStuckParams, type ImportDetailParams, type OrderEntryHeaderParams, type OrderEntryHeaderSalesrepParams, type OrderEntryHeaderWebParams, type ScheduledImportSftpParams } from './schemas';
4
+ /**
5
+ * P21 SISM (System Integration & Storage Management) API Client
6
+ * @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
7
+ * @fullPath api.p21Sism
8
+ * @service p21-sism
9
+ * @domain system-integration-and-storage-management
10
+ * @discoverable true
11
+ * @searchTerms ["p21-sism", "system integration", "storage management", "data import", "order entry", "scheduled imports", "ERP integration", "import processing", "data synchronization", "batch processing"]
12
+ * @relatedEndpoints ["api.p21Core.company", "api.p21Core.location", "api.orders.orders", "api.items.products", "api.nexus.receiving"]
13
+ * @commonPatterns ["Import data management", "Order entry processing", "Scheduled data synchronization", "System integration workflows", "Batch import operations"]
14
+ * @workflow ["data-import", "system-integration", "order-entry-processing", "scheduled-synchronization", "batch-operations"]
15
+ * @prerequisites ["Valid P21 system access", "ERP authentication", "Import processing permissions", "Company-specific data access"]
16
+ * @nextSteps ["api.orders.orders for order processing", "api.items.products for inventory integration", "api.p21Core for system configuration"]
17
+ * @businessRules ["Import state transitions: initial → hold → delivered", "Import UID required for all operations", "SFTP metadata for scheduled imports", "Order entry header data validation"]
18
+ * @functionalArea "system-integration-and-storage-management"
19
+ * @caching "Cache import lists for 5 minutes, real-time for import status updates, no caching for order entry operations"
20
+ * @performance "Supports pagination for import lists, batch processing for large imports, optimized for ERP transaction volumes"
21
+ * @example
22
+ * ```typescript
23
+ * import { HTTPClient } from '@augur/api-client/core';
24
+ * import { P21SismClient } from '@augur/api-client/services/p21-sism';
25
+ *
26
+ * const client = new P21SismClient(new HTTPClient({ baseURL: 'https://p21-sism.augur-api.com' }));
27
+ *
28
+ * // List recent imports for monitoring
29
+ * const recentImports = await client.import.recent({ hours: 24, limit: 50 });
30
+ * console.log(recentImports.data); // Import[]
31
+ *
32
+ * // Get import details for processing
33
+ * const importDetails = await client.import.get({ importUid: '12345' });
34
+ * console.log(importDetails.data); // Import
35
+ *
36
+ * // Process order entry header data
37
+ * const orderHeader = await client.orderEntry.getHeader({ importUid: '12345' });
38
+ * console.log(orderHeader.data); // Order entry header data
39
+ *
40
+ * // Check for stuck imports
41
+ * const stuckImports = await client.import.stuck({ hours: 48 });
42
+ * console.log(stuckImports.data); // Import[]
43
+ * ```
44
+ */
45
+ export declare class P21SismClient extends BaseServiceClient {
46
+ private readonly _schemaRefs;
47
+ private get schemaRefs();
48
+ /**
49
+ * Create a new P21SismClient instance
50
+ * @param http Configured HTTPClient instance with authentication
51
+ * @param baseUrl Base URL for the P21 SISM API (default: https://p21-sism.augur-api.com)
52
+ */
53
+ constructor(http: HTTPClient, baseUrl?: string);
54
+ /**
55
+ * Import management operations for data processing and system integration
56
+ * @fullPath api.p21Sism.import
57
+ * @service p21-sism
58
+ * @domain data-import-management
59
+ * @discoverable true
60
+ */
61
+ readonly import: {
62
+ /**
63
+ * List imports with filtering capabilities for data management and monitoring
64
+ *
65
+ * @fullPath api.p21Sism.import.list
66
+ * @service p21-sism
67
+ * @domain data-import-management
68
+ * @dataMethod listData - returns only the imports array without metadata
69
+ * @discoverable true
70
+ * @searchTerms ["imports", "data import", "import list", "batch processing", "data synchronization", "import management"]
71
+ * @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.recent", "api.p21Sism.import.stuck"]
72
+ * @commonPatterns ["List all imports", "Filter imports by state", "Search import history", "Monitor import progress"]
73
+ * @workflow ["import-monitoring", "data-management", "system-integration", "batch-processing"]
74
+ * @prerequisites ["Valid authentication", "Import management permissions"]
75
+ * @nextSteps ["api.p21Sism.import.get for details", "api.p21Sism.import.update for modifications"]
76
+ * @businessRules ["Import states: initial, hold, delivered", "Supports pagination and filtering", "Search by reference number or source name"]
77
+ * @functionalArea "data-import-management"
78
+ * @caching "Cache for 5 minutes, invalidate on import state changes"
79
+ * @performance "Indexed by import state and date, supports text search across multiple fields"
80
+ *
81
+ * @param params Optional filtering and pagination parameters
82
+ * @returns Promise<BaseResponse<Import[]>> Complete response with imports array and metadata
83
+ *
84
+ * @example
85
+ * ```typescript
86
+ * // Get all pending imports
87
+ * const response = await client.import.list({ importState: 'initial', limit: 50 });
88
+ * console.log(response.data); // Import[]
89
+ *
90
+ * // Get just the data
91
+ * const imports = await client.import.listData({ importState: 'delivered' });
92
+ *
93
+ * // Search for specific imports
94
+ * const found = await client.import.list({ q: 'order123' });
95
+ * ```
96
+ */
97
+ list: (params?: {
98
+ limit?: number | undefined;
99
+ offset?: number | undefined;
100
+ q?: string | undefined;
101
+ orderBy?: string | undefined;
102
+ importState?: "initial" | "hold" | "delivered" | undefined;
103
+ } | undefined) => Promise<BaseResponse<unknown[]>>;
104
+ /**
105
+ * Get recent imports for monitoring and status tracking
106
+ *
107
+ * @fullPath api.p21Sism.import.recent
108
+ * @service p21-sism
109
+ * @domain data-import-management
110
+ * @dataMethod recentData - returns only the imports array without metadata
111
+ * @discoverable true
112
+ * @searchTerms ["recent imports", "import monitoring", "latest imports", "import status", "recent activity"]
113
+ * @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.stuck", "api.p21Sism.health.check"]
114
+ * @commonPatterns ["Monitor recent import activity", "Check latest import status", "Track import progress"]
115
+ * @workflow ["import-monitoring", "status-tracking", "system-health", "operational-awareness"]
116
+ * @prerequisites ["Valid authentication", "Import monitoring permissions"]
117
+ * @nextSteps ["api.p21Sism.import.get for import details", "api.p21Sism.import.stuck to check for issues"]
118
+ * @businessRules ["Default 48 hours lookback", "Maximum 1000 results", "Ordered by creation date"]
119
+ * @functionalArea "data-import-management"
120
+ * @caching "Cache for 2 minutes, recent data needs freshness"
121
+ * @performance "Optimized query with date range filtering, minimal processing overhead"
122
+ *
123
+ * @param params Optional time range and limit parameters
124
+ * @returns Promise<BaseResponse<Import[]>> Complete response with recent imports
125
+ *
126
+ * @example
127
+ * ```typescript
128
+ * // Get imports from last 24 hours
129
+ * const response = await client.import.recent({ hours: 24, limit: 100 });
130
+ * console.log(response.data); // Import[]
131
+ *
132
+ * // Get just the data
133
+ * const recentImports = await client.import.recentData({ hours: 12 });
134
+ * ```
135
+ */
136
+ recent: (params?: {
137
+ limit?: number | undefined;
138
+ hours?: number | undefined;
139
+ } | undefined) => Promise<BaseResponse<unknown[]>>;
140
+ /**
141
+ * Get stuck imports for troubleshooting and error resolution
142
+ *
143
+ * @fullPath api.p21Sism.import.stuck
144
+ * @service p21-sism
145
+ * @domain data-import-management
146
+ * @dataMethod stuckData - returns only the imports array without metadata
147
+ * @discoverable true
148
+ * @searchTerms ["stuck imports", "failed imports", "import errors", "import troubleshooting", "processing issues"]
149
+ * @relatedEndpoints ["api.p21Sism.import.recent", "api.p21Sism.import.get", "api.p21Sism.import.update"]
150
+ * @commonPatterns ["Troubleshoot import issues", "Find failed imports", "Monitor processing problems"]
151
+ * @workflow ["error-resolution", "import-troubleshooting", "system-maintenance", "issue-identification"]
152
+ * @prerequisites ["Valid authentication", "Import troubleshooting permissions"]
153
+ * @nextSteps ["api.p21Sism.import.get for error details", "api.p21Sism.import.update to retry", "api.p21Sism.import.delete to clean up"]
154
+ * @businessRules ["Default 48 hours lookback for stuck detection", "Maximum 1000 results", "Identifies imports in error states"]
155
+ * @functionalArea "data-import-management"
156
+ * @caching "Cache for 1 minute, error data needs immediate visibility"
157
+ * @performance "Specialized query for error detection, includes diagnostic information"
158
+ *
159
+ * @param params Optional time range and limit parameters
160
+ * @returns Promise<BaseResponse<Import[]>> Complete response with stuck imports for troubleshooting
161
+ *
162
+ * @example
163
+ * ```typescript
164
+ * // Get imports stuck in last 48 hours
165
+ * const response = await client.import.stuck({ hours: 48, limit: 200 });
166
+ * console.log(response.data); // Import[]
167
+ *
168
+ * // Get just the data
169
+ * const stuckImports = await client.import.stuckData({ hours: 72 });
170
+ * ```
171
+ */
172
+ stuck: (params?: {
173
+ limit?: number | undefined;
174
+ hours?: number | undefined;
175
+ } | undefined) => Promise<BaseResponse<unknown[]>>;
176
+ /**
177
+ * Get import details by UID for comprehensive import information
178
+ *
179
+ * @fullPath api.p21Sism.import.get
180
+ * @service p21-sism
181
+ * @domain data-import-management
182
+ * @dataMethod getData - returns only the import object without metadata
183
+ * @discoverable true
184
+ * @searchTerms ["import details", "import info", "import status", "import data", "import processing"]
185
+ * @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.update", "api.p21Sism.orderEntry.getHeader"]
186
+ * @commonPatterns ["Get import status", "View import details", "Check processing results", "Retrieve import data"]
187
+ * @workflow ["import-details", "status-checking", "data-retrieval", "import-analysis"]
188
+ * @prerequisites ["Valid import UID", "Import access permissions"]
189
+ * @nextSteps ["api.p21Sism.import.update for modifications", "api.p21Sism.orderEntry for related data"]
190
+ * @businessRules ["Import UID must exist", "Includes processing results and status", "Shows complete import lifecycle"]
191
+ * @functionalArea "data-import-management"
192
+ * @performance "Direct lookup by UID, includes all related import data"
193
+ *
194
+ * @param params Import UID parameter
195
+ * @returns Promise<BaseResponse<Import>> Complete response with detailed import information
196
+ */
197
+ get: (params: ImportDetailParams) => Promise<BaseResponse<unknown>>;
198
+ /**
199
+ * Update import details and processing status
200
+ *
201
+ * @fullPath api.p21Sism.import.update
202
+ * @service p21-sism
203
+ * @domain data-import-management
204
+ * @dataMethod updateData - returns only the updated import object without metadata
205
+ * @discoverable true
206
+ * @searchTerms ["update import", "modify import", "import processing", "import status change", "import management"]
207
+ * @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.list", "api.p21Sism.import.delete"]
208
+ * @commonPatterns ["Update import status", "Modify import data", "Retry failed import", "Change import state"]
209
+ * @workflow ["import-management", "status-updates", "import-processing", "error-recovery"]
210
+ * @prerequisites ["Valid import UID", "Import modification permissions"]
211
+ * @nextSteps ["api.p21Sism.import.get to verify changes", "api.p21Sism.orderEntry for processing"]
212
+ * @businessRules ["State transitions must be valid", "Updates affect processing workflow", "Audit trail maintained"]
213
+ * @functionalArea "data-import-management"
214
+ * @performance "Immediate update with validation, triggers workflow processing"
215
+ *
216
+ * @param params Import UID parameter
217
+ * @returns Promise<BaseResponse<Import>> Complete response with updated import information
218
+ */
219
+ update: (params: ImportDetailParams) => Promise<BaseResponse<unknown>>;
220
+ /**
221
+ * Clean pending import data for import cleanup and maintenance
222
+ *
223
+ * @fullPath api.p21Sism.import.delete
224
+ * @service p21-sism
225
+ * @domain data-import-management
226
+ * @dataMethod deleteData - returns only the cleanup result without metadata
227
+ * @discoverable true
228
+ * @searchTerms ["delete import", "clean import", "remove import", "import cleanup", "pending import cleanup"]
229
+ * @relatedEndpoints ["api.p21Sism.import.get", "api.p21Sism.import.stuck", "api.p21Sism.import.list"]
230
+ * @commonPatterns ["Clean up failed imports", "Remove stuck imports", "System maintenance", "Import cleanup"]
231
+ * @workflow ["import-cleanup", "system-maintenance", "error-recovery", "data-cleanup"]
232
+ * @prerequisites ["Valid import UID", "Import cleanup permissions", "Import in deletable state"]
233
+ * @nextSteps ["api.p21Sism.import.list to verify removal", "system maintenance workflows"]
234
+ * @businessRules ["Only cleans pending import data", "Does not affect completed imports", "Maintains audit trail"]
235
+ * @functionalArea "data-import-management"
236
+ * @performance "Cleanup operation with validation, affects related pending data"
237
+ *
238
+ * @param params Import UID parameter
239
+ * @returns Promise<BaseResponse<Import>> Complete response with cleanup confirmation
240
+ */
241
+ delete: (params: ImportDetailParams) => Promise<BaseResponse<unknown>>;
242
+ listData: (params?: ImportListParams) => Promise<unknown[]>;
243
+ recentData: (params?: ImportRecentParams) => Promise<unknown[]>;
244
+ stuckData: (params?: ImportStuckParams) => Promise<unknown[]>;
245
+ getData: (params: ImportDetailParams) => Promise<unknown>;
246
+ updateData: (params: ImportDetailParams) => Promise<unknown>;
247
+ deleteData: (params: ImportDetailParams) => Promise<unknown>;
248
+ };
249
+ /**
250
+ * Order entry operations for processing order header and sales representative data
251
+ * @fullPath api.p21Sism.orderEntry
252
+ * @service p21-sism
253
+ * @domain order-entry-processing
254
+ * @discoverable true
255
+ */
256
+ readonly orderEntry: {
257
+ /**
258
+ * Get order entry header details from imp_oe_hdr table
259
+ *
260
+ * @fullPath api.p21Sism.orderEntry.getHeader
261
+ * @service p21-sism
262
+ * @domain order-entry-processing
263
+ * @dataMethod getHeaderData - returns only the header data without metadata
264
+ * @discoverable true
265
+ * @searchTerms ["order entry header", "oe header", "order header", "import order header", "order processing"]
266
+ * @relatedEndpoints ["api.p21Sism.orderEntry.updateHeader", "api.p21Sism.orderEntry.getSalesrep", "api.p21Sism.import.get"]
267
+ * @commonPatterns ["Get order header data", "Process order entry", "Order import processing", "Header data retrieval"]
268
+ * @workflow ["order-entry-processing", "order-import", "header-processing", "order-management"]
269
+ * @prerequisites ["Valid import UID", "Order entry access permissions", "Import must contain order data"]
270
+ * @nextSteps ["api.p21Sism.orderEntry.updateHeader for modifications", "api.orders.orders for order processing"]
271
+ * @businessRules ["Import UID must reference valid order entry import", "Header data structure varies by import type", "Processing state affects data availability"]
272
+ * @functionalArea "order-entry-processing"
273
+ * @performance "Direct table access, optimized for order processing workflows"
274
+ *
275
+ * @param params Import UID parameter
276
+ * @returns Promise<BaseResponse<unknown>> Complete response with order entry header data
277
+ */
278
+ getHeader: (params: OrderEntryHeaderParams) => Promise<BaseResponse<unknown>>;
279
+ /**
280
+ * Update order entry header data in imp_oe_hdr table
281
+ *
282
+ * @fullPath api.p21Sism.orderEntry.updateHeader
283
+ * @service p21-sism
284
+ * @domain order-entry-processing
285
+ * @dataMethod updateHeaderData - returns only the updated header data without metadata
286
+ * @discoverable true
287
+ * @searchTerms ["update order header", "modify order entry", "order header update", "oe header update"]
288
+ * @relatedEndpoints ["api.p21Sism.orderEntry.getHeader", "api.p21Sism.orderEntry.updateSalesrep", "api.p21Sism.import.update"]
289
+ * @commonPatterns ["Update order header", "Modify order entry data", "Process order changes", "Header data updates"]
290
+ * @workflow ["order-processing", "order-modifications", "header-updates", "order-management"]
291
+ * @prerequisites ["Valid import UID", "Order modification permissions", "Order in editable state"]
292
+ * @nextSteps ["api.p21Sism.orderEntry.getHeader to verify changes", "api.orders.orders for order processing"]
293
+ * @businessRules ["Validation rules apply to header updates", "State transitions must be valid", "Updates affect order processing workflow"]
294
+ * @functionalArea "order-entry-processing"
295
+ * @performance "Direct table updates with validation, triggers order processing workflows"
296
+ *
297
+ * @param params Import UID parameter
298
+ * @returns Promise<BaseResponse<unknown>> Complete response with updated order entry header data
299
+ */
300
+ updateHeader: (params: OrderEntryHeaderParams) => Promise<BaseResponse<unknown>>;
301
+ /**
302
+ * Get order entry sales representative details from imp_oe_hdr_salesrep table
303
+ *
304
+ * @fullPath api.p21Sism.orderEntry.getSalesrep
305
+ * @service p21-sism
306
+ * @domain order-entry-processing
307
+ * @dataMethod getSalesrepData - returns only the salesrep data without metadata
308
+ * @discoverable true
309
+ * @searchTerms ["order salesrep", "sales representative", "oe salesrep", "order sales rep", "salesrep data"]
310
+ * @relatedEndpoints ["api.p21Sism.orderEntry.updateSalesrep", "api.p21Sism.orderEntry.getHeader", "api.orders.orders.salesrep"]
311
+ * @commonPatterns ["Get sales rep info", "Process salesrep data", "Order sales rep processing", "Commission processing"]
312
+ * @workflow ["salesrep-processing", "commission-calculation", "order-attribution", "sales-management"]
313
+ * @prerequisites ["Valid import UID", "Sales rep access permissions", "Import must contain salesrep data"]
314
+ * @nextSteps ["api.p21Sism.orderEntry.updateSalesrep for modifications", "api.orders.orders for commission processing"]
315
+ * @businessRules ["Sales rep assignments affect commission calculation", "Multiple sales reps per order supported", "Territory validation applies"]
316
+ * @functionalArea "order-entry-processing"
317
+ * @performance "Optimized for sales rep lookup and commission calculations"
318
+ *
319
+ * @param params Import UID parameter
320
+ * @returns Promise<BaseResponse<unknown>> Complete response with sales representative data
321
+ */
322
+ getSalesrep: (params: OrderEntryHeaderSalesrepParams) => Promise<BaseResponse<unknown>>;
323
+ /**
324
+ * Update order entry sales representative data in imp_oe_hdr_salesrep table
325
+ *
326
+ * @fullPath api.p21Sism.orderEntry.updateSalesrep
327
+ * @service p21-sism
328
+ * @domain order-entry-processing
329
+ * @dataMethod updateSalesrepData - returns only the updated salesrep data without metadata
330
+ * @discoverable true
331
+ * @searchTerms ["update salesrep", "modify sales rep", "salesrep update", "commission update", "sales rep assignment"]
332
+ * @relatedEndpoints ["api.p21Sism.orderEntry.getSalesrep", "api.p21Sism.orderEntry.updateHeader", "api.orders.orders.updateSalesrep"]
333
+ * @commonPatterns ["Update sales rep assignment", "Modify commission data", "Change order attribution", "Sales rep management"]
334
+ * @workflow ["salesrep-management", "commission-updates", "order-attribution", "territory-management"]
335
+ * @prerequisites ["Valid import UID", "Sales rep modification permissions", "Valid sales rep codes"]
336
+ * @nextSteps ["api.p21Sism.orderEntry.getSalesrep to verify changes", "api.orders.orders for commission processing"]
337
+ * @businessRules ["Sales rep validation required", "Commission recalculation triggered", "Territory assignments must be valid"]
338
+ * @functionalArea "order-entry-processing"
339
+ * @performance "Updates with validation, triggers commission recalculation workflows"
340
+ *
341
+ * @param params Import UID parameter
342
+ * @returns Promise<BaseResponse<unknown>> Complete response with updated sales representative data
343
+ */
344
+ updateSalesrep: (params: OrderEntryHeaderSalesrepParams) => Promise<BaseResponse<unknown>>;
345
+ /**
346
+ * Get order entry web header details from imp_oe_hdr_web table
347
+ *
348
+ * @fullPath api.p21Sism.orderEntry.getWebHeader
349
+ * @service p21-sism
350
+ * @domain order-entry-processing
351
+ * @dataMethod getWebHeaderData - returns only the web header data without metadata
352
+ * @discoverable true
353
+ * @searchTerms ["web order header", "oe web header", "web order data", "online order header", "e-commerce order"]
354
+ * @relatedEndpoints ["api.p21Sism.orderEntry.getHeader", "api.p21Sism.orderEntry.getSalesrep", "api.commerce.cartHeaders"]
355
+ * @commonPatterns ["Get web order data", "Process online orders", "Web order integration", "E-commerce order processing"]
356
+ * @workflow ["web-order-processing", "e-commerce-integration", "online-order-management", "web-integration"]
357
+ * @prerequisites ["Valid import UID", "Web order access permissions", "Import must contain web order data"]
358
+ * @nextSteps ["api.p21Sism.orderEntry.getHeader for complete order data", "api.commerce.cartHeaders for e-commerce processing"]
359
+ * @businessRules ["Web-specific order attributes included", "Integration with e-commerce systems", "Web order validation rules apply"]
360
+ * @functionalArea "order-entry-processing"
361
+ * @performance "Optimized for web order processing and e-commerce integration"
362
+ *
363
+ * @param params Import UID parameter
364
+ * @returns Promise<BaseResponse<unknown>> Complete response with web order header data
365
+ */
366
+ getWebHeader: (params: OrderEntryHeaderWebParams) => Promise<BaseResponse<unknown>>;
367
+ getHeaderData: (params: OrderEntryHeaderParams) => Promise<unknown>;
368
+ updateHeaderData: (params: OrderEntryHeaderParams) => Promise<unknown>;
369
+ getSalesrepData: (params: OrderEntryHeaderSalesrepParams) => Promise<unknown>;
370
+ updateSalesrepData: (params: OrderEntryHeaderSalesrepParams) => Promise<unknown>;
371
+ getWebHeaderData: (params: OrderEntryHeaderWebParams) => Promise<unknown>;
372
+ };
373
+ /**
374
+ * Scheduled import operations for SFTP metadata management and automated import processing
375
+ * @fullPath api.p21Sism.scheduledImport
376
+ * @service p21-sism
377
+ * @domain scheduled-import-management
378
+ * @discoverable true
379
+ */
380
+ readonly scheduledImport: {
381
+ /**
382
+ * Create SFTP metadata for a scheduled import master configuration
383
+ *
384
+ * @fullPath api.p21Sism.scheduledImport.createSftpMetadata
385
+ * @service p21-sism
386
+ * @domain scheduled-import-management
387
+ * @dataMethod createSftpMetadataData - returns only the SFTP metadata without response wrapper
388
+ * @discoverable true
389
+ * @searchTerms ["SFTP metadata", "scheduled import", "import master", "SFTP configuration", "automated import", "file transfer"]
390
+ * @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.recent", "api.p21Core.company"]
391
+ * @commonPatterns ["Configure SFTP import", "Setup automated data transfer", "Scheduled import configuration", "File transfer setup"]
392
+ * @workflow ["sftp-configuration", "scheduled-imports", "automated-processing", "file-transfer-setup"]
393
+ * @prerequisites ["Valid scheduled import master UID", "SFTP configuration permissions", "Scheduled import master exists"]
394
+ * @nextSteps ["api.p21Sism.import.recent to monitor scheduled imports", "SFTP file monitoring systems"]
395
+ * @businessRules ["SFTP metadata defines transfer parameters", "Scheduled import master must be configured", "File transfer validation rules apply"]
396
+ * @functionalArea "scheduled-import-management"
397
+ * @performance "Configuration operation, minimal processing overhead"
398
+ *
399
+ * @param params Scheduled import master UID parameter
400
+ * @returns Promise<BaseResponse<unknown>> Complete response with SFTP metadata configuration
401
+ */
402
+ createSftpMetadata: (params: ScheduledImportSftpParams) => Promise<BaseResponse<unknown>>;
403
+ createSftpMetadataData: (params: ScheduledImportSftpParams) => Promise<unknown>;
404
+ };
405
+ /**
406
+ * Health check operations for service monitoring and system status verification
407
+ * @fullPath api.p21Sism.health
408
+ * @service p21-sism
409
+ * @domain system-monitoring
410
+ * @discoverable true
411
+ */
412
+ readonly health: {
413
+ /**
414
+ * Perform health check to verify P21 SISM service status and connectivity
415
+ *
416
+ * @fullPath api.p21Sism.health.check
417
+ * @service p21-sism
418
+ * @domain system-monitoring
419
+ * @dataMethod checkData - returns only the health status without metadata
420
+ * @discoverable true
421
+ * @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test", "SISM health"]
422
+ * @relatedEndpoints ["api.p21Core.health.check", "api.p21Sism.import.recent", "system monitoring endpoints"]
423
+ * @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
424
+ * @workflow ["system-monitoring", "health-verification", "service-diagnostics", "integration-testing"]
425
+ * @prerequisites ["System access", "Monitoring permissions"]
426
+ * @nextSteps ["Service remediation if unhealthy", "Integration health checks", "api.p21Sism.import.stuck for processing issues"]
427
+ * @businessRules ["Returns site configuration", "Includes system hash for verification", "No authentication required for health check"]
428
+ * @functionalArea "system-monitoring"
429
+ * @performance "Lightweight check, immediate response, minimal system impact"
430
+ *
431
+ * @returns Promise<BaseResponse<HealthCheckResponse>> Service health status and configuration
432
+ */
433
+ check: () => Promise<{
434
+ params: Record<string, unknown> | unknown[];
435
+ data: {
436
+ siteHash: string;
437
+ siteId: string;
438
+ };
439
+ options: Record<string, unknown> | unknown[];
440
+ status: number;
441
+ message: string;
442
+ count: number;
443
+ total: number;
444
+ totalResults: number;
445
+ }>;
446
+ checkData: () => Promise<{
447
+ siteHash: string;
448
+ siteId: string;
449
+ }>;
450
+ };
451
+ }
452
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/p21-sism/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAU9E,OAAO,EAWL,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,8BAA8B,EACnC,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC/B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAElD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAEjB;IAGX,OAAO,KAAK,UAAU,GAErB;IAED;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAyC;IAMhF;;;;;;OAMG;IACH,SAAgB,MAAM;QACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;;;;QAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;;;;QAOH;;;;;;;;;;;;;;;;;;;;WAoBG;sBACiB,kBAAkB;QAYtC;;;;;;;;;;;;;;;;;;;;WAoBG;yBACoB,kBAAkB;QAYzC;;;;;;;;;;;;;;;;;;;;WAoBG;yBACoB,kBAAkB;4BAaf,gBAAgB;8BAKd,kBAAkB;6BAKnB,iBAAiB;0BAKpB,kBAAkB;6BAKf,kBAAkB;6BAKlB,kBAAkB;MAI7C;IAEF;;;;;;OAMG;IACH,SAAgB,UAAU;QACxB;;;;;;;;;;;;;;;;;;;;WAoBG;4BACuB,sBAAsB;QAYhD;;;;;;;;;;;;;;;;;;;;WAoBG;+BAC0B,sBAAsB;QAYnD;;;;;;;;;;;;;;;;;;;;WAoBG;8BACyB,8BAA8B;QAY1D;;;;;;;;;;;;;;;;;;;;WAoBG;iCAC4B,8BAA8B;QAY7D;;;;;;;;;;;;;;;;;;;;WAoBG;+BAC0B,yBAAyB;gCAaxB,sBAAsB;mCAKnB,sBAAsB;kCAKvB,8BAA8B;qCAK3B,8BAA8B;mCAKhC,yBAAyB;MAI1D;IAEF;;;;;;OAMG;IACH,SAAgB,eAAe;QAC7B;;;;;;;;;;;;;;;;;;;;WAoBG;qCACgC,yBAAyB;yCAarB,yBAAyB;MAIhE;IAEF;;;;;;OAMG;IACH,SAAgB,MAAM;QACpB;;;;;;;;;;;;;;;;;;;WAmBG;;;;;;;;;;;;;;;;;;MAcH;CACH"}