@planqk/planqk-api-sdk 1.1.0 → 1.3.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 (211) hide show
  1. package/.env.template +2 -1
  2. package/.gitlab-ci.yml +1 -0
  3. package/README-node.md +13 -0
  4. package/README-python.md +13 -0
  5. package/README.md +6 -49
  6. package/apps/python-test-app/main.py +159 -0
  7. package/apps/python-test-app/my_file.txt +1 -0
  8. package/apps/ts-test-app/index.ts +140 -0
  9. package/apps/ts-test-app/package-lock.json +693 -0
  10. package/apps/ts-test-app/package.json +19 -0
  11. package/apps/ts-test-app/test-file.txt +1 -0
  12. package/apps/ts-test-app/tsconfig.json +11 -0
  13. package/dist/index.d.ts +1 -4
  14. package/dist/index.js +4 -31
  15. package/dist/{Client.d.ts → sdk/Client.d.ts} +4 -1
  16. package/dist/{Client.js → sdk/Client.js} +1 -1
  17. package/dist/{api → sdk/api}/resources/dataPools/client/Client.d.ts +7 -0
  18. package/dist/{api → sdk/api}/resources/dataPools/client/Client.js +36 -8
  19. package/dist/sdk/index.d.ts +4 -0
  20. package/dist/sdk/index.js +44 -0
  21. package/fern/fern.config.json +1 -1
  22. package/fern/openapi/openapi.json +121 -15
  23. package/package.json +3 -4
  24. package/planqk/api/_version.py +1 -1
  25. package/planqk/api/client.py +1 -5
  26. package/planqk/api/sdk/__init__.py +34 -2
  27. package/planqk/api/sdk/authentication/__init__.py +7 -0
  28. package/planqk/api/sdk/authentication/client.py +102 -0
  29. package/planqk/api/sdk/authentication/raw_client.py +183 -0
  30. package/planqk/api/sdk/authentication/types/__init__.py +7 -0
  31. package/planqk/api/sdk/authentication/types/authorize_response.py +8 -0
  32. package/planqk/api/sdk/client.py +11 -0
  33. package/planqk/api/sdk/core/client_wrapper.py +12 -2
  34. package/planqk/api/sdk/data_pools/client.py +16 -0
  35. package/planqk/api/sdk/environment.py +1 -1
  36. package/planqk/api/sdk/types/__init__.py +30 -1
  37. package/planqk/api/sdk/types/access_token.py +26 -0
  38. package/planqk/api/sdk/types/organization_membership.py +27 -0
  39. package/planqk/api/sdk/types/organization_membership_account_type.py +5 -0
  40. package/planqk/api/sdk/types/organization_membership_role.py +5 -0
  41. package/planqk/api/sdk/types/personal_access_token_principal.py +31 -0
  42. package/planqk/api/sdk/types/personal_access_token_principal_account_type.py +5 -0
  43. package/planqk/api/sdk/types/service_execution.py +27 -0
  44. package/planqk/api/sdk/types/service_execution_status.py +7 -0
  45. package/planqk/api/sdk/types/service_execution_token_principal.py +34 -0
  46. package/planqk/api/sdk/types/user_context.py +35 -0
  47. package/planqk/api/sdk/types/user_context_account_type.py +5 -0
  48. package/planqk/api/sdk/types/user_context_context_type.py +5 -0
  49. package/pyproject.toml +2 -6
  50. package/src/index.test.ts +6 -5
  51. package/src/index.ts +1 -4
  52. package/src/{Client.ts → sdk/Client.ts} +5 -2
  53. package/src/{api → sdk/api}/resources/dataPools/client/Client.ts +40 -8
  54. package/src/sdk/index.ts +4 -0
  55. package/uv.lock +340 -559
  56. /package/dist/{api → sdk/api}/errors/BadRequestError.d.ts +0 -0
  57. /package/dist/{api → sdk/api}/errors/BadRequestError.js +0 -0
  58. /package/dist/{api → sdk/api}/errors/ForbiddenError.d.ts +0 -0
  59. /package/dist/{api → sdk/api}/errors/ForbiddenError.js +0 -0
  60. /package/dist/{api → sdk/api}/errors/InternalServerError.d.ts +0 -0
  61. /package/dist/{api → sdk/api}/errors/InternalServerError.js +0 -0
  62. /package/dist/{api → sdk/api}/errors/NotFoundError.d.ts +0 -0
  63. /package/dist/{api → sdk/api}/errors/NotFoundError.js +0 -0
  64. /package/dist/{api → sdk/api}/errors/UnauthorizedError.d.ts +0 -0
  65. /package/dist/{api → sdk/api}/errors/UnauthorizedError.js +0 -0
  66. /package/dist/{api → sdk/api}/errors/index.d.ts +0 -0
  67. /package/dist/{api → sdk/api}/errors/index.js +0 -0
  68. /package/dist/{api → sdk/api}/index.d.ts +0 -0
  69. /package/dist/{api → sdk/api}/index.js +0 -0
  70. /package/dist/{api → sdk/api}/resources/dataPools/client/index.d.ts +0 -0
  71. /package/dist/{api → sdk/api}/resources/dataPools/client/index.js +0 -0
  72. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts +0 -0
  73. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.js +0 -0
  74. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts +0 -0
  75. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.js +0 -0
  76. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts +0 -0
  77. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.js +0 -0
  78. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/index.d.ts +0 -0
  79. /package/dist/{api → sdk/api}/resources/dataPools/client/requests/index.js +0 -0
  80. /package/dist/{api → sdk/api}/resources/dataPools/index.d.ts +0 -0
  81. /package/dist/{api → sdk/api}/resources/dataPools/index.js +0 -0
  82. /package/dist/{api → sdk/api}/resources/index.d.ts +0 -0
  83. /package/dist/{api → sdk/api}/resources/index.js +0 -0
  84. /package/dist/{api → sdk/api}/types/DataPoolDto.d.ts +0 -0
  85. /package/dist/{api → sdk/api}/types/DataPoolDto.js +0 -0
  86. /package/dist/{api → sdk/api}/types/DataPoolFileDto.d.ts +0 -0
  87. /package/dist/{api → sdk/api}/types/DataPoolFileDto.js +0 -0
  88. /package/dist/{api → sdk/api}/types/OauthScope.d.ts +0 -0
  89. /package/dist/{api → sdk/api}/types/OauthScope.js +0 -0
  90. /package/dist/{api → sdk/api}/types/index.d.ts +0 -0
  91. /package/dist/{api → sdk/api}/types/index.js +0 -0
  92. /package/dist/{core → sdk/core}/fetcher/APIResponse.d.ts +0 -0
  93. /package/dist/{core → sdk/core}/fetcher/APIResponse.js +0 -0
  94. /package/dist/{core → sdk/core}/fetcher/BinaryResponse.d.ts +0 -0
  95. /package/dist/{core → sdk/core}/fetcher/BinaryResponse.js +0 -0
  96. /package/dist/{core → sdk/core}/fetcher/Fetcher.d.ts +0 -0
  97. /package/dist/{core → sdk/core}/fetcher/Fetcher.js +0 -0
  98. /package/dist/{core → sdk/core}/fetcher/Headers.d.ts +0 -0
  99. /package/dist/{core → sdk/core}/fetcher/Headers.js +0 -0
  100. /package/dist/{core → sdk/core}/fetcher/HttpResponsePromise.d.ts +0 -0
  101. /package/dist/{core → sdk/core}/fetcher/HttpResponsePromise.js +0 -0
  102. /package/dist/{core → sdk/core}/fetcher/RawResponse.d.ts +0 -0
  103. /package/dist/{core → sdk/core}/fetcher/RawResponse.js +0 -0
  104. /package/dist/{core → sdk/core}/fetcher/ResponseWithBody.d.ts +0 -0
  105. /package/dist/{core → sdk/core}/fetcher/ResponseWithBody.js +0 -0
  106. /package/dist/{core → sdk/core}/fetcher/Supplier.d.ts +0 -0
  107. /package/dist/{core → sdk/core}/fetcher/Supplier.js +0 -0
  108. /package/dist/{core → sdk/core}/fetcher/createRequestUrl.d.ts +0 -0
  109. /package/dist/{core → sdk/core}/fetcher/createRequestUrl.js +0 -0
  110. /package/dist/{core → sdk/core}/fetcher/getErrorResponseBody.d.ts +0 -0
  111. /package/dist/{core → sdk/core}/fetcher/getErrorResponseBody.js +0 -0
  112. /package/dist/{core → sdk/core}/fetcher/getFetchFn.d.ts +0 -0
  113. /package/dist/{core → sdk/core}/fetcher/getFetchFn.js +0 -0
  114. /package/dist/{core → sdk/core}/fetcher/getHeader.d.ts +0 -0
  115. /package/dist/{core → sdk/core}/fetcher/getHeader.js +0 -0
  116. /package/dist/{core → sdk/core}/fetcher/getRequestBody.d.ts +0 -0
  117. /package/dist/{core → sdk/core}/fetcher/getRequestBody.js +0 -0
  118. /package/dist/{core → sdk/core}/fetcher/getResponseBody.d.ts +0 -0
  119. /package/dist/{core → sdk/core}/fetcher/getResponseBody.js +0 -0
  120. /package/dist/{core → sdk/core}/fetcher/index.d.ts +0 -0
  121. /package/dist/{core → sdk/core}/fetcher/index.js +0 -0
  122. /package/dist/{core → sdk/core}/fetcher/makeRequest.d.ts +0 -0
  123. /package/dist/{core → sdk/core}/fetcher/makeRequest.js +0 -0
  124. /package/dist/{core → sdk/core}/fetcher/requestWithRetries.d.ts +0 -0
  125. /package/dist/{core → sdk/core}/fetcher/requestWithRetries.js +0 -0
  126. /package/dist/{core → sdk/core}/fetcher/signals.d.ts +0 -0
  127. /package/dist/{core → sdk/core}/fetcher/signals.js +0 -0
  128. /package/dist/{core → sdk/core}/file.d.ts +0 -0
  129. /package/dist/{core → sdk/core}/file.js +0 -0
  130. /package/dist/{core → sdk/core}/form-data-utils/FormDataWrapper.d.ts +0 -0
  131. /package/dist/{core → sdk/core}/form-data-utils/FormDataWrapper.js +0 -0
  132. /package/dist/{core → sdk/core}/form-data-utils/encodeAsFormParameter.d.ts +0 -0
  133. /package/dist/{core → sdk/core}/form-data-utils/encodeAsFormParameter.js +0 -0
  134. /package/dist/{core → sdk/core}/form-data-utils/index.d.ts +0 -0
  135. /package/dist/{core → sdk/core}/form-data-utils/index.js +0 -0
  136. /package/dist/{core → sdk/core}/headers.d.ts +0 -0
  137. /package/dist/{core → sdk/core}/headers.js +0 -0
  138. /package/dist/{core → sdk/core}/index.d.ts +0 -0
  139. /package/dist/{core → sdk/core}/index.js +0 -0
  140. /package/dist/{core → sdk/core}/json.d.ts +0 -0
  141. /package/dist/{core → sdk/core}/json.js +0 -0
  142. /package/dist/{core → sdk/core}/runtime/index.d.ts +0 -0
  143. /package/dist/{core → sdk/core}/runtime/index.js +0 -0
  144. /package/dist/{core → sdk/core}/runtime/runtime.d.ts +0 -0
  145. /package/dist/{core → sdk/core}/runtime/runtime.js +0 -0
  146. /package/dist/{core → sdk/core}/url/index.d.ts +0 -0
  147. /package/dist/{core → sdk/core}/url/index.js +0 -0
  148. /package/dist/{core → sdk/core}/url/join.d.ts +0 -0
  149. /package/dist/{core → sdk/core}/url/join.js +0 -0
  150. /package/dist/{core → sdk/core}/url/qs.d.ts +0 -0
  151. /package/dist/{core → sdk/core}/url/qs.js +0 -0
  152. /package/dist/{environments.d.ts → sdk/environments.d.ts} +0 -0
  153. /package/dist/{environments.js → sdk/environments.js} +0 -0
  154. /package/dist/{errors → sdk/errors}/PlanqkApiError.d.ts +0 -0
  155. /package/dist/{errors → sdk/errors}/PlanqkApiError.js +0 -0
  156. /package/dist/{errors → sdk/errors}/PlanqkApiTimeoutError.d.ts +0 -0
  157. /package/dist/{errors → sdk/errors}/PlanqkApiTimeoutError.js +0 -0
  158. /package/dist/{errors → sdk/errors}/index.d.ts +0 -0
  159. /package/dist/{errors → sdk/errors}/index.js +0 -0
  160. /package/src/{api → sdk/api}/errors/BadRequestError.ts +0 -0
  161. /package/src/{api → sdk/api}/errors/ForbiddenError.ts +0 -0
  162. /package/src/{api → sdk/api}/errors/InternalServerError.ts +0 -0
  163. /package/src/{api → sdk/api}/errors/NotFoundError.ts +0 -0
  164. /package/src/{api → sdk/api}/errors/UnauthorizedError.ts +0 -0
  165. /package/src/{api → sdk/api}/errors/index.ts +0 -0
  166. /package/src/{api → sdk/api}/index.ts +0 -0
  167. /package/src/{api → sdk/api}/resources/dataPools/client/index.ts +0 -0
  168. /package/src/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.ts +0 -0
  169. /package/src/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.ts +0 -0
  170. /package/src/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.ts +0 -0
  171. /package/src/{api → sdk/api}/resources/dataPools/client/requests/index.ts +0 -0
  172. /package/src/{api → sdk/api}/resources/dataPools/index.ts +0 -0
  173. /package/src/{api → sdk/api}/resources/index.ts +0 -0
  174. /package/src/{api → sdk/api}/types/DataPoolDto.ts +0 -0
  175. /package/src/{api → sdk/api}/types/DataPoolFileDto.ts +0 -0
  176. /package/src/{api → sdk/api}/types/OauthScope.ts +0 -0
  177. /package/src/{api → sdk/api}/types/index.ts +0 -0
  178. /package/src/{core → sdk/core}/fetcher/APIResponse.ts +0 -0
  179. /package/src/{core → sdk/core}/fetcher/BinaryResponse.ts +0 -0
  180. /package/src/{core → sdk/core}/fetcher/Fetcher.ts +0 -0
  181. /package/src/{core → sdk/core}/fetcher/Headers.ts +0 -0
  182. /package/src/{core → sdk/core}/fetcher/HttpResponsePromise.ts +0 -0
  183. /package/src/{core → sdk/core}/fetcher/RawResponse.ts +0 -0
  184. /package/src/{core → sdk/core}/fetcher/ResponseWithBody.ts +0 -0
  185. /package/src/{core → sdk/core}/fetcher/Supplier.ts +0 -0
  186. /package/src/{core → sdk/core}/fetcher/createRequestUrl.ts +0 -0
  187. /package/src/{core → sdk/core}/fetcher/getErrorResponseBody.ts +0 -0
  188. /package/src/{core → sdk/core}/fetcher/getFetchFn.ts +0 -0
  189. /package/src/{core → sdk/core}/fetcher/getHeader.ts +0 -0
  190. /package/src/{core → sdk/core}/fetcher/getRequestBody.ts +0 -0
  191. /package/src/{core → sdk/core}/fetcher/getResponseBody.ts +0 -0
  192. /package/src/{core → sdk/core}/fetcher/index.ts +0 -0
  193. /package/src/{core → sdk/core}/fetcher/makeRequest.ts +0 -0
  194. /package/src/{core → sdk/core}/fetcher/requestWithRetries.ts +0 -0
  195. /package/src/{core → sdk/core}/fetcher/signals.ts +0 -0
  196. /package/src/{core → sdk/core}/file.ts +0 -0
  197. /package/src/{core → sdk/core}/form-data-utils/FormDataWrapper.ts +0 -0
  198. /package/src/{core → sdk/core}/form-data-utils/encodeAsFormParameter.ts +0 -0
  199. /package/src/{core → sdk/core}/form-data-utils/index.ts +0 -0
  200. /package/src/{core → sdk/core}/headers.ts +0 -0
  201. /package/src/{core → sdk/core}/index.ts +0 -0
  202. /package/src/{core → sdk/core}/json.ts +0 -0
  203. /package/src/{core → sdk/core}/runtime/index.ts +0 -0
  204. /package/src/{core → sdk/core}/runtime/runtime.ts +0 -0
  205. /package/src/{core → sdk/core}/url/index.ts +0 -0
  206. /package/src/{core → sdk/core}/url/join.ts +0 -0
  207. /package/src/{core → sdk/core}/url/qs.ts +0 -0
  208. /package/src/{environments.ts → sdk/environments.ts} +0 -0
  209. /package/src/{errors → sdk/errors}/PlanqkApiError.ts +0 -0
  210. /package/src/{errors → sdk/errors}/PlanqkApiTimeoutError.ts +0 -0
  211. /package/src/{errors → sdk/errors}/index.ts +0 -0
