@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.
- package/README-node.md +17 -0
- package/README-python.md +17 -0
- package/README.md +66 -6
- package/package.json +1 -1
- package/pyproject.toml +1 -1
- package/uv.lock +1 -1
- package/.gitlab-ci.yml +0 -110
- package/dist/index.d.ts +0 -1
- package/dist/index.js +0 -17
- package/dist/sdk/Client.d.ts +0 -44
- package/dist/sdk/Client.js +0 -71
- package/dist/sdk/api/errors/BadRequestError.d.ts +0 -8
- package/dist/sdk/api/errors/BadRequestError.js +0 -52
- package/dist/sdk/api/errors/ForbiddenError.d.ts +0 -8
- package/dist/sdk/api/errors/ForbiddenError.js +0 -52
- package/dist/sdk/api/errors/InternalServerError.d.ts +0 -8
- package/dist/sdk/api/errors/InternalServerError.js +0 -52
- package/dist/sdk/api/errors/NotFoundError.d.ts +0 -8
- package/dist/sdk/api/errors/NotFoundError.js +0 -52
- package/dist/sdk/api/errors/UnauthorizedError.d.ts +0 -8
- package/dist/sdk/api/errors/UnauthorizedError.js +0 -52
- package/dist/sdk/api/errors/index.d.ts +0 -5
- package/dist/sdk/api/errors/index.js +0 -21
- package/dist/sdk/api/index.d.ts +0 -3
- package/dist/sdk/api/index.js +0 -19
- package/dist/sdk/api/resources/dataPools/client/Client.d.ts +0 -187
- package/dist/sdk/api/resources/dataPools/client/Client.js +0 -722
- package/dist/sdk/api/resources/dataPools/client/index.d.ts +0 -2
- package/dist/sdk/api/resources/dataPools/client/index.js +0 -17
- package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts +0 -14
- package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.js +0 -5
- package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts +0 -11
- package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.js +0 -5
- package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts +0 -15
- package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.js +0 -5
- package/dist/sdk/api/resources/dataPools/client/requests/index.d.ts +0 -3
- package/dist/sdk/api/resources/dataPools/client/requests/index.js +0 -2
- package/dist/sdk/api/resources/dataPools/index.d.ts +0 -1
- package/dist/sdk/api/resources/dataPools/index.js +0 -17
- package/dist/sdk/api/resources/index.d.ts +0 -5
- package/dist/sdk/api/resources/index.js +0 -44
- package/dist/sdk/api/resources/serviceExecutions/client/Client.d.ts +0 -90
- package/dist/sdk/api/resources/serviceExecutions/client/Client.js +0 -271
- package/dist/sdk/api/resources/serviceExecutions/client/index.d.ts +0 -1
- package/dist/sdk/api/resources/serviceExecutions/client/index.js +0 -2
- package/dist/sdk/api/resources/serviceExecutions/index.d.ts +0 -1
- package/dist/sdk/api/resources/serviceExecutions/index.js +0 -17
- package/dist/sdk/api/resources/serviceJobs/client/Client.d.ts +0 -138
- package/dist/sdk/api/resources/serviceJobs/client/Client.js +0 -489
- package/dist/sdk/api/resources/serviceJobs/client/index.d.ts +0 -2
- package/dist/sdk/api/resources/serviceJobs/client/index.js +0 -17
- package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.d.ts +0 -15
- package/dist/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.js +0 -5
- package/dist/sdk/api/resources/serviceJobs/client/requests/index.d.ts +0 -1
- package/dist/sdk/api/resources/serviceJobs/client/requests/index.js +0 -2
- package/dist/sdk/api/resources/serviceJobs/index.d.ts +0 -1
- package/dist/sdk/api/resources/serviceJobs/index.js +0 -17
- package/dist/sdk/api/types/ActivityInstance.d.ts +0 -20
- package/dist/sdk/api/types/ActivityInstance.js +0 -14
- package/dist/sdk/api/types/DataPoolDto.d.ts +0 -28
- package/dist/sdk/api/types/DataPoolDto.js +0 -14
- package/dist/sdk/api/types/DataPoolFileDto.d.ts +0 -19
- package/dist/sdk/api/types/DataPoolFileDto.js +0 -5
- package/dist/sdk/api/types/LogEntry.d.ts +0 -24
- package/dist/sdk/api/types/LogEntry.js +0 -16
- package/dist/sdk/api/types/MetricDataPoint.d.ts +0 -12
- package/dist/sdk/api/types/MetricDataPoint.js +0 -5
- package/dist/sdk/api/types/OauthScope.d.ts +0 -9
- package/dist/sdk/api/types/OauthScope.js +0 -9
- package/dist/sdk/api/types/ServiceExecutionDto.d.ts +0 -21
- package/dist/sdk/api/types/ServiceExecutionDto.js +0 -17
- package/dist/sdk/api/types/ServiceExecutionLogs.d.ts +0 -5
- package/dist/sdk/api/types/ServiceExecutionLogs.js +0 -5
- package/dist/sdk/api/types/ServiceExecutionMetrics.d.ts +0 -23
- package/dist/sdk/api/types/ServiceExecutionMetrics.js +0 -5
- package/dist/sdk/api/types/ServiceJobDto.d.ts +0 -46
- package/dist/sdk/api/types/ServiceJobDto.js +0 -22
- package/dist/sdk/api/types/VariableInstance.d.ts +0 -9
- package/dist/sdk/api/types/VariableInstance.js +0 -5
- package/dist/sdk/api/types/WorkflowInstance.d.ts +0 -23
- package/dist/sdk/api/types/WorkflowInstance.js +0 -17
- package/dist/sdk/api/types/WorkflowServiceExecutionDto.d.ts +0 -8
- package/dist/sdk/api/types/WorkflowServiceExecutionDto.js +0 -5
- package/dist/sdk/api/types/index.d.ts +0 -13
- package/dist/sdk/api/types/index.js +0 -29
- package/dist/sdk/core/exports.d.ts +0 -1
- package/dist/sdk/core/exports.js +0 -17
- package/dist/sdk/core/fetcher/APIResponse.d.ts +0 -20
- package/dist/sdk/core/fetcher/APIResponse.js +0 -2
- package/dist/sdk/core/fetcher/BinaryResponse.d.ts +0 -20
- package/dist/sdk/core/fetcher/BinaryResponse.js +0 -17
- package/dist/sdk/core/fetcher/Fetcher.d.ts +0 -40
- package/dist/sdk/core/fetcher/Fetcher.js +0 -105
- package/dist/sdk/core/fetcher/Headers.d.ts +0 -2
- package/dist/sdk/core/fetcher/Headers.js +0 -85
- package/dist/sdk/core/fetcher/HttpResponsePromise.d.ts +0 -58
- package/dist/sdk/core/fetcher/HttpResponsePromise.js +0 -94
- package/dist/sdk/core/fetcher/RawResponse.d.ts +0 -29
- package/dist/sdk/core/fetcher/RawResponse.js +0 -44
- package/dist/sdk/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/sdk/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/sdk/core/fetcher/Supplier.d.ts +0 -4
- package/dist/sdk/core/fetcher/Supplier.js +0 -13
- package/dist/sdk/core/fetcher/createRequestUrl.d.ts +0 -1
- package/dist/sdk/core/fetcher/createRequestUrl.js +0 -8
- package/dist/sdk/core/fetcher/getErrorResponseBody.d.ts +0 -1
- package/dist/sdk/core/fetcher/getErrorResponseBody.js +0 -32
- package/dist/sdk/core/fetcher/getFetchFn.d.ts +0 -1
- package/dist/sdk/core/fetcher/getFetchFn.js +0 -6
- package/dist/sdk/core/fetcher/getHeader.d.ts +0 -1
- package/dist/sdk/core/fetcher/getHeader.js +0 -11
- package/dist/sdk/core/fetcher/getRequestBody.d.ts +0 -7
- package/dist/sdk/core/fetcher/getRequestBody.js +0 -12
- package/dist/sdk/core/fetcher/getResponseBody.d.ts +0 -1
- package/dist/sdk/core/fetcher/getResponseBody.js +0 -44
- package/dist/sdk/core/fetcher/index.d.ts +0 -9
- package/dist/sdk/core/fetcher/index.js +0 -15
- package/dist/sdk/core/fetcher/makeRequest.d.ts +0 -1
- package/dist/sdk/core/fetcher/makeRequest.js +0 -33
- package/dist/sdk/core/fetcher/requestWithRetries.d.ts +0 -1
- package/dist/sdk/core/fetcher/requestWithRetries.js +0 -29
- package/dist/sdk/core/fetcher/signals.d.ts +0 -11
- package/dist/sdk/core/fetcher/signals.js +0 -36
- package/dist/sdk/core/file/exports.d.ts +0 -1
- package/dist/sdk/core/file/exports.js +0 -2
- package/dist/sdk/core/file/file.d.ts +0 -5
- package/dist/sdk/core/file/file.js +0 -185
- package/dist/sdk/core/file/index.d.ts +0 -2
- package/dist/sdk/core/file/index.js +0 -18
- package/dist/sdk/core/file/types.d.ts +0 -66
- package/dist/sdk/core/file/types.js +0 -2
- package/dist/sdk/core/form-data-utils/FormDataWrapper.d.ts +0 -16
- package/dist/sdk/core/form-data-utils/FormDataWrapper.js +0 -175
- package/dist/sdk/core/form-data-utils/encodeAsFormParameter.d.ts +0 -1
- package/dist/sdk/core/form-data-utils/encodeAsFormParameter.js +0 -12
- package/dist/sdk/core/form-data-utils/index.d.ts +0 -2
- package/dist/sdk/core/form-data-utils/index.js +0 -20
- package/dist/sdk/core/headers.d.ts +0 -3
- package/dist/sdk/core/headers.js +0 -29
- package/dist/sdk/core/index.d.ts +0 -5
- package/dist/sdk/core/index.js +0 -44
- package/dist/sdk/core/json.d.ts +0 -15
- package/dist/sdk/core/json.js +0 -24
- package/dist/sdk/core/runtime/index.d.ts +0 -1
- package/dist/sdk/core/runtime/index.js +0 -5
- package/dist/sdk/core/runtime/runtime.d.ts +0 -9
- package/dist/sdk/core/runtime/runtime.js +0 -101
- package/dist/sdk/core/url/index.d.ts +0 -2
- package/dist/sdk/core/url/index.js +0 -7
- package/dist/sdk/core/url/join.d.ts +0 -1
- package/dist/sdk/core/url/join.js +0 -69
- package/dist/sdk/core/url/qs.d.ts +0 -6
- package/dist/sdk/core/url/qs.js +0 -67
- package/dist/sdk/environments.d.ts +0 -7
- package/dist/sdk/environments.js +0 -9
- package/dist/sdk/errors/PlanqkApiError.d.ts +0 -15
- package/dist/sdk/errors/PlanqkApiError.js +0 -33
- package/dist/sdk/errors/PlanqkApiTimeoutError.d.ts +0 -6
- package/dist/sdk/errors/PlanqkApiTimeoutError.js +0 -13
- package/dist/sdk/errors/index.d.ts +0 -2
- package/dist/sdk/errors/index.js +0 -7
- package/dist/sdk/exports.d.ts +0 -1
- package/dist/sdk/exports.js +0 -17
- package/dist/sdk/index.d.ts +0 -5
- package/dist/sdk/index.js +0 -48
package/README-node.md
CHANGED
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
> **⚠️ DEPRECATED ⚠️**
|
|
2
|
+
>
|
|
3
|
+
> **This package has been deprecated and is no longer maintained.**
|
|
4
|
+
>
|
|
5
|
+
> Please migrate to the new package:
|
|
6
|
+
> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
|
|
7
|
+
> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
|
|
8
|
+
>
|
|
9
|
+
> Install the new package:
|
|
10
|
+
> ```bash
|
|
11
|
+
> pip install qhub-api
|
|
12
|
+
> # or
|
|
13
|
+
> npm install @quantum-hub/qhub-api
|
|
14
|
+
> ```
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
1
18
|
# PLANQK API SDK
|
|
2
19
|
|
|
3
20
|
## Installation
|
package/README-python.md
CHANGED
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
> **⚠️ DEPRECATED ⚠️**
|
|
2
|
+
>
|
|
3
|
+
> **This package has been deprecated and is no longer maintained.**
|
|
4
|
+
>
|
|
5
|
+
> Please migrate to the new package:
|
|
6
|
+
> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
|
|
7
|
+
> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
|
|
8
|
+
>
|
|
9
|
+
> Install the new package:
|
|
10
|
+
> ```bash
|
|
11
|
+
> pip install qhub-api
|
|
12
|
+
> # or
|
|
13
|
+
> npm install @quantum-hub/qhub-api
|
|
14
|
+
> ```
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
1
18
|
# PLANQK API SDK
|
|
2
19
|
|
|
3
20
|
## Installation
|
package/README.md
CHANGED
|
@@ -1,13 +1,73 @@
|
|
|
1
|
-
|
|
1
|
+
> **⚠️ DEPRECATED ⚠️**
|
|
2
|
+
>
|
|
3
|
+
> **This package has been deprecated and is no longer maintained.**
|
|
4
|
+
>
|
|
5
|
+
> Please migrate to the new package:
|
|
6
|
+
> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
|
|
7
|
+
> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
|
|
8
|
+
>
|
|
9
|
+
> Install the new package:
|
|
10
|
+
> ```bash
|
|
11
|
+
> pip install qhub-api
|
|
12
|
+
> # or
|
|
13
|
+
> npm install @quantum-hub/qhub-api
|
|
14
|
+
> ```
|
|
2
15
|
|
|
3
|
-
|
|
16
|
+
---
|
|
4
17
|
|
|
5
|
-
|
|
18
|
+
# planqk-api-sdk
|
|
19
|
+
|
|
20
|
+
This repository contains the SDK to interact with the official PLANQK API.
|
|
21
|
+
The clients are generated from a [OpenAPI](https://swagger.io/specification) description using [Fern](https://buildwithfern.com).
|
|
22
|
+
The generated clients are a baseline, and the idea is to adapt and extend them to our specific needs.
|
|
23
|
+
|
|
24
|
+
## Generate the SDK clients with Fern
|
|
25
|
+
|
|
26
|
+
> <https://buildwithfern.com/docs/getting-started>
|
|
6
27
|
|
|
7
28
|
```bash
|
|
8
|
-
npm install
|
|
29
|
+
npm install -g fern-api
|
|
30
|
+
fern upgrade
|
|
31
|
+
fern generate
|
|
9
32
|
```
|
|
10
33
|
|
|
11
|
-
##
|
|
34
|
+
## Python Setup
|
|
35
|
+
|
|
36
|
+
To create a new virtual environment and install the dependencies, run:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
uv venv
|
|
40
|
+
source .venv/bin/activate
|
|
41
|
+
|
|
42
|
+
uv sync
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Update dependencies and lock files:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
uv sync -U
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## How to update the Python client?
|
|
52
|
+
|
|
53
|
+
After generating the SDK clients with Fern, the Python client needs to be copied manually.
|
|
54
|
+
|
|
55
|
+
Copy the content of `./generated/python` to `./planqk/api/sdk`.
|
|
56
|
+
Make sure you overwrite any existing files.
|
|
57
|
+
It is recommended to remove the old files first.
|
|
58
|
+
|
|
59
|
+
Next, check if the changes are compatible with our wrapper, e.g., by running the Jupyter notebook in the `notebooks` directory.
|
|
60
|
+
|
|
61
|
+
## How to update the TypeScript client?
|
|
62
|
+
|
|
63
|
+
After generating the SDK clients with Fern, the TypeScript client needs to be copied manually.
|
|
64
|
+
|
|
65
|
+
Copy the content of `./generated/typescript` to `./typescript/src/sdk`.
|
|
66
|
+
Make sure you overwrite any existing files.
|
|
67
|
+
It is recommended to remove the old files first.
|
|
68
|
+
|
|
69
|
+
Next, check if the changes are compatible with our wrapper, e.g., by running the `index.test.ts` file.
|
|
70
|
+
|
|
71
|
+
## License
|
|
12
72
|
|
|
13
|
-
|
|
73
|
+
Apache-2.0 | Copyright 2025 Kipu Quantum GmbH
|
package/package.json
CHANGED
package/pyproject.toml
CHANGED
package/uv.lock
CHANGED
package/.gitlab-ci.yml
DELETED
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
variables:
|
|
2
|
-
TWINE_USERNAME: __token__
|
|
3
|
-
UV_VERSION: 0.8
|
|
4
|
-
PYTHON_VERSION: 3.11
|
|
5
|
-
BASE_LAYER: bookworm-slim
|
|
6
|
-
# GitLab CI creates a separate mountpoint for the build directory,
|
|
7
|
-
# so we need to copy instead of using hard links.
|
|
8
|
-
UV_LINK_MODE: copy
|
|
9
|
-
UV_CACHE_DIR: .uv-cache
|
|
10
|
-
|
|
11
|
-
stages:
|
|
12
|
-
- commit-test
|
|
13
|
-
- compliance
|
|
14
|
-
- commit-release-check
|
|
15
|
-
- release-package
|
|
16
|
-
|
|
17
|
-
compile-node-sdk:
|
|
18
|
-
stage: commit-test
|
|
19
|
-
rules:
|
|
20
|
-
- if: '$CI_COMMIT_MESSAGE =~ /^chore\(release\):/'
|
|
21
|
-
when: never
|
|
22
|
-
- if: '$CI_PIPELINE_SOURCE == "web"'
|
|
23
|
-
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
|
24
|
-
image: node:lts
|
|
25
|
-
before_script:
|
|
26
|
-
- npm ci
|
|
27
|
-
script:
|
|
28
|
-
- npm run build
|
|
29
|
-
cache:
|
|
30
|
-
key: node_modules
|
|
31
|
-
paths:
|
|
32
|
-
- node_modules
|
|
33
|
-
|
|
34
|
-
semantic-release:
|
|
35
|
-
stage: commit-release-check
|
|
36
|
-
rules:
|
|
37
|
-
- if: '$CI_COMMIT_MESSAGE =~ /^chore\(release\):/'
|
|
38
|
-
when: never
|
|
39
|
-
- if: '$CI_PIPELINE_SOURCE == "web"'
|
|
40
|
-
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
|
41
|
-
variables:
|
|
42
|
-
BASE_LAYER: bookworm
|
|
43
|
-
GIT_AUTHOR_NAME: "$GITLAB_USER_NAME"
|
|
44
|
-
GIT_AUTHOR_EMAIL: "$GITLAB_USER_EMAIL"
|
|
45
|
-
GIT_COMMITTER_NAME: "$GITLAB_USER_NAME"
|
|
46
|
-
GIT_COMMITTER_EMAIL: "$GITLAB_USER_EMAIL"
|
|
47
|
-
image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
|
|
48
|
-
before_script:
|
|
49
|
-
- curl -o- https://fnm.vercel.app/install | bash
|
|
50
|
-
- source ~/.bashrc
|
|
51
|
-
- fnm install 22
|
|
52
|
-
- npm install -g semantic-release @semantic-release/gitlab @semantic-release/git @semantic-release/exec
|
|
53
|
-
script:
|
|
54
|
-
- semantic-release
|
|
55
|
-
|
|
56
|
-
oss-compliance-check:
|
|
57
|
-
stage: compliance
|
|
58
|
-
rules:
|
|
59
|
-
- if: "$CI_COMMIT_TAG"
|
|
60
|
-
image: ubuntu:latest
|
|
61
|
-
before_script:
|
|
62
|
-
- apt-get update && apt-get install -y --no-install-recommends ca-certificates curl
|
|
63
|
-
- curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install-latest.sh | bash
|
|
64
|
-
script:
|
|
65
|
-
- FOSSA_REVISION=$([ -z $CI_COMMIT_TAG ] && echo $CI_COMMIT_SHA || echo $CI_COMMIT_TAG)
|
|
66
|
-
- FOSSA_BRANCH=$([ -z $CI_COMMIT_BRANCH ] && echo 'main' || echo $CI_COMMIT_BRANCH)
|
|
67
|
-
- fossa analyze -b $FOSSA_BRANCH -r $FOSSA_REVISION .
|
|
68
|
-
- fossa test -r $FOSSA_REVISION
|
|
69
|
-
|
|
70
|
-
publish-python-sdk:
|
|
71
|
-
stage: release-package
|
|
72
|
-
rules:
|
|
73
|
-
- if: '$CI_COMMIT_TAG'
|
|
74
|
-
image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
|
|
75
|
-
before_script:
|
|
76
|
-
- uv venv
|
|
77
|
-
- uv sync --frozen
|
|
78
|
-
- source .venv/bin/activate
|
|
79
|
-
- uv pip install twine
|
|
80
|
-
script:
|
|
81
|
-
- uv build
|
|
82
|
-
- twine upload dist/*
|
|
83
|
-
cache:
|
|
84
|
-
- key:
|
|
85
|
-
files:
|
|
86
|
-
- uv.lock
|
|
87
|
-
paths:
|
|
88
|
-
- $UV_CACHE_DIR
|
|
89
|
-
|
|
90
|
-
publish-node-sdk:
|
|
91
|
-
stage: release-package
|
|
92
|
-
rules:
|
|
93
|
-
- if: '$CI_COMMIT_TAG'
|
|
94
|
-
image: node:lts
|
|
95
|
-
id_tokens:
|
|
96
|
-
NPM_ID_TOKEN:
|
|
97
|
-
aud: "npm:registry.npmjs.org"
|
|
98
|
-
SIGSTORE_ID_TOKEN:
|
|
99
|
-
aud: sigstore
|
|
100
|
-
before_script:
|
|
101
|
-
- npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
|
|
102
|
-
script:
|
|
103
|
-
- npm ci
|
|
104
|
-
- cp README-node.md README.md
|
|
105
|
-
- npm run build
|
|
106
|
-
- npm publish
|
|
107
|
-
cache:
|
|
108
|
-
key: node_modules
|
|
109
|
-
paths:
|
|
110
|
-
- node_modules
|
package/dist/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./sdk";
|
package/dist/index.js
DELETED
|
@@ -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("./sdk"), exports);
|
package/dist/sdk/Client.d.ts
DELETED
|
@@ -1,44 +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 { ServiceJobs } from "./api/resources/serviceJobs/client/Client.js";
|
|
7
|
-
import { DataPools } from "./api/resources/dataPools/client/Client.js";
|
|
8
|
-
import { ServiceExecutions } from "./api/resources/serviceExecutions/client/Client.js";
|
|
9
|
-
export declare namespace PlanqkApiClient {
|
|
10
|
-
interface Options {
|
|
11
|
-
environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
|
|
12
|
-
/** Specify a custom URL to connect the client to. */
|
|
13
|
-
baseUrl?: core.Supplier<string>;
|
|
14
|
-
apiKey: core.Supplier<string>;
|
|
15
|
-
/** Override the X-OrganizationId header */
|
|
16
|
-
organizationId?: core.Supplier<string | undefined>;
|
|
17
|
-
/** Additional headers to include in requests. */
|
|
18
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
19
|
-
}
|
|
20
|
-
interface RequestOptions {
|
|
21
|
-
/** The maximum time to wait for a response in seconds. */
|
|
22
|
-
timeoutInSeconds?: number;
|
|
23
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
24
|
-
maxRetries?: number;
|
|
25
|
-
/** A hook to abort the request. */
|
|
26
|
-
abortSignal?: AbortSignal;
|
|
27
|
-
/** Override the X-OrganizationId header */
|
|
28
|
-
organizationId?: string | undefined;
|
|
29
|
-
/** Additional query string parameters to include in the request. */
|
|
30
|
-
queryParams?: Record<string, unknown>;
|
|
31
|
-
/** Additional headers to include in the request. */
|
|
32
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
export declare class PlanqkApiClient {
|
|
36
|
-
protected readonly _options: PlanqkApiClient.Options;
|
|
37
|
-
protected _serviceJobs: ServiceJobs | undefined;
|
|
38
|
-
protected _dataPools: DataPools | undefined;
|
|
39
|
-
protected _serviceExecutions: ServiceExecutions | undefined;
|
|
40
|
-
constructor(_options: PlanqkApiClient.Options);
|
|
41
|
-
get serviceJobs(): ServiceJobs;
|
|
42
|
-
get dataPools(): DataPools;
|
|
43
|
-
get serviceExecutions(): ServiceExecutions;
|
|
44
|
-
}
|
package/dist/sdk/Client.js
DELETED
|
@@ -1,71 +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.PlanqkApiClient = void 0;
|
|
40
|
-
const core = __importStar(require("./core/index.js"));
|
|
41
|
-
const headers_js_1 = require("./core/headers.js");
|
|
42
|
-
const Client_js_1 = require("./api/resources/serviceJobs/client/Client.js");
|
|
43
|
-
const Client_js_2 = require("./api/resources/dataPools/client/Client.js");
|
|
44
|
-
const Client_js_3 = require("./api/resources/serviceExecutions/client/Client.js");
|
|
45
|
-
class PlanqkApiClient {
|
|
46
|
-
_options;
|
|
47
|
-
_serviceJobs;
|
|
48
|
-
_dataPools;
|
|
49
|
-
_serviceExecutions;
|
|
50
|
-
constructor(_options) {
|
|
51
|
-
this._options = {
|
|
52
|
-
..._options,
|
|
53
|
-
headers: (0, headers_js_1.mergeHeaders)({
|
|
54
|
-
"X-OrganizationId": _options?.organizationId,
|
|
55
|
-
"X-Fern-Language": "JavaScript",
|
|
56
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
57
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
58
|
-
}, _options?.headers),
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
get serviceJobs() {
|
|
62
|
-
return (this._serviceJobs ??= new Client_js_1.ServiceJobs(this._options));
|
|
63
|
-
}
|
|
64
|
-
get dataPools() {
|
|
65
|
-
return (this._dataPools ??= new Client_js_2.DataPools(this._options));
|
|
66
|
-
}
|
|
67
|
-
get serviceExecutions() {
|
|
68
|
-
return (this._serviceExecutions ??= new Client_js_3.ServiceExecutions(this._options));
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
exports.PlanqkApiClient = PlanqkApiClient;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as core from "../../core/index.js";
|
|
6
|
-
export declare class BadRequestError extends errors.PlanqkApiError {
|
|
7
|
-
constructor(body?: any, rawResponse?: core.RawResponse);
|
|
8
|
-
}
|
|
@@ -1,52 +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.BadRequestError = void 0;
|
|
40
|
-
const errors = __importStar(require("../../errors/index.js"));
|
|
41
|
-
class BadRequestError extends errors.PlanqkApiError {
|
|
42
|
-
constructor(body, rawResponse) {
|
|
43
|
-
super({
|
|
44
|
-
message: "BadRequestError",
|
|
45
|
-
statusCode: 400,
|
|
46
|
-
body: body,
|
|
47
|
-
rawResponse: rawResponse,
|
|
48
|
-
});
|
|
49
|
-
Object.setPrototypeOf(this, BadRequestError.prototype);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
exports.BadRequestError = BadRequestError;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as core from "../../core/index.js";
|
|
6
|
-
export declare class ForbiddenError extends errors.PlanqkApiError {
|
|
7
|
-
constructor(body?: any, rawResponse?: core.RawResponse);
|
|
8
|
-
}
|
|
@@ -1,52 +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.ForbiddenError = void 0;
|
|
40
|
-
const errors = __importStar(require("../../errors/index.js"));
|
|
41
|
-
class ForbiddenError extends errors.PlanqkApiError {
|
|
42
|
-
constructor(body, rawResponse) {
|
|
43
|
-
super({
|
|
44
|
-
message: "ForbiddenError",
|
|
45
|
-
statusCode: 403,
|
|
46
|
-
body: body,
|
|
47
|
-
rawResponse: rawResponse,
|
|
48
|
-
});
|
|
49
|
-
Object.setPrototypeOf(this, ForbiddenError.prototype);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
exports.ForbiddenError = ForbiddenError;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as core from "../../core/index.js";
|
|
6
|
-
export declare class InternalServerError extends errors.PlanqkApiError {
|
|
7
|
-
constructor(body?: any, rawResponse?: core.RawResponse);
|
|
8
|
-
}
|
|
@@ -1,52 +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.InternalServerError = void 0;
|
|
40
|
-
const errors = __importStar(require("../../errors/index.js"));
|
|
41
|
-
class InternalServerError extends errors.PlanqkApiError {
|
|
42
|
-
constructor(body, rawResponse) {
|
|
43
|
-
super({
|
|
44
|
-
message: "InternalServerError",
|
|
45
|
-
statusCode: 500,
|
|
46
|
-
body: body,
|
|
47
|
-
rawResponse: rawResponse,
|
|
48
|
-
});
|
|
49
|
-
Object.setPrototypeOf(this, InternalServerError.prototype);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
exports.InternalServerError = InternalServerError;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as core from "../../core/index.js";
|
|
6
|
-
export declare class NotFoundError extends errors.PlanqkApiError {
|
|
7
|
-
constructor(body?: any, rawResponse?: core.RawResponse);
|
|
8
|
-
}
|
|
@@ -1,52 +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.NotFoundError = void 0;
|
|
40
|
-
const errors = __importStar(require("../../errors/index.js"));
|
|
41
|
-
class NotFoundError extends errors.PlanqkApiError {
|
|
42
|
-
constructor(body, rawResponse) {
|
|
43
|
-
super({
|
|
44
|
-
message: "NotFoundError",
|
|
45
|
-
statusCode: 404,
|
|
46
|
-
body: body,
|
|
47
|
-
rawResponse: rawResponse,
|
|
48
|
-
});
|
|
49
|
-
Object.setPrototypeOf(this, NotFoundError.prototype);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
exports.NotFoundError = NotFoundError;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as core from "../../core/index.js";
|
|
6
|
-
export declare class UnauthorizedError extends errors.PlanqkApiError {
|
|
7
|
-
constructor(body?: any, rawResponse?: core.RawResponse);
|
|
8
|
-
}
|