@planqk/planqk-service-sdk 2.1.2 → 2.2.0

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 (171) hide show
  1. package/README-node.md +16 -12
  2. package/README.md +16 -12
  3. package/dist/sdk/Client.d.ts +10 -4
  4. package/dist/sdk/Client.js +46 -4
  5. package/dist/sdk/api/index.d.ts +2 -3
  6. package/dist/sdk/api/index.js +2 -3
  7. package/dist/sdk/api/resources/index.d.ts +2 -2
  8. package/dist/sdk/api/resources/index.js +2 -2
  9. package/dist/sdk/api/resources/serviceApi/client/Client.d.ts +41 -55
  10. package/dist/sdk/api/resources/serviceApi/client/Client.js +131 -227
  11. package/dist/sdk/api/resources/serviceApi/index.d.ts +2 -2
  12. package/dist/sdk/api/resources/serviceApi/index.js +2 -2
  13. package/dist/sdk/api/resources/serviceApi/types/GetResultResponse.d.ts +13 -3
  14. package/dist/sdk/api/resources/serviceApi/types/index.d.ts +1 -4
  15. package/dist/sdk/api/resources/serviceApi/types/index.js +1 -4
  16. package/dist/sdk/api/types/ServiceExecution.d.ts +12 -2
  17. package/dist/sdk/api/types/ServiceExecution.js +12 -0
  18. package/dist/sdk/api/types/index.d.ts +2 -6
  19. package/dist/sdk/api/types/index.js +2 -6
  20. package/dist/sdk/core/auth/BasicAuth.js +3 -3
  21. package/dist/sdk/core/auth/index.d.ts +2 -2
  22. package/dist/sdk/core/auth/index.js +4 -4
  23. package/dist/sdk/core/base64.d.ts +2 -0
  24. package/dist/sdk/core/base64.js +26 -0
  25. package/dist/sdk/core/fetcher/APIResponse.d.ts +10 -0
  26. package/dist/sdk/core/fetcher/BinaryResponse.d.ts +20 -0
  27. package/dist/sdk/core/fetcher/BinaryResponse.js +17 -0
  28. package/dist/sdk/core/fetcher/Fetcher.d.ts +5 -4
  29. package/dist/sdk/core/fetcher/Fetcher.js +41 -22
  30. package/dist/sdk/core/fetcher/Headers.d.ts +2 -0
  31. package/dist/sdk/core/fetcher/Headers.js +85 -0
  32. package/dist/sdk/core/fetcher/HttpResponsePromise.d.ts +58 -0
  33. package/dist/sdk/core/fetcher/HttpResponsePromise.js +94 -0
  34. package/dist/sdk/core/fetcher/RawResponse.d.ts +29 -0
  35. package/dist/sdk/core/fetcher/RawResponse.js +44 -0
  36. package/dist/sdk/core/fetcher/ResponseWithBody.d.ts +4 -0
  37. package/dist/sdk/core/fetcher/ResponseWithBody.js +6 -0
  38. package/dist/sdk/core/fetcher/createRequestUrl.d.ts +1 -1
  39. package/dist/sdk/core/fetcher/createRequestUrl.js +3 -7
  40. package/dist/sdk/core/fetcher/getErrorResponseBody.d.ts +1 -0
  41. package/dist/sdk/core/fetcher/getErrorResponseBody.js +32 -0
  42. package/dist/sdk/core/fetcher/getFetchFn.d.ts +1 -4
  43. package/dist/sdk/core/fetcher/getFetchFn.js +1 -52
  44. package/dist/sdk/core/fetcher/getRequestBody.js +2 -1
  45. package/dist/sdk/core/fetcher/getResponseBody.js +34 -30
  46. package/dist/sdk/core/fetcher/index.d.ts +9 -5
  47. package/dist/sdk/core/fetcher/index.js +13 -7
  48. package/dist/sdk/core/fetcher/makeRequest.js +3 -3
  49. package/dist/sdk/core/fetcher/requestWithRetries.js +14 -5
  50. package/dist/sdk/core/headers.d.ts +3 -0
  51. package/dist/sdk/core/headers.js +29 -0
  52. package/dist/sdk/core/index.d.ts +5 -3
  53. package/dist/sdk/core/index.js +28 -3
  54. package/dist/sdk/core/json.d.ts +15 -0
  55. package/dist/sdk/core/json.js +24 -0
  56. package/dist/sdk/core/runtime/index.d.ts +1 -1
  57. package/dist/sdk/core/runtime/index.js +2 -2
  58. package/dist/sdk/core/runtime/runtime.d.ts +1 -1
  59. package/dist/sdk/core/runtime/runtime.js +49 -40
  60. package/dist/sdk/core/url/index.d.ts +2 -0
  61. package/dist/sdk/core/url/index.js +7 -0
  62. package/dist/sdk/core/url/join.d.ts +1 -0
  63. package/dist/sdk/core/url/join.js +49 -0
  64. package/dist/sdk/core/url/qs.d.ts +6 -0
  65. package/dist/sdk/core/url/qs.js +67 -0
  66. package/dist/sdk/errors/PlanqkServiceApiError.d.ts +4 -1
  67. package/dist/sdk/errors/PlanqkServiceApiError.js +7 -8
  68. package/dist/sdk/errors/PlanqkServiceApiTimeoutError.d.ts +1 -1
  69. package/dist/sdk/errors/PlanqkServiceApiTimeoutError.js +2 -2
  70. package/dist/sdk/errors/index.d.ts +2 -2
  71. package/dist/sdk/errors/index.js +4 -4
  72. package/dist/sdk/index.d.ts +4 -4
  73. package/dist/sdk/index.js +9 -9
  74. package/fern/fern.config.json +1 -1
  75. package/fern/generators.yml +2 -2
  76. package/fern/openapi/openapi.yml +41 -131
  77. package/package.json +1 -1
  78. package/planqk/service/_version.py +1 -1
  79. package/pyproject.toml +1 -1
  80. package/src/index.test.ts +29 -16
  81. package/src/sdk/Client.ts +27 -7
  82. package/src/sdk/api/index.ts +2 -3
  83. package/src/sdk/api/resources/index.ts +2 -2
  84. package/src/sdk/api/resources/serviceApi/client/Client.ts +223 -250
  85. package/src/sdk/api/resources/serviceApi/index.ts +2 -2
  86. package/src/sdk/api/resources/serviceApi/types/GetResultResponse.ts +15 -3
  87. package/src/sdk/api/resources/serviceApi/types/index.ts +1 -4
  88. package/src/sdk/api/types/ServiceExecution.ts +13 -3
  89. package/src/sdk/api/types/index.ts +2 -6
  90. package/src/sdk/core/auth/BasicAuth.ts +3 -3
  91. package/src/sdk/core/auth/index.ts +2 -2
  92. package/src/sdk/core/base64.ts +27 -0
  93. package/src/sdk/core/fetcher/APIResponse.ts +11 -0
  94. package/src/sdk/core/fetcher/BinaryResponse.ts +36 -0
  95. package/src/sdk/core/fetcher/Fetcher.ts +46 -26
  96. package/src/sdk/core/fetcher/Headers.ts +93 -0
  97. package/src/sdk/core/fetcher/HttpResponsePromise.ts +116 -0
  98. package/src/sdk/core/fetcher/RawResponse.ts +61 -0
  99. package/src/sdk/core/fetcher/ResponseWithBody.ts +7 -0
  100. package/src/sdk/core/fetcher/createRequestUrl.ts +4 -8
  101. package/src/sdk/core/fetcher/getErrorResponseBody.ts +32 -0
  102. package/src/sdk/core/fetcher/getFetchFn.ts +2 -24
  103. package/src/sdk/core/fetcher/getRequestBody.ts +3 -1
  104. package/src/sdk/core/fetcher/getResponseBody.ts +38 -27
  105. package/src/sdk/core/fetcher/index.ts +9 -5
  106. package/src/sdk/core/fetcher/makeRequest.ts +2 -2
  107. package/src/sdk/core/fetcher/requestWithRetries.ts +18 -6
  108. package/src/sdk/core/fetcher/signals.ts +1 -1
  109. package/src/sdk/core/headers.ts +35 -0
  110. package/src/sdk/core/index.ts +5 -3
  111. package/src/sdk/core/json.ts +27 -0
  112. package/src/sdk/core/runtime/index.ts +1 -1
  113. package/src/sdk/core/runtime/runtime.ts +60 -53
  114. package/src/sdk/core/url/index.ts +2 -0
  115. package/src/sdk/core/url/join.ts +55 -0
  116. package/src/sdk/core/url/qs.ts +74 -0
  117. package/src/sdk/errors/PlanqkServiceApiError.ts +21 -11
  118. package/src/sdk/errors/PlanqkServiceApiTimeoutError.ts +2 -2
  119. package/src/sdk/errors/index.ts +2 -2
  120. package/src/sdk/index.ts +4 -4
  121. package/dist/sdk/api/errors/BadRequestError.d.ts +0 -7
  122. package/dist/sdk/api/errors/BadRequestError.js +0 -51
  123. package/dist/sdk/api/errors/ForbiddenError.d.ts +0 -7
  124. package/dist/sdk/api/errors/ForbiddenError.js +0 -51
  125. package/dist/sdk/api/errors/InternalServerError.d.ts +0 -7
  126. package/dist/sdk/api/errors/InternalServerError.js +0 -51
  127. package/dist/sdk/api/errors/NotFoundError.d.ts +0 -7
  128. package/dist/sdk/api/errors/NotFoundError.js +0 -51
  129. package/dist/sdk/api/errors/UnauthorizedError.d.ts +0 -7
  130. package/dist/sdk/api/errors/UnauthorizedError.js +0 -51
  131. package/dist/sdk/api/errors/index.d.ts +0 -5
  132. package/dist/sdk/api/errors/index.js +0 -21
  133. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.d.ts +0 -7
  134. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.js +0 -5
  135. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseLinks.d.ts +0 -7
  136. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseLinks.js +0 -5
  137. package/dist/sdk/api/resources/serviceApi/types/HealthCheckResponse.d.ts +0 -7
  138. package/dist/sdk/api/resources/serviceApi/types/HealthCheckResponse.js +0 -5
  139. package/dist/sdk/api/types/InputData.d.ts +0 -4
  140. package/dist/sdk/api/types/InputData.js +0 -5
  141. package/dist/sdk/api/types/InputDataRef.d.ts +0 -8
  142. package/dist/sdk/api/types/InputDataRef.js +0 -5
  143. package/dist/sdk/api/types/InputParams.d.ts +0 -4
  144. package/dist/sdk/api/types/InputParams.js +0 -5
  145. package/dist/sdk/api/types/ServiceExecutionStatus.d.ts +0 -12
  146. package/dist/sdk/api/types/ServiceExecutionStatus.js +0 -14
  147. package/dist/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
  148. package/dist/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -232
  149. package/dist/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
  150. package/dist/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -91
  151. package/dist/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
  152. package/dist/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -214
  153. package/dist/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
  154. package/dist/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -48
  155. package/src/sdk/api/errors/BadRequestError.ts +0 -16
  156. package/src/sdk/api/errors/ForbiddenError.ts +0 -16
  157. package/src/sdk/api/errors/InternalServerError.ts +0 -16
  158. package/src/sdk/api/errors/NotFoundError.ts +0 -16
  159. package/src/sdk/api/errors/UnauthorizedError.ts +0 -16
  160. package/src/sdk/api/errors/index.ts +0 -5
  161. package/src/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.ts +0 -9
  162. package/src/sdk/api/resources/serviceApi/types/GetResultResponseLinks.ts +0 -9
  163. package/src/sdk/api/resources/serviceApi/types/HealthCheckResponse.ts +0 -8
  164. package/src/sdk/api/types/InputData.ts +0 -5
  165. package/src/sdk/api/types/InputDataRef.ts +0 -9
  166. package/src/sdk/api/types/InputParams.ts +0 -5
  167. package/src/sdk/api/types/ServiceExecutionStatus.ts +0 -14
  168. package/src/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.ts +0 -252
  169. package/src/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.ts +0 -106
  170. package/src/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.ts +0 -239
  171. package/src/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.ts +0 -33