@@ -0,0 +1,19 @@
1
+ {
2
+ "name": "ts-test-app",
3
+ "version": "1.0.0",
4
+ "main": "index.ts",
5
+ "scripts": {
6
+ "start": "npx tsc && node dist/index.js",
7
+ "test": "echo \"Error: no test specified\" && exit 1"
8
+ },
9
+ "keywords": [],
10
+ "author": "",
11
+ "description": "",
12
+ "dependencies": {
13
+ "@planqk/planqk-api-sdk": "^1.2.0",
14
+ "@types/node": "^20.14.10"
15
+ },
16
+ "devDependencies": {
17
+ "typescript": "^5.8.3"
18
+ }
19
+ }
@@ -0,0 +1 @@
1
+ This is a test file for the PlanQK API SDK.
@@ -0,0 +1,11 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es2016",
4
+ "module": "commonjs",
5
+ "outDir": "./dist",
6
+ "esModuleInterop": true,
7
+ "forceConsistentCasingInFileNames": true,
8
+ "strict": true,
9
+ "skipLibCheck": true
10
+ }
11
+ }
package/dist/index.d.ts CHANGED
@@ -1,4 +1 @@
1
- export * as PlanqkApi from "./api/index.js";
2
- export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
3
- export { PlanqkApiClient } from "./Client.js";
4
- export { PlanqkApiEnvironment } from "./environments.js";
1
+ export * from "./sdk";
package/dist/index.js CHANGED
@@ -10,35 +10,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
10
10
  if (k2 === undefined) k2 = k;
