@planqk/planqk-api-sdk 1.2.0 → 1.3.1

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 (246) 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/README.md +24 -0
  7. package/apps/python-test-app/main.py +159 -0
  8. package/apps/test-file.txt +1 -0
  9. package/apps/ts-test-app/index.ts +140 -0
  10. package/apps/ts-test-app/package-lock.json +695 -0
  11. package/apps/ts-test-app/package.json +15 -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} +2 -5
  16. package/dist/{Client.js → sdk/Client.js} +1 -6
  17. package/dist/{api → sdk/api}/resources/dataPools/client/Client.d.ts +3 -3
  18. package/dist/{api → sdk/api}/resources/dataPools/client/Client.js +1 -1
  19. package/dist/sdk/api/resources/index.d.ts +2 -0
  20. package/dist/{api → sdk/api}/resources/index.js +1 -3
  21. package/dist/sdk/api/types/index.d.ts +3 -0
  22. package/dist/{api/resources/authentication → sdk/api}/types/index.js +3 -1
  23. package/dist/sdk/index.d.ts +4 -0
  24. package/dist/sdk/index.js +44 -0
  25. package/fern/fern.config.json +1 -1
  26. package/fern/openapi/openapi.json +2 -202
  27. package/notebooks/python-sdk.ipynb +2 -1
  28. package/package.json +3 -4
  29. package/planqk/api/_version.py +1 -1
  30. package/planqk/api/client.py +5 -2
  31. package/planqk/api/sdk/__init__.py +2 -34
  32. package/planqk/api/sdk/client.py +0 -3
  33. package/planqk/api/sdk/types/__init__.py +1 -30
  34. package/pyproject.toml +3 -6
  35. package/src/index.test.ts +6 -5
  36. package/src/index.ts +1 -4
  37. package/src/{Client.ts → sdk/Client.ts} +2 -8
  38. package/src/{api → sdk/api}/resources/dataPools/client/Client.ts +2 -2
  39. package/src/sdk/api/resources/index.ts +2 -0
  40. package/src/sdk/api/types/index.ts +3 -0
  41. package/src/sdk/index.ts +4 -0
  42. package/uv.lock +658 -324
  43. package/dist/api/resources/authentication/client/Client.d.ts +0 -55
  44. package/dist/api/resources/authentication/client/Client.js +0 -126
  45. package/dist/api/resources/authentication/client/index.d.ts +0 -1
  46. package/dist/api/resources/authentication/index.d.ts +0 -2
  47. package/dist/api/resources/authentication/index.js +0 -18
  48. package/dist/api/resources/authentication/types/AuthorizeResponse.d.ts +0 -5
  49. package/dist/api/resources/authentication/types/AuthorizeResponse.js +0 -5
  50. package/dist/api/resources/authentication/types/index.d.ts +0 -1
  51. package/dist/api/resources/dataPools/client/requests/index.js +0 -2
  52. package/dist/api/resources/index.d.ts +0 -4
  53. package/dist/api/types/AccessToken.d.ts +0 -10
  54. package/dist/api/types/AccessToken.js +0 -5
  55. package/dist/api/types/OrganizationMembership.d.ts +0 -22
  56. package/dist/api/types/OrganizationMembership.js +0 -19
  57. package/dist/api/types/PersonalAccessTokenPrincipal.d.ts +0 -18
  58. package/dist/api/types/PersonalAccessTokenPrincipal.js +0 -14
  59. package/dist/api/types/ServiceExecution.d.ts +0 -20
  60. package/dist/api/types/ServiceExecution.js +0 -16
  61. package/dist/api/types/ServiceExecutionTokenPrincipal.d.ts +0 -8
  62. package/dist/api/types/ServiceExecutionTokenPrincipal.js +0 -5
  63. package/dist/api/types/UserContext.d.ts +0 -24
  64. package/dist/api/types/UserContext.js +0 -19
  65. package/dist/api/types/index.d.ts +0 -9
  66. package/dist/api/types/index.js +0 -25
  67. package/planqk/api/sdk/authentication/__init__.py +0 -7
  68. package/planqk/api/sdk/authentication/client.py +0 -102
  69. package/planqk/api/sdk/authentication/raw_client.py +0 -183
  70. package/planqk/api/sdk/authentication/types/__init__.py +0 -7
  71. package/planqk/api/sdk/authentication/types/authorize_response.py +0 -8
  72. package/planqk/api/sdk/types/access_token.py +0 -26
  73. package/planqk/api/sdk/types/organization_membership.py +0 -27
  74. package/planqk/api/sdk/types/organization_membership_account_type.py +0 -5
  75. package/planqk/api/sdk/types/organization_membership_role.py +0 -5
  76. package/planqk/api/sdk/types/personal_access_token_principal.py +0 -31
  77. package/planqk/api/sdk/types/personal_access_token_principal_account_type.py +0 -5
  78. package/planqk/api/sdk/types/service_execution.py +0 -27
  79. package/planqk/api/sdk/types/service_execution_status.py +0 -7
  80. package/planqk/api/sdk/types/service_execution_token_principal.py +0 -34
  81. package/planqk/api/sdk/types/user_context.py +0 -35
  82. package/planqk/api/sdk/types/user_context_account_type.py +0 -5
  83. package/planqk/api/sdk/types/user_context_context_type.py +0 -5
  84. package/src/api/resources/authentication/client/Client.ts +0 -134
  85. package/src/api/resources/authentication/client/index.ts +0 -1
  86. package/src/api/resources/authentication/index.ts +0 -2
  87. package/src/api/resources/authentication/types/AuthorizeResponse.ts +0 -7
  88. package/src/api/resources/authentication/types/index.ts +0 -1
  89. package/src/api/resources/index.ts +0 -4
  90. package/src/api/types/AccessToken.ts +0 -11
  91. package/src/api/types/OrganizationMembership.ts +0 -24
  92. package/src/api/types/PersonalAccessTokenPrincipal.ts +0 -21
  93. package/src/api/types/ServiceExecution.ts +0 -22
  94. package/src/api/types/ServiceExecutionTokenPrincipal.ts +0 -10
  95. package/src/api/types/UserContext.ts +0 -27
  96. package/src/api/types/index.ts +0 -9
  97. package/dist/{api → sdk/api}/errors/BadRequestError.d.ts +0 -0
  98. package/dist/{api → sdk/api}/errors/BadRequestError.js +0 -0
  99. package/dist/{api → sdk/api}/errors/ForbiddenError.d.ts +0 -0
  100. package/dist/{api → sdk/api}/errors/ForbiddenError.js +0 -0
  101. package/dist/{api → sdk/api}/errors/InternalServerError.d.ts +0 -0
  102. package/dist/{api → sdk/api}/errors/InternalServerError.js +0 -0
  103. package/dist/{api → sdk/api}/errors/NotFoundError.d.ts +0 -0
  104. package/dist/{api → sdk/api}/errors/NotFoundError.js +0 -0
  105. package/dist/{api → sdk/api}/errors/UnauthorizedError.d.ts +0 -0
  106. package/dist/{api → sdk/api}/errors/UnauthorizedError.js +0 -0
  107. package/dist/{api → sdk/api}/errors/index.d.ts +0 -0
  108. package/dist/{api → sdk/api}/errors/index.js +0 -0
  109. package/dist/{api → sdk/api}/index.d.ts +1 -1
  110. package/dist/{api → sdk/api}/index.js +1 -1
  111. package/dist/{api → sdk/api}/resources/dataPools/client/index.d.ts +0 -0
  112. package/dist/{api → sdk/api}/resources/dataPools/client/index.js +0 -0
  113. package/dist/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts +0 -0
  114. package/dist/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.js +0 -0
  115. package/dist/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts +0 -0
  116. package/dist/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.js +0 -0
  117. package/dist/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts +0 -0
  118. package/dist/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.js +0 -0
  119. package/dist/{api → sdk/api}/resources/dataPools/client/requests/index.d.ts +0 -0
  120. package/dist/{api/resources/authentication/client → sdk/api/resources/dataPools/client/requests}/index.js +0 -0
  121. package/dist/{api → sdk/api}/resources/dataPools/index.d.ts +0 -0
  122. package/dist/{api → sdk/api}/resources/dataPools/index.js +0 -0
  123. package/dist/{api → sdk/api}/types/DataPoolDto.d.ts +0 -0
  124. package/dist/{api → sdk/api}/types/DataPoolDto.js +0 -0
  125. package/dist/{api → sdk/api}/types/DataPoolFileDto.d.ts +0 -0
  126. package/dist/{api → sdk/api}/types/DataPoolFileDto.js +0 -0
  127. package/dist/{api → sdk/api}/types/OauthScope.d.ts +0 -0
  128. package/dist/{api → sdk/api}/types/OauthScope.js +0 -0
  129. package/dist/{core → sdk/core}/fetcher/APIResponse.d.ts +0 -0
  130. package/dist/{core → sdk/core}/fetcher/APIResponse.js +0 -0
  131. package/dist/{core → sdk/core}/fetcher/BinaryResponse.d.ts +0 -0
  132. package/dist/{core → sdk/core}/fetcher/BinaryResponse.js +0 -0
  133. package/dist/{core → sdk/core}/fetcher/Fetcher.d.ts +0 -0
  134. package/dist/{core → sdk/core}/fetcher/Fetcher.js +0 -0
  135. package/dist/{core → sdk/core}/fetcher/Headers.d.ts +0 -0
  136. package/dist/{core → sdk/core}/fetcher/Headers.js +0 -0
  137. package/dist/{core → sdk/core}/fetcher/HttpResponsePromise.d.ts +0 -0
  138. package/dist/{core → sdk/core}/fetcher/HttpResponsePromise.js +0 -0
  139. package/dist/{core → sdk/core}/fetcher/RawResponse.d.ts +0 -0
  140. package/dist/{core → sdk/core}/fetcher/RawResponse.js +0 -0
  141. package/dist/{core → sdk/core}/fetcher/ResponseWithBody.d.ts +0 -0
  142. package/dist/{core → sdk/core}/fetcher/ResponseWithBody.js +0 -0
  143. package/dist/{core → sdk/core}/fetcher/Supplier.d.ts +0 -0
  144. package/dist/{core → sdk/core}/fetcher/Supplier.js +0 -0
  145. package/dist/{core → sdk/core}/fetcher/createRequestUrl.d.ts +0 -0
  146. package/dist/{core → sdk/core}/fetcher/createRequestUrl.js +0 -0
  147. package/dist/{core → sdk/core}/fetcher/getErrorResponseBody.d.ts +0 -0
  148. package/dist/{core → sdk/core}/fetcher/getErrorResponseBody.js +0 -0
  149. package/dist/{core → sdk/core}/fetcher/getFetchFn.d.ts +0 -0
  150. package/dist/{core → sdk/core}/fetcher/getFetchFn.js +0 -0
  151. package/dist/{core → sdk/core}/fetcher/getHeader.d.ts +0 -0
  152. package/dist/{core → sdk/core}/fetcher/getHeader.js +0 -0
  153. package/dist/{core → sdk/core}/fetcher/getRequestBody.d.ts +0 -0
  154. package/dist/{core → sdk/core}/fetcher/getRequestBody.js +0 -0
  155. package/dist/{core → sdk/core}/fetcher/getResponseBody.d.ts +0 -0
  156. package/dist/{core → sdk/core}/fetcher/getResponseBody.js +0 -0
  157. package/dist/{core → sdk/core}/fetcher/index.d.ts +0 -0
  158. package/dist/{core → sdk/core}/fetcher/index.js +0 -0
  159. package/dist/{core → sdk/core}/fetcher/makeRequest.d.ts +0 -0
  160. package/dist/{core → sdk/core}/fetcher/makeRequest.js +0 -0
  161. package/dist/{core → sdk/core}/fetcher/requestWithRetries.d.ts +0 -0
  162. package/dist/{core → sdk/core}/fetcher/requestWithRetries.js +0 -0
  163. package/dist/{core → sdk/core}/fetcher/signals.d.ts +0 -0
  164. package/dist/{core → sdk/core}/fetcher/signals.js +0 -0
  165. package/dist/{core → sdk/core}/file.d.ts +0 -0
  166. package/dist/{core → sdk/core}/file.js +0 -0
  167. package/dist/{core → sdk/core}/form-data-utils/FormDataWrapper.d.ts +0 -0
  168. package/dist/{core → sdk/core}/form-data-utils/FormDataWrapper.js +0 -0
  169. package/dist/{core → sdk/core}/form-data-utils/encodeAsFormParameter.d.ts +0 -0
  170. package/dist/{core → sdk/core}/form-data-utils/encodeAsFormParameter.js +0 -0
  171. package/dist/{core → sdk/core}/form-data-utils/index.d.ts +0 -0
  172. package/dist/{core → sdk/core}/form-data-utils/index.js +0 -0
  173. package/dist/{core → sdk/core}/headers.d.ts +0 -0
  174. package/dist/{core → sdk/core}/headers.js +0 -0
  175. package/dist/{core → sdk/core}/index.d.ts +0 -0
  176. package/dist/{core → sdk/core}/index.js +0 -0
  177. package/dist/{core → sdk/core}/json.d.ts +0 -0
  178. package/dist/{core → sdk/core}/json.js +0 -0
  179. package/dist/{core → sdk/core}/runtime/index.d.ts +0 -0
  180. package/dist/{core → sdk/core}/runtime/index.js +0 -0
  181. package/dist/{core → sdk/core}/runtime/runtime.d.ts +0 -0
  182. package/dist/{core → sdk/core}/runtime/runtime.js +0 -0
  183. package/dist/{core → sdk/core}/url/index.d.ts +0 -0
  184. package/dist/{core → sdk/core}/url/index.js +0 -0
  185. package/dist/{core → sdk/core}/url/join.d.ts +0 -0
  186. package/dist/{core → sdk/core}/url/join.js +0 -0
  187. package/dist/{core → sdk/core}/url/qs.d.ts +0 -0
  188. package/dist/{core → sdk/core}/url/qs.js +0 -0
  189. package/dist/{environments.d.ts → sdk/environments.d.ts} +0 -0
  190. package/dist/{environments.js → sdk/environments.js} +0 -0
  191. package/dist/{errors → sdk/errors}/PlanqkApiError.d.ts +0 -0
  192. package/dist/{errors → sdk/errors}/PlanqkApiError.js +0 -0
  193. package/dist/{errors → sdk/errors}/PlanqkApiTimeoutError.d.ts +0 -0
  194. package/dist/{errors → sdk/errors}/PlanqkApiTimeoutError.js +0 -0
  195. package/dist/{errors → sdk/errors}/index.d.ts +0 -0
  196. package/dist/{errors → sdk/errors}/index.js +0 -0
  197. package/src/{api → sdk/api}/errors/BadRequestError.ts +0 -0
  198. package/src/{api → sdk/api}/errors/ForbiddenError.ts +0 -0
  199. package/src/{api → sdk/api}/errors/InternalServerError.ts +0 -0
  200. package/src/{api → sdk/api}/errors/NotFoundError.ts +0 -0
  201. package/src/{api → sdk/api}/errors/UnauthorizedError.ts +0 -0
  202. package/src/{api → sdk/api}/errors/index.ts +0 -0
  203. package/src/{api → sdk/api}/index.ts +1 -1
  204. /package/src/{api → sdk/api}/resources/dataPools/client/index.ts +0 -0
  205. /package/src/{api → sdk/api}/resources/dataPools/client/requests/AddDataPoolFileRequest.ts +0 -0
  206. /package/src/{api → sdk/api}/resources/dataPools/client/requests/CreateDataPoolRequest.ts +0 -0
  207. /package/src/{api → sdk/api}/resources/dataPools/client/requests/UpdateDataPoolRequest.ts +0 -0
  208. /package/src/{api → sdk/api}/resources/dataPools/client/requests/index.ts +0 -0
  209. /package/src/{api → sdk/api}/resources/dataPools/index.ts +0 -0
  210. /package/src/{api → sdk/api}/types/DataPoolDto.ts +0 -0
  211. /package/src/{api → sdk/api}/types/DataPoolFileDto.ts +0 -0
  212. /package/src/{api → sdk/api}/types/OauthScope.ts +0 -0
  213. /package/src/{core → sdk/core}/fetcher/APIResponse.ts +0 -0
  214. /package/src/{core → sdk/core}/fetcher/BinaryResponse.ts +0 -0
  215. /package/src/{core → sdk/core}/fetcher/Fetcher.ts +0 -0
  216. /package/src/{core → sdk/core}/fetcher/Headers.ts +0 -0
  217. /package/src/{core → sdk/core}/fetcher/HttpResponsePromise.ts +0 -0
  218. /package/src/{core → sdk/core}/fetcher/RawResponse.ts +0 -0
  219. /package/src/{core → sdk/core}/fetcher/ResponseWithBody.ts +0 -0
  220. /package/src/{core → sdk/core}/fetcher/Supplier.ts +0 -0
  221. /package/src/{core → sdk/core}/fetcher/createRequestUrl.ts +0 -0
  222. /package/src/{core → sdk/core}/fetcher/getErrorResponseBody.ts +0 -0
  223. /package/src/{core → sdk/core}/fetcher/getFetchFn.ts +0 -0
  224. /package/src/{core → sdk/core}/fetcher/getHeader.ts +0 -0
  225. /package/src/{core → sdk/core}/fetcher/getRequestBody.ts +0 -0
  226. /package/src/{core → sdk/core}/fetcher/getResponseBody.ts +0 -0
  227. /package/src/{core → sdk/core}/fetcher/index.ts +0 -0
  228. /package/src/{core → sdk/core}/fetcher/makeRequest.ts +0 -0
  229. /package/src/{core → sdk/core}/fetcher/requestWithRetries.ts +0 -0
  230. /package/src/{core → sdk/core}/fetcher/signals.ts +0 -0
  231. /package/src/{core → sdk/core}/file.ts +0 -0
  232. /package/src/{core → sdk/core}/form-data-utils/FormDataWrapper.ts +0 -0
  233. /package/src/{core → sdk/core}/form-data-utils/encodeAsFormParameter.ts +0 -0
  234. /package/src/{core → sdk/core}/form-data-utils/index.ts +0 -0
  235. /package/src/{core → sdk/core}/headers.ts +0 -0
  236. /package/src/{core → sdk/core}/index.ts +0 -0
  237. /package/src/{core → sdk/core}/json.ts +0 -0
  238. /package/src/{core → sdk/core}/runtime/index.ts +0 -0
  239. /package/src/{core → sdk/core}/runtime/runtime.ts +0 -0
  240. /package/src/{core → sdk/core}/url/index.ts +0 -0
  241. /package/src/{core → sdk/core}/url/join.ts +0 -0
  242. /package/src/{core → sdk/core}/url/qs.ts +0 -0
  243. /package/src/{environments.ts → sdk/environments.ts} +0 -0
  244. /package/src/{errors → sdk/errors}/PlanqkApiError.ts +0 -0
  245. /package/src/{errors → sdk/errors}/PlanqkApiTimeoutError.ts +0 -0
  246. /package/src/{errors → sdk/errors}/index.ts +0 -0
