@planqk/planqk-api-sdk 1.9.3 → 1.9.4

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 (165) hide show
  1. package/README-node.md +17 -0
  2. package/README-python.md +17 -0
  3. package/README.md +66 -6
  4. package/package.json +1 -1
  5. package/pyproject.toml +1 -1
  6. package/uv.lock +1 -1
  7. package/.gitlab-ci.yml +0 -110
  8. package/dist/index.d.ts +0 -1
  9. package/dist/index.js +0 -17
  10. package/dist/sdk/Client.d.ts +0 -44
  11. package/dist/sdk/Client.js +0 -71
  12. package/dist/sdk/api/errors/BadRequestError.d.ts +0 -8
  13. package/dist/sdk/api/errors/BadRequestError.js +0 -52
  14. package/dist/sdk/api/errors/ForbiddenError.d.ts +0 -8
  15. package/dist/sdk/api/errors/ForbiddenError.js +0 -52
  16. package/dist/sdk/api/errors/InternalServerError.d.ts +0 -8
  17. package/dist/sdk/api/errors/InternalServerError.js +0 -52
  18. package/dist/sdk/api/errors/NotFoundError.d.ts +0 -8
  19. package/dist/sdk/api/errors/NotFoundError.js +0 -52
  20. package/dist/sdk/api/errors/UnauthorizedError.d.ts +0 -8
  21. package/dist/sdk/api/errors/UnauthorizedError.js +0 -52
  22. package/dist/sdk/api/errors/index.d.ts +0 -5
  23. package/dist/sdk/api/errors/index.js +0 -21
  24. package/dist/sdk/api/index.d.ts +0 -3
  25. package/dist/sdk/api/index.js +0 -19
  26. package/dist/sdk/api/resources/dataPools/client/Client.d.ts +0 -187
  27. package/dist/sdk/api/resources/dataPools/client/Client.js +0 -722
  28. package/dist/sdk/api/resources/dataPools/client/index.d.ts +0 -2
  29. package/dist/sdk/api/resources/dataPools/client/index.js +0 -17
  30. package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts +0 -14
  31. package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.js +0 -5
  32. package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts +0 -11
  33. package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.js +0 -5
  34. package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts +0 -15
  35. package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.js +0 -5
  36. package/dist/sdk/api/resources/dataPools/client/requests/index.d.ts +0 -3
  37. package/dist/sdk/api/resources/dataPools/client/requests/index.js +0 -2
  38. package/dist/sdk/api/resources/dataPools/index.d.ts +0 -1
  39. package/dist/sdk/api/resources/dataPools/index.js +0 -17
  40. package/dist/sdk/api/resources/index.d.ts +0 -5
  41. package/dist/sdk/api/resources/index.js +0 -44
  42. package/dist/sdk/api/resources/serviceExecutions/client/Client.d.ts +0 -90
  43. package/dist/sdk/api/resources/serviceExecutions/client/Client.js +0 -271
  44. package/dist/sdk/api/resources/serviceExecutions/client/index.d.ts +0 -1
  45. package/dist/sdk/api/resources/serviceExecutions/client/index.js +0 -2
  46. package/dist/sdk/api/resources/serviceExecutions/index.d.ts +0 -1
  47. package/dist/sdk/api/resources/serviceExecutions/index.js +0 -17
  48. package/dist/sdk/api/resources/serviceJobs/client/Client.d.ts +0 -138
  49. package/dist/sdk/api/resources/serviceJobs/client/Client.js +0 -489
  50. package/dist/sdk/api/resources/serviceJobs/client/index.d.ts +0 -2
  51. package/dist/sdk/api/resources/serviceJobs/client/index.js +0 -17
  52. package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.d.ts +0 -15
  53. package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.js +0 -5
  54. package/dist/sdk/api/resources/serviceJobs/client/requests/index.d.ts +0 -1
  55. package/dist/sdk/api/resources/serviceJobs/client/requests/index.js +0 -2
  56. package/dist/sdk/api/resources/serviceJobs/index.d.ts +0 -1
  57. package/dist/sdk/api/resources/serviceJobs/index.js +0 -17
  58. package/dist/sdk/api/types/ActivityInstance.d.ts +0 -20
  59. package/dist/sdk/api/types/ActivityInstance.js +0 -14
  60. package/dist/sdk/api/types/DataPoolDto.d.ts +0 -28
  61. package/dist/sdk/api/types/DataPoolDto.js +0 -14
  62. package/dist/sdk/api/types/DataPoolFileDto.d.ts +0 -19
  63. package/dist/sdk/api/types/DataPoolFileDto.js +0 -5
  64. package/dist/sdk/api/types/LogEntry.d.ts +0 -24
  65. package/dist/sdk/api/types/LogEntry.js +0 -16
  66. package/dist/sdk/api/types/MetricDataPoint.d.ts +0 -12
  67. package/dist/sdk/api/types/MetricDataPoint.js +0 -5
  68. package/dist/sdk/api/types/OauthScope.d.ts +0 -9
  69. package/dist/sdk/api/types/OauthScope.js +0 -9
  70. package/dist/sdk/api/types/ServiceExecutionDto.d.ts +0 -21
  71. package/dist/sdk/api/types/ServiceExecutionDto.js +0 -17
  72. package/dist/sdk/api/types/ServiceExecutionLogs.d.ts +0 -5
  73. package/dist/sdk/api/types/ServiceExecutionLogs.js +0 -5
  74. package/dist/sdk/api/types/ServiceExecutionMetrics.d.ts +0 -23
  75. package/dist/sdk/api/types/ServiceExecutionMetrics.js +0 -5
  76. package/dist/sdk/api/types/ServiceJobDto.d.ts +0 -46
  77. package/dist/sdk/api/types/ServiceJobDto.js +0 -22
  78. package/dist/sdk/api/types/VariableInstance.d.ts +0 -9
  79. package/dist/sdk/api/types/VariableInstance.js +0 -5
  80. package/dist/sdk/api/types/WorkflowInstance.d.ts +0 -23
  81. package/dist/sdk/api/types/WorkflowInstance.js +0 -17
  82. package/dist/sdk/api/types/WorkflowServiceExecutionDto.d.ts +0 -8
  83. package/dist/sdk/api/types/WorkflowServiceExecutionDto.js +0 -5
  84. package/dist/sdk/api/types/index.d.ts +0 -13
  85. package/dist/sdk/api/types/index.js +0 -29
  86. package/dist/sdk/core/exports.d.ts +0 -1
  87. package/dist/sdk/core/exports.js +0 -17
  88. package/dist/sdk/core/fetcher/APIResponse.d.ts +0 -20
  89. package/dist/sdk/core/fetcher/APIResponse.js +0 -2
  90. package/dist/sdk/core/fetcher/BinaryResponse.d.ts +0 -20
  91. package/dist/sdk/core/fetcher/BinaryResponse.js +0 -17
  92. package/dist/sdk/core/fetcher/Fetcher.d.ts +0 -40
  93. package/dist/sdk/core/fetcher/Fetcher.js +0 -105
  94. package/dist/sdk/core/fetcher/Headers.d.ts +0 -2
  95. package/dist/sdk/core/fetcher/Headers.js +0 -85
  96. package/dist/sdk/core/fetcher/HttpResponsePromise.d.ts +0 -58
  97. package/dist/sdk/core/fetcher/HttpResponsePromise.js +0 -94
  98. package/dist/sdk/core/fetcher/RawResponse.d.ts +0 -29
  99. package/dist/sdk/core/fetcher/RawResponse.js +0 -44
  100. package/dist/sdk/core/fetcher/ResponseWithBody.d.ts +0 -4
  101. package/dist/sdk/core/fetcher/ResponseWithBody.js +0 -6
  102. package/dist/sdk/core/fetcher/Supplier.d.ts +0 -4
  103. package/dist/sdk/core/fetcher/Supplier.js +0 -13
  104. package/dist/sdk/core/fetcher/createRequestUrl.d.ts +0 -1
  105. package/dist/sdk/core/fetcher/createRequestUrl.js +0 -8
  106. package/dist/sdk/core/fetcher/getErrorResponseBody.d.ts +0 -1
  107. package/dist/sdk/core/fetcher/getErrorResponseBody.js +0 -32
  108. package/dist/sdk/core/fetcher/getFetchFn.d.ts +0 -1
  109. package/dist/sdk/core/fetcher/getFetchFn.js +0 -6
  110. package/dist/sdk/core/fetcher/getHeader.d.ts +0 -1
  111. package/dist/sdk/core/fetcher/getHeader.js +0 -11
  112. package/dist/sdk/core/fetcher/getRequestBody.d.ts +0 -7
  113. package/dist/sdk/core/fetcher/getRequestBody.js +0 -12
  114. package/dist/sdk/core/fetcher/getResponseBody.d.ts +0 -1
  115. package/dist/sdk/core/fetcher/getResponseBody.js +0 -44
  116. package/dist/sdk/core/fetcher/index.d.ts +0 -9
  117. package/dist/sdk/core/fetcher/index.js +0 -15
  118. package/dist/sdk/core/fetcher/makeRequest.d.ts +0 -1
  119. package/dist/sdk/core/fetcher/makeRequest.js +0 -33
  120. package/dist/sdk/core/fetcher/requestWithRetries.d.ts +0 -1
  121. package/dist/sdk/core/fetcher/requestWithRetries.js +0 -29
  122. package/dist/sdk/core/fetcher/signals.d.ts +0 -11
  123. package/dist/sdk/core/fetcher/signals.js +0 -36
  124. package/dist/sdk/core/file/exports.d.ts +0 -1
  125. package/dist/sdk/core/file/exports.js +0 -2
  126. package/dist/sdk/core/file/file.d.ts +0 -5
  127. package/dist/sdk/core/file/file.js +0 -185
  128. package/dist/sdk/core/file/index.d.ts +0 -2
  129. package/dist/sdk/core/file/index.js +0 -18
  130. package/dist/sdk/core/file/types.d.ts +0 -66
  131. package/dist/sdk/core/file/types.js +0 -2
  132. package/dist/sdk/core/form-data-utils/FormDataWrapper.d.ts +0 -16
  133. package/dist/sdk/core/form-data-utils/FormDataWrapper.js +0 -175
  134. package/dist/sdk/core/form-data-utils/encodeAsFormParameter.d.ts +0 -1
  135. package/dist/sdk/core/form-data-utils/encodeAsFormParameter.js +0 -12
  136. package/dist/sdk/core/form-data-utils/index.d.ts +0 -2
  137. package/dist/sdk/core/form-data-utils/index.js +0 -20
  138. package/dist/sdk/core/headers.d.ts +0 -3
  139. package/dist/sdk/core/headers.js +0 -29
  140. package/dist/sdk/core/index.d.ts +0 -5
  141. package/dist/sdk/core/index.js +0 -44
  142. package/dist/sdk/core/json.d.ts +0 -15
  143. package/dist/sdk/core/json.js +0 -24
  144. package/dist/sdk/core/runtime/index.d.ts +0 -1
  145. package/dist/sdk/core/runtime/index.js +0 -5
  146. package/dist/sdk/core/runtime/runtime.d.ts +0 -9
  147. package/dist/sdk/core/runtime/runtime.js +0 -101
  148. package/dist/sdk/core/url/index.d.ts +0 -2
  149. package/dist/sdk/core/url/index.js +0 -7
  150. package/dist/sdk/core/url/join.d.ts +0 -1
  151. package/dist/sdk/core/url/join.js +0 -69
  152. package/dist/sdk/core/url/qs.d.ts +0 -6
  153. package/dist/sdk/core/url/qs.js +0 -67
  154. package/dist/sdk/environments.d.ts +0 -7
  155. package/dist/sdk/environments.js +0 -9
  156. package/dist/sdk/errors/PlanqkApiError.d.ts +0 -15
  157. package/dist/sdk/errors/PlanqkApiError.js +0 -33
  158. package/dist/sdk/errors/PlanqkApiTimeoutError.d.ts +0 -6
  159. package/dist/sdk/errors/PlanqkApiTimeoutError.js +0 -13
  160. package/dist/sdk/errors/index.d.ts +0 -2
  161. package/dist/sdk/errors/index.js +0 -7
  162. package/dist/sdk/exports.d.ts +0 -1
  163. package/dist/sdk/exports.js +0 -17
  164. package/dist/sdk/index.d.ts +0 -5
  165. package/dist/sdk/index.js +0 -48