11
11
  o[k2] = m[k];
12
12
  }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || (function () {
19
- var ownKeys = function(o) {
20
- ownKeys = Object.getOwnPropertyNames || function (o) {
21
- var ar = [];
22
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
- return ar;
24
- };
25
- return ownKeys(o);
26
- };
27
- return function (mod) {
28
- if (mod && mod.__esModule) return mod;
29
- var result = {};
30
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
- __setModuleDefault(result, mod);
32
- return result;
33
- };
34
- })();
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
+ };
35
16
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.PlanqkApiEnvironment = exports.PlanqkApiClient = exports.PlanqkApiTimeoutError = exports.PlanqkApiError = exports.PlanqkApi = void 0;
37
- exports.PlanqkApi = __importStar(require("./api/index.js"));
38
- var index_js_1 = require("./errors/index.js");
39
- Object.defineProperty(exports, "PlanqkApiError", { enumerable: true, get: function () { return index_js_1.PlanqkApiError; } });
40
- Object.defineProperty(exports, "PlanqkApiTimeoutError", { enumerable: true, get: function () { return index_js_1.PlanqkApiTimeoutError; } });
41
- var Client_js_1 = require("./Client.js");
42
- Object.defineProperty(exports, "PlanqkApiClient", { enumerable: true, get: function () { return Client_js_1.PlanqkApiClient; } });
43
- var environments_js_1 = require("./environments.js");
44
- Object.defineProperty(exports, "PlanqkApiEnvironment", { enumerable: true, get: function () { return environments_js_1.PlanqkApiEnvironment; } });
17
+ __exportStar(require("./sdk"), exports);
@@ -10,7 +10,8 @@ export declare namespace PlanqkApiClient {
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey: core.Supplier<string>;
13
- organizationId?: core.Supplier<string>;
13
+ /** Override the X-OrganizationId header */
14
+ organizationId?: core.Supplier<string | undefined>;
14
15
  /** Additional headers to include in requests. */
15
16
  headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
16
17
  }