@@ -0,0 +1,15 @@
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
+ },
8
+ "dependencies": {
9
+ "@planqk/planqk-api-sdk": "^1"
10
+ },
11
+ "devDependencies": {
12
+ "typescript": "^5",
13
+ "@types/node": "^22"
14
+ }
15
+ }
@@ -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);
@@ -4,13 +4,12 @@
4
4
  import * as environments from "./environments.js";
5
5
  import * as core from "./core/index.js";
6
6
  import { DataPools } from "./api/resources/dataPools/client/Client.js";
7
- import { Authentication } from "./api/resources/authentication/client/Client.js";
8
7
  export declare namespace PlanqkApiClient {
9
8
  interface Options {
10
9
  environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
11
10
  /** Specify a custom URL to connect the client to. */
12
11
  baseUrl?: core.Supplier<string>;
13
- apiKey?: core.Supplier<string | undefined>;
12
+ apiKey: core.Supplier<string>;
14
13
  /** Override the X-OrganizationId header */
15
14
  organizationId?: core.Supplier<string | undefined>;
16
15
  /** Additional headers to include in requests. */
@@ -32,8 +31,6 @@ export declare namespace PlanqkApiClient {
32
31
  export declare class PlanqkApiClient {
33
32
  protected readonly _options: PlanqkApiClient.Options;
34
33
  protected _dataPools: DataPools | undefined;
35
- protected _authentication: Authentication | undefined;
36
- constructor(_options?: PlanqkApiClient.Options);
34
+ constructor(_options: PlanqkApiClient.Options);
37
35
  get dataPools(): DataPools;
38
- get authentication(): Authentication;
39
36
  }
@@ -40,12 +40,10 @@ exports.PlanqkApiClient = void 0;
40
40
  const core = __importStar(require("./core/index.js"));
41
41
  const headers_js_1 = require("./core/headers.js");
42
42
  const Client_js_1 = require("./api/resources/dataPools/client/Client.js");
43
- const Client_js_2 = require("./api/resources/authentication/client/Client.js");
44
43
  class PlanqkApiClient {
45
44
  _options;
46
45
  _dataPools;
47
- _authentication;
48
- constructor(_options = {}) {
46
+ constructor(_options) {
49
47
  this._options = {
50
48
  ..._options,
51
49
  headers: (0, headers_js_1.mergeHeaders)({
@@ -59,8 +57,5 @@ class PlanqkApiClient {
59
57
  get dataPools() {
60
58
  return (this._dataPools ??= new Client_js_1.DataPools(this._options));
61
59
  }
62
- get authentication() {
63
- return (this._authentication ??= new Client_js_2.Authentication(this._options));
64
- }
65
60
  }
66
61
  exports.PlanqkApiClient = PlanqkApiClient;
@@ -9,7 +9,7 @@ export declare namespace DataPools {
9
9
  environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey?: core.Supplier<string | undefined>;
12
+ apiKey: core.Supplier<string>;
13
13
  /** Override the X-OrganizationId header */
14
14
  organizationId?: core.Supplier<string | undefined>;
15
15
  /** Additional headers to include in requests. */
@@ -33,7 +33,7 @@ export declare namespace DataPools {
33
33
  */
34
34
  export declare class DataPools {
35
35
  protected readonly _options: DataPools.Options;
36
- constructor(_options?: DataPools.Options);
36
+ constructor(_options: DataPools.Options);
37
37
  /**
38
38
  * Get a specific data pool (identified by its ID).
39
39
  *
@@ -179,6 +179,6 @@ export declare class DataPools {
179
179
  deleteDataPoolFile(id: string, fileId: string, requestOptions?: DataPools.RequestOptions): core.HttpResponsePromise<void>;
180
180
  private __deleteDataPoolFile;
181
181
  protected _getCustomAuthorizationHeaders(): Promise<{
182
- "X-Auth-Token": string | undefined;
182
+ "X-Auth-Token": string;
183
183
  }>;
184
184
  }
@@ -47,7 +47,7 @@ const errors = __importStar(require("../../../../errors/index.js"));
47
47
  */
48
48
  class DataPools {
49
49
  _options;
50
- constructor(_options = {}) {
50
+ constructor(_options) {
51
51
  this._options = _options;
52
52
  }
53
53
  /**
@@ -0,0 +1,2 @@
1
+ export * as dataPools from "./dataPools/index.js";
2
+ export * from "./dataPools/client/requests/index.js";
@@ -36,8 +36,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
36
36
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
37
37
  };
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.dataPools = exports.authentication = void 0;
40
- exports.authentication = __importStar(require("./authentication/index.js"));
41
- __exportStar(require("./authentication/types/index.js"), exports);
39
+ exports.dataPools = void 0;
42
40
  exports.dataPools = __importStar(require("./dataPools/index.js"));
43
41
  __exportStar(require("./dataPools/client/requests/index.js"), exports);
@@ -0,0 +1,3 @@
1
+ export * from "./OauthScope.js";
2
+ export * from "./DataPoolDto.js";
3
+ export * from "./DataPoolFileDto.js";
@@ -14,4 +14,6 @@ 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("./AuthorizeResponse.js"), exports);
17
+ __exportStar(require("./OauthScope.js"), exports);
18
+ __exportStar(require("./DataPoolDto.js"), exports);
19
+ __exportStar(require("./DataPoolFileDto.js"), exports);
@@ -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.25"
3
+ "version": "0.65.35"
4
4
  }
@@ -17,10 +17,6 @@
17
17
  }
18
18
  ],
19
19
  "tags": [
20
- {
21
- "name": "Authentication",
22
- "description": "Endpoints for checking authentication and authorization."
23
- },
24
20
  {
25
21
  "name": "Data Pools",
26
22
  "description": "Manage data pools, which are organized collections of files that serve as reusable data sources for services."
@@ -475,57 +471,6 @@
475
471
  ]
476
472
  }
477
473
  },
478
- "/authorize": {
479
- "post": {
480
- "tags": [
481
- "Authentication"
482
- ],
483
- "description": "Get the authenticated principal based on the provided token.",
484
- "operationId": "authorize",
485
- "parameters": [
486
- {
487
- "name": "X-Auth-Token",
488
- "in": "header",
489
- "required": false,
490
- "schema": {
491
- "type": "string"
492
- }
493
- }
494
- ],
495
- "responses": {
496
- "200": {
497
- "description": "The scopes of the provided token.",
498
- "content": {
499
- "application/json": {
500
- "schema": {
501
- "type": "object",
502
- "oneOf": [
503
- {
504
- "$ref": "#/components/schemas/PersonalAccessTokenPrincipal"
505
- },
506
- {
507
- "$ref": "#/components/schemas/ServiceExecutionTokenPrincipal"
508
- }
509
- ]
510
- }
511
- }
512
- }
513
- },
514
- "401": {
515
- "description": "Unauthorized"
516
- },
517
- "403": {
518
- "description": "Forbidden"
519
- },
520
- "404": {
521
- "description": "Not Found"
522
- },
523
- "500": {
524
- "description": "Internal Server Error"
525
- }
526
- }
527
- }
528
- },
529
474
  "/datapools/{id}/files/{fileId}": {
530
475
  "get": {
531
476
  "tags": [
@@ -746,151 +691,6 @@
746
691
  "pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
747
692
  }
748
693
  }
749
- },
750
- "AccessToken": {
751
- "type": "object",
752
- "properties": {
753
- "id": {
754
- "type": "string",
755
- "format": "uuid"
756
- },
757
- "name": {
758
- "type": "string"
759
- },
760
- "createdAt": {
761
- "type": "string",
762
- "format": "date-time"
763
- },
764
- "usedAt": {
765
- "type": "string",
766
- "format": "date-time"
767
- },
768
- "expiresAt": {
769
- "type": "string",
770
- "format": "date"
771
- }
772
- }
773
- },
774
- "OrganizationMembership": {
775
- "type": "object",
776
- "properties": {
777
- "id": {
778
- "type": "string",
779
- "format": "uuid"
780
- },
781
- "accountType": {
782
- "type": "string",
783
- "enum": [
784
- "BASIC",
785
- "PRO",
786
- "BUSINESS"
787
- ]
788
- },
789
- "role": {
790
- "type": "string",
791
- "enum": [
792
- "VIEWER",
793
- "MAINTAINER",
794
- "OWNER"
795
- ]
796
- }
797
- }
798
- },
799
- "PersonalAccessTokenPrincipal": {
800
- "type": "object",
801
- "properties": {
802
- "id": {
803
- "type": "string",
804
- "format": "uuid"
805
- },
806
- "accessToken": {
807
- "$ref": "#/components/schemas/AccessToken"
808
- },
809
- "accountType": {
810
- "type": "string",
811
- "enum": [
812
- "BASIC",
813
- "PRO",
814
- "BUSINESS"
815
- ]
816
- },
817
- "organizationMemberships": {
818
- "type": "array",
819
- "items": {
820
- "$ref": "#/components/schemas/OrganizationMembership"
821
- }
822
- }
823
- }
824
- },
825
- "ServiceExecution": {
826
- "type": "object",
827
- "properties": {
828
- "id": {
829
- "type": "string",
830
- "format": "uuid"
831
- },
832
- "createdAt": {
833
- "type": "string",
834
- "format": "date-time"
835
- },
836
- "startedAt": {
837
- "type": "string",
838
- "format": "date-time"
839
- },
840
- "endedAt": {
841
- "type": "string",
842
- "format": "date-time"
843
- },
844
- "status": {
845
- "type": "string",
846
- "enum": [
847
- "UNKNOWN",
848
- "PENDING",
849
- "RUNNING",
850
- "SUCCEEDED",
851
- "FAILED"
852
- ]
853
- }
854
- }
855
- },
856
- "ServiceExecutionTokenPrincipal": {
857
- "type": "object",
858
- "properties": {
859
- "serviceExecution": {
860
- "$ref": "#/components/schemas/ServiceExecution"
861
- },
862
- "serviceProvider": {
863
- "$ref": "#/components/schemas/UserContext"
864
- }
865
- }
866
- },
867
- "UserContext": {
868
- "type": "object",
869
- "properties": {
870
- "id": {
871
- "type": "string",
872
- "format": "uuid"
873
- },
874
- "contextType": {
875
- "type": "string",
876
- "enum": [
877
- "USER",
878
- "ORGANIZATION",
879
- "SERVICE_EXECUTION"
880
- ]
881
- },
882
- "accountType": {
883
- "type": "string",
884
- "enum": [
885
- "BASIC",
886
- "PRO",
887
- "BUSINESS"
888
- ]
889
- },
890
- "parent": {
891
- "$ref": "#/components/schemas/UserContext"
892
- }
893
- }
894
694
  }
895
695
  },
896
696
  "securitySchemes": {
@@ -903,8 +703,8 @@
903
703
  "type": "oauth2",
904
704
  "flows": {
905
705
  "password": {
906
- "tokenUrl": "https://login.platform.planqk.de/realms/planqk/protocol/openid-connect/token",
907
- "refreshUrl": "https://login.platform.planqk.de/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",
908
708
  "scopes": {
909
709
  "profile": ""
910
710
  }
@@ -55,6 +55,7 @@
55
55
  "\n",
56
56
  "# Create a new data pool\n",
57
57
  "data_pool = client.data_pools.create_data_pool(name=\"Example Data Pool\")\n",
58
+ "data_pool = client.api.data_pools.get_data_pool(id=data_pool.id)\n",
58
59
  "\n",
59
60
  "# Add a file to the data pool\n",
60
61
  "file = client.data_pools.add_data_pool_file(\n",
@@ -210,7 +211,7 @@
210
211
  "name": "python",
211
212
  "nbconvert_exporter": "python",
212
213
  "pygments_lexer": "ipython3",
213
- "version": "3.11.11"
214
+ "version": "3.11.9"
214
215
  }
215
216
  },
216
217
  "nbformat": 4,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@planqk/planqk-api-sdk",
3
- "version": "1.2.0",
4
- "description": "SDK to interact with official PLANQK API.",
3
+ "version": "1.3.1",
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.2.0"
1
+ __version__ = "1.3.1"
@@ -1,6 +1,8 @@
1
1
  import os
2
2
  from typing import Optional
3
3
 
4
+ from deprecated import deprecated
5
+
4
6
  from planqk.api.credentials import DefaultCredentialsProvider
5
7
  from planqk.api.sdk import PlanqkApi
6
8
  from planqk.api.sdk.data_pools.client import DataPoolsClient
@@ -13,8 +15,9 @@ class PlanqkApiClient:
13
15
  base_url = os.environ.get(_PLANQK_API_BASE_URL_NAME, "https://platform.planqk.de/qc-catalog")
14
16
  credentials_provider = DefaultCredentialsProvider(access_token)
15
17
 
16
- self._api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)
18
+ self.api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)
17
19
 
18
20
  @property
21
+ @deprecated(version="1.3.0", reason="Use `api.data_pools` instead.")
19
22
  def data_pools(self) -> DataPoolsClient:
20
- return self._api.data_pools
23
+ return self.api.data_pools
@@ -2,34 +2,14 @@
2
2
 
3
3
  # isort: skip_file
4
4
 
5
- from .types import (
6
- AccessToken,
7
- DataPoolDto,
8
- DataPoolDtoCurrentUserPermission,
9
- DataPoolFileDto,
10
- OauthScope,
11
- OrganizationMembership,
12
- OrganizationMembershipAccountType,
13
- OrganizationMembershipRole,
14
- PersonalAccessTokenPrincipal,
15
- PersonalAccessTokenPrincipalAccountType,
16
- ServiceExecution,
17
- ServiceExecutionStatus,
18
- ServiceExecutionTokenPrincipal,
19
- UserContext,
20
- UserContextAccountType,
21
- UserContextContextType,
22
- )
5
+ from .types import DataPoolDto, DataPoolDtoCurrentUserPermission, DataPoolFileDto, OauthScope
23
6
  from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError, UnauthorizedError
24
- from . import authentication, data_pools
25
- from .authentication import AuthorizeResponse
7
+ from . import data_pools
26
8
  from .client import AsyncPlanqkApi, PlanqkApi
27
9
  from .environment import PlanqkApiEnvironment
28
10
 
29
11
  __all__ = [
30
- "AccessToken",
31
12
  "AsyncPlanqkApi",
32
- "AuthorizeResponse",
33
13
  "BadRequestError",
34
14
  "DataPoolDto",
35
15
  "DataPoolDtoCurrentUserPermission",
@@ -38,20 +18,8 @@ __all__ = [
38
18
  "InternalServerError",
39
19
  "NotFoundError",
40
20
  "OauthScope",
41
- "OrganizationMembership",
42
- "OrganizationMembershipAccountType",
43
- "OrganizationMembershipRole",
44
- "PersonalAccessTokenPrincipal",
45
- "PersonalAccessTokenPrincipalAccountType",
46
21
  "PlanqkApi",
47
22
  "PlanqkApiEnvironment",
48
- "ServiceExecution",
49
- "ServiceExecutionStatus",
50
- "ServiceExecutionTokenPrincipal",
51
23
  "UnauthorizedError",
52
- "UserContext",
53
- "UserContextAccountType",
54
- "UserContextContextType",
55
- "authentication",
56
24
  "data_pools",
57
25
  ]
@@ -3,7 +3,6 @@
3
3
  import typing
4
4
 
5
5
  import httpx
6
- from .authentication.client import AsyncAuthenticationClient, AuthenticationClient
7
6
  from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
8
7
  from .data_pools.client import AsyncDataPoolsClient, DataPoolsClient
9
8
  from .environment import PlanqkApiEnvironment
@@ -79,7 +78,6 @@ class PlanqkApi:
79
78
  timeout=_defaulted_timeout,
80
79
  )
81
80
  self.data_pools = DataPoolsClient(client_wrapper=self._client_wrapper)
82
- self.authentication = AuthenticationClient(client_wrapper=self._client_wrapper)
83
81
 
84
82
 
85
83
  class AsyncPlanqkApi:
@@ -152,7 +150,6 @@ class AsyncPlanqkApi:
152
150
  timeout=_defaulted_timeout,
153
151
  )
154
152
  self.data_pools = AsyncDataPoolsClient(client_wrapper=self._client_wrapper)
155
- self.authentication = AsyncAuthenticationClient(client_wrapper=self._client_wrapper)
156
153
 
157
154
 
158
155
  def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PlanqkApiEnvironment) -> str:
@@ -2,38 +2,9 @@
2
2
 
3
3
  # isort: skip_file
4
4
 
5
- from .access_token import AccessToken
6
5
  from .data_pool_dto import DataPoolDto
7
6
  from .data_pool_dto_current_user_permission import DataPoolDtoCurrentUserPermission
8
7
  from .data_pool_file_dto import DataPoolFileDto
9
8
  from .oauth_scope import OauthScope
10
- from .organization_membership import OrganizationMembership
11
- from .organization_membership_account_type import OrganizationMembershipAccountType
12
- from .organization_membership_role import OrganizationMembershipRole
13
- from .personal_access_token_principal import PersonalAccessTokenPrincipal
14
- from .personal_access_token_principal_account_type import PersonalAccessTokenPrincipalAccountType
15
- from .service_execution import ServiceExecution
16
- from .service_execution_status import ServiceExecutionStatus
17
- from .service_execution_token_principal import ServiceExecutionTokenPrincipal
18
- from .user_context import UserContext
19
- from .user_context_account_type import UserContextAccountType
20
- from .user_context_context_type import UserContextContextType
21
9
 
22
- __all__ = [
23
- "AccessToken",
24
- "DataPoolDto",
25
- "DataPoolDtoCurrentUserPermission",
26
- "DataPoolFileDto",
27
- "OauthScope",
28
- "OrganizationMembership",
29
- "OrganizationMembershipAccountType",
30
- "OrganizationMembershipRole",
31
- "PersonalAccessTokenPrincipal",
32
- "PersonalAccessTokenPrincipalAccountType",
33
- "ServiceExecution",
34
- "ServiceExecutionStatus",
35
- "ServiceExecutionTokenPrincipal",
36
- "UserContext",
37
- "UserContextAccountType",
38
- "UserContextContextType",
39
- ]
10
+ __all__ = ["DataPoolDto", "DataPoolDtoCurrentUserPermission", "DataPoolFileDto", "OauthScope"]