@@ -35,54 +35,49 @@ var __importStar = (this && this.__importStar) || (function () {
35
35
  return result;
36
36
  };
37
37
  })();
38
- var __importDefault = (this && this.__importDefault) || function (mod) {
39
- return (mod && mod.__esModule) ? mod : { "default": mod };
40
- };
41
38
  Object.defineProperty(exports, "__esModule", { value: true });
42
39
  exports.ServiceApi = void 0;
43
- const environments = __importStar(require("../../../../environments"));
44
- const core = __importStar(require("../../../../core"));
45
- const PlanqkServiceApi = __importStar(require("../../../index"));
46
- const errors = __importStar(require("../../../../errors/index"));
47
- const url_join_1 = __importDefault(require("url-join"));
40
+ const environments = __importStar(require("../../../../environments.js"));
41
+ const core = __importStar(require("../../../../core/index.js"));
42
+ const headers_js_1 = require("../../../../core/headers.js");
43
+ const errors = __importStar(require("../../../../errors/index.js"));
48
44
  class ServiceApi {
49
45
  _options;
50
46
  constructor(_options) {
51
47
  this._options = _options;
52
48
  }
53
49
  /**
54
- * This method checks the health of the service.
50
+ * Retrieves a list of all service executions.
51
+ * The response includes links to each service execution, allowing for further queries on their status and results.
55
52
  *
56
53
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
57
54
  *
58
55
  * @example
59
- * await client.serviceApi.healthCheck()
56
+ * await client.serviceApi.getServiceExecutions()
60
57
  */
61
- async healthCheck(requestOptions) {
58
+ getServiceExecutions(requestOptions) {
59
+ return core.HttpResponsePromise.fromPromise(this.__getServiceExecutions(requestOptions));
60
+ }
61
+ async __getServiceExecutions(requestOptions) {
62
62
  const _response = await core.fetcher({
63
- url: (await core.Supplier.get(this._options.environment)) ??
63
+ url: (await core.Supplier.get(this._options.baseUrl)) ??
64
+ (await core.Supplier.get(this._options.environment)) ??
64
65
  environments.PlanqkServiceApiEnvironment.Default,
65
66
  method: "GET",
66
- headers: {
67
- Authorization: await this._getAuthorizationHeader(),
68
- "X-Fern-Language": "JavaScript",
69
- "X-Fern-Runtime": core.RUNTIME.type,
70
- "X-Fern-Runtime-Version": core.RUNTIME.version,
71
- },
72
- contentType: "application/json",
73
- requestType: "json",
67
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
74
68
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
75
69
  maxRetries: requestOptions?.maxRetries,
76
70
  withCredentials: true,
77
71
  abortSignal: requestOptions?.abortSignal,
78
72
  });
79
73
  if (_response.ok) {
80
- return _response.body;
74
+ return { data: _response.body, rawResponse: _response.rawResponse };
81
75
  }
82
76
  if (_response.error.reason === "status-code") {
83
77
  throw new errors.PlanqkServiceApiError({
84
78
  statusCode: _response.error.statusCode,
85
79
  body: _response.error.body,
80
+ rawResponse: _response.rawResponse,
86
81
  });
87
82
  }
88
83
  switch (_response.error.reason) {
@@ -90,46 +85,39 @@ class ServiceApi {
90
85
  throw new errors.PlanqkServiceApiError({
91
86
  statusCode: _response.error.statusCode,
92
87
  body: _response.error.rawBody,
88
+ rawResponse: _response.rawResponse,
93
89
  });
94
90
  case "timeout":
95
- throw new errors.PlanqkServiceApiTimeoutError();
91
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling GET /.");
96
92
  case "unknown":
97
93
  throw new errors.PlanqkServiceApiError({
98
94
  message: _response.error.errorMessage,
95
+ rawResponse: _response.rawResponse,
99
96
  });
100
97
  }
101
98
  }
102
99
  /**
103
- * This method starts a service execution, which in turn is processed asynchronously by PLANQK.
100
+ * Starts a service execution, which in turn is processed asynchronously.
104
101
  * The location header of the response contains the URL which can be used to query the status and the result of the service execution.
105
102
  *
106
- * @param {Record<string, Record<string, any>>} request
103
+ * @param {Record<string, any>} request
107
104
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
108
105
  *
109
- * @throws {@link PlanqkServiceApi.BadRequestError}
110
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
111
- * @throws {@link PlanqkServiceApi.ForbiddenError}
112
- * @throws {@link PlanqkServiceApi.NotFoundError}
113
- * @throws {@link PlanqkServiceApi.InternalServerError}
114
- *
115
106
  * @example
116
- * await client.serviceApi.execute({
117
- * "key": {
118
- * "key": "value"
119
- * }
107
+ * await client.serviceApi.startExecution({
108
+ * "key": "value"
120
109
  * })
121
110
  */
122
- async execute(request, requestOptions) {
111
+ startExecution(request, requestOptions) {
112
+ return core.HttpResponsePromise.fromPromise(this.__startExecution(request, requestOptions));
113
+ }
114
+ async __startExecution(request, requestOptions) {
123
115
  const _response = await core.fetcher({
124
- url: (await core.Supplier.get(this._options.environment)) ??
116
+ url: (await core.Supplier.get(this._options.baseUrl)) ??
117
+ (await core.Supplier.get(this._options.environment)) ??
125
118
  environments.PlanqkServiceApiEnvironment.Default,
126
119
  method: "POST",
127
- headers: {
128
- Authorization: await this._getAuthorizationHeader(),
129
- "X-Fern-Language": "JavaScript",
130
- "X-Fern-Runtime": core.RUNTIME.type,
131
- "X-Fern-Runtime-Version": core.RUNTIME.version,
132
- },
120
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
133
121
  contentType: "application/json",
134
122
  requestType: "json",
135
123
  body: request,
@@ -139,362 +127,278 @@ class ServiceApi {
139
127
  abortSignal: requestOptions?.abortSignal,
140
128
  });
141
129
  if (_response.ok) {
142
- return _response.body;
130
+ return { data: _response.body, rawResponse: _response.rawResponse };
143
131
  }
144
132
  if (_response.error.reason === "status-code") {
145
- switch (_response.error.statusCode) {
146
- case 400:
147
- throw new PlanqkServiceApi.BadRequestError(_response.error.body);
148
- case 401:
149
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
150
- case 403:
151
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
152
- case 404:
153
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
154
- case 500:
155
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
156
- default:
157
- throw new errors.PlanqkServiceApiError({
158
- statusCode: _response.error.statusCode,
159
- body: _response.error.body,
160
- });
161
- }
133
+ throw new errors.PlanqkServiceApiError({
134
+ statusCode: _response.error.statusCode,
135
+ body: _response.error.body,
136
+ rawResponse: _response.rawResponse,
137
+ });
162
138
  }
163
139
  switch (_response.error.reason) {
164
140
  case "non-json":
165
141
  throw new errors.PlanqkServiceApiError({
166
142
  statusCode: _response.error.statusCode,
167
143
  body: _response.error.rawBody,
144
+ rawResponse: _response.rawResponse,
168
145
  });
169
146
  case "timeout":
170
- throw new errors.PlanqkServiceApiTimeoutError();
147
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling POST /.");
171
148
  case "unknown":
172
149
  throw new errors.PlanqkServiceApiError({
173
150
  message: _response.error.errorMessage,
151
+ rawResponse: _response.rawResponse,
174
152
  });
175
153
  }
176
154
  }
177
155
  /**
178
- * This method checks the status of a service execution.
156
+ * Retrieves the status of a service execution.
157
+ * The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
179
158
  *
180
159
  * @param {string} id - The id of a service execution
181
160
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
182
161
  *
183
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
184
- * @throws {@link PlanqkServiceApi.ForbiddenError}
185
- * @throws {@link PlanqkServiceApi.NotFoundError}
186
- * @throws {@link PlanqkServiceApi.InternalServerError}
187
- *
188
162
  * @example
189
163
  * await client.serviceApi.getStatus("id")
190
164
  */
191
- async getStatus(id, requestOptions) {
165
+ getStatus(id, requestOptions) {
166
+ return core.HttpResponsePromise.fromPromise(this.__getStatus(id, requestOptions));
167
+ }
168
+ async __getStatus(id, requestOptions) {
192
169
  const _response = await core.fetcher({
193
- url: (0, url_join_1.default)((await core.Supplier.get(this._options.environment)) ??
170
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
171
+ (await core.Supplier.get(this._options.environment)) ??
194
172
  environments.PlanqkServiceApiEnvironment.Default, `${encodeURIComponent(id)}`),
195
173
  method: "GET",
196
- headers: {
197
- Authorization: await this._getAuthorizationHeader(),
198
- "X-Fern-Language": "JavaScript",
199
- "X-Fern-Runtime": core.RUNTIME.type,
200
- "X-Fern-Runtime-Version": core.RUNTIME.version,
201
- },
202
- contentType: "application/json",
203
- requestType: "json",
174
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
204
175
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
205
176
  maxRetries: requestOptions?.maxRetries,
206
177
  withCredentials: true,
207
178
  abortSignal: requestOptions?.abortSignal,
208
179
  });
209
180
  if (_response.ok) {
210
- return _response.body;
181
+ return { data: _response.body, rawResponse: _response.rawResponse };
211
182
  }
212
183
  if (_response.error.reason === "status-code") {
213
- switch (_response.error.statusCode) {
214
- case 401:
215
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
216
- case 403:
217
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
218
- case 404:
219
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
220
- case 500:
221
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
222
- default:
223
- throw new errors.PlanqkServiceApiError({
224
- statusCode: _response.error.statusCode,
225
- body: _response.error.body,
226
- });
227
- }
184
+ throw new errors.PlanqkServiceApiError({
185
+ statusCode: _response.error.statusCode,
186
+ body: _response.error.body,
187
+ rawResponse: _response.rawResponse,
188
+ });
228
189
  }
229
190
  switch (_response.error.reason) {
230
191
  case "non-json":
231
192
  throw new errors.PlanqkServiceApiError({
232
193
  statusCode: _response.error.statusCode,
233
194
  body: _response.error.rawBody,
195
+ rawResponse: _response.rawResponse,
234
196
  });
235
197
  case "timeout":
236
- throw new errors.PlanqkServiceApiTimeoutError();
198
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling GET /{id}.");
237
199
  case "unknown":
238
200
  throw new errors.PlanqkServiceApiError({
239
201
  message: _response.error.errorMessage,
202
+ rawResponse: _response.rawResponse,
240
203
  });
241
204
  }
242
205
  }
243
206
  /**
244
- * This method retrieves the result of a service execution.
207
+ * Retrieves the result of a service execution.
208
+ * The result is returned as a JSON object containing the status and any additional data.
209
+ * The result may include links to download specific result files.
245
210
  *
246
211
  * @param {string} id - The id of a service execution
247
212
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
248
213
  *
249
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
250
- * @throws {@link PlanqkServiceApi.ForbiddenError}
251
- * @throws {@link PlanqkServiceApi.NotFoundError}
252
- * @throws {@link PlanqkServiceApi.InternalServerError}
253
- *
254
214
  * @example
255
215
  * await client.serviceApi.getResult("id")
256
216
  */
257
- async getResult(id, requestOptions) {
217
+ getResult(id, requestOptions) {
218
+ return core.HttpResponsePromise.fromPromise(this.__getResult(id, requestOptions));
219
+ }
220
+ async __getResult(id, requestOptions) {
258
221
  const _response = await core.fetcher({
259
- url: (0, url_join_1.default)((await core.Supplier.get(this._options.environment)) ??
222
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
223
+ (await core.Supplier.get(this._options.environment)) ??
260
224
  environments.PlanqkServiceApiEnvironment.Default, `${encodeURIComponent(id)}/result`),
261
225
  method: "GET",
262
- headers: {
263
- Authorization: await this._getAuthorizationHeader(),
264
- "X-Fern-Language": "JavaScript",
265
- "X-Fern-Runtime": core.RUNTIME.type,
266
- "X-Fern-Runtime-Version": core.RUNTIME.version,
267
- },
268
- contentType: "application/json",
269
- requestType: "json",
226
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
270
227
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
271
228
  maxRetries: requestOptions?.maxRetries,
272
229
  withCredentials: true,
273
230
  abortSignal: requestOptions?.abortSignal,
274
231
  });
275
232
  if (_response.ok) {
276
- return _response.body;
233
+ return { data: _response.body, rawResponse: _response.rawResponse };
277
234
  }
278
235
  if (_response.error.reason === "status-code") {
279
- switch (_response.error.statusCode) {
280
- case 401:
281
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
282
- case 403:
283
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
284
- case 404:
285
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
286
- case 500:
287
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
288
- default:
289
- throw new errors.PlanqkServiceApiError({
290
- statusCode: _response.error.statusCode,
291
- body: _response.error.body,
292
- });
293
- }
236
+ throw new errors.PlanqkServiceApiError({
237
+ statusCode: _response.error.statusCode,
238
+ body: _response.error.body,
239
+ rawResponse: _response.rawResponse,
240
+ });
294
241
  }
295
242
  switch (_response.error.reason) {
296
243
  case "non-json":
297
244
  throw new errors.PlanqkServiceApiError({
298
245
  statusCode: _response.error.statusCode,
299
246
  body: _response.error.rawBody,
247
+ rawResponse: _response.rawResponse,
300
248
  });
301
249
  case "timeout":
302
- throw new errors.PlanqkServiceApiTimeoutError();
250
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling GET /{id}/result.");
303
251
  case "unknown":
304
252
  throw new errors.PlanqkServiceApiError({
305
253
  message: _response.error.errorMessage,
254
+ rawResponse: _response.rawResponse,
306
255
  });
307
256
  }
308
257
  }
309
258
  /**
310
- * This method downloads a result file of a service execution.
311
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
312
- * @throws {@link PlanqkServiceApi.ForbiddenError}
313
- * @throws {@link PlanqkServiceApi.NotFoundError}
314
- * @throws {@link PlanqkServiceApi.InternalServerError}
259
+ * Retrieves a specific result file of a service execution.
260
+ * The file name is provided in the path parameter.
261
+ * The result file is returned as a binary stream.
315
262
  */
316
- async getResultFile(id, file, requestOptions) {
263
+ getResultFile(id, file, requestOptions) {
264
+ return core.HttpResponsePromise.fromPromise(this.__getResultFile(id, file, requestOptions));
265
+ }
266
+ async __getResultFile(id, file, requestOptions) {
317
267
  const _response = await core.fetcher({
318
- url: (0, url_join_1.default)((await core.Supplier.get(this._options.environment)) ??
268
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
269
+ (await core.Supplier.get(this._options.environment)) ??
319
270
  environments.PlanqkServiceApiEnvironment.Default, `${encodeURIComponent(id)}/result/${encodeURIComponent(file)}`),
320
271
  method: "GET",
321
- headers: {
322
- Authorization: await this._getAuthorizationHeader(),
323
- "X-Fern-Language": "JavaScript",
324
- "X-Fern-Runtime": core.RUNTIME.type,
325
- "X-Fern-Runtime-Version": core.RUNTIME.version,
326
- },
327
- contentType: "application/json",
328
- requestType: "json",
329
- responseType: "streaming",
272
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
273
+ responseType: "binary-response",
330
274
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
331
275
  maxRetries: requestOptions?.maxRetries,
332
276
  withCredentials: true,
333
277
  abortSignal: requestOptions?.abortSignal,
334
278
  });
335
279
  if (_response.ok) {
336
- return _response.body;
280
+ return { data: _response.body, rawResponse: _response.rawResponse };
337
281
  }
338
282
  if (_response.error.reason === "status-code") {
339
- switch (_response.error.statusCode) {
340
- case 401:
341
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
342
- case 403:
343
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
344
- case 404:
345
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
346
- case 500:
347
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
348
- default:
349
- throw new errors.PlanqkServiceApiError({
350
- statusCode: _response.error.statusCode,
351
- body: _response.error.body,
352
- });
353
- }
283
+ throw new errors.PlanqkServiceApiError({
284
+ statusCode: _response.error.statusCode,
285
+ body: _response.error.body,
286
+ rawResponse: _response.rawResponse,
287
+ });
354
288
  }
355
289
  switch (_response.error.reason) {
356
290
  case "non-json":
357
291
  throw new errors.PlanqkServiceApiError({
358
292
  statusCode: _response.error.statusCode,
359
293
  body: _response.error.rawBody,
294
+ rawResponse: _response.rawResponse,
360
295
  });
361
296
  case "timeout":
362
- throw new errors.PlanqkServiceApiTimeoutError();
297
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling GET /{id}/result/{file}.");
363
298
  case "unknown":
364
299
  throw new errors.PlanqkServiceApiError({
365
300
  message: _response.error.errorMessage,
301
+ rawResponse: _response.rawResponse,
366
302
  });
367
303
  }
368
304
  }
369
305
  /**
370
- * This method retrieves the log output of a service execution.
306
+ * Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
371
307
  *
372
308
  * @param {string} id - The id of a service execution
373
309
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
374
310
  *
375
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
376
- * @throws {@link PlanqkServiceApi.ForbiddenError}
377
- * @throws {@link PlanqkServiceApi.NotFoundError}
378
- * @throws {@link PlanqkServiceApi.InternalServerError}
379
- *
380
311
  * @example
381
312
  * await client.serviceApi.getLogs("id")
382
313
  */
383
- async getLogs(id, requestOptions) {
314
+ getLogs(id, requestOptions) {
315
+ return core.HttpResponsePromise.fromPromise(this.__getLogs(id, requestOptions));
316
+ }
317
+ async __getLogs(id, requestOptions) {
384
318
  const _response = await core.fetcher({
385
- url: (0, url_join_1.default)((await core.Supplier.get(this._options.environment)) ??
319
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
320
+ (await core.Supplier.get(this._options.environment)) ??
386
321
  environments.PlanqkServiceApiEnvironment.Default, `${encodeURIComponent(id)}/log`),
387
322
  method: "GET",
388
- headers: {
389
- Authorization: await this._getAuthorizationHeader(),
390
- "X-Fern-Language": "JavaScript",
391
- "X-Fern-Runtime": core.RUNTIME.type,
392
- "X-Fern-Runtime-Version": core.RUNTIME.version,
393
- },
394
- contentType: "application/json",
395
- requestType: "json",
323
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
396
324
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
397
325
  maxRetries: requestOptions?.maxRetries,
398
326
  withCredentials: true,
399
327
  abortSignal: requestOptions?.abortSignal,
400
328
  });
401
329
  if (_response.ok) {
402
- return _response.body;
330
+ return { data: _response.body, rawResponse: _response.rawResponse };
403
331
  }
404
332
  if (_response.error.reason === "status-code") {
405
- switch (_response.error.statusCode) {
406
- case 401:
407
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
408
- case 403:
409
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
410
- case 404:
411
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
412
- case 500:
413
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
414
- default:
415
- throw new errors.PlanqkServiceApiError({
416
- statusCode: _response.error.statusCode,
417
- body: _response.error.body,
418
- });
419
- }
333
+ throw new errors.PlanqkServiceApiError({
334
+ statusCode: _response.error.statusCode,
335
+ body: _response.error.body,
336
+ rawResponse: _response.rawResponse,
337
+ });
420
338
  }
421
339
  switch (_response.error.reason) {
422
340
  case "non-json":
423
341
  throw new errors.PlanqkServiceApiError({
424
342
  statusCode: _response.error.statusCode,
425
343
  body: _response.error.rawBody,
344
+ rawResponse: _response.rawResponse,
426
345
  });
427
346
  case "timeout":
428
- throw new errors.PlanqkServiceApiTimeoutError();
347
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling GET /{id}/log.");
429
348
  case "unknown":
430
349
  throw new errors.PlanqkServiceApiError({
431
350
  message: _response.error.errorMessage,
351
+ rawResponse: _response.rawResponse,
432
352
  });
433
353
  }
434
354
  }
435
355
  /**
436
- * This method cancels a service execution.
356
+ * Cancel a pending or running service execution.
437
357
  *
438
358
  * @param {string} id - The id of a service execution
439
359
  * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
440
360
  *
441
- * @throws {@link PlanqkServiceApi.UnauthorizedError}
442
- * @throws {@link PlanqkServiceApi.ForbiddenError}
443
- * @throws {@link PlanqkServiceApi.NotFoundError}
444
- * @throws {@link PlanqkServiceApi.InternalServerError}
445
- *
446
361
  * @example
447
- * await client.serviceApi.cancel("id")
362
+ * await client.serviceApi.cancelExecution("id")
448
363
  */
449
- async cancel(id, requestOptions) {
364
+ cancelExecution(id, requestOptions) {
365
+ return core.HttpResponsePromise.fromPromise(this.__cancelExecution(id, requestOptions));
366
+ }
367
+ async __cancelExecution(id, requestOptions) {
450
368
  const _response = await core.fetcher({
451
- url: (0, url_join_1.default)((await core.Supplier.get(this._options.environment)) ??
369
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
370
+ (await core.Supplier.get(this._options.environment)) ??
452
371
  environments.PlanqkServiceApiEnvironment.Default, `${encodeURIComponent(id)}/cancel`),
453
372
  method: "PUT",
454
- headers: {
455
- Authorization: await this._getAuthorizationHeader(),
456
- "X-Fern-Language": "JavaScript",
457
- "X-Fern-Runtime": core.RUNTIME.type,
458
- "X-Fern-Runtime-Version": core.RUNTIME.version,
459
- },
460
- contentType: "application/json",
461
- requestType: "json",
373
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions?.headers),
462
374
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
463
375
  maxRetries: requestOptions?.maxRetries,
464
376
  withCredentials: true,
465
377
  abortSignal: requestOptions?.abortSignal,
466
378
  });
467
379
  if (_response.ok) {
468
- return _response.body;
380
+ return { data: _response.body, rawResponse: _response.rawResponse };
469
381
  }
470
382
  if (_response.error.reason === "status-code") {
471
- switch (_response.error.statusCode) {
472
- case 401:
473
- throw new PlanqkServiceApi.UnauthorizedError(_response.error.body);
474
- case 403:
475
- throw new PlanqkServiceApi.ForbiddenError(_response.error.body);
476
- case 404:
477
- throw new PlanqkServiceApi.NotFoundError(_response.error.body);
478
- case 500:
479
- throw new PlanqkServiceApi.InternalServerError(_response.error.body);
480
- default:
481
- throw new errors.PlanqkServiceApiError({
482
- statusCode: _response.error.statusCode,
483
- body: _response.error.body,
484
- });
485
- }
383
+ throw new errors.PlanqkServiceApiError({
384
+ statusCode: _response.error.statusCode,
385
+ body: _response.error.body,
386
+ rawResponse: _response.rawResponse,
387
+ });
486
388
  }
487
389
  switch (_response.error.reason) {
488
390
  case "non-json":
489
391
  throw new errors.PlanqkServiceApiError({
490
392
  statusCode: _response.error.statusCode,
491
393
  body: _response.error.rawBody,
394
+ rawResponse: _response.rawResponse,
492
395
  });
493
396
  case "timeout":
494
- throw new errors.PlanqkServiceApiTimeoutError();
397
+ throw new errors.PlanqkServiceApiTimeoutError("Timeout exceeded when calling PUT /{id}/cancel.");
495
398
  case "unknown":
496
399
  throw new errors.PlanqkServiceApiError({
497
400
  message: _response.error.errorMessage,
401
+ rawResponse: _response.rawResponse,
498
402
  });
499
403
  }
500
404
  }
@@ -1,2 +1,2 @@
1
- export * from "./types";
2
- export * from "./client";
1
+ export * from "./types/index.js";
2
+ export * from "./client/index.js";
@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./types"), exports);
18
- __exportStar(require("./client"), exports);
17
+ __exportStar(require("./types/index.js"), exports);
18
+ __exportStar(require("./client/index.js"), exports);
@@ -1,8 +1,18 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- import * as PlanqkServiceApi from "../../../index";
4
+ import * as PlanqkServiceApi from "../../../index.js";
5
5
  export interface GetResultResponse {
6
- _links?: PlanqkServiceApi.GetResultResponseLinks;
7
- _embedded?: PlanqkServiceApi.GetResultResponseEmbedded;
6
+ _links?: GetResultResponse.Links;
7
+ _embedded?: GetResultResponse.Embedded;
8
+ /** Accepts any additional properties */
9
+ [key: string]: any;
10
+ }
11
+ export declare namespace GetResultResponse {
12
+ interface Links {
13
+ status?: PlanqkServiceApi.HalLink;
14
+ }
15
+ interface Embedded {
16
+ status?: PlanqkServiceApi.ServiceExecution;
17
+ }
8
18
  }
@@ -1,4 +1 @@
1
- export * from "./HealthCheckResponse";
2
- export * from "./GetResultResponseLinks";
3
- export * from "./GetResultResponseEmbedded";
4
- export * from "./GetResultResponse";
1
+ export * from "./GetResultResponse.js";
@@ -14,7 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./HealthCheckResponse"), exports);
18
- __exportStar(require("./GetResultResponseLinks"), exports);
19
- __exportStar(require("./GetResultResponseEmbedded"), exports);
20
- __exportStar(require("./GetResultResponse"), exports);
17
+ __exportStar(require("./GetResultResponse.js"), exports);