@@ -21,6 +22,8 @@ export declare namespace PlanqkApiClient {
21
22
  maxRetries?: number;
22
23
  /** A hook to abort the request. */
23
24
  abortSignal?: AbortSignal;
25
+ /** Override the X-OrganizationId header */
26
+ organizationId?: string | undefined;
24
27
  /** Additional headers to include in the request. */
25
28
  headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
29
  }
@@ -47,10 +47,10 @@ class PlanqkApiClient {
47
47
  this._options = {
48
48
  ..._options,
49
49
  headers: (0, headers_js_1.mergeHeaders)({
50
+ "X-OrganizationId": _options?.organizationId,
50
51
  "X-Fern-Language": "JavaScript",
51
52
  "X-Fern-Runtime": core.RUNTIME.type,
52
53
  "X-Fern-Runtime-Version": core.RUNTIME.version,
53
- "X-OrganizationId": _options.organizationId,
54
54
  }, _options?.headers),
55
55
  };
56
56
  }
@@ -10,6 +10,8 @@ export declare namespace DataPools {
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey: core.Supplier<string>;
13
+ /** Override the X-OrganizationId header */
14
+ organizationId?: core.Supplier<string | undefined>;
13
15
  /** Additional headers to include in requests. */
14
16
  headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
15
17
  }