@@ -1,138 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../environments.js";
5
- import * as core from "../../../../core/index.js";
6
- import * as PlanqkApi from "../../../index.js";
7
- export declare namespace ServiceJobs {
8
- interface Options {
9
- environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
13
- /** Override the X-OrganizationId header */
14
- organizationId?: core.Supplier<string | undefined>;
15
- /** Additional headers to include in requests. */
16
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
17
- }
18
- interface RequestOptions {
19
- /** The maximum time to wait for a response in seconds. */
20
- timeoutInSeconds?: number;
21
- /** The number of times to retry the request. Defaults to 2. */
22
- maxRetries?: number;
23
- /** A hook to abort the request. */
24
- abortSignal?: AbortSignal;
25
- /** Override the X-OrganizationId header */
26
- organizationId?: string | undefined;
27
- /** Additional query string parameters to include in the request. */
28
- queryParams?: Record<string, unknown>;
29
- /** Additional headers to include in the request. */
30
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
31
- }
32
- }
33
- /**
34
- * Run your created services in a job-based manner. Service jobs allow you to execute services with specific parameters and track their execution status, costs, logs, metrics, and results.
35
- */
36
- export declare class ServiceJobs {
37
- protected readonly _options: ServiceJobs.Options;
38
- constructor(_options: ServiceJobs.Options);
39
- /**
40
- * Cancel a specific service job (identified by its ID). Only service jobs that are pending or currently running can be cancelled.
41
- *
42
- * @param {string} id
43
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
44
- *
45
- * @throws {@link PlanqkApi.UnauthorizedError}
46
- * @throws {@link PlanqkApi.ForbiddenError}
47
- * @throws {@link PlanqkApi.NotFoundError}
48
- * @throws {@link PlanqkApi.InternalServerError}
49
- *
50
- * @example
51
- * await client.serviceJobs.cancelServiceJob("id")
52
- */
53
- cancelServiceJob(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<void>;
54
- private __cancelServiceJob;
55
- /**
56
- * Get a list of all service jobs for the current user or organization.
57
- *
58
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
59
- *
60
- * @throws {@link PlanqkApi.UnauthorizedError}
61
- * @throws {@link PlanqkApi.ForbiddenError}
62
- * @throws {@link PlanqkApi.NotFoundError}
63
- * @throws {@link PlanqkApi.InternalServerError}
64
- *
65
- * @example
66
- * await client.serviceJobs.getServiceJobs()
67
- */
68
- getServiceJobs(requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto[]>;
69
- private __getServiceJobs;
70
- /**
71
- * Create and start a new service job.
72
- *
73
- * @param {PlanqkApi.CreateServiceJobRequest} request
74
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
75
- *
76
- * @throws {@link PlanqkApi.BadRequestError}
77
- * @throws {@link PlanqkApi.UnauthorizedError}
78
- * @throws {@link PlanqkApi.ForbiddenError}
79
- * @throws {@link PlanqkApi.NotFoundError}
80
- * @throws {@link PlanqkApi.InternalServerError}
81
- *
82
- * @example
83
- * await client.serviceJobs.createServiceJob()
84
- */
85
- createServiceJob(request?: PlanqkApi.CreateServiceJobRequest, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto>;
86
- private __createServiceJob;
87
- /**
88
- * Get a specific service job (identified by its ID).
89
- *
90
- * @param {string} id
91
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
92
- *
93
- * @throws {@link PlanqkApi.UnauthorizedError}
94
- * @throws {@link PlanqkApi.ForbiddenError}
95
- * @throws {@link PlanqkApi.NotFoundError}
96
- * @throws {@link PlanqkApi.InternalServerError}
97
- *
98
- * @example
99
- * await client.serviceJobs.getServiceJob("id")
100
- */
101
- getServiceJob(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto>;
102
- private __getServiceJob;
103
- /**
104
- * Get the results for a specific service job (identified by its ID). If the service job has not completed yet or no results are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
105
- *
106
- * @param {string} id
107
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
108
- *
109
- * @throws {@link PlanqkApi.UnauthorizedError}
110
- * @throws {@link PlanqkApi.ForbiddenError}
111
- * @throws {@link PlanqkApi.NotFoundError}
112
- * @throws {@link PlanqkApi.InternalServerError}
113
- *
114
- * @example
115
- * await client.serviceJobs.getServiceJobResults("id")
116
- */
117
- getServiceJobResults(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<Record<string, any>>;
118
- private __getServiceJobResults;
119
- /**
120
- * Get the logs for a specific service job (identified by its ID). If the service job has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
121
- *
122
- * @param {string} id
123
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
124
- *
125
- * @throws {@link PlanqkApi.UnauthorizedError}
126
- * @throws {@link PlanqkApi.ForbiddenError}
127
- * @throws {@link PlanqkApi.NotFoundError}
128
- * @throws {@link PlanqkApi.InternalServerError}
129
- *
130
- * @example
131
- * await client.serviceJobs.getServiceJobLogs("id")
132
- */
133
- getServiceJobLogs(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceExecutionLogs>;
134
- private __getServiceJobLogs;
135
- protected _getCustomAuthorizationHeaders(): Promise<{
136
- "X-Auth-Token": string;
137
- }>;
138
- }
@@ -1,489 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
- desc = { enumerable: true, get: function() { return m[k]; } };
10
- }
11
- Object.defineProperty(o, k2, desc);
12
- }) : (function(o, m, k, k2) {
13
- if (k2 === undefined) k2 = k;
14
- o[k2] = m[k];
15
- }));
16
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
- Object.defineProperty(o, "default", { enumerable: true, value: v });
18
- }) : function(o, v) {
19
- o["default"] = v;
20
- });
21
- var __importStar = (this && this.__importStar) || (function () {
22
- var ownKeys = function(o) {
23
- ownKeys = Object.getOwnPropertyNames || function (o) {
24
- var ar = [];
25
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
- return ar;
27
- };
28
- return ownKeys(o);
29
- };
30
- return function (mod) {
31
- if (mod && mod.__esModule) return mod;
32
- var result = {};
33
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
- __setModuleDefault(result, mod);
35
- return result;
36
- };
37
- })();
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.ServiceJobs = void 0;
40
- const environments = __importStar(require("../../../../environments.js"));
41
- const core = __importStar(require("../../../../core/index.js"));
42
- const PlanqkApi = __importStar(require("../../../index.js"));
43
- const headers_js_1 = require("../../../../core/headers.js");
44
- const errors = __importStar(require("../../../../errors/index.js"));
45
- /**
46
- * Run your created services in a job-based manner. Service jobs allow you to execute services with specific parameters and track their execution status, costs, logs, metrics, and results.
47
- */
48
- class ServiceJobs {
49
- _options;
50
- constructor(_options) {
51
- this._options = _options;
52
- }
53
- /**
54
- * Cancel a specific service job (identified by its ID). Only service jobs that are pending or currently running can be cancelled.
55
- *
56
- * @param {string} id
57
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
58
- *
59
- * @throws {@link PlanqkApi.UnauthorizedError}
60
- * @throws {@link PlanqkApi.ForbiddenError}
61
- * @throws {@link PlanqkApi.NotFoundError}
62
- * @throws {@link PlanqkApi.InternalServerError}
63
- *
64
- * @example
65
- * await client.serviceJobs.cancelServiceJob("id")
66
- */
67
- cancelServiceJob(id, requestOptions) {
68
- return core.HttpResponsePromise.fromPromise(this.__cancelServiceJob(id, requestOptions));
69
- }
70
- async __cancelServiceJob(id, requestOptions) {
71
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
72
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
73
- ...(await this._getCustomAuthorizationHeaders()),
74
- }), requestOptions?.headers);
75
- const _response = await core.fetcher({
76
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
77
- (await core.Supplier.get(this._options.environment)) ??
78
- environments.PlanqkApiEnvironment.Default, `service-jobs/${encodeURIComponent(id)}/cancel`),
79
- method: "PUT",
80
- headers: _headers,
81
- queryParameters: requestOptions?.queryParams,
82
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
83
- maxRetries: requestOptions?.maxRetries,
84
- withCredentials: true,
85
- abortSignal: requestOptions?.abortSignal,
86
- });
87
- if (_response.ok) {
88
- return { data: undefined, rawResponse: _response.rawResponse };
89
- }
90
- if (_response.error.reason === "status-code") {
91
- switch (_response.error.statusCode) {
92
- case 401:
93
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
94
- case 403:
95
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
96
- case 404:
97
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
98
- case 500:
99
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
100
- default:
101
- throw new errors.PlanqkApiError({
102
- statusCode: _response.error.statusCode,
103
- body: _response.error.body,
104
- rawResponse: _response.rawResponse,
105
- });
106
- }
107
- }
108
- switch (_response.error.reason) {
109
- case "non-json":
110
- throw new errors.PlanqkApiError({
111
- statusCode: _response.error.statusCode,
112
- body: _response.error.rawBody,
113
- rawResponse: _response.rawResponse,
114
- });
115
- case "timeout":
116
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling PUT /service-jobs/{id}/cancel.");
117
- case "unknown":
118
- throw new errors.PlanqkApiError({
119
- message: _response.error.errorMessage,
120
- rawResponse: _response.rawResponse,
121
- });
122
- }
123
- }
124
- /**
125
- * Get a list of all service jobs for the current user or organization.
126
- *
127
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
128
- *
129
- * @throws {@link PlanqkApi.UnauthorizedError}
130
- * @throws {@link PlanqkApi.ForbiddenError}
131
- * @throws {@link PlanqkApi.NotFoundError}
132
- * @throws {@link PlanqkApi.InternalServerError}
133
- *
134
- * @example
135
- * await client.serviceJobs.getServiceJobs()
136
- */
137
- getServiceJobs(requestOptions) {
138
- return core.HttpResponsePromise.fromPromise(this.__getServiceJobs(requestOptions));
139
- }
140
- async __getServiceJobs(requestOptions) {
141
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
142
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
143
- ...(await this._getCustomAuthorizationHeaders()),
144
- }), requestOptions?.headers);
145
- const _response = await core.fetcher({
146
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
147
- (await core.Supplier.get(this._options.environment)) ??
148
- environments.PlanqkApiEnvironment.Default, "service-jobs"),
149
- method: "GET",
150
- headers: _headers,
151
- queryParameters: requestOptions?.queryParams,
152
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
153
- maxRetries: requestOptions?.maxRetries,
154
- withCredentials: true,
155
- abortSignal: requestOptions?.abortSignal,
156
- });
157
- if (_response.ok) {
158
- return { data: _response.body, rawResponse: _response.rawResponse };
159
- }
160
- if (_response.error.reason === "status-code") {
161
- switch (_response.error.statusCode) {
162
- case 401:
163
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
164
- case 403:
165
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
166
- case 404:
167
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
168
- case 500:
169
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
170
- default:
171
- throw new errors.PlanqkApiError({
172
- statusCode: _response.error.statusCode,
173
- body: _response.error.body,
174
- rawResponse: _response.rawResponse,
175
- });
176
- }
177
- }
178
- switch (_response.error.reason) {
179
- case "non-json":
180
- throw new errors.PlanqkApiError({
181
- statusCode: _response.error.statusCode,
182
- body: _response.error.rawBody,
183
- rawResponse: _response.rawResponse,
184
- });
185
- case "timeout":
186
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-jobs.");
187
- case "unknown":
188
- throw new errors.PlanqkApiError({
189
- message: _response.error.errorMessage,
190
- rawResponse: _response.rawResponse,
191
- });
192
- }
193
- }
194
- /**
195
- * Create and start a new service job.
196
- *
197
- * @param {PlanqkApi.CreateServiceJobRequest} request
198
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
199
- *
200
- * @throws {@link PlanqkApi.BadRequestError}
201
- * @throws {@link PlanqkApi.UnauthorizedError}
202
- * @throws {@link PlanqkApi.ForbiddenError}
203
- * @throws {@link PlanqkApi.NotFoundError}
204
- * @throws {@link PlanqkApi.InternalServerError}
205
- *
206
- * @example
207
- * await client.serviceJobs.createServiceJob()
208
- */
209
- createServiceJob(request = {}, requestOptions) {
210
- return core.HttpResponsePromise.fromPromise(this.__createServiceJob(request, requestOptions));
211
- }
212
- async __createServiceJob(request = {}, requestOptions) {
213
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
214
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
215
- ...(await this._getCustomAuthorizationHeaders()),
216
- }), requestOptions?.headers);
217
- const _response = await core.fetcher({
218
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
219
- (await core.Supplier.get(this._options.environment)) ??
220
- environments.PlanqkApiEnvironment.Default, "service-jobs"),
221
- method: "POST",
222
- headers: _headers,
223
- contentType: "application/json",
224
- queryParameters: requestOptions?.queryParams,
225
- requestType: "json",
226
- body: request,
227
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
228
- maxRetries: requestOptions?.maxRetries,
229
- withCredentials: true,
230
- abortSignal: requestOptions?.abortSignal,
231
- });
232
- if (_response.ok) {
233
- return { data: _response.body, rawResponse: _response.rawResponse };
234
- }
235
- if (_response.error.reason === "status-code") {
236
- switch (_response.error.statusCode) {
237
- case 400:
238
- throw new PlanqkApi.BadRequestError(_response.error.body, _response.rawResponse);
239
- case 401:
240
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
241
- case 403:
242
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
243
- case 404:
244
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
245
- case 500:
246
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
247
- default:
248
- throw new errors.PlanqkApiError({
249
- statusCode: _response.error.statusCode,
250
- body: _response.error.body,
251
- rawResponse: _response.rawResponse,
252
- });
253
- }
254
- }
255
- switch (_response.error.reason) {
256
- case "non-json":
257
- throw new errors.PlanqkApiError({
258
- statusCode: _response.error.statusCode,
259
- body: _response.error.rawBody,
260
- rawResponse: _response.rawResponse,
261
- });
262
- case "timeout":
263
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling POST /service-jobs.");
264
- case "unknown":
265
- throw new errors.PlanqkApiError({
266
- message: _response.error.errorMessage,
267
- rawResponse: _response.rawResponse,
268
- });
269
- }
270
- }
271
- /**
272
- * Get a specific service job (identified by its ID).
273
- *
274
- * @param {string} id
275
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
276
- *
277
- * @throws {@link PlanqkApi.UnauthorizedError}
278
- * @throws {@link PlanqkApi.ForbiddenError}
279
- * @throws {@link PlanqkApi.NotFoundError}
280
- * @throws {@link PlanqkApi.InternalServerError}
281
- *
282
- * @example
283
- * await client.serviceJobs.getServiceJob("id")
284
- */
285
- getServiceJob(id, requestOptions) {
286
- return core.HttpResponsePromise.fromPromise(this.__getServiceJob(id, requestOptions));
287
- }
288
- async __getServiceJob(id, requestOptions) {
289
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
290
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
291
- ...(await this._getCustomAuthorizationHeaders()),
292
- }), requestOptions?.headers);
293
- const _response = await core.fetcher({
294
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
295
- (await core.Supplier.get(this._options.environment)) ??
296
- environments.PlanqkApiEnvironment.Default, `service-jobs/${encodeURIComponent(id)}`),
297
- method: "GET",
298
- headers: _headers,
299
- queryParameters: requestOptions?.queryParams,
300
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
301
- maxRetries: requestOptions?.maxRetries,
302
- withCredentials: true,
303
- abortSignal: requestOptions?.abortSignal,
304
- });
305
- if (_response.ok) {
306
- return { data: _response.body, rawResponse: _response.rawResponse };
307
- }
308
- if (_response.error.reason === "status-code") {
309
- switch (_response.error.statusCode) {
310
- case 401:
311
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
312
- case 403:
313
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
314
- case 404:
315
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
316
- case 500:
317
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
318
- default:
319
- throw new errors.PlanqkApiError({
320
- statusCode: _response.error.statusCode,
321
- body: _response.error.body,
322
- rawResponse: _response.rawResponse,
323
- });
324
- }
325
- }
326
- switch (_response.error.reason) {
327
- case "non-json":
328
- throw new errors.PlanqkApiError({
329
- statusCode: _response.error.statusCode,
330
- body: _response.error.rawBody,
331
- rawResponse: _response.rawResponse,
332
- });
333
- case "timeout":
334
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-jobs/{id}.");
335
- case "unknown":
336
- throw new errors.PlanqkApiError({
337
- message: _response.error.errorMessage,
338
- rawResponse: _response.rawResponse,
339
- });
340
- }
341
- }
342
- /**
343
- * Get the results for a specific service job (identified by its ID). If the service job has not completed yet or no results are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
344
- *
345
- * @param {string} id
346
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
347
- *
348
- * @throws {@link PlanqkApi.UnauthorizedError}
349
- * @throws {@link PlanqkApi.ForbiddenError}
350
- * @throws {@link PlanqkApi.NotFoundError}
351
- * @throws {@link PlanqkApi.InternalServerError}
352
- *
353
- * @example
354
- * await client.serviceJobs.getServiceJobResults("id")
355
- */
356
- getServiceJobResults(id, requestOptions) {
357
- return core.HttpResponsePromise.fromPromise(this.__getServiceJobResults(id, requestOptions));
358
- }
359
- async __getServiceJobResults(id, requestOptions) {
360
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
361
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
362
- ...(await this._getCustomAuthorizationHeaders()),
363
- }), requestOptions?.headers);
364
- const _response = await core.fetcher({
365
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
366
- (await core.Supplier.get(this._options.environment)) ??
367
- environments.PlanqkApiEnvironment.Default, `service-jobs/${encodeURIComponent(id)}/results`),
368
- method: "GET",
369
- headers: _headers,
370
- queryParameters: requestOptions?.queryParams,
371
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
372
- maxRetries: requestOptions?.maxRetries,
373
- withCredentials: true,
374
- abortSignal: requestOptions?.abortSignal,
375
- });
376
- if (_response.ok) {
377
- return { data: _response.body, rawResponse: _response.rawResponse };
378
- }
379
- if (_response.error.reason === "status-code") {
380
- switch (_response.error.statusCode) {
381
- case 401:
382
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
383
- case 403:
384
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
385
- case 404:
386
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
387
- case 500:
388
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
389
- default:
390
- throw new errors.PlanqkApiError({
391
- statusCode: _response.error.statusCode,
392
- body: _response.error.body,
393
- rawResponse: _response.rawResponse,
394
- });
395
- }
396
- }
397
- switch (_response.error.reason) {
398
- case "non-json":
399
- throw new errors.PlanqkApiError({
400
- statusCode: _response.error.statusCode,
401
- body: _response.error.rawBody,
402
- rawResponse: _response.rawResponse,
403
- });
404
- case "timeout":
405
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-jobs/{id}/results.");
406
- case "unknown":
407
- throw new errors.PlanqkApiError({
408
- message: _response.error.errorMessage,
409
- rawResponse: _response.rawResponse,
410
- });
411
- }
412
- }
413
- /**
414
- * Get the logs for a specific service job (identified by its ID). If the service job has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
415
- *
416
- * @param {string} id
417
- * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
418
- *
419
- * @throws {@link PlanqkApi.UnauthorizedError}
420
- * @throws {@link PlanqkApi.ForbiddenError}
421
- * @throws {@link PlanqkApi.NotFoundError}
422
- * @throws {@link PlanqkApi.InternalServerError}
423
- *
424
- * @example
425
- * await client.serviceJobs.getServiceJobLogs("id")
426
- */
427
- getServiceJobLogs(id, requestOptions) {
428
- return core.HttpResponsePromise.fromPromise(this.__getServiceJobLogs(id, requestOptions));
429
- }
430
- async __getServiceJobLogs(id, requestOptions) {
431
- let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
432
- "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
433
- ...(await this._getCustomAuthorizationHeaders()),
434
- }), requestOptions?.headers);
435
- const _response = await core.fetcher({
436
- url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
437
- (await core.Supplier.get(this._options.environment)) ??
438
- environments.PlanqkApiEnvironment.Default, `service-jobs/${encodeURIComponent(id)}/logs`),
439
- method: "GET",
440
- headers: _headers,
441
- queryParameters: requestOptions?.queryParams,
442
- timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
443
- maxRetries: requestOptions?.maxRetries,
444
- withCredentials: true,
445
- abortSignal: requestOptions?.abortSignal,
446
- });
447
- if (_response.ok) {
448
- return { data: _response.body, rawResponse: _response.rawResponse };
449
- }
450
- if (_response.error.reason === "status-code") {
451
- switch (_response.error.statusCode) {
452
- case 401:
453
- throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
454
- case 403:
455
- throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
456
- case 404:
457
- throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
458
- case 500:
459
- throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
460
- default:
461
- throw new errors.PlanqkApiError({
462
- statusCode: _response.error.statusCode,
463
- body: _response.error.body,
464
- rawResponse: _response.rawResponse,
465
- });
466
- }
467
- }
468
- switch (_response.error.reason) {
469
- case "non-json":
470
- throw new errors.PlanqkApiError({
471
- statusCode: _response.error.statusCode,
472
- body: _response.error.rawBody,
473
- rawResponse: _response.rawResponse,
474
- });
475
- case "timeout":
476
- throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-jobs/{id}/logs.");
477
- case "unknown":
478
- throw new errors.PlanqkApiError({
479
- message: _response.error.errorMessage,
480
- rawResponse: _response.rawResponse,
481
- });
482
- }
483
- }
484
- async _getCustomAuthorizationHeaders() {
485
- const apiKeyValue = await core.Supplier.get(this._options.apiKey);
486
- return { "X-Auth-Token": apiKeyValue };
487
- }
488
- }
489
- exports.ServiceJobs = ServiceJobs;
@@ -1,2 +0,0 @@
1
- export {};
2
- export * from "./requests/index.js";
@@ -1,17 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./requests/index.js"), exports);
@@ -1,15 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- /**
5
- * @example
6
- * {}
7
- */
8
- export interface CreateServiceJobRequest {
9
- /** The ID fo the service for which the job is created. */
10
- serviceId?: string;
11
- /** Input data for the service job. This can be any JSON object that the service expects as input. The structure and content of this object depend on the specific service being executed. */
12
- input?: Record<string, any>;
13
- /** List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching. */
14
- tags?: string[];
15
- }
@@ -1,5 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +0,0 @@
1
- export { type CreateServiceJobRequest } from "./CreateServiceJobRequest.js";
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });