@simpleapps-com/augur-api 0.1.7 → 0.1.8
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/dist/cjs/core/base-client.d.ts +42 -0
- package/dist/cjs/core/base-client.d.ts.map +1 -1
- package/dist/cjs/core/base-client.js +102 -36
- package/dist/cjs/core/base-client.js.map +1 -1
- package/dist/cjs/core/errors.d.ts +21 -0
- package/dist/cjs/core/errors.d.ts.map +1 -1
- package/dist/cjs/core/errors.js +41 -0
- package/dist/cjs/core/errors.js.map +1 -1
- package/dist/cjs/services/customers/client.d.ts +40 -13
- package/dist/cjs/services/customers/client.d.ts.map +1 -1
- package/dist/cjs/services/customers/client.js +40 -13
- package/dist/cjs/services/customers/client.js.map +1 -1
- package/dist/esm/core/base-client.d.ts +42 -0
- package/dist/esm/core/base-client.d.ts.map +1 -1
- package/dist/esm/core/base-client.js +102 -36
- package/dist/esm/core/base-client.js.map +1 -1
- package/dist/esm/core/errors.d.ts +21 -0
- package/dist/esm/core/errors.d.ts.map +1 -1
- package/dist/esm/core/errors.js +41 -0
- package/dist/esm/core/errors.js.map +1 -1
- package/dist/esm/services/customers/client.d.ts +40 -13
- package/dist/esm/services/customers/client.d.ts.map +1 -1
- package/dist/esm/services/customers/client.js +40 -13
- package/dist/esm/services/customers/client.js.map +1 -1
- package/dist/types/core/base-client.d.ts +42 -0
- package/dist/types/core/base-client.d.ts.map +1 -1
- package/dist/types/core/errors.d.ts +21 -0
- package/dist/types/core/errors.d.ts.map +1 -1
- package/dist/types/services/customers/client.d.ts +40 -13
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -136,6 +136,18 @@ export declare abstract class BaseServiceClient {
|
|
|
136
136
|
* @throws AugurError For HTTP errors (handled by HTTPClient interceptors)
|
|
137
137
|
*/
|
|
138
138
|
protected executeRequest<TParams = unknown, TResponse = unknown>(config: EndpointConfig<TParams, TResponse>, params?: TParams, pathParams?: Record<string, string | number>): Promise<TResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Validate request parameters using the provided schema
|
|
141
|
+
*/
|
|
142
|
+
private validateParameters;
|
|
143
|
+
/**
|
|
144
|
+
* Execute HTTP request based on the configured method
|
|
145
|
+
*/
|
|
146
|
+
private executeHttpRequest;
|
|
147
|
+
/**
|
|
148
|
+
* Create a detailed validation error with context information
|
|
149
|
+
*/
|
|
150
|
+
private createValidationError;
|
|
139
151
|
/**
|
|
140
152
|
* Create a standardized list method factory
|
|
141
153
|
*
|
|
@@ -288,5 +300,35 @@ export declare abstract class BaseServiceClient {
|
|
|
288
300
|
* ```
|
|
289
301
|
*/
|
|
290
302
|
private buildEndpointPath;
|
|
303
|
+
/**
|
|
304
|
+
* Create a debugging helper for troubleshooting validation errors
|
|
305
|
+
*
|
|
306
|
+
* @param config Endpoint configuration
|
|
307
|
+
* @param params Parameters being validated
|
|
308
|
+
* @returns Debug information object
|
|
309
|
+
*/
|
|
310
|
+
protected createDebugInfo<TParams>(config: EndpointConfig<TParams>, params?: TParams): {
|
|
311
|
+
endpoint: string;
|
|
312
|
+
method: string;
|
|
313
|
+
hasParamSchema: boolean;
|
|
314
|
+
providedParams: TParams | undefined;
|
|
315
|
+
expectedSchema?: string;
|
|
316
|
+
};
|
|
317
|
+
/**
|
|
318
|
+
* Validate parameters and provide detailed error information for debugging
|
|
319
|
+
*
|
|
320
|
+
* @param schema Zod schema to validate against
|
|
321
|
+
* @param params Parameters to validate
|
|
322
|
+
* @param context Context information for error messages
|
|
323
|
+
* @returns Validation result with detailed error information
|
|
324
|
+
*/
|
|
325
|
+
protected validateWithDebugInfo<T>(schema: z.ZodSchema<T>, params: unknown, context: string): {
|
|
326
|
+
success: true;
|
|
327
|
+
data: T;
|
|
328
|
+
} | {
|
|
329
|
+
success: false;
|
|
330
|
+
errors: string[];
|
|
331
|
+
rawErrors: z.ZodError;
|
|
332
|
+
};
|
|
291
333
|
}
|
|
292
334
|
//# sourceMappingURL=base-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../../src/core/base-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO;IACpE,kCAAkC;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpC,8CAA8C;IAC9C,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACvC,oEAAoE;IACpE,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,0BAA0B;IAC1B,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY,EAAE,WAAW;CAAG;AAEvE;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,IAAI,EAAE,CAAC,CAAC;IACR,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,8BAAsB,iBAAiB;IACrC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;gBACS,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM;IAMlE;;;;;;;;;;;;;;;OAeG;cACa,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACnE,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,EAC1C,MAAM,CAAC,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../../src/core/base-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO;IACpE,kCAAkC;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpC,8CAA8C;IAC9C,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACvC,oEAAoE;IACpE,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,0BAA0B;IAC1B,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY,EAAE,WAAW;CAAG;AAEvE;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,IAAI,EAAE,CAAC,CAAC;IACR,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,8BAAsB,iBAAiB;IACrC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;gBACS,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM;IAMlE;;;;;;;;;;;;;;;OAeG;cACa,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACnE,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,EAC1C,MAAM,CAAC,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,SAAS,CAAC;IAgBrB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;YACW,kBAAkB;IAqBhC;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAiC7B;;;;;;;;;;OAUG;IACH,SAAS,CAAC,gBAAgB,CACxB,OAAO,SAAS,iBAAiB,GAAG,iBAAiB,EACrD,KAAK,GAAG,OAAO,EACf,SAAS,SAAS,gBAAgB,CAAC,KAAK,EAAE,CAAC,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC,EACvE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAC9E,SAAS,OAAO,KAAG,OAAO,CAAC,SAAS,CAAC;IAarD;;;;;;;;;OASG;IACH,SAAS,CAAC,eAAe,CACvB,OAAO,SAAS,WAAW,GAAG,WAAW,EACzC,KAAK,GAAG,OAAO,EACf,SAAS,SAAS,gBAAgB,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAEnE,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,EACtC,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAErB,IAAI,MAAM,GAAG,MAAM,EAAE,SAAS,OAAO,KAAG,OAAO,CAAC,SAAS,CAAC;IAc1E;;;;;;;;;OASG;IACH,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,EAC9C,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,EACpC,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAExB,MAAM,QAAQ,KAAG,OAAO,CAAC,SAAS,CAAC;IAanD;;;;;;;;;OASG;IACH,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,EAC9C,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,EACpC,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAExB,IAAI,MAAM,GAAG,MAAM,EAAE,MAAM,QAAQ,KAAG,OAAO,CAAC,SAAS,CAAC;IAcxE;;;;;;;;OAQG;IACH,SAAS,CAAC,kBAAkB,CAAC,SAAS,EACpC,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAExB,IAAI,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,SAAS,CAAC;IAaxD;;;;;OAKG;IACH,SAAS,CAAC,uBAAuB,CAAC,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,SAChE,OAAO,CAAC,SAAS,CAAC;IAWrC;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB,CAAC,gBAAgB,EAAE,MAAM,IAC5C,IAAI,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IActD;;;;;;;;;OASG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,SAAS,YAAY,EAAE,SAAS,EAClE,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAClC,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAExB,QAAQ,OAAO,KAAG,OAAO,CAAC,SAAS,CAAC;IA2BpD;;;;;;;;;OASG;IACH,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,KAAK,EAC7C,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAClC,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAEhB,QAAQ,OAAO,KAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAc5D;;;;;;;;;;OAUG;IACH,SAAS,CAAC,kBAAkB,CAAC,SAAS,EACpC,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,MAAM,GAAG,KAAK,EACtB,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,EACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAErB,IAAI,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,SAAS,CAAC;IAaxD;;;;;;;;OAQG;IACH,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,IACvD,KAAK,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAapD;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAIjC;;;;;;;;;OASG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,EAC1C,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,EACtC,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAErB,IAAI,MAAM,GAAG,MAAM,EAAE,SAAS,OAAO,KAAG,OAAO,CAAC,SAAS,CAAC;IAc1E;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,SACzD,OAAO,CAAC,SAAS,CAAC;IAUrC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,iBAAiB;IAgBzB;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAC/B,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,EAC/B,MAAM,CAAC,EAAE,OAAO,GACf;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,OAAO,CAAC;QACxB,cAAc,EAAE,OAAO,GAAG,SAAS,CAAC;QACpC,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAUD;;;;;;;OAOG;IACH,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAC/B,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACtB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,MAAM,GACd;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,CAAC,CAAA;KAAE,GAAG;QAAE,OAAO,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAA;KAAE;CAoB5F"}
|
|
@@ -69,51 +69,73 @@ class BaseServiceClient {
|
|
|
69
69
|
async executeRequest(config, params, pathParams) {
|
|
70
70
|
const endpoint = this.buildEndpointPath(config.path, pathParams);
|
|
71
71
|
try {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
if (config.paramsSchema) {
|
|
75
|
-
// Always validate when schema is provided, treating undefined as empty object
|
|
76
|
-
validatedParams = config.paramsSchema.parse(params ?? {});
|
|
77
|
-
}
|
|
78
|
-
else {
|
|
79
|
-
validatedParams = params;
|
|
80
|
-
}
|
|
81
|
-
// Execute HTTP request based on method
|
|
82
|
-
let response;
|
|
83
|
-
switch (config.method) {
|
|
84
|
-
case 'GET':
|
|
85
|
-
response = await this.http.get(`${this.baseUrl}${endpoint}`, validatedParams);
|
|
86
|
-
break;
|
|
87
|
-
case 'POST':
|
|
88
|
-
response = await this.http.post(`${this.baseUrl}${endpoint}`, validatedParams);
|
|
89
|
-
break;
|
|
90
|
-
case 'PUT':
|
|
91
|
-
response = await this.http.put(`${this.baseUrl}${endpoint}`, validatedParams);
|
|
92
|
-
break;
|
|
93
|
-
case 'DELETE':
|
|
94
|
-
response = await this.http.delete(`${this.baseUrl}${endpoint}`);
|
|
95
|
-
break;
|
|
96
|
-
default:
|
|
97
|
-
throw new Error(`Unsupported HTTP method: ${config.method}`);
|
|
98
|
-
}
|
|
99
|
-
// Validate response structure and return exactly as received
|
|
72
|
+
const validatedParams = this.validateParameters(config, params);
|
|
73
|
+
const response = await this.executeHttpRequest(config, endpoint, validatedParams);
|
|
100
74
|
const validatedResponse = config.responseSchema.parse(response);
|
|
101
|
-
// Return the complete response without transformation
|
|
102
|
-
// The client should return data exactly as received from the API
|
|
103
75
|
return validatedResponse;
|
|
104
76
|
}
|
|
105
77
|
catch (error) {
|
|
106
78
|
if (error instanceof zod_1.z.ZodError) {
|
|
107
|
-
throw
|
|
108
|
-
message: 'Invalid parameters or response',
|
|
109
|
-
service: this.serviceName,
|
|
110
|
-
endpoint,
|
|
111
|
-
validationErrors: error.errors,
|
|
112
|
-
});
|
|
79
|
+
throw this.createValidationError(error, config, params, endpoint);
|
|
113
80
|
}
|
|
114
81
|
throw error;
|
|
115
82
|
}
|
|
116
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Validate request parameters using the provided schema
|
|
86
|
+
*/
|
|
87
|
+
validateParameters(config, params) {
|
|
88
|
+
if (config.paramsSchema) {
|
|
89
|
+
// Always validate when schema is provided, treating undefined as empty object
|
|
90
|
+
return config.paramsSchema.parse(params ?? {});
|
|
91
|
+
}
|
|
92
|
+
return params;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Execute HTTP request based on the configured method
|
|
96
|
+
*/
|
|
97
|
+
async executeHttpRequest(config, endpoint, validatedParams) {
|
|
98
|
+
const url = `${this.baseUrl}${endpoint}`;
|
|
99
|
+
switch (config.method) {
|
|
100
|
+
case 'GET':
|
|
101
|
+
return await this.http.get(url, validatedParams);
|
|
102
|
+
case 'POST':
|
|
103
|
+
return await this.http.post(url, validatedParams);
|
|
104
|
+
case 'PUT':
|
|
105
|
+
return await this.http.put(url, validatedParams);
|
|
106
|
+
case 'DELETE':
|
|
107
|
+
return await this.http.delete(url);
|
|
108
|
+
default:
|
|
109
|
+
throw new Error(`Unsupported HTTP method: ${config.method}`);
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Create a detailed validation error with context information
|
|
114
|
+
*/
|
|
115
|
+
createValidationError(zodError, config, params, endpoint) {
|
|
116
|
+
const hasParamSchema = !!config.paramsSchema;
|
|
117
|
+
let message = 'Invalid parameters or response';
|
|
118
|
+
let contextInfo = '';
|
|
119
|
+
if (hasParamSchema && params !== undefined) {
|
|
120
|
+
message = 'Invalid request parameters';
|
|
121
|
+
contextInfo = `\nProvided parameters: ${JSON.stringify(params, null, 2)}`;
|
|
122
|
+
}
|
|
123
|
+
else if (!hasParamSchema) {
|
|
124
|
+
message = 'Invalid API response structure';
|
|
125
|
+
contextInfo =
|
|
126
|
+
'\nThis appears to be a response validation error. The API returned data in an unexpected format.';
|
|
127
|
+
}
|
|
128
|
+
const validationError = new errors_1.ValidationError({
|
|
129
|
+
message,
|
|
130
|
+
service: this.serviceName,
|
|
131
|
+
endpoint,
|
|
132
|
+
validationErrors: zodError.errors,
|
|
133
|
+
});
|
|
134
|
+
if (contextInfo) {
|
|
135
|
+
validationError.message += contextInfo;
|
|
136
|
+
}
|
|
137
|
+
return validationError;
|
|
138
|
+
}
|
|
117
139
|
/**
|
|
118
140
|
* Create a standardized list method factory
|
|
119
141
|
*
|
|
@@ -407,6 +429,50 @@ class BaseServiceClient {
|
|
|
407
429
|
}
|
|
408
430
|
return path;
|
|
409
431
|
}
|
|
432
|
+
/**
|
|
433
|
+
* Create a debugging helper for troubleshooting validation errors
|
|
434
|
+
*
|
|
435
|
+
* @param config Endpoint configuration
|
|
436
|
+
* @param params Parameters being validated
|
|
437
|
+
* @returns Debug information object
|
|
438
|
+
*/
|
|
439
|
+
createDebugInfo(config, params) {
|
|
440
|
+
return {
|
|
441
|
+
endpoint: config.path,
|
|
442
|
+
method: config.method,
|
|
443
|
+
hasParamSchema: !!config.paramsSchema,
|
|
444
|
+
providedParams: params,
|
|
445
|
+
expectedSchema: config.paramsSchema?.description || 'No schema description available',
|
|
446
|
+
};
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* Validate parameters and provide detailed error information for debugging
|
|
450
|
+
*
|
|
451
|
+
* @param schema Zod schema to validate against
|
|
452
|
+
* @param params Parameters to validate
|
|
453
|
+
* @param context Context information for error messages
|
|
454
|
+
* @returns Validation result with detailed error information
|
|
455
|
+
*/
|
|
456
|
+
validateWithDebugInfo(schema, params, context) {
|
|
457
|
+
try {
|
|
458
|
+
const data = schema.parse(params);
|
|
459
|
+
return { success: true, data };
|
|
460
|
+
}
|
|
461
|
+
catch (error) {
|
|
462
|
+
if (error instanceof zod_1.z.ZodError) {
|
|
463
|
+
const formattedErrors = error.errors.map(err => {
|
|
464
|
+
const path = err.path.length > 0 ? err.path.join('.') : 'root';
|
|
465
|
+
return `${context} - ${path}: ${err.message}`;
|
|
466
|
+
});
|
|
467
|
+
return {
|
|
468
|
+
success: false,
|
|
469
|
+
errors: formattedErrors,
|
|
470
|
+
rawErrors: error,
|
|
471
|
+
};
|
|
472
|
+
}
|
|
473
|
+
throw error;
|
|
474
|
+
}
|
|
475
|
+
}
|
|
410
476
|
}
|
|
411
477
|
exports.BaseServiceClient = BaseServiceClient;
|
|
412
478
|
//# sourceMappingURL=base-client.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-client.js","sourceRoot":"","sources":["../../../src/core/base-client.ts"],"names":[],"mappings":";;;AACA,qCAA2C;AAC3C,uCAA+C;AAC/C,6BAAwB;AAmFxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAsB,iBAAiB;IAKrC;;;;;OAKG;IACH,YAAY,WAAmB,EAAE,IAAgB,EAAE,OAAe;QAChE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACO,KAAK,CAAC,cAAc,CAC5B,MAA0C,EAC1C,MAAgB,EAChB,UAA4C;QAE5C,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC;YACH,
|
|
1
|
+
{"version":3,"file":"base-client.js","sourceRoot":"","sources":["../../../src/core/base-client.ts"],"names":[],"mappings":";;;AACA,qCAA2C;AAC3C,uCAA+C;AAC/C,6BAAwB;AAmFxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAsB,iBAAiB;IAKrC;;;;;OAKG;IACH,YAAY,WAAmB,EAAE,IAAgB,EAAE,OAAe;QAChE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACO,KAAK,CAAC,cAAc,CAC5B,MAA0C,EAC1C,MAAgB,EAChB,UAA4C;QAE5C,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAChE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;YAClF,MAAM,iBAAiB,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAChE,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YACpE,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACK,kBAAkB,CACxB,MAA+B,EAC/B,MAAgB;QAEhB,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,8EAA8E;YAC9E,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,kBAAkB,CAC9B,MAA+B,EAC/B,QAAgB,EAChB,eAAyB;QAEzB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;QAEzC,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,KAAK,KAAK;gBACR,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YACnD,KAAK,MAAM;gBACT,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YACpD,KAAK,KAAK;gBACR,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YACnD,KAAK,QAAQ;gBACX,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrC;gBACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED;;OAEG;IACK,qBAAqB,CAC3B,QAAoB,EACpB,MAA+B,EAC/B,MAA2B,EAC3B,QAAgB;QAEhB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QAC7C,IAAI,OAAO,GAAG,gCAAgC,CAAC;QAC/C,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,IAAI,cAAc,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAC3C,OAAO,GAAG,4BAA4B,CAAC;YACvC,WAAW,GAAG,0BAA0B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAC5E,CAAC;aAAM,IAAI,CAAC,cAAc,EAAE,CAAC;YAC3B,OAAO,GAAG,gCAAgC,CAAC;YAC3C,WAAW;gBACT,kGAAkG,CAAC;QACvG,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,wBAAe,CAAC;YAC1C,OAAO;YACP,OAAO,EAAE,IAAI,CAAC,WAAW;YACzB,QAAQ;YACR,gBAAgB,EAAE,QAAQ,CAAC,MAAM;SAClC,CAAC,CAAC;QAEH,IAAI,WAAW,EAAE,CAAC;YAChB,eAAe,CAAC,OAAO,IAAI,WAAW,CAAC;QACzC,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACO,gBAAgB,CAIxB,QAAgB,EAAE,YAAkC,EAAE,cAAsC;QAC5F,OAAO,KAAK,EAAE,MAAgB,EAAsB,EAAE;YACpD,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,QAAQ;gBACd,YAAY;gBACZ,cAAc;aACf,EACD,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,eAAe,CAKvB,gBAAwB,EACxB,cAAsC,EACtC,YAAmC;QAEnC,OAAO,KAAK,EAAE,EAAmB,EAAE,MAAgB,EAAsB,EAAE;YACzE,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB;gBACtB,YAAY;gBACZ,cAAc;aACf,EACD,MAAM,EACN,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,kBAAkB,CAC1B,QAAgB,EAChB,aAAoC,EACpC,cAAsC;QAEtC,OAAO,KAAK,EAAE,IAAc,EAAsB,EAAE;YAClD,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,QAAQ;gBACd,YAAY,EAAE,aAAa;gBAC3B,cAAc;aACf,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,kBAAkB,CAC1B,gBAAwB,EACxB,aAAoC,EACpC,cAAsC;QAEtC,OAAO,KAAK,EAAE,EAAmB,EAAE,IAAc,EAAsB,EAAE;YACvE,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB;gBACtB,YAAY,EAAE,aAAa;gBAC3B,cAAc;aACf,EACD,IAAI,EACJ,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,kBAAkB,CAC1B,gBAAwB,EACxB,cAAsC;QAEtC,OAAO,KAAK,EAAE,EAAmB,EAAsB,EAAE;YACvD,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,gBAAgB;gBACtB,cAAc;aACf,EACD,SAAS,EACT,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACO,uBAAuB,CAAY,cAAsC;QACjF,OAAO,KAAK,IAAwB,EAAE;YACpC,gDAAgD;YAChD,OAAO,IAAI,CAAC,cAAc,CAAC;gBACzB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,eAAe;gBACrB,cAAc;gBACd,YAAY,EAAE,KAAK;aACpB,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,yBAAyB,CAAC,gBAAwB;QAC1D,OAAO,KAAK,EAAE,EAAmB,EAAoB,EAAE;YACrD,MAAM,IAAI,CAAC,cAAc,CACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,gBAAgB;gBACtB,cAAc,EAAE,OAAC,CAAC,GAAG,EAAE,EAAE,oDAAoD;aAC9E,EACD,SAAS,EACT,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CACnB,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,kBAAkB,CAC1B,QAAgB,EAChB,YAAkC,EAClC,cAAsC;QAEtC,OAAO,KAAK,EAAE,MAAe,EAAsB,EAAE;YACnD,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACxC,MAAM,IAAI,wBAAe,CAAC;oBACxB,OAAO,EAAE,0BAA0B;oBACnC,OAAO,EAAE,IAAI,CAAC,WAAW;oBACzB,QAAQ;oBACR,gBAAgB,EAAE;wBAChB;4BACE,IAAI,EAAE,CAAC,GAAG,CAAC;4BACX,OAAO,EAAE,8BAA8B;4BACvC,IAAI,EAAE,QAAQ;yBACf;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,QAAQ;gBACd,YAAY;gBACZ,cAAc;aACf,EACD,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,sBAAsB,CAC9B,QAAgB,EAChB,YAAkC,EAClC,UAA8B;QAE9B,OAAO,KAAK,EAAE,MAAe,EAA8B,EAAE;YAC3D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CACxC;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,QAAQ;gBACd,YAAY;gBACZ,cAAc,EAAE,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC;aAC3D,EACD,MAAM,CACP,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACO,kBAAkB,CAC1B,gBAAwB,EACxB,MAAsB,EACtB,cAAsC,EACtC,UAAmC;QAEnC,OAAO,KAAK,EAAE,EAAmB,EAAsB,EAAE;YACvD,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM;gBACN,IAAI,EAAE,gBAAgB;gBACtB,cAAc;aACf,EACD,SAAS,EACT,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,UAAU,EAAE,CAClC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,gBAAgB,CAAC,gBAAwB,EAAE,MAAkB;QACrE,OAAO,KAAK,EAAE,EAAoB,EAAiB,EAAE;YACnD,MAAM,IAAI,CAAC,cAAc,CACvB;gBACE,MAAM;gBACN,IAAI,EAAE,gBAAgB;gBACtB,cAAc,EAAE,OAAC,CAAC,GAAG,EAAE;aACxB,EACD,SAAS,EACT,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CACpC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,yBAAyB,CAAI,UAA0B;QAC7D,OAAO,IAAA,4BAAkB,EAAC,OAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACO,eAAe,CACvB,gBAAwB,EACxB,cAAsC,EACtC,YAAmC;QAEnC,OAAO,KAAK,EAAE,EAAmB,EAAE,MAAgB,EAAsB,EAAE;YACzE,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,gBAAgB;gBACtB,YAAY;gBACZ,cAAc;aACf,EACD,MAAM,EACN,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACO,gBAAgB,CAAY,cAAsC;QAC1E,OAAO,KAAK,IAAwB,EAAE;YACpC,OAAO,IAAI,CAAC,cAAc,CAAC;gBACzB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,OAAO;gBACb,cAAc;gBACd,YAAY,EAAE,KAAK;aACpB,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,iBAAiB,CACvB,YAAoB,EACpB,UAA4C;QAE5C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,IAAI,IAAI,GAAG,YAAY,CAAC;QACxB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACtD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACO,eAAe,CACvB,MAA+B,EAC/B,MAAgB;QAQhB,OAAO;YACL,QAAQ,EAAE,MAAM,CAAC,IAAI;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,cAAc,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY;YACrC,cAAc,EAAE,MAAM;YACtB,cAAc,EAAE,MAAM,CAAC,YAAY,EAAE,WAAW,IAAI,iCAAiC;SACtF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACO,qBAAqB,CAC7B,MAAsB,EACtB,MAAe,EACf,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAClC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;oBAC7C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBAC/D,OAAO,GAAG,OAAO,MAAM,IAAI,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChD,CAAC,CAAC,CAAC;gBAEH,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,eAAe;oBACvB,SAAS,EAAE,KAAK;iBACjB,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAlkBD,8CAkkBC"}
|
|
@@ -31,6 +31,27 @@ export declare class ValidationError extends AugurError {
|
|
|
31
31
|
endpoint: string;
|
|
32
32
|
validationErrors: z.ZodError['errors'];
|
|
33
33
|
});
|
|
34
|
+
/**
|
|
35
|
+
* Format validation errors into human-readable messages
|
|
36
|
+
* @returns Array of formatted error messages
|
|
37
|
+
*/
|
|
38
|
+
getFormattedErrors(): string[];
|
|
39
|
+
/**
|
|
40
|
+
* Get detailed validation error information for debugging
|
|
41
|
+
* @returns Object with detailed error information
|
|
42
|
+
*/
|
|
43
|
+
getDetailedErrors(): Array<{
|
|
44
|
+
path: string;
|
|
45
|
+
message: string;
|
|
46
|
+
code: string;
|
|
47
|
+
received?: unknown;
|
|
48
|
+
expected?: unknown;
|
|
49
|
+
}>;
|
|
50
|
+
/**
|
|
51
|
+
* Override toString to include formatted validation errors
|
|
52
|
+
* @returns String representation with validation details
|
|
53
|
+
*/
|
|
54
|
+
toString(): string;
|
|
34
55
|
}
|
|
35
56
|
export declare class AuthenticationError extends AugurError {
|
|
36
57
|
constructor(params: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,qBAAa,UAAW,SAAQ,KAAM,YAAW,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAEnC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzC;CAeF;AAED,qBAAa,eAAgB,SAAQ,UAAU;gBACjC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACxC;
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,qBAAa,UAAW,SAAQ,KAAM,YAAW,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAEnC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzC;CAeF;AAED,qBAAa,eAAgB,SAAQ,UAAU;gBACjC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACxC;IAQD;;;OAGG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAW9B;;;OAGG;IACH,iBAAiB,IAAI,KAAK,CAAC;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;IAcF;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAUnB;AAED,qBAAa,mBAAoB,SAAQ,UAAU;gBACrC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,cAAe,SAAQ,UAAU;gBAChC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E"}
|
package/dist/cjs/core/errors.js
CHANGED
|
@@ -26,6 +26,47 @@ class ValidationError extends AugurError {
|
|
|
26
26
|
statusCode: 400,
|
|
27
27
|
});
|
|
28
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* Format validation errors into human-readable messages
|
|
31
|
+
* @returns Array of formatted error messages
|
|
32
|
+
*/
|
|
33
|
+
getFormattedErrors() {
|
|
34
|
+
if (!this.validationErrors) {
|
|
35
|
+
return [];
|
|
36
|
+
}
|
|
37
|
+
return this.validationErrors.map(error => {
|
|
38
|
+
const path = error.path.length > 0 ? error.path.join('.') : 'root';
|
|
39
|
+
return `${path}: ${error.message}`;
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Get detailed validation error information for debugging
|
|
44
|
+
* @returns Object with detailed error information
|
|
45
|
+
*/
|
|
46
|
+
getDetailedErrors() {
|
|
47
|
+
if (!this.validationErrors) {
|
|
48
|
+
return [];
|
|
49
|
+
}
|
|
50
|
+
return this.validationErrors.map(error => ({
|
|
51
|
+
path: error.path.length > 0 ? error.path.join('.') : 'root',
|
|
52
|
+
message: error.message,
|
|
53
|
+
code: error.code,
|
|
54
|
+
received: 'received' in error ? error.received : undefined,
|
|
55
|
+
expected: 'expected' in error ? error.expected : undefined,
|
|
56
|
+
}));
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Override toString to include formatted validation errors
|
|
60
|
+
* @returns String representation with validation details
|
|
61
|
+
*/
|
|
62
|
+
toString() {
|
|
63
|
+
const baseMessage = super.toString();
|
|
64
|
+
const formattedErrors = this.getFormattedErrors();
|
|
65
|
+
if (formattedErrors.length > 0) {
|
|
66
|
+
return `${baseMessage}\nValidation errors:\n${formattedErrors.map(err => ` - ${err}`).join('\n')}`;
|
|
67
|
+
}
|
|
68
|
+
return baseMessage;
|
|
69
|
+
}
|
|
29
70
|
}
|
|
30
71
|
exports.ValidationError = ValidationError;
|
|
31
72
|
class AuthenticationError extends AugurError {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":";;;AAWA,MAAa,UAAW,SAAQ,KAAK;IAQnC,YAAY,MAQX;QACC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAEhD,qFAAqF;QACrF,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA/BD,gCA+BC;AAED,MAAa,eAAgB,SAAQ,UAAU;IAC7C,YAAY,MAKX;QACC,KAAK,CAAC;YACJ,GAAG,MAAM;YACT,IAAI,EAAE,kBAAkB;YACxB,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":";;;AAWA,MAAa,UAAW,SAAQ,KAAK;IAQnC,YAAY,MAQX;QACC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAEhD,qFAAqF;QACrF,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA/BD,gCA+BC;AAED,MAAa,eAAgB,SAAQ,UAAU;IAC7C,YAAY,MAKX;QACC,KAAK,CAAC;YACJ,GAAG,MAAM;YACT,IAAI,EAAE,kBAAkB;YACxB,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YACvC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACnE,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,iBAAiB;QAOf,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACzC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM;YAC3D,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC1D,QAAQ,EAAE,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAElD,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,GAAG,WAAW,yBAAyB,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACtG,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAnED,0CAmEC;AAED,MAAa,mBAAoB,SAAQ,UAAU;IACjD,YAAY,MAA8D;QACxE,KAAK,CAAC;YACJ,GAAG,MAAM;YACT,IAAI,EAAE,sBAAsB;YAC5B,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AARD,kDAQC;AAED,MAAa,aAAc,SAAQ,UAAU;IAC3C,YAAY,MAA8D;QACxE,KAAK,CAAC;YACJ,GAAG,MAAM;YACT,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AARD,sCAQC;AAED,MAAa,cAAe,SAAQ,UAAU;IAC5C,YAAY,MAA8D;QACxE,KAAK,CAAC;YACJ,GAAG,MAAM;YACT,IAAI,EAAE,qBAAqB;YAC3B,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AARD,wCAQC"}
|
|
@@ -401,27 +401,54 @@ export declare class CustomersClient extends BaseServiceClient {
|
|
|
401
401
|
/**
|
|
402
402
|
* List customer orders
|
|
403
403
|
* @description Returns customer orders with different detail levels based on fullDocument parameter
|
|
404
|
-
* @param customerId Customer ID
|
|
404
|
+
* @param customerId Customer ID (number)
|
|
405
405
|
* @param params Optional filtering and pagination parameters
|
|
406
|
-
* @param params.
|
|
407
|
-
*
|
|
408
|
-
* - 'Y': Returns complete order documents with orderLines array and shipping details
|
|
409
|
-
*
|
|
406
|
+
* @param params.addressId Filter by specific ship-to address ID (number, optional)
|
|
407
|
+
* @param params.fullDocument Controls response detail level (string, optional):
|
|
408
|
+
* - 'Y' (default): Returns complete order documents with orderLines array and shipping details
|
|
409
|
+
* - 'N': Returns order headers only - summary information without line items
|
|
410
|
+
* @param params.limit Maximum number of results to return (number, optional, default: 10)
|
|
411
|
+
* @param params.offset Number of results to skip for pagination (number, optional, default: 0)
|
|
412
|
+
* @param params.orderBy Sort ordering in format 'field|direction' (string, optional, default: 'date_created|DESC')
|
|
413
|
+
* @param params.q Search query string (string, optional)
|
|
414
|
+
* @returns Promise resolving to either OrderHeaderListResponse or OrderDocumentListResponse
|
|
410
415
|
* @throws ValidationError When parameters are invalid or response is malformed
|
|
411
|
-
*
|
|
416
|
+
*
|
|
417
|
+
* @example Basic usage
|
|
412
418
|
* ```typescript
|
|
413
|
-
* // Get order
|
|
414
|
-
* const
|
|
415
|
-
* // Returns:
|
|
419
|
+
* // Get complete order documents (default behavior)
|
|
420
|
+
* const fullOrders = await client.customer.orders.list(12345);
|
|
421
|
+
* // Returns: OrderDocumentListResponse
|
|
416
422
|
*
|
|
423
|
+
* // Get order headers with pagination
|
|
424
|
+
* const paginatedHeaders = await client.customer.orders.list(12345, {
|
|
425
|
+
* limit: 25,
|
|
426
|
+
* offset: 50,
|
|
427
|
+
* fullDocument: 'N'
|
|
428
|
+
* });
|
|
429
|
+
* ```
|
|
430
|
+
*
|
|
431
|
+
* @example Advanced usage
|
|
432
|
+
* ```typescript
|
|
417
433
|
* // Get complete order documents with line items
|
|
418
|
-
* const fullOrders = await client.customer.orders.list(12345, {
|
|
434
|
+
* const fullOrders = await client.customer.orders.list(12345, {
|
|
435
|
+
* fullDocument: 'Y',
|
|
436
|
+
* orderBy: 'order_date|DESC',
|
|
437
|
+
* q: 'PO-2023'
|
|
438
|
+
* });
|
|
419
439
|
* // Returns: OrderDocumentListResponse
|
|
420
440
|
*
|
|
421
|
-
* //
|
|
422
|
-
* const
|
|
423
|
-
*
|
|
441
|
+
* // Filter by ship-to address
|
|
442
|
+
* const addressOrders = await client.customer.orders.list(12345, {
|
|
443
|
+
* addressId: 67890,
|
|
444
|
+
* fullDocument: 'N'
|
|
445
|
+
* });
|
|
424
446
|
* ```
|
|
447
|
+
*
|
|
448
|
+
* @note Parameter Types
|
|
449
|
+
* - fullDocument must be exactly 'Y' or 'N' (strings, not boolean)
|
|
450
|
+
* - orderBy format: 'field_name|ASC' or 'field_name|DESC'
|
|
451
|
+
* - All parameters are optional; method works without any parameters
|
|
425
452
|
*/
|
|
426
453
|
list: (customerId: number, params?: OrderListParams) => Promise<OrderHeaderListResponse | OrderDocumentListResponse>;
|
|
427
454
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA8BL,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EAiBrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAA0C;IAIjF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;WAUG;yBACoB,oBAAoB;;;;;;;;;;;;;;;;;;;;;QAY3C;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;QAc5D;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;;;;;;;eAiBG;iCACwB,MAAM,QAAQ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAc9D;;;WAGG;;YAED;;;;;;;;;;;;;;;eAeG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAajE;;;;;;;;;;;;;;;;;;eAkBG;iCACwB,MAAM,QAAQ,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAcpE;;;WAGG;;YAED
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA8BL,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EAiBrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAA0C;IAIjF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;WAUG;yBACoB,oBAAoB;;;;;;;;;;;;;;;;;;;;;QAY3C;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;QAc5D;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;;;;;;;eAiBG;iCACwB,MAAM,QAAQ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAc9D;;;WAGG;;YAED;;;;;;;;;;;;;;;eAeG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAajE;;;;;;;;;;;;;;;;;;eAkBG;iCACwB,MAAM,QAAQ,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAcpE;;;WAGG;;YAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAmDG;+BAEW,MAAM,WACT,eAAe,KACvB,OAAO,CAAC,uBAAuB,GAAG,yBAAyB,CAAC;YAmB/D;;;;;;;;;;;;eAYG;8BACqB,MAAM,WAAW,MAAM,KAAG,OAAO,CAAC,qBAAqB,CAAC;;QAalF;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;eAWG;8BACqB,MAAM,aAAa,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAanD;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,WAAW,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAazD;;;;;;;;;;;eAWG;8BACqB,MAAM,WAAW,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAajD;;;WAGG;;YAED;;;;;;;;;;;;;eAaG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;MAanE;IAEF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;qCACgC,MAAM;;;;;;;;;;;;;QAYzC;;;;;;;;;;;;;;WAcG;kCAC6B,MAAM,WAAW,sBAAsB;;;;;;;;;;;;;;;QAavE;;;;;;;;;;WAUG;0CACqC,MAAM;;;;;;;;;;;;;;;;QAY9C;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,aAAa;QACX;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,yBAAyB;QACvB;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;;;;;;;;OAUG;IACH,cAAc;;;;;;;;;;OAA2D;CAC1E"}
|
|
@@ -232,27 +232,54 @@ class CustomersClient extends base_client_1.BaseServiceClient {
|
|
|
232
232
|
/**
|
|
233
233
|
* List customer orders
|
|
234
234
|
* @description Returns customer orders with different detail levels based on fullDocument parameter
|
|
235
|
-
* @param customerId Customer ID
|
|
235
|
+
* @param customerId Customer ID (number)
|
|
236
236
|
* @param params Optional filtering and pagination parameters
|
|
237
|
-
* @param params.
|
|
238
|
-
*
|
|
239
|
-
* - 'Y': Returns complete order documents with orderLines array and shipping details
|
|
240
|
-
*
|
|
237
|
+
* @param params.addressId Filter by specific ship-to address ID (number, optional)
|
|
238
|
+
* @param params.fullDocument Controls response detail level (string, optional):
|
|
239
|
+
* - 'Y' (default): Returns complete order documents with orderLines array and shipping details
|
|
240
|
+
* - 'N': Returns order headers only - summary information without line items
|
|
241
|
+
* @param params.limit Maximum number of results to return (number, optional, default: 10)
|
|
242
|
+
* @param params.offset Number of results to skip for pagination (number, optional, default: 0)
|
|
243
|
+
* @param params.orderBy Sort ordering in format 'field|direction' (string, optional, default: 'date_created|DESC')
|
|
244
|
+
* @param params.q Search query string (string, optional)
|
|
245
|
+
* @returns Promise resolving to either OrderHeaderListResponse or OrderDocumentListResponse
|
|
241
246
|
* @throws ValidationError When parameters are invalid or response is malformed
|
|
242
|
-
*
|
|
247
|
+
*
|
|
248
|
+
* @example Basic usage
|
|
243
249
|
* ```typescript
|
|
244
|
-
* // Get order
|
|
245
|
-
* const
|
|
246
|
-
* // Returns:
|
|
250
|
+
* // Get complete order documents (default behavior)
|
|
251
|
+
* const fullOrders = await client.customer.orders.list(12345);
|
|
252
|
+
* // Returns: OrderDocumentListResponse
|
|
247
253
|
*
|
|
254
|
+
* // Get order headers with pagination
|
|
255
|
+
* const paginatedHeaders = await client.customer.orders.list(12345, {
|
|
256
|
+
* limit: 25,
|
|
257
|
+
* offset: 50,
|
|
258
|
+
* fullDocument: 'N'
|
|
259
|
+
* });
|
|
260
|
+
* ```
|
|
261
|
+
*
|
|
262
|
+
* @example Advanced usage
|
|
263
|
+
* ```typescript
|
|
248
264
|
* // Get complete order documents with line items
|
|
249
|
-
* const fullOrders = await client.customer.orders.list(12345, {
|
|
265
|
+
* const fullOrders = await client.customer.orders.list(12345, {
|
|
266
|
+
* fullDocument: 'Y',
|
|
267
|
+
* orderBy: 'order_date|DESC',
|
|
268
|
+
* q: 'PO-2023'
|
|
269
|
+
* });
|
|
250
270
|
* // Returns: OrderDocumentListResponse
|
|
251
271
|
*
|
|
252
|
-
* //
|
|
253
|
-
* const
|
|
254
|
-
*
|
|
272
|
+
* // Filter by ship-to address
|
|
273
|
+
* const addressOrders = await client.customer.orders.list(12345, {
|
|
274
|
+
* addressId: 67890,
|
|
275
|
+
* fullDocument: 'N'
|
|
276
|
+
* });
|
|
255
277
|
* ```
|
|
278
|
+
*
|
|
279
|
+
* @note Parameter Types
|
|
280
|
+
* - fullDocument must be exactly 'Y' or 'N' (strings, not boolean)
|
|
281
|
+
* - orderBy format: 'field_name|ASC' or 'field_name|DESC'
|
|
282
|
+
* - All parameters are optional; method works without any parameters
|
|
256
283
|
*/
|
|
257
284
|
list: async (customerId, params) => {
|
|
258
285
|
// Runtime schema selection based on fullDocument parameter
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCA4DmB;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,eAAgB,SAAQ,+BAAiB;IACpD;;;;OAIG;IACH,YAAY,IAAgB,EAAE,UAAkB,iCAAiC;QAC/E,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAGpC;;;WAGG;QACH,aAAQ,GAAG;YACT;;;;;;;;;;;;;;;;;;eAkBG;YACH,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,kCAAwB,EAAE,oCAA0B,CAAC;YAE9F;;;;;;;;;;;eAWG;YACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,oBAAoB,EAAE,gCAAsB,CAAC;YAEvE;;;;;;;;;;eAUG;YACH,MAAM,EAAE,KAAK,EAAE,MAA4B,EAAE,EAAE;gBAC7C,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,kBAAkB;oBACxB,YAAY,EAAE,oCAA0B;oBACxC,cAAc,EAAE,sCAA4B;iBAC7C,EACD,MAAM,CACP,CAAC;YACJ,CAAC;YAED;;;eAGG;YACH,SAAS,EAAE;gBACT;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAyB,EAAE,EAAE;oBAC5D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,iCAAuB;wBACrC,cAAc,EAAE,mCAAyB;qBAC1C,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,QAAQ,EAAE;gBACR;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAyB,EAAE,EAAE;oBAC5D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,iCAAiC;wBACvC,YAAY,EAAE,iCAAuB;wBACrC,cAAc,EAAE,mCAAyB;qBAC1C,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;;;;;;mBAiBG;gBACH,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,IAAyB,EAAE,EAAE;oBAC9D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,iCAAiC;wBACvC,YAAY,EAAE,mCAAyB;wBACvC,cAAc,EAAE,+BAAqB;qBACtC,EACD,IAAI,EACJ,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,MAAM,EAAE;gBACN;;;;;;;;;;;;;;;mBAeG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAgC,EAAE,EAAE;oBACnE,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,uCAA6B;wBAC3C,cAAc,EAAE,yCAA+B;qBAChD,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;;;;;;;mBAkBG;gBACH,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,IAA+B,EAAE,EAAE;oBACpE,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,yCAA+B;wBAC7C,cAAc,EAAE,qCAA2B;qBAC5C,EACD,IAAI,EACJ,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,MAAM,EAAE;gBACN
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCA4DmB;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,eAAgB,SAAQ,+BAAiB;IACpD;;;;OAIG;IACH,YAAY,IAAgB,EAAE,UAAkB,iCAAiC;QAC/E,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAGpC;;;WAGG;QACH,aAAQ,GAAG;YACT;;;;;;;;;;;;;;;;;;eAkBG;YACH,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,kCAAwB,EAAE,oCAA0B,CAAC;YAE9F;;;;;;;;;;;eAWG;YACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,oBAAoB,EAAE,gCAAsB,CAAC;YAEvE;;;;;;;;;;eAUG;YACH,MAAM,EAAE,KAAK,EAAE,MAA4B,EAAE,EAAE;gBAC7C,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,kBAAkB;oBACxB,YAAY,EAAE,oCAA0B;oBACxC,cAAc,EAAE,sCAA4B;iBAC7C,EACD,MAAM,CACP,CAAC;YACJ,CAAC;YAED;;;eAGG;YACH,SAAS,EAAE;gBACT;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAyB,EAAE,EAAE;oBAC5D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,iCAAuB;wBACrC,cAAc,EAAE,mCAAyB;qBAC1C,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,QAAQ,EAAE;gBACR;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAyB,EAAE,EAAE;oBAC5D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,iCAAiC;wBACvC,YAAY,EAAE,iCAAuB;wBACrC,cAAc,EAAE,mCAAyB;qBAC1C,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;;;;;;mBAiBG;gBACH,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,IAAyB,EAAE,EAAE;oBAC9D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,iCAAiC;wBACvC,YAAY,EAAE,mCAAyB;wBACvC,cAAc,EAAE,+BAAqB;qBACtC,EACD,IAAI,EACJ,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,MAAM,EAAE;gBACN;;;;;;;;;;;;;;;mBAeG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAgC,EAAE,EAAE;oBACnE,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,uCAA6B;wBAC3C,cAAc,EAAE,yCAA+B;qBAChD,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;;;;;;;mBAkBG;gBACH,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,IAA+B,EAAE,EAAE;oBACpE,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,gCAAgC;wBACtC,YAAY,EAAE,yCAA+B;wBAC7C,cAAc,EAAE,qCAA2B;qBAC5C,EACD,IAAI,EACJ,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,MAAM,EAAE;gBACN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmDG;gBACH,IAAI,EAAE,KAAK,EACT,UAAkB,EAClB,MAAwB,EACsC,EAAE;oBAChE,2DAA2D;oBAC3D,MAAM,cAAc,GAAG,MAAM,EAAE,YAAY,KAAK,GAAG,CAAC;oBACpD,MAAM,cAAc,GAAG,cAAc;wBACnC,CAAC,CAAC,yCAA+B;wBACjC,CAAC,CAAC,uCAA6B,CAAC;oBAElC,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,+BAA+B;wBACrC,YAAY,EAAE,+BAAqB;wBACnC,cAAc,EAAE,cAAc;qBAC/B,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;mBAYG;gBACH,GAAG,EAAE,KAAK,EAAE,UAAkB,EAAE,OAAe,EAAkC,EAAE;oBACjF,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,yCAAyC;wBAC/C,cAAc,EAAE,qCAA2B;qBAC5C,EACD,SAAS,EACT,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,QAAQ,EAAE;gBACR;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAyB,EAAE,EAAE;oBAC5D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,iCAAiC;wBACvC,YAAY,EAAE,iCAAuB;wBACrC,cAAc,EAAE,mCAAyB;qBAC1C,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;mBAWG;gBACH,GAAG,EAAE,KAAK,EAAE,UAAkB,EAAE,SAAiB,EAAE,EAAE;oBACnD,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,6CAA6C;wBACnD,cAAc,EAAE,+BAAqB;qBACtC,EACD,SAAS,EACT,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CACjE,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,MAAM,EAAE;gBACN;;;;;;;;;;;mBAWG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAwB,EAAE,EAAE;oBAC3D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,+BAA+B;wBACrC,YAAY,EAAE,+BAAqB;wBACnC,cAAc,EAAE,iCAAuB;qBACxC,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;mBAWG;gBACH,GAAG,EAAE,KAAK,EAAE,UAAkB,EAAE,OAAe,EAAE,EAAE;oBACjD,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,yCAAyC;wBAC/C,cAAc,EAAE,6BAAmB;qBACpC,EACD,SAAS,EACT,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAC;gBACJ,CAAC;aACF;YAED;;;eAGG;YACH,eAAe,EAAE;gBACf;;;;;;;;;;;;;mBAaG;gBACH,IAAI,EAAE,KAAK,EAAE,UAAkB,EAAE,MAAgC,EAAE,EAAE;oBACnE,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,wCAAwC;wBAC9C,YAAY,EAAE,uCAA6B;wBAC3C,cAAc,EAAE,yCAA+B;qBAChD,EACD,MAAM,EACN,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CACnC,CAAC;gBACJ,CAAC;aACF;SACF,CAAC;QAEF;;;WAGG;QACH,aAAQ,GAAG;YACT;;;;;;;;;;;eAWG;YACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,oBAAoB,EAAE,+BAAqB,CAAC;YAEtE;;;;;;;;;;;eAWG;YACH,eAAe,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;gBAC3C,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,qCAAqC;oBAC3C,cAAc,EAAE,oCAA0B;iBAC3C,EACD,SAAS,EACT,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CACjC,CAAC;YACJ,CAAC;YAED;;;;;;;;;;;;;;eAcG;YACH,YAAY,EAAE,KAAK,EAAE,SAAiB,EAAE,MAA+B,EAAE,EAAE;gBACzE,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,iCAAiC;oBACvC,YAAY,EAAE,sCAA4B;oBAC1C,cAAc,EAAE,wCAA8B;iBAC/C,EACD,MAAM,EACN,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CACjC,CAAC;YACJ,CAAC;YAED;;;;;;;;;;eAUG;YACH,oBAAoB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;gBAChD,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,0BAA0B;oBAChC,cAAc,EAAE,gDAAsC;iBACvD,EACD,SAAS,EACT,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CACjC,CAAC;YACJ,CAAC;YAED;;;;;;;;;;eAUG;YACH,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,OAAO,IAAI,CAAC,cAAc,CAAC;oBACzB,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,mBAAmB;oBACzB,cAAc,EAAE,2CAAiC;iBAClD,CAAC,CAAC;YACL,CAAC;SACF,CAAC;QAEF;;;WAGG;QACH,kBAAa,GAAG;YACd;;;;;;;;;;eAUG;YACH,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,OAAO,IAAI,CAAC,cAAc,CAAC;oBACzB,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,kBAAkB;oBACxB,cAAc,EAAE,2CAAiC;iBAClD,CAAC,CAAC;YACL,CAAC;SACF,CAAC;QAEF;;;WAGG;QACH,8BAAyB,GAAG;YAC1B;;;;;;;;;;eAUG;YACH,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,OAAO,IAAI,CAAC,cAAc,CAAC;oBACzB,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,+BAA+B;oBACrC,cAAc,EAAE,2CAAiC;iBAClD,CAAC,CAAC;YACL,CAAC;SACF,CAAC;QAEF;;;;;;;;;;WAUG;QACH,mBAAc,GAAG,IAAI,CAAC,uBAAuB,CAAC,mCAAyB,CAAC,CAAC;IAzoBzE,CAAC;CA0oBF;AAlpBD,0CAkpBC"}
|
|
@@ -136,6 +136,18 @@ export declare abstract class BaseServiceClient {
|
|
|
136
136
|
* @throws AugurError For HTTP errors (handled by HTTPClient interceptors)
|
|
137
137
|
*/
|
|
138
138
|
protected executeRequest<TParams = unknown, TResponse = unknown>(config: EndpointConfig<TParams, TResponse>, params?: TParams, pathParams?: Record<string, string | number>): Promise<TResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Validate request parameters using the provided schema
|
|
141
|
+
*/
|
|
142
|
+
private validateParameters;
|
|
143
|
+
/**
|
|
144
|
+
* Execute HTTP request based on the configured method
|
|
145
|
+
*/
|
|
146
|
+
private executeHttpRequest;
|
|
147
|
+
/**
|
|
148
|
+
* Create a detailed validation error with context information
|
|
149
|
+
*/
|
|
150
|
+
private createValidationError;
|
|
139
151
|
/**
|
|
140
152
|
* Create a standardized list method factory
|
|
141
153
|
*
|
|
@@ -288,5 +300,35 @@ export declare abstract class BaseServiceClient {
|
|
|
288
300
|
* ```
|
|
289
301
|
*/
|
|
290
302
|
private buildEndpointPath;
|
|
303
|
+
/**
|
|
304
|
+
* Create a debugging helper for troubleshooting validation errors
|
|
305
|
+
*
|
|
306
|
+
* @param config Endpoint configuration
|
|
307
|
+
* @param params Parameters being validated
|
|
308
|
+
* @returns Debug information object
|
|
309
|
+
*/
|
|
310
|
+
protected createDebugInfo<TParams>(config: EndpointConfig<TParams>, params?: TParams): {
|
|
311
|
+
endpoint: string;
|
|
312
|
+
method: string;
|
|
313
|
+
hasParamSchema: boolean;
|
|
314
|
+
providedParams: TParams | undefined;
|
|
315
|
+
expectedSchema?: string;
|
|
316
|
+
};
|
|
317
|
+
/**
|
|
318
|
+
* Validate parameters and provide detailed error information for debugging
|
|
319
|
+
*
|
|
320
|
+
* @param schema Zod schema to validate against
|
|
321
|
+
* @param params Parameters to validate
|
|
322
|
+
* @param context Context information for error messages
|
|
323
|
+
* @returns Validation result with detailed error information
|
|
324
|
+
*/
|
|
325
|
+
protected validateWithDebugInfo<T>(schema: z.ZodSchema<T>, params: unknown, context: string): {
|
|
326
|
+
success: true;
|
|
327
|
+
data: T;
|
|
328
|
+
} | {
|
|
329
|
+
success: false;
|
|
330
|
+
errors: string[];
|
|
331
|
+
rawErrors: z.ZodError;
|
|
332
|
+
};
|
|
291
333
|
}
|
|
292
334
|
//# sourceMappingURL=base-client.d.ts.map
|