@@ -20,10 +22,15 @@ export declare namespace DataPools {
20
22
  maxRetries?: number;
21
23
  /** A hook to abort the request. */
22
24
  abortSignal?: AbortSignal;
25
+ /** Override the X-OrganizationId header */
26
+ organizationId?: string | undefined;
23
27
  /** Additional headers to include in the request. */
24
28
  headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
25
29
  }
26
30
  }
31
+ /**
32
+ * Manage data pools, which are organized collections of files that serve as reusable data sources for services.
33
+ */
27
34
  export declare class DataPools {
28
35
  protected readonly _options: DataPools.Options;
29
36
  constructor(_options: DataPools.Options);
@@ -42,6 +42,9 @@ const core = __importStar(require("../../../../core/index.js"));
42
42
  const PlanqkApi = __importStar(require("../../../index.js"));
43
43
  const headers_js_1 = require("../../../../core/headers.js");
44
44
  const errors = __importStar(require("../../../../errors/index.js"));
45
+ /**
46
+ * Manage data pools, which are organized collections of files that serve as reusable data sources for services.
47
+ */
45
48
  class DataPools {
46
49
  _options;
47
50
  constructor(_options) {
@@ -70,7 +73,10 @@ class DataPools {
70
73
  (await core.Supplier.get(this._options.environment)) ??
71
74
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}`),
72
75
  method: "GET",
73
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
76
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
77
+ "X-OrganizationId": requestOptions?.organizationId,
78
+ ...(await this._getCustomAuthorizationHeaders()),
79
+ }), requestOptions?.headers),
74
80
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
75
81
  maxRetries: requestOptions?.maxRetries,
76
82
  withCredentials: true,
@@ -138,7 +144,10 @@ class DataPools {
138
144
  (await core.Supplier.get(this._options.environment)) ??
139
145
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}`),
140
146
  method: "PUT",
141
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
147
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
148
+ "X-OrganizationId": requestOptions?.organizationId,
149
+ ...(await this._getCustomAuthorizationHeaders()),
150
+ }), requestOptions?.headers),
142
151
  contentType: "application/json",
143
152
  requestType: "json",
144
153
  body: request,
