@superblocksteam/sdk-api 2.0.143 → 2.0.144

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 (2) hide show
  1. package/package.json +2 -2
  2. package/src/integrations/restapiintegration/overlays/response-types-unsupported.md +3 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@superblocksteam/sdk-api",
3
- "version": "2.0.143",
3
+ "version": "2.0.144",
4
4
  "description": "Superblocks SDK for TypeScript-based API definitions",
5
5
  "license": "Superblocks Community Software License",
6
6
  "files": [
@@ -31,7 +31,7 @@
31
31
  "typescript-eslint": "^8.59.2",
32
32
  "uuid": "^11.1.1",
33
33
  "vitest": "^2.0.0",
34
- "@superblocksteam/shared": "0.9601.3"
34
+ "@superblocksteam/shared": "0.9602.0"
35
35
  },
36
36
  "engines": {
37
37
  "node": ">=20",
package/src/integrations/restapiintegration/overlays/response-types-unsupported.md CHANGED
@@ -2,4 +2,6 @@
2
2
 
3
3
  This organization's agent does not support the `responseType` option on `apiRequest()` — its worker runs an sdk-api version that decodes every response as JSON and always requires a response schema. Endpoints returning XML, CSV, or other non-JSON payloads cannot be consumed from SDK APIs until the agent is upgraded.
4
4
 
5
- Do not generate code that passes a `responseType` value: it may typecheck against a newer local copy of the SDK but fails at runtime on this agent with a `RestApiValidationError` (for example, "Integration query returned ... — expected a JSON response object"). If the user needs to consume a non-JSON endpoint, tell them their Superblocks agent must be upgraded first.
5
+ Do not generate code that passes a `responseType` value: it may typecheck against a newer local copy of the SDK but fails at runtime on this agent with a `RestApiValidationError` (for example, "Integration query returned ... — expected a JSON response object").
6
+
7
+ When the user needs to consume a non-JSON endpoint, this is not something you can fix in code. Tell them the required action: an administrator must upgrade this organization's Superblocks agent (On-Premise Agent / OPA) to a newer version that supports the `responseType` option. Until that upgrade happens, non-JSON endpoints cannot be consumed and there is no code-level workaround. Do not attempt to work around the limitation yourself.