@@ -209,7 +218,10 @@ class DataPools {
209
218
  (await core.Supplier.get(this._options.environment)) ??
210
219
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}`),
211
220
  method: "DELETE",
212
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
221
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
222
+ "X-OrganizationId": requestOptions?.organizationId,
223
+ ...(await this._getCustomAuthorizationHeaders()),
224
+ }), requestOptions?.headers),
213
225
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
214
226
  maxRetries: requestOptions?.maxRetries,
215
227
  withCredentials: true,
@@ -274,7 +286,10 @@ class DataPools {
274
286
  (await core.Supplier.get(this._options.environment)) ??
275
287
  environments.PlanqkApiEnvironment.Default, "datapools"),
276
288
  method: "GET",
277
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
289
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
290
+ "X-OrganizationId": requestOptions?.organizationId,
291
+ ...(await this._getCustomAuthorizationHeaders()),
292
+ }), requestOptions?.headers),
278
293
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
279
294
  maxRetries: requestOptions?.maxRetries,
280
295
  withCredentials: true,
@@ -341,7 +356,10 @@ class DataPools {
341
356
  (await core.Supplier.get(this._options.environment)) ??
342
357
  environments.PlanqkApiEnvironment.Default, "datapools"),
343
358
  method: "POST",
344
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
359
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
360
+ "X-OrganizationId": requestOptions?.organizationId,
361
+ ...(await this._getCustomAuthorizationHeaders()),
362
+ }), requestOptions?.headers),
345
363
  contentType: "application/json",
346
364
  requestType: "json",
347
365
  body: request,
@@ -412,7 +430,10 @@ class DataPools {
412
430
  (await core.Supplier.get(this._options.environment)) ??
413
431
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}/files`),
414
432
  method: "GET",
415
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
433
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
434
+ "X-OrganizationId": requestOptions?.organizationId,
435
+ ...(await this._getCustomAuthorizationHeaders()),
436
+ }), requestOptions?.headers),
416
437
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
417
438
  maxRetries: requestOptions?.maxRetries,
418
439
  withCredentials: true,
@@ -490,6 +511,7 @@ class DataPools {
490
511
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}/files`),
491
512
  method: "POST",
492
513
  headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
514
+ "X-OrganizationId": requestOptions?.organizationId,
493
515
  ...(await this._getCustomAuthorizationHeaders()),
494
516
  ..._maybeEncodedRequest.headers,
495
517
  }), requestOptions?.headers),
@@ -557,7 +579,10 @@ class DataPools {
557
579
  (await core.Supplier.get(this._options.environment)) ??
558
580
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`),
559
581
  method: "GET",
560
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
582
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
583
+ "X-OrganizationId": requestOptions?.organizationId,
584
+ ...(await this._getCustomAuthorizationHeaders()),
585
+ }), requestOptions?.headers),
561
586
  responseType: "binary-response",
562
587
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
563
588
  maxRetries: requestOptions?.maxRetries,
@@ -625,7 +650,10 @@ class DataPools {
625
650
  (await core.Supplier.get(this._options.environment)) ??
626
651
  environments.PlanqkApiEnvironment.Default, `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`),
627
652
  method: "DELETE",
628
- headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ ...(await this._getCustomAuthorizationHeaders()) }), requestOptions?.headers),
653
+ headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
654
+ "X-OrganizationId": requestOptions?.organizationId,
655
+ ...(await this._getCustomAuthorizationHeaders()),
656
+ }), requestOptions?.headers),
629
657
  timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
630
658
  maxRetries: requestOptions?.maxRetries,
631
659
  withCredentials: true,
@@ -0,0 +1,4 @@
1
+ export * as PlanqkApi from "./api/index.js";
2
+ export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
3
+ export { PlanqkApiClient } from "./Client.js";
4
+ export { PlanqkApiEnvironment } from "./environments.js";
@@ -0,0 +1,44 @@
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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.PlanqkApiEnvironment = exports.PlanqkApiClient = exports.PlanqkApiTimeoutError = exports.PlanqkApiError = exports.PlanqkApi = void 0;
37
+ exports.PlanqkApi = __importStar(require("./api/index.js"));
38
+ var index_js_1 = require("./errors/index.js");
39
+ Object.defineProperty(exports, "PlanqkApiError", { enumerable: true, get: function () { return index_js_1.PlanqkApiError; } });
40
+ Object.defineProperty(exports, "PlanqkApiTimeoutError", { enumerable: true, get: function () { return index_js_1.PlanqkApiTimeoutError; } });
41
+ var Client_js_1 = require("./Client.js");
42
+ Object.defineProperty(exports, "PlanqkApiClient", { enumerable: true, get: function () { return Client_js_1.PlanqkApiClient; } });
43
+ var environments_js_1 = require("./environments.js");
44
+ Object.defineProperty(exports, "PlanqkApiEnvironment", { enumerable: true, get: function () { return environments_js_1.PlanqkApiEnvironment; } });
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "organization": "planqk",
3
- "version": "0.65.7"
3
+ "version": "0.65.35"
4
4
  }
@@ -12,14 +12,22 @@
12
12
  },
13
13
  "servers": [
14
14
  {
15
- "url": "https://34.90.225.20.nip.io/qc-catalog",
15
+ "url": "https://platform.planqk.de/qc-catalog",
16
16
  "description": "Generated server url"
17
17
  }
18
18
  ],
19
+ "tags": [
20
+ {
21
+ "name": "Data Pools",
22
+ "description": "Manage data pools, which are organized collections of files that serve as reusable data sources for services."
23
+ }
24
+ ],
19
25
  "paths": {
20
26
  "/datapools/{id}": {
21
27
  "get": {
22
- "tags": ["Data Pools"],
28
+ "tags": [
29
+ "Data Pools"
30
+ ],
23
31
  "description": "Get a specific data pool (identified by its ID).",
24
32
  "operationId": "getDataPool",
25
33
  "parameters": [
@@ -31,6 +39,14 @@
31
39
  "type": "string",
32
40
  "format": "uuid"
33
41
  }
42
+ },
43
+ {
44
+ "name": "X-OrganizationId",
45
+ "in": "header",
46
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
47
+ "schema": {
48
+ "type": "string"
49
+ }
34
50
  }
35
51
  ],
36
52
  "responses": {
@@ -67,7 +83,9 @@
67
83
  ]
68
84
  },
69
85
  "put": {
70
- "tags": ["Data Pools"],
86
+ "tags": [
87
+ "Data Pools"
88
+ ],
71
89
  "description": "Update an existing data pool (identified by its ID).",
72
90
  "operationId": "updateDataPool",
73
91
  "parameters": [
@@ -79,6 +97,14 @@
79
97
  "type": "string",
80
98
  "format": "uuid"
81
99
  }
100
+ },
101
+ {
102
+ "name": "X-OrganizationId",
103
+ "in": "header",
104
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
105
+ "schema": {
106
+ "type": "string"
107
+ }
82
108
  }
83
109
  ],
84
110
  "requestBody": {
@@ -128,7 +154,9 @@
128
154
  ]
129
155
  },
130
156
  "delete": {
131
- "tags": ["Data Pools"],
157
+ "tags": [
158
+ "Data Pools"
159
+ ],
132
160
  "description": "Delete a specific data pool (identified by its ID).",
133
161
  "operationId": "deleteDataPool",
134
162
  "parameters": [
@@ -140,6 +168,14 @@
140
168
  "type": "string",
141
169
  "format": "uuid"
142
170
  }
171
+ },
172
+ {
173
+ "name": "X-OrganizationId",
174
+ "in": "header",
175
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
176
+ "schema": {
177
+ "type": "string"
178
+ }
143
179
  }
144
180
  ],
145
181
  "responses": {
@@ -171,9 +207,21 @@
171
207
  },
172
208
  "/datapools": {
173
209
  "get": {
174
- "tags": ["Data Pools"],
210
+ "tags": [
211
+ "Data Pools"
212
+ ],
175
213
  "description": "Get a list of all data pools for the current user.",
176
214
  "operationId": "getDataPools",
215
+ "parameters": [
216
+ {
217
+ "name": "X-OrganizationId",
218
+ "in": "header",
219
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
220
+ "schema": {
221
+ "type": "string"
222
+ }
223
+ }
224
+ ],
177
225
  "responses": {
178
226
  "200": {
179
227
  "description": "List of data pools",
@@ -211,9 +259,21 @@
211
259
  ]
212
260
  },
213
261
  "post": {
214
- "tags": ["Data Pools"],
262
+ "tags": [
263
+ "Data Pools"
264
+ ],
215
265
  "description": "Create a new data pool.",
216
266
  "operationId": "createDataPool",
267
+ "parameters": [
268
+ {
269
+ "name": "X-OrganizationId",
270
+ "in": "header",
271
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
272
+ "schema": {
273
+ "type": "string"
274
+ }
275
+ }
276
+ ],
217
277
  "requestBody": {
218
278
  "content": {
219
279
  "application/json": {
@@ -263,7 +323,9 @@
263
323
  },
264
324
  "/datapools/{id}/files": {
265
325
  "get": {
266
- "tags": ["Data Pools"],
326
+ "tags": [
327
+ "Data Pools"
328
+ ],
267
329
  "description": "Get all files associated with a specific data pool (identified by its ID).",
268
330
  "operationId": "getDataPoolFiles",
269
331
  "parameters": [
@@ -275,6 +337,14 @@
275
337
  "type": "string",
276
338
  "format": "uuid"
277
339
  }
340
+ },
341
+ {
342
+ "name": "X-OrganizationId",
343
+ "in": "header",
344
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
345
+ "schema": {
346
+ "type": "string"
347
+ }
278
348
  }
279
349
  ],
280
350
  "responses": {
@@ -314,7 +384,9 @@
314
384
  ]
315
385
  },
316
386
  "post": {
317
- "tags": ["Data Pools"],
387
+ "tags": [
388
+ "Data Pools"
389
+ ],
318
390
  "description": "Add a new file to a specific data pool (identified by its ID).",
319
391
  "operationId": "addDataPoolFile",
320
392
  "parameters": [
@@ -334,6 +406,14 @@
334
406
  "schema": {
335
407
  "type": "string"
336
408
  }
409
+ },
410
+ {
411
+ "name": "X-OrganizationId",
412
+ "in": "header",
413
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
414
+ "schema": {
415
+ "type": "string"
416
+ }
337
417
  }
338
418
  ],
339
419
  "requestBody": {
@@ -347,7 +427,9 @@
347
427
  "format": "binary"
348
428
  }
349
429
  },
350
- "required": ["file"]
430
+ "required": [
431
+ "file"
432
+ ]
351
433
  }
352
434
  }
353
435
  }
@@ -391,7 +473,9 @@
391
473
  },
392
474
  "/datapools/{id}/files/{fileId}": {
393
475
  "get": {
394
- "tags": ["Data Pools"],
476
+ "tags": [
477
+ "Data Pools"
478
+ ],
395
479
  "description": "Get the content of a specific file from a data pool (both file and data pool identified by their ID).",
396
480
  "operationId": "getDataPoolFile",
397
481
  "parameters": [
@@ -412,6 +496,14 @@
412
496
  "type": "string",
413
497
  "format": "uuid"
414
498
  }
499
+ },
500
+ {
501
+ "name": "X-OrganizationId",
502
+ "in": "header",
503
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
504
+ "schema": {
505
+ "type": "string"
506
+ }
415
507
  }
416
508
  ],
417
509
  "responses": {
@@ -452,7 +544,9 @@
452
544
  ]
453
545
  },
454
546
  "delete": {
455
- "tags": ["Data Pools"],
547
+ "tags": [
548
+ "Data Pools"
549
+ ],
456
550
  "description": "Delete a specific file from a data pool (both file and data pool identified by their IDs).",
457
551
  "operationId": "deleteDataPoolFile",
458
552
  "parameters": [
@@ -473,6 +567,14 @@
473
567
  "type": "string",
474
568
  "format": "uuid"
475
569
  }
570
+ },
571
+ {
572
+ "name": "X-OrganizationId",
573
+ "in": "header",
574
+ "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
575
+ "schema": {
576
+ "type": "string"
577
+ }
476
578
  }
477
579
  ],
478
580
  "responses": {
@@ -525,7 +627,11 @@
525
627
  "currentUserPermission": {
526
628
  "type": "string",
527
629
  "description": "The access permission role for this entity of the current user",
528
- "enum": ["VIEWER", "MAINTAINER", "OWNER"],
630
+ "enum": [
631
+ "VIEWER",
632
+ "MAINTAINER",
633
+ "OWNER"
634
+ ],
529
635
  "example": "OWNER",
530
636
  "readOnly": true
531
637
  },
@@ -597,8 +703,8 @@
597
703
  "type": "oauth2",
598
704
  "flows": {
599
705
  "password": {
600
- "tokenUrl": "https://login.34.90.225.20.nip.io/realms/planqk/protocol/openid-connect/token",
601
- "refreshUrl": "https://login.34.90.225.20.nip.io/realms/planqk/protocol/openid-connect/token",
706
+ "tokenUrl": "https://login.planqk.de/realms/planqk/protocol/openid-connect/token",
707
+ "refreshUrl": "https://login.planqk.de/realms/planqk/protocol/openid-connect/token",
602
708
  "scopes": {
603
709
  "profile": ""
604
710
  }
@@ -607,4 +713,4 @@
607
713
  }
608
714
  }
609
715
  }
610
- }
716
+ }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@planqk/planqk-api-sdk",
3
- "version": "1.1.0",
4
- "description": "SDK to interact with official PLANQK API.",
3
+ "version": "1.3.0",
4
+ "description": "SDK to interact with the official PLANQK API.",
5
5
  "author": "Kipu Quantum GmbH",
6
6
  "contributors": [
7
7
  "Wurster, Michael <michael.wurster@kipu-quantum.com>"
@@ -43,6 +43,5 @@
43
43
  "private": false,
44
44
  "publishConfig": {
45
45
  "access": "public"
46
- },
47
- "readme": "./README-node.md"
46
+ }
48
47
  }
@@ -1 +1 @@
1
- __version__ = "1.1.0"
1
+ __version__ = "1.3.0"
@@ -13,11 +13,7 @@ class PlanqkApiClient:
13
13
  base_url = os.environ.get(_PLANQK_API_BASE_URL_NAME, "https://platform.planqk.de/qc-catalog")
14
14
  credentials_provider = DefaultCredentialsProvider(access_token)
15
15
 
16
- headers = None
17
- if organization_id:
18
- headers = {"X-OrganizationId": organization_id}
19
-
20
- self._api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), headers=headers)
16
+ self._api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)
21
17
 
22
18
  @property
23
19
  def data_pools(self) -> DataPoolsClient: