mirror of
https://github.com/GlueOps/autoglue.git
synced 2026-02-13 04:40:05 +01:00
fis: updates to remove Terraform Provider reserved word collisions
Signed-off-by: allanice001 <allanice001@gmail.com>
This commit is contained in:
allanice001
4
sdk/ts/.gitignore
vendored
Normal file
4
sdk/ts/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
wwwroot/*.js
|
||||
node_modules
|
||||
typings
|
||||
dist
|
||||
1
sdk/ts/.npmignore
Normal file
1
sdk/ts/.npmignore
Normal file
@@ -0,0 +1 @@
|
||||
README.md
|
||||
23
sdk/ts/.openapi-generator-ignore
Normal file
23
sdk/ts/.openapi-generator-ignore
Normal file
@@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
189
sdk/ts/.openapi-generator/FILES
Normal file
189
sdk/ts/.openapi-generator/FILES
Normal file
@@ -0,0 +1,189 @@
|
||||
.gitignore
|
||||
.npmignore
|
||||
.openapi-generator-ignore
|
||||
README.md
|
||||
docs/AnnotationsApi.md
|
||||
docs/ArcherAdminApi.md
|
||||
docs/AuthApi.md
|
||||
docs/ClustersApi.md
|
||||
docs/CredentialsApi.md
|
||||
docs/DNSApi.md
|
||||
docs/DtoAnnotationResponse.md
|
||||
docs/DtoAttachAnnotationsRequest.md
|
||||
docs/DtoAttachBastionRequest.md
|
||||
docs/DtoAttachCaptainDomainRequest.md
|
||||
docs/DtoAttachLabelsRequest.md
|
||||
docs/DtoAttachLoadBalancerRequest.md
|
||||
docs/DtoAttachNodePoolRequest.md
|
||||
docs/DtoAttachRecordSetRequest.md
|
||||
docs/DtoAttachServersRequest.md
|
||||
docs/DtoAttachTaintsRequest.md
|
||||
docs/DtoAuthStartResponse.md
|
||||
docs/DtoClusterResponse.md
|
||||
docs/DtoCreateAnnotationRequest.md
|
||||
docs/DtoCreateClusterRequest.md
|
||||
docs/DtoCreateCredentialRequest.md
|
||||
docs/DtoCreateDomainRequest.md
|
||||
docs/DtoCreateLabelRequest.md
|
||||
docs/DtoCreateLoadBalancerRequest.md
|
||||
docs/DtoCreateNodePoolRequest.md
|
||||
docs/DtoCreateRecordSetRequest.md
|
||||
docs/DtoCreateSSHRequest.md
|
||||
docs/DtoCreateServerRequest.md
|
||||
docs/DtoCreateTaintRequest.md
|
||||
docs/DtoCredentialOut.md
|
||||
docs/DtoDomainResponse.md
|
||||
docs/DtoEnqueueRequest.md
|
||||
docs/DtoJWK.md
|
||||
docs/DtoJWKS.md
|
||||
docs/DtoJob.md
|
||||
docs/DtoJobStatus.md
|
||||
docs/DtoLabelResponse.md
|
||||
docs/DtoLoadBalancerResponse.md
|
||||
docs/DtoLogoutRequest.md
|
||||
docs/DtoNodePoolResponse.md
|
||||
docs/DtoPageJob.md
|
||||
docs/DtoQueueInfo.md
|
||||
docs/DtoRecordSetResponse.md
|
||||
docs/DtoRefreshRequest.md
|
||||
docs/DtoServerResponse.md
|
||||
docs/DtoSetKubeconfigRequest.md
|
||||
docs/DtoSshResponse.md
|
||||
docs/DtoSshRevealResponse.md
|
||||
docs/DtoTaintResponse.md
|
||||
docs/DtoTokenPair.md
|
||||
docs/DtoUpdateAnnotationRequest.md
|
||||
docs/DtoUpdateClusterRequest.md
|
||||
docs/DtoUpdateCredentialRequest.md
|
||||
docs/DtoUpdateDomainRequest.md
|
||||
docs/DtoUpdateLabelRequest.md
|
||||
docs/DtoUpdateLoadBalancerRequest.md
|
||||
docs/DtoUpdateNodePoolRequest.md
|
||||
docs/DtoUpdateRecordSetRequest.md
|
||||
docs/DtoUpdateServerRequest.md
|
||||
docs/DtoUpdateTaintRequest.md
|
||||
docs/GetSSHKey200Response.md
|
||||
docs/HandlersCreateUserKeyRequest.md
|
||||
docs/HandlersHealthStatus.md
|
||||
docs/HandlersMeResponse.md
|
||||
docs/HandlersMemberOut.md
|
||||
docs/HandlersMemberUpsertReq.md
|
||||
docs/HandlersOrgCreateReq.md
|
||||
docs/HandlersOrgKeyCreateReq.md
|
||||
docs/HandlersOrgKeyCreateResp.md
|
||||
docs/HandlersOrgUpdateReq.md
|
||||
docs/HandlersUpdateMeRequest.md
|
||||
docs/HandlersUserAPIKeyOut.md
|
||||
docs/HandlersVersionResponse.md
|
||||
docs/HealthApi.md
|
||||
docs/LabelsApi.md
|
||||
docs/LoadBalancersApi.md
|
||||
docs/MeAPIKeysApi.md
|
||||
docs/MeApi.md
|
||||
docs/MetaApi.md
|
||||
docs/ModelsAPIKey.md
|
||||
docs/ModelsOrganization.md
|
||||
docs/ModelsUser.md
|
||||
docs/ModelsUserEmail.md
|
||||
docs/NodePoolsApi.md
|
||||
docs/OrgsApi.md
|
||||
docs/ServersApi.md
|
||||
docs/SshApi.md
|
||||
docs/TaintsApi.md
|
||||
docs/UtilsErrorResponse.md
|
||||
package.json
|
||||
src/apis/AnnotationsApi.ts
|
||||
src/apis/ArcherAdminApi.ts
|
||||
src/apis/AuthApi.ts
|
||||
src/apis/ClustersApi.ts
|
||||
src/apis/CredentialsApi.ts
|
||||
src/apis/DNSApi.ts
|
||||
src/apis/HealthApi.ts
|
||||
src/apis/LabelsApi.ts
|
||||
src/apis/LoadBalancersApi.ts
|
||||
src/apis/MeAPIKeysApi.ts
|
||||
src/apis/MeApi.ts
|
||||
src/apis/MetaApi.ts
|
||||
src/apis/NodePoolsApi.ts
|
||||
src/apis/OrgsApi.ts
|
||||
src/apis/ServersApi.ts
|
||||
src/apis/SshApi.ts
|
||||
src/apis/TaintsApi.ts
|
||||
src/apis/index.ts
|
||||
src/index.ts
|
||||
src/models/DtoAnnotationResponse.ts
|
||||
src/models/DtoAttachAnnotationsRequest.ts
|
||||
src/models/DtoAttachBastionRequest.ts
|
||||
src/models/DtoAttachCaptainDomainRequest.ts
|
||||
src/models/DtoAttachLabelsRequest.ts
|
||||
src/models/DtoAttachLoadBalancerRequest.ts
|
||||
src/models/DtoAttachNodePoolRequest.ts
|
||||
src/models/DtoAttachRecordSetRequest.ts
|
||||
src/models/DtoAttachServersRequest.ts
|
||||
src/models/DtoAttachTaintsRequest.ts
|
||||
src/models/DtoAuthStartResponse.ts
|
||||
src/models/DtoClusterResponse.ts
|
||||
src/models/DtoCreateAnnotationRequest.ts
|
||||
src/models/DtoCreateClusterRequest.ts
|
||||
src/models/DtoCreateCredentialRequest.ts
|
||||
src/models/DtoCreateDomainRequest.ts
|
||||
src/models/DtoCreateLabelRequest.ts
|
||||
src/models/DtoCreateLoadBalancerRequest.ts
|
||||
src/models/DtoCreateNodePoolRequest.ts
|
||||
src/models/DtoCreateRecordSetRequest.ts
|
||||
src/models/DtoCreateSSHRequest.ts
|
||||
src/models/DtoCreateServerRequest.ts
|
||||
src/models/DtoCreateTaintRequest.ts
|
||||
src/models/DtoCredentialOut.ts
|
||||
src/models/DtoDomainResponse.ts
|
||||
src/models/DtoEnqueueRequest.ts
|
||||
src/models/DtoJWK.ts
|
||||
src/models/DtoJWKS.ts
|
||||
src/models/DtoJob.ts
|
||||
src/models/DtoJobStatus.ts
|
||||
src/models/DtoLabelResponse.ts
|
||||
src/models/DtoLoadBalancerResponse.ts
|
||||
src/models/DtoLogoutRequest.ts
|
||||
src/models/DtoNodePoolResponse.ts
|
||||
src/models/DtoPageJob.ts
|
||||
src/models/DtoQueueInfo.ts
|
||||
src/models/DtoRecordSetResponse.ts
|
||||
src/models/DtoRefreshRequest.ts
|
||||
src/models/DtoServerResponse.ts
|
||||
src/models/DtoSetKubeconfigRequest.ts
|
||||
src/models/DtoSshResponse.ts
|
||||
src/models/DtoSshRevealResponse.ts
|
||||
src/models/DtoTaintResponse.ts
|
||||
src/models/DtoTokenPair.ts
|
||||
src/models/DtoUpdateAnnotationRequest.ts
|
||||
src/models/DtoUpdateClusterRequest.ts
|
||||
src/models/DtoUpdateCredentialRequest.ts
|
||||
src/models/DtoUpdateDomainRequest.ts
|
||||
src/models/DtoUpdateLabelRequest.ts
|
||||
src/models/DtoUpdateLoadBalancerRequest.ts
|
||||
src/models/DtoUpdateNodePoolRequest.ts
|
||||
src/models/DtoUpdateRecordSetRequest.ts
|
||||
src/models/DtoUpdateServerRequest.ts
|
||||
src/models/DtoUpdateTaintRequest.ts
|
||||
src/models/GetSSHKey200Response.ts
|
||||
src/models/HandlersCreateUserKeyRequest.ts
|
||||
src/models/HandlersHealthStatus.ts
|
||||
src/models/HandlersMeResponse.ts
|
||||
src/models/HandlersMemberOut.ts
|
||||
src/models/HandlersMemberUpsertReq.ts
|
||||
src/models/HandlersOrgCreateReq.ts
|
||||
src/models/HandlersOrgKeyCreateReq.ts
|
||||
src/models/HandlersOrgKeyCreateResp.ts
|
||||
src/models/HandlersOrgUpdateReq.ts
|
||||
src/models/HandlersUpdateMeRequest.ts
|
||||
src/models/HandlersUserAPIKeyOut.ts
|
||||
src/models/HandlersVersionResponse.ts
|
||||
src/models/ModelsAPIKey.ts
|
||||
src/models/ModelsOrganization.ts
|
||||
src/models/ModelsUser.ts
|
||||
src/models/ModelsUserEmail.ts
|
||||
src/models/UtilsErrorResponse.ts
|
||||
src/models/index.ts
|
||||
src/runtime.ts
|
||||
tsconfig.esm.json
|
||||
tsconfig.json
|
||||
1
sdk/ts/.openapi-generator/VERSION
Normal file
1
sdk/ts/.openapi-generator/VERSION
Normal file
@@ -0,0 +1 @@
|
||||
7.17.0
|
||||
325
sdk/ts/README.md
Normal file
325
sdk/ts/README.md
Normal file
@@ -0,0 +1,325 @@
|
||||
# @glueops/autoglue-sdk-go@0.1.0
|
||||
|
||||
A TypeScript SDK client for the autoglue.glueopshosted.com API.
|
||||
|
||||
## Usage
|
||||
|
||||
First, install the SDK from npm.
|
||||
|
||||
```bash
|
||||
npm install @glueops/autoglue-sdk-go --save
|
||||
```
|
||||
|
||||
Next, try it out.
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
AnnotationsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateAnnotationRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateAnnotationRequest | Annotation payload
|
||||
dtoCreateAnnotationRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateAnnotationRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createAnnotation(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
### API Endpoints
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Class | Method | HTTP request | Description |
|
||||
| ------------------ | ---------------------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| _AnnotationsApi_ | [**createAnnotation**](docs/AnnotationsApi.md#createannotation) | **POST** /annotations | Create annotation (org scoped) |
|
||||
| _AnnotationsApi_ | [**deleteAnnotation**](docs/AnnotationsApi.md#deleteannotation) | **DELETE** /annotations/{id} | Delete annotation (org scoped) |
|
||||
| _AnnotationsApi_ | [**getAnnotation**](docs/AnnotationsApi.md#getannotation) | **GET** /annotations/{id} | Get annotation by ID (org scoped) |
|
||||
| _AnnotationsApi_ | [**listAnnotations**](docs/AnnotationsApi.md#listannotations) | **GET** /annotations | List annotations (org scoped) |
|
||||
| _AnnotationsApi_ | [**updateAnnotation**](docs/AnnotationsApi.md#updateannotation) | **PATCH** /annotations/{id} | Update annotation (org scoped) |
|
||||
| _ArcherAdminApi_ | [**adminCancelArcherJob**](docs/ArcherAdminApi.md#admincancelarcherjob) | **POST** /admin/archer/jobs/{id}/cancel | Cancel an Archer job (admin) |
|
||||
| _ArcherAdminApi_ | [**adminEnqueueArcherJob**](docs/ArcherAdminApi.md#adminenqueuearcherjob) | **POST** /admin/archer/jobs | Enqueue a new Archer job (admin) |
|
||||
| _ArcherAdminApi_ | [**adminListArcherJobs**](docs/ArcherAdminApi.md#adminlistarcherjobs) | **GET** /admin/archer/jobs | List Archer jobs (admin) |
|
||||
| _ArcherAdminApi_ | [**adminListArcherQueues**](docs/ArcherAdminApi.md#adminlistarcherqueues) | **GET** /admin/archer/queues | List Archer queues (admin) |
|
||||
| _ArcherAdminApi_ | [**adminRetryArcherJob**](docs/ArcherAdminApi.md#adminretryarcherjob) | **POST** /admin/archer/jobs/{id}/retry | Retry a failed/canceled Archer job (admin) |
|
||||
| _AuthApi_ | [**authCallback**](docs/AuthApi.md#authcallback) | **GET** /auth/{provider}/callback | Handle social login callback |
|
||||
| _AuthApi_ | [**authStart**](docs/AuthApi.md#authstart) | **POST** /auth/{provider}/start | Begin social login |
|
||||
| _AuthApi_ | [**getJWKS**](docs/AuthApi.md#getjwks) | **GET** /.well-known/jwks.json | Get JWKS |
|
||||
| _AuthApi_ | [**logout**](docs/AuthApi.md#logout) | **POST** /auth/logout | Revoke refresh token family (logout everywhere) |
|
||||
| _AuthApi_ | [**refresh**](docs/AuthApi.md#refresh) | **POST** /auth/refresh | Rotate refresh token |
|
||||
| _ClustersApi_ | [**attachAppsLoadBalancer**](docs/ClustersApi.md#attachappsloadbalancer) | **POST** /clusters/{clusterID}/apps-load-balancer | Attach an apps load balancer to a cluster |
|
||||
| _ClustersApi_ | [**attachBastionServer**](docs/ClustersApi.md#attachbastionserver) | **POST** /clusters/{clusterID}/bastion | Attach a bastion server to a cluster |
|
||||
| _ClustersApi_ | [**attachCaptainDomain**](docs/ClustersApi.md#attachcaptaindomain) | **POST** /clusters/{clusterID}/captain-domain | Attach a captain domain to a cluster |
|
||||
| _ClustersApi_ | [**attachControlPlaneRecordSet**](docs/ClustersApi.md#attachcontrolplanerecordset) | **POST** /clusters/{clusterID}/control-plane-record-set | Attach a control plane record set to a cluster |
|
||||
| _ClustersApi_ | [**attachGlueOpsLoadBalancer**](docs/ClustersApi.md#attachglueopsloadbalancer) | **POST** /clusters/{clusterID}/glueops-load-balancer | Attach a GlueOps/control-plane load balancer to a cluster |
|
||||
| _ClustersApi_ | [**attachNodePool**](docs/ClustersApi.md#attachnodepool) | **POST** /clusters/{clusterID}/node-pools | Attach a node pool to a cluster |
|
||||
| _ClustersApi_ | [**clearClusterKubeconfig**](docs/ClustersApi.md#clearclusterkubeconfig) | **DELETE** /clusters/{clusterID}/kubeconfig | Clear the kubeconfig for a cluster |
|
||||
| _ClustersApi_ | [**createCluster**](docs/ClustersApi.md#createcluster) | **POST** /clusters | Create cluster (org scoped) |
|
||||
| _ClustersApi_ | [**deleteCluster**](docs/ClustersApi.md#deletecluster) | **DELETE** /clusters/{clusterID} | Delete a cluster (org scoped) |
|
||||
| _ClustersApi_ | [**detachAppsLoadBalancer**](docs/ClustersApi.md#detachappsloadbalancer) | **DELETE** /clusters/{clusterID}/apps-load-balancer | Detach the apps load balancer from a cluster |
|
||||
| _ClustersApi_ | [**detachBastionServer**](docs/ClustersApi.md#detachbastionserver) | **DELETE** /clusters/{clusterID}/bastion | Detach the bastion server from a cluster |
|
||||
| _ClustersApi_ | [**detachCaptainDomain**](docs/ClustersApi.md#detachcaptaindomain) | **DELETE** /clusters/{clusterID}/captain-domain | Detach the captain domain from a cluster |
|
||||
| _ClustersApi_ | [**detachControlPlaneRecordSet**](docs/ClustersApi.md#detachcontrolplanerecordset) | **DELETE** /clusters/{clusterID}/control-plane-record-set | Detach the control plane record set from a cluster |
|
||||
| _ClustersApi_ | [**detachGlueOpsLoadBalancer**](docs/ClustersApi.md#detachglueopsloadbalancer) | **DELETE** /clusters/{clusterID}/glueops-load-balancer | Detach the GlueOps/control-plane load balancer from a cluster |
|
||||
| _ClustersApi_ | [**detachNodePool**](docs/ClustersApi.md#detachnodepool) | **DELETE** /clusters/{clusterID}/node-pools/{nodePoolID} | Detach a node pool from a cluster |
|
||||
| _ClustersApi_ | [**getCluster**](docs/ClustersApi.md#getcluster) | **GET** /clusters/{clusterID} | Get a single cluster by ID (org scoped) |
|
||||
| _ClustersApi_ | [**listClusters**](docs/ClustersApi.md#listclusters) | **GET** /clusters | List clusters (org scoped) |
|
||||
| _ClustersApi_ | [**setClusterKubeconfig**](docs/ClustersApi.md#setclusterkubeconfig) | **POST** /clusters/{clusterID}/kubeconfig | Set (or replace) the kubeconfig for a cluster |
|
||||
| _ClustersApi_ | [**updateCluster**](docs/ClustersApi.md#updatecluster) | **PATCH** /clusters/{clusterID} | Update basic cluster details (org scoped) |
|
||||
| _CredentialsApi_ | [**createCredential**](docs/CredentialsApi.md#createcredential) | **POST** /credentials | Create a credential (encrypts secret) |
|
||||
| _CredentialsApi_ | [**deleteCredential**](docs/CredentialsApi.md#deletecredential) | **DELETE** /credentials/{id} | Delete credential |
|
||||
| _CredentialsApi_ | [**getCredential**](docs/CredentialsApi.md#getcredential) | **GET** /credentials/{id} | Get credential by ID (metadata only) |
|
||||
| _CredentialsApi_ | [**listCredentials**](docs/CredentialsApi.md#listcredentials) | **GET** /credentials | List credentials (metadata only) |
|
||||
| _CredentialsApi_ | [**revealCredential**](docs/CredentialsApi.md#revealcredential) | **POST** /credentials/{id}/reveal | Reveal decrypted secret (one-time read) |
|
||||
| _CredentialsApi_ | [**updateCredential**](docs/CredentialsApi.md#updatecredential) | **PATCH** /credentials/{id} | Update credential metadata and/or rotate secret |
|
||||
| _DNSApi_ | [**createDomain**](docs/DNSApi.md#createdomain) | **POST** /dns/domains | Create a domain (org scoped) |
|
||||
| _DNSApi_ | [**createRecordSet**](docs/DNSApi.md#createrecordset) | **POST** /dns/domains/{domain_id}/records | Create a record set (pending; Archer will UPSERT to Route 53) |
|
||||
| _DNSApi_ | [**deleteDomain**](docs/DNSApi.md#deletedomain) | **DELETE** /dns/domains/{id} | Delete a domain |
|
||||
| _DNSApi_ | [**deleteRecordSet**](docs/DNSApi.md#deleterecordset) | **DELETE** /dns/records/{id} | Delete a record set (API removes row; worker can optionally handle external deletion policy) |
|
||||
| _DNSApi_ | [**getDomain**](docs/DNSApi.md#getdomain) | **GET** /dns/domains/{id} | Get a domain (org scoped) |
|
||||
| _DNSApi_ | [**listDomains**](docs/DNSApi.md#listdomains) | **GET** /dns/domains | List domains (org scoped) |
|
||||
| _DNSApi_ | [**listRecordSets**](docs/DNSApi.md#listrecordsets) | **GET** /dns/domains/{domain_id}/records | List record sets for a domain |
|
||||
| _DNSApi_ | [**updateDomain**](docs/DNSApi.md#updatedomain) | **PATCH** /dns/domains/{id} | Update a domain (org scoped) |
|
||||
| _DNSApi_ | [**updateRecordSet**](docs/DNSApi.md#updaterecordset) | **PATCH** /dns/records/{id} | Update a record set (flips to pending for reconciliation) |
|
||||
| _HealthApi_ | [**healthCheckOperationId**](docs/HealthApi.md#healthcheckoperationid) | **GET** /healthz | Basic health check |
|
||||
| _LabelsApi_ | [**createLabel**](docs/LabelsApi.md#createlabel) | **POST** /labels | Create label (org scoped) |
|
||||
| _LabelsApi_ | [**deleteLabel**](docs/LabelsApi.md#deletelabel) | **DELETE** /labels/{id} | Delete label (org scoped) |
|
||||
| _LabelsApi_ | [**getLabel**](docs/LabelsApi.md#getlabel) | **GET** /labels/{id} | Get label by ID (org scoped) |
|
||||
| _LabelsApi_ | [**listLabels**](docs/LabelsApi.md#listlabels) | **GET** /labels | List node labels (org scoped) |
|
||||
| _LabelsApi_ | [**updateLabel**](docs/LabelsApi.md#updatelabel) | **PATCH** /labels/{id} | Update label (org scoped) |
|
||||
| _LoadBalancersApi_ | [**createLoadBalancer**](docs/LoadBalancersApi.md#createloadbalancer) | **POST** /load-balancers | Create a load balancer |
|
||||
| _LoadBalancersApi_ | [**deleteLoadBalancer**](docs/LoadBalancersApi.md#deleteloadbalancer) | **DELETE** /load-balancers/{id} | Delete a load balancer |
|
||||
| _LoadBalancersApi_ | [**getLoadBalancers**](docs/LoadBalancersApi.md#getloadbalancers) | **GET** /load-balancers/{id} | Get a load balancer (org scoped) |
|
||||
| _LoadBalancersApi_ | [**listLoadBalancers**](docs/LoadBalancersApi.md#listloadbalancers) | **GET** /load-balancers | List load balancers (org scoped) |
|
||||
| _LoadBalancersApi_ | [**updateLoadBalancer**](docs/LoadBalancersApi.md#updateloadbalancer) | **PATCH** /load-balancers/{id} | Update a load balancer (org scoped) |
|
||||
| _MeApi_ | [**getMe**](docs/MeApi.md#getme) | **GET** /me | Get current user profile |
|
||||
| _MeApi_ | [**updateMe**](docs/MeApi.md#updateme) | **PATCH** /me | Update current user profile |
|
||||
| _MeAPIKeysApi_ | [**createUserAPIKey**](docs/MeAPIKeysApi.md#createuserapikey) | **POST** /me/api-keys | Create a new user API key |
|
||||
| _MeAPIKeysApi_ | [**deleteUserAPIKey**](docs/MeAPIKeysApi.md#deleteuserapikey) | **DELETE** /me/api-keys/{id} | Delete a user API key |
|
||||
| _MeAPIKeysApi_ | [**listUserAPIKeys**](docs/MeAPIKeysApi.md#listuserapikeys) | **GET** /me/api-keys | List my API keys |
|
||||
| _MetaApi_ | [**versionOperationId**](docs/MetaApi.md#versionoperationid) | **GET** /version | Service version information |
|
||||
| _NodePoolsApi_ | [**attachNodePoolAnnotations**](docs/NodePoolsApi.md#attachnodepoolannotations) | **POST** /node-pools/{id}/annotations | Attach annotation to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**attachNodePoolLabels**](docs/NodePoolsApi.md#attachnodepoollabels) | **POST** /node-pools/{id}/labels | Attach labels to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**attachNodePoolServers**](docs/NodePoolsApi.md#attachnodepoolservers) | **POST** /node-pools/{id}/servers | Attach servers to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**attachNodePoolTaints**](docs/NodePoolsApi.md#attachnodepooltaints) | **POST** /node-pools/{id}/taints | Attach taints to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**createNodePool**](docs/NodePoolsApi.md#createnodepool) | **POST** /node-pools | Create node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**deleteNodePool**](docs/NodePoolsApi.md#deletenodepool) | **DELETE** /node-pools/{id} | Delete node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**detachNodePoolAnnotation**](docs/NodePoolsApi.md#detachnodepoolannotation) | **DELETE** /node-pools/{id}/annotations/{annotationId} | Detach one annotation from a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**detachNodePoolLabel**](docs/NodePoolsApi.md#detachnodepoollabel) | **DELETE** /node-pools/{id}/labels/{labelId} | Detach one label from a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**detachNodePoolServer**](docs/NodePoolsApi.md#detachnodepoolserver) | **DELETE** /node-pools/{id}/servers/{serverId} | Detach one server from a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**detachNodePoolTaint**](docs/NodePoolsApi.md#detachnodepooltaint) | **DELETE** /node-pools/{id}/taints/{taintId} | Detach one taint from a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**getNodePool**](docs/NodePoolsApi.md#getnodepool) | **GET** /node-pools/{id} | Get node pool by ID (org scoped) |
|
||||
| _NodePoolsApi_ | [**listNodePoolAnnotations**](docs/NodePoolsApi.md#listnodepoolannotations) | **GET** /node-pools/{id}/annotations | List annotations attached to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**listNodePoolLabels**](docs/NodePoolsApi.md#listnodepoollabels) | **GET** /node-pools/{id}/labels | List labels attached to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**listNodePoolServers**](docs/NodePoolsApi.md#listnodepoolservers) | **GET** /node-pools/{id}/servers | List servers attached to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**listNodePoolTaints**](docs/NodePoolsApi.md#listnodepooltaints) | **GET** /node-pools/{id}/taints | List taints attached to a node pool (org scoped) |
|
||||
| _NodePoolsApi_ | [**listNodePools**](docs/NodePoolsApi.md#listnodepools) | **GET** /node-pools | List node pools (org scoped) |
|
||||
| _NodePoolsApi_ | [**updateNodePool**](docs/NodePoolsApi.md#updatenodepool) | **PATCH** /node-pools/{id} | Update node pool (org scoped) |
|
||||
| _OrgsApi_ | [**addOrUpdateMember**](docs/OrgsApi.md#addorupdatemember) | **POST** /orgs/{id}/members | Add or update a member (owner/admin) |
|
||||
| _OrgsApi_ | [**createOrg**](docs/OrgsApi.md#createorg) | **POST** /orgs | Create organization |
|
||||
| _OrgsApi_ | [**createOrgKey**](docs/OrgsApi.md#createorgkey) | **POST** /orgs/{id}/api-keys | Create org key/secret pair (owner/admin) |
|
||||
| _OrgsApi_ | [**deleteOrg**](docs/OrgsApi.md#deleteorg) | **DELETE** /orgs/{id} | Delete organization (owner) |
|
||||
| _OrgsApi_ | [**deleteOrgKey**](docs/OrgsApi.md#deleteorgkey) | **DELETE** /orgs/{id}/api-keys/{key_id} | Delete org key (owner/admin) |
|
||||
| _OrgsApi_ | [**getOrg**](docs/OrgsApi.md#getorg) | **GET** /orgs/{id} | Get organization |
|
||||
| _OrgsApi_ | [**listMembers**](docs/OrgsApi.md#listmembers) | **GET** /orgs/{id}/members | List members in org |
|
||||
| _OrgsApi_ | [**listMyOrgs**](docs/OrgsApi.md#listmyorgs) | **GET** /orgs | List organizations I belong to |
|
||||
| _OrgsApi_ | [**listOrgKeys**](docs/OrgsApi.md#listorgkeys) | **GET** /orgs/{id}/api-keys | List org-scoped API keys (no secrets) |
|
||||
| _OrgsApi_ | [**removeMember**](docs/OrgsApi.md#removemember) | **DELETE** /orgs/{id}/members/{user_id} | Remove a member (owner/admin) |
|
||||
| _OrgsApi_ | [**updateOrg**](docs/OrgsApi.md#updateorg) | **PATCH** /orgs/{id} | Update organization (owner/admin) |
|
||||
| _ServersApi_ | [**createServer**](docs/ServersApi.md#createserver) | **POST** /servers | Create server (org scoped) |
|
||||
| _ServersApi_ | [**deleteServer**](docs/ServersApi.md#deleteserver) | **DELETE** /servers/{id} | Delete server (org scoped) |
|
||||
| _ServersApi_ | [**getServer**](docs/ServersApi.md#getserver) | **GET** /servers/{id} | Get server by ID (org scoped) |
|
||||
| _ServersApi_ | [**listServers**](docs/ServersApi.md#listservers) | **GET** /servers | List servers (org scoped) |
|
||||
| _ServersApi_ | [**resetServerHostKey**](docs/ServersApi.md#resetserverhostkey) | **POST** /servers/{id}/reset-hostkey | Reset SSH host key (org scoped) |
|
||||
| _ServersApi_ | [**updateServer**](docs/ServersApi.md#updateserver) | **PATCH** /servers/{id} | Update server (org scoped) |
|
||||
| _SshApi_ | [**createSSHKey**](docs/SshApi.md#createsshkey) | **POST** /ssh | Create ssh keypair (org scoped) |
|
||||
| _SshApi_ | [**deleteSSHKey**](docs/SshApi.md#deletesshkey) | **DELETE** /ssh/{id} | Delete ssh keypair (org scoped) |
|
||||
| _SshApi_ | [**downloadSSHKey**](docs/SshApi.md#downloadsshkey) | **GET** /ssh/{id}/download | Download ssh key files by ID (org scoped) |
|
||||
| _SshApi_ | [**getSSHKey**](docs/SshApi.md#getsshkey) | **GET** /ssh/{id} | Get ssh key by ID (org scoped) |
|
||||
| _SshApi_ | [**listPublicSshKeys**](docs/SshApi.md#listpublicsshkeys) | **GET** /ssh | List ssh keys (org scoped) |
|
||||
| _TaintsApi_ | [**createTaint**](docs/TaintsApi.md#createtaint) | **POST** /taints | Create node taint (org scoped) |
|
||||
| _TaintsApi_ | [**deleteTaint**](docs/TaintsApi.md#deletetaint) | **DELETE** /taints/{id} | Delete taint (org scoped) |
|
||||
| _TaintsApi_ | [**getTaint**](docs/TaintsApi.md#gettaint) | **GET** /taints/{id} | Get node taint by ID (org scoped) |
|
||||
| _TaintsApi_ | [**listTaints**](docs/TaintsApi.md#listtaints) | **GET** /taints | List node pool taints (org scoped) |
|
||||
| _TaintsApi_ | [**updateTaint**](docs/TaintsApi.md#updatetaint) | **PATCH** /taints/{id} | Update node taint (org scoped) |
|
||||
|
||||
### Models
|
||||
|
||||
- [DtoAnnotationResponse](docs/DtoAnnotationResponse.md)
|
||||
- [DtoAttachAnnotationsRequest](docs/DtoAttachAnnotationsRequest.md)
|
||||
- [DtoAttachBastionRequest](docs/DtoAttachBastionRequest.md)
|
||||
- [DtoAttachCaptainDomainRequest](docs/DtoAttachCaptainDomainRequest.md)
|
||||
- [DtoAttachLabelsRequest](docs/DtoAttachLabelsRequest.md)
|
||||
- [DtoAttachLoadBalancerRequest](docs/DtoAttachLoadBalancerRequest.md)
|
||||
- [DtoAttachNodePoolRequest](docs/DtoAttachNodePoolRequest.md)
|
||||
- [DtoAttachRecordSetRequest](docs/DtoAttachRecordSetRequest.md)
|
||||
- [DtoAttachServersRequest](docs/DtoAttachServersRequest.md)
|
||||
- [DtoAttachTaintsRequest](docs/DtoAttachTaintsRequest.md)
|
||||
- [DtoAuthStartResponse](docs/DtoAuthStartResponse.md)
|
||||
- [DtoClusterResponse](docs/DtoClusterResponse.md)
|
||||
- [DtoCreateAnnotationRequest](docs/DtoCreateAnnotationRequest.md)
|
||||
- [DtoCreateClusterRequest](docs/DtoCreateClusterRequest.md)
|
||||
- [DtoCreateCredentialRequest](docs/DtoCreateCredentialRequest.md)
|
||||
- [DtoCreateDomainRequest](docs/DtoCreateDomainRequest.md)
|
||||
- [DtoCreateLabelRequest](docs/DtoCreateLabelRequest.md)
|
||||
- [DtoCreateLoadBalancerRequest](docs/DtoCreateLoadBalancerRequest.md)
|
||||
- [DtoCreateNodePoolRequest](docs/DtoCreateNodePoolRequest.md)
|
||||
- [DtoCreateRecordSetRequest](docs/DtoCreateRecordSetRequest.md)
|
||||
- [DtoCreateSSHRequest](docs/DtoCreateSSHRequest.md)
|
||||
- [DtoCreateServerRequest](docs/DtoCreateServerRequest.md)
|
||||
- [DtoCreateTaintRequest](docs/DtoCreateTaintRequest.md)
|
||||
- [DtoCredentialOut](docs/DtoCredentialOut.md)
|
||||
- [DtoDomainResponse](docs/DtoDomainResponse.md)
|
||||
- [DtoEnqueueRequest](docs/DtoEnqueueRequest.md)
|
||||
- [DtoJWK](docs/DtoJWK.md)
|
||||
- [DtoJWKS](docs/DtoJWKS.md)
|
||||
- [DtoJob](docs/DtoJob.md)
|
||||
- [DtoJobStatus](docs/DtoJobStatus.md)
|
||||
- [DtoLabelResponse](docs/DtoLabelResponse.md)
|
||||
- [DtoLoadBalancerResponse](docs/DtoLoadBalancerResponse.md)
|
||||
- [DtoLogoutRequest](docs/DtoLogoutRequest.md)
|
||||
- [DtoNodePoolResponse](docs/DtoNodePoolResponse.md)
|
||||
- [DtoPageJob](docs/DtoPageJob.md)
|
||||
- [DtoQueueInfo](docs/DtoQueueInfo.md)
|
||||
- [DtoRecordSetResponse](docs/DtoRecordSetResponse.md)
|
||||
- [DtoRefreshRequest](docs/DtoRefreshRequest.md)
|
||||
- [DtoServerResponse](docs/DtoServerResponse.md)
|
||||
- [DtoSetKubeconfigRequest](docs/DtoSetKubeconfigRequest.md)
|
||||
- [DtoSshResponse](docs/DtoSshResponse.md)
|
||||
- [DtoSshRevealResponse](docs/DtoSshRevealResponse.md)
|
||||
- [DtoTaintResponse](docs/DtoTaintResponse.md)
|
||||
- [DtoTokenPair](docs/DtoTokenPair.md)
|
||||
- [DtoUpdateAnnotationRequest](docs/DtoUpdateAnnotationRequest.md)
|
||||
- [DtoUpdateClusterRequest](docs/DtoUpdateClusterRequest.md)
|
||||
- [DtoUpdateCredentialRequest](docs/DtoUpdateCredentialRequest.md)
|
||||
- [DtoUpdateDomainRequest](docs/DtoUpdateDomainRequest.md)
|
||||
- [DtoUpdateLabelRequest](docs/DtoUpdateLabelRequest.md)
|
||||
- [DtoUpdateLoadBalancerRequest](docs/DtoUpdateLoadBalancerRequest.md)
|
||||
- [DtoUpdateNodePoolRequest](docs/DtoUpdateNodePoolRequest.md)
|
||||
- [DtoUpdateRecordSetRequest](docs/DtoUpdateRecordSetRequest.md)
|
||||
- [DtoUpdateServerRequest](docs/DtoUpdateServerRequest.md)
|
||||
- [DtoUpdateTaintRequest](docs/DtoUpdateTaintRequest.md)
|
||||
- [GetSSHKey200Response](docs/GetSSHKey200Response.md)
|
||||
- [HandlersCreateUserKeyRequest](docs/HandlersCreateUserKeyRequest.md)
|
||||
- [HandlersHealthStatus](docs/HandlersHealthStatus.md)
|
||||
- [HandlersMeResponse](docs/HandlersMeResponse.md)
|
||||
- [HandlersMemberOut](docs/HandlersMemberOut.md)
|
||||
- [HandlersMemberUpsertReq](docs/HandlersMemberUpsertReq.md)
|
||||
- [HandlersOrgCreateReq](docs/HandlersOrgCreateReq.md)
|
||||
- [HandlersOrgKeyCreateReq](docs/HandlersOrgKeyCreateReq.md)
|
||||
- [HandlersOrgKeyCreateResp](docs/HandlersOrgKeyCreateResp.md)
|
||||
- [HandlersOrgUpdateReq](docs/HandlersOrgUpdateReq.md)
|
||||
- [HandlersUpdateMeRequest](docs/HandlersUpdateMeRequest.md)
|
||||
- [HandlersUserAPIKeyOut](docs/HandlersUserAPIKeyOut.md)
|
||||
- [HandlersVersionResponse](docs/HandlersVersionResponse.md)
|
||||
- [ModelsAPIKey](docs/ModelsAPIKey.md)
|
||||
- [ModelsOrganization](docs/ModelsOrganization.md)
|
||||
- [ModelsUser](docs/ModelsUser.md)
|
||||
- [ModelsUserEmail](docs/ModelsUserEmail.md)
|
||||
- [UtilsErrorResponse](docs/UtilsErrorResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="ApiKeyAuth"></a>
|
||||
|
||||
#### ApiKeyAuth
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: `X-API-KEY`
|
||||
- **Location**: HTTP header
|
||||
<a id="BearerAuth"></a>
|
||||
|
||||
#### BearerAuth
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: `Authorization`
|
||||
- **Location**: HTTP header
|
||||
<a id="OrgKeyAuth"></a>
|
||||
|
||||
#### OrgKeyAuth
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: `X-ORG-KEY`
|
||||
- **Location**: HTTP header
|
||||
<a id="OrgSecretAuth"></a>
|
||||
|
||||
#### OrgSecretAuth
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: `X-ORG-SECRET`
|
||||
- **Location**: HTTP header
|
||||
|
||||
## About
|
||||
|
||||
This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
|
||||
and is automatically generated by the
|
||||
[OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: `dev`
|
||||
- Package version: `0.1.0`
|
||||
- Generator version: `7.17.0`
|
||||
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
||||
|
||||
The generated npm module supports the following:
|
||||
|
||||
- Environments
|
||||
- Node.js
|
||||
- Webpack
|
||||
- Browserify
|
||||
- Language levels
|
||||
- ES5 - you must have a Promises/A+ library installed
|
||||
- ES6
|
||||
- Module systems
|
||||
- CommonJS
|
||||
- ES6 module system
|
||||
|
||||
## Development
|
||||
|
||||
### Building
|
||||
|
||||
To build the TypeScript source code, you need to have Node.js and npm installed.
|
||||
After cloning the repository, navigate to the project directory and run:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Publishing
|
||||
|
||||
Once you've built the package, you can publish it to npm:
|
||||
|
||||
```bash
|
||||
npm publish
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[]()
|
||||
412
sdk/ts/docs/AnnotationsApi.md
Normal file
412
sdk/ts/docs/AnnotationsApi.md
Normal file
@@ -0,0 +1,412 @@
|
||||
# AnnotationsApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ---------------------------------------------------------- | ---------------------------- | --------------------------------- |
|
||||
| [**createAnnotation**](AnnotationsApi.md#createannotation) | **POST** /annotations | Create annotation (org scoped) |
|
||||
| [**deleteAnnotation**](AnnotationsApi.md#deleteannotation) | **DELETE** /annotations/{id} | Delete annotation (org scoped) |
|
||||
| [**getAnnotation**](AnnotationsApi.md#getannotation) | **GET** /annotations/{id} | Get annotation by ID (org scoped) |
|
||||
| [**listAnnotations**](AnnotationsApi.md#listannotations) | **GET** /annotations | List annotations (org scoped) |
|
||||
| [**updateAnnotation**](AnnotationsApi.md#updateannotation) | **PATCH** /annotations/{id} | Update annotation (org scoped) |
|
||||
|
||||
## createAnnotation
|
||||
|
||||
> DtoAnnotationResponse createAnnotation(dtoCreateAnnotationRequest, xOrgID)
|
||||
|
||||
Create annotation (org scoped)
|
||||
|
||||
Creates an annotation.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
AnnotationsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateAnnotationRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateAnnotationRequest | Annotation payload
|
||||
dtoCreateAnnotationRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateAnnotationRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createAnnotation(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------------ | ----------------------------------------------------------- | ------------------ | ------------------------------------ |
|
||||
| **dtoCreateAnnotationRequest** | [DtoCreateAnnotationRequest](DtoCreateAnnotationRequest.md) | Annotation payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | invalid json / missing fields | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | create failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteAnnotation
|
||||
|
||||
> deleteAnnotation(id, xOrgID)
|
||||
|
||||
Delete annotation (org scoped)
|
||||
|
||||
Permanently deletes the annotation.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AnnotationsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteAnnotationRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Annotation ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteAnnotationRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteAnnotation(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Annotation ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | delete failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getAnnotation
|
||||
|
||||
> DtoAnnotationResponse getAnnotation(id, xOrgID)
|
||||
|
||||
Get annotation by ID (org scoped)
|
||||
|
||||
Returns one annotation. Add `include=node_pools` to include node pools.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AnnotationsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetAnnotationRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Annotation ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetAnnotationRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getAnnotation(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Annotation ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | fetch failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listAnnotations
|
||||
|
||||
> Array<DtoAnnotationResponse> listAnnotations(xOrgID, key, value, q)
|
||||
|
||||
List annotations (org scoped)
|
||||
|
||||
Returns annotations for the organization in X-Org-ID. Filters: `key`, `value`, and `q` (key contains). Add `include=node_pools` to include linked node pools.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AnnotationsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListAnnotationsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Exact key (optional)
|
||||
key: key_example,
|
||||
// string | Exact value (optional)
|
||||
value: value_example,
|
||||
// string | key contains (case-insensitive) (optional)
|
||||
q: q_example,
|
||||
} satisfies ListAnnotationsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listAnnotations(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ------------------------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **key** | `string` | Exact key | [Optional] [Defaults to `undefined`] |
|
||||
| **value** | `string` | Exact value | [Optional] [Defaults to `undefined`] |
|
||||
| **q** | `string` | key contains (case-insensitive) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoAnnotationResponse>**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | -------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list annotations | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateAnnotation
|
||||
|
||||
> DtoAnnotationResponse updateAnnotation(id, dtoUpdateAnnotationRequest, xOrgID)
|
||||
|
||||
Update annotation (org scoped)
|
||||
|
||||
Partially update annotation fields.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
AnnotationsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateAnnotationRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new AnnotationsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Annotation ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateAnnotationRequest | Fields to update
|
||||
dtoUpdateAnnotationRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateAnnotationRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateAnnotation(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------------ | ----------------------------------------------------------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Annotation ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateAnnotationRequest** | [DtoUpdateAnnotationRequest](DtoUpdateAnnotationRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id / invalid json | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | update failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
373
sdk/ts/docs/ArcherAdminApi.md
Normal file
373
sdk/ts/docs/ArcherAdminApi.md
Normal file
@@ -0,0 +1,373 @@
|
||||
# ArcherAdminApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| -------------------------------------------------------------------- | --------------------------------------- | ------------------------------------------ |
|
||||
| [**adminCancelArcherJob**](ArcherAdminApi.md#admincancelarcherjob) | **POST** /admin/archer/jobs/{id}/cancel | Cancel an Archer job (admin) |
|
||||
| [**adminEnqueueArcherJob**](ArcherAdminApi.md#adminenqueuearcherjob) | **POST** /admin/archer/jobs | Enqueue a new Archer job (admin) |
|
||||
| [**adminListArcherJobs**](ArcherAdminApi.md#adminlistarcherjobs) | **GET** /admin/archer/jobs | List Archer jobs (admin) |
|
||||
| [**adminListArcherQueues**](ArcherAdminApi.md#adminlistarcherqueues) | **GET** /admin/archer/queues | List Archer queues (admin) |
|
||||
| [**adminRetryArcherJob**](ArcherAdminApi.md#adminretryarcherjob) | **POST** /admin/archer/jobs/{id}/retry | Retry a failed/canceled Archer job (admin) |
|
||||
|
||||
## adminCancelArcherJob
|
||||
|
||||
> DtoJob adminCancelArcherJob(id, body)
|
||||
|
||||
Cancel an Archer job (admin)
|
||||
|
||||
Set job status to canceled if cancellable. For running jobs, this only affects future picks; wire to Archer if you need active kill.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ArcherAdminApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AdminCancelArcherJobRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ArcherAdminApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Job ID
|
||||
id: id_example,
|
||||
// object (optional)
|
||||
body: Object,
|
||||
} satisfies AdminCancelArcherJobRequest;
|
||||
|
||||
try {
|
||||
const data = await api.adminCancelArcherJob(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------- | -------- | ----------- | ------------------------- |
|
||||
| **id** | `string` | Job ID | [Defaults to `undefined`] |
|
||||
| **body** | `object` | | [Optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid job or not cancellable | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | forbidden | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## adminEnqueueArcherJob
|
||||
|
||||
> DtoJob adminEnqueueArcherJob(dtoEnqueueRequest)
|
||||
|
||||
Enqueue a new Archer job (admin)
|
||||
|
||||
Create a job immediately or schedule it for the future via `run_at`.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
ArcherAdminApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { AdminEnqueueArcherJobRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ArcherAdminApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoEnqueueRequest | Job parameters
|
||||
dtoEnqueueRequest: ...,
|
||||
} satisfies AdminEnqueueArcherJobRequest;
|
||||
|
||||
try {
|
||||
const data = await api.adminEnqueueArcherJob(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------- | ----------------------------------------- | -------------- | ----- |
|
||||
| **dtoEnqueueRequest** | [DtoEnqueueRequest](DtoEnqueueRequest.md) | Job parameters | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid json or missing fields | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | forbidden | - |
|
||||
| **500** | internal error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## adminListArcherJobs
|
||||
|
||||
> DtoPageJob adminListArcherJobs(status, queue, q, page, pageSize)
|
||||
|
||||
List Archer jobs (admin)
|
||||
|
||||
Paginated background jobs with optional filters. Search `q` may match id, type, error, payload (implementation-dependent).
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ArcherAdminApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AdminListArcherJobsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ArcherAdminApi(config);
|
||||
|
||||
const body = {
|
||||
// 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'retrying' | 'scheduled' | Filter by status (optional)
|
||||
status: status_example,
|
||||
// string | Filter by queue name / worker name (optional)
|
||||
queue: queue_example,
|
||||
// string | Free-text search (optional)
|
||||
q: q_example,
|
||||
// number | Page number (optional)
|
||||
page: 56,
|
||||
// number | Items per page (optional)
|
||||
pageSize: 56,
|
||||
} satisfies AdminListArcherJobsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.adminListArcherJobs(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------ | ------------------------------------------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| **status** | `queued`, `running`, `succeeded`, `failed`, `canceled`, `retrying`, `scheduled` | Filter by status | [Optional] [Defaults to `undefined`] [Enum: queued, running, succeeded, failed, canceled, retrying, scheduled] |
|
||||
| **queue** | `string` | Filter by queue name / worker name | [Optional] [Defaults to `undefined`] |
|
||||
| **q** | `string` | Free-text search | [Optional] [Defaults to `undefined`] |
|
||||
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
|
||||
| **pageSize** | `number` | Items per page | [Optional] [Defaults to `25`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoPageJob**](DtoPageJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | -------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | forbidden | - |
|
||||
| **500** | internal error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## adminListArcherQueues
|
||||
|
||||
> Array<DtoQueueInfo> adminListArcherQueues()
|
||||
|
||||
List Archer queues (admin)
|
||||
|
||||
Summary metrics per queue (pending, running, failed, scheduled).
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ArcherAdminApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AdminListArcherQueuesRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ArcherAdminApi(config);
|
||||
|
||||
try {
|
||||
const data = await api.adminListArcherQueues();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoQueueInfo>**](DtoQueueInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | -------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | forbidden | - |
|
||||
| **500** | internal error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## adminRetryArcherJob
|
||||
|
||||
> DtoJob adminRetryArcherJob(id, body)
|
||||
|
||||
Retry a failed/canceled Archer job (admin)
|
||||
|
||||
Marks the job retriable (DB flip). Swap this for an Archer admin call if you expose one.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ArcherAdminApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AdminRetryArcherJobRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ArcherAdminApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Job ID
|
||||
id: id_example,
|
||||
// object (optional)
|
||||
body: Object,
|
||||
} satisfies AdminRetryArcherJobRequest;
|
||||
|
||||
try {
|
||||
const data = await api.adminRetryArcherJob(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------- | -------- | ----------- | ------------------------- |
|
||||
| **id** | `string` | Job ID | [Defaults to `undefined`] |
|
||||
| **body** | `object` | | [Optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid job or not eligible | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | forbidden | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
314
sdk/ts/docs/AuthApi.md
Normal file
314
sdk/ts/docs/AuthApi.md
Normal file
@@ -0,0 +1,314 @@
|
||||
# AuthApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------------------------------------------- | --------------------------------- | ----------------------------------------------- |
|
||||
| [**authCallback**](AuthApi.md#authcallback) | **GET** /auth/{provider}/callback | Handle social login callback |
|
||||
| [**authStart**](AuthApi.md#authstart) | **POST** /auth/{provider}/start | Begin social login |
|
||||
| [**getJWKS**](AuthApi.md#getjwks) | **GET** /.well-known/jwks.json | Get JWKS |
|
||||
| [**logout**](AuthApi.md#logout) | **POST** /auth/logout | Revoke refresh token family (logout everywhere) |
|
||||
| [**refresh**](AuthApi.md#refresh) | **POST** /auth/refresh | Rotate refresh token |
|
||||
|
||||
## authCallback
|
||||
|
||||
> DtoTokenPair authCallback(provider)
|
||||
|
||||
Handle social login callback
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AuthApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AuthCallbackRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new AuthApi();
|
||||
|
||||
const body = {
|
||||
// string | google|github
|
||||
provider: provider_example,
|
||||
} satisfies AuthCallbackRequest;
|
||||
|
||||
try {
|
||||
const data = await api.authCallback(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------ | -------- | ----------- | ------ | ------------------------- |
|
||||
| **provider** | `string` | google | github | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoTokenPair**](DtoTokenPair.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## authStart
|
||||
|
||||
> DtoAuthStartResponse authStart(provider)
|
||||
|
||||
Begin social login
|
||||
|
||||
Returns provider authorization URL for the frontend to redirect
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AuthApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { AuthStartRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new AuthApi();
|
||||
|
||||
const body = {
|
||||
// string | google|github
|
||||
provider: provider_example,
|
||||
} satisfies AuthStartRequest;
|
||||
|
||||
try {
|
||||
const data = await api.authStart(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------ | -------- | ----------- | ------ | ------------------------- |
|
||||
| **provider** | `string` | google | github | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAuthStartResponse**](DtoAuthStartResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getJWKS
|
||||
|
||||
> DtoJWKS getJWKS()
|
||||
|
||||
Get JWKS
|
||||
|
||||
Returns the JSON Web Key Set for token verification
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, AuthApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetJWKSRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new AuthApi();
|
||||
|
||||
try {
|
||||
const data = await api.getJWKS();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJWKS**](DtoJWKS.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## logout
|
||||
|
||||
> logout(dtoLogoutRequest)
|
||||
|
||||
Revoke refresh token family (logout everywhere)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
AuthApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { LogoutRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new AuthApi();
|
||||
|
||||
const body = {
|
||||
// DtoLogoutRequest | Refresh token
|
||||
dtoLogoutRequest: ...,
|
||||
} satisfies LogoutRequest;
|
||||
|
||||
try {
|
||||
const data = await api.logout(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------- | --------------------------------------- | ------------- | ----- |
|
||||
| **dtoLogoutRequest** | [DtoLogoutRequest](DtoLogoutRequest.md) | Refresh token | |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## refresh
|
||||
|
||||
> DtoTokenPair refresh(dtoRefreshRequest)
|
||||
|
||||
Rotate refresh token
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
AuthApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { RefreshRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new AuthApi();
|
||||
|
||||
const body = {
|
||||
// DtoRefreshRequest | Refresh token
|
||||
dtoRefreshRequest: ...,
|
||||
} satisfies RefreshRequest;
|
||||
|
||||
try {
|
||||
const data = await api.refresh(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------- | ----------------------------------------- | ------------- | ----- |
|
||||
| **dtoRefreshRequest** | [DtoRefreshRequest](DtoRefreshRequest.md) | Refresh token | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoTokenPair**](DtoTokenPair.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
1558
sdk/ts/docs/ClustersApi.md
Normal file
1558
sdk/ts/docs/ClustersApi.md
Normal file
File diff suppressed because it is too large
Load Diff
472
sdk/ts/docs/CredentialsApi.md
Normal file
472
sdk/ts/docs/CredentialsApi.md
Normal file
@@ -0,0 +1,472 @@
|
||||
# CredentialsApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ---------------------------------------------------------- | --------------------------------- | ----------------------------------------------- |
|
||||
| [**createCredential**](CredentialsApi.md#createcredential) | **POST** /credentials | Create a credential (encrypts secret) |
|
||||
| [**deleteCredential**](CredentialsApi.md#deletecredential) | **DELETE** /credentials/{id} | Delete credential |
|
||||
| [**getCredential**](CredentialsApi.md#getcredential) | **GET** /credentials/{id} | Get credential by ID (metadata only) |
|
||||
| [**listCredentials**](CredentialsApi.md#listcredentials) | **GET** /credentials | List credentials (metadata only) |
|
||||
| [**revealCredential**](CredentialsApi.md#revealcredential) | **POST** /credentials/{id}/reveal | Reveal decrypted secret (one-time read) |
|
||||
| [**updateCredential**](CredentialsApi.md#updatecredential) | **PATCH** /credentials/{id} | Update credential metadata and/or rotate secret |
|
||||
|
||||
## createCredential
|
||||
|
||||
> DtoCredentialOut createCredential(dtoCreateCredentialRequest, xOrgID)
|
||||
|
||||
Create a credential (encrypts secret)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
CredentialsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateCredentialRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateCredentialRequest | Credential payload
|
||||
dtoCreateCredentialRequest: ...,
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateCredentialRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createCredential(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------------ | ----------------------------------------------------------- | ---------------------- | ------------------------------------ |
|
||||
| **dtoCreateCredentialRequest** | [DtoCreateCredentialRequest](DtoCreateCredentialRequest.md) | Credential payload | |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoCredentialOut**](DtoCredentialOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | internal server error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteCredential
|
||||
|
||||
> deleteCredential(id, xOrgID)
|
||||
|
||||
Delete credential
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, CredentialsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteCredentialRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Credential ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteCredentialRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteCredential(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Credential ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getCredential
|
||||
|
||||
> DtoCredentialOut getCredential(id, xOrgID)
|
||||
|
||||
Get credential by ID (metadata only)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, CredentialsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetCredentialRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Credential ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetCredentialRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getCredential(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Credential ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoCredentialOut**](DtoCredentialOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | internal server error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listCredentials
|
||||
|
||||
> Array<DtoCredentialOut> listCredentials(xOrgID, credentialProvider, kind, scopeKind)
|
||||
|
||||
List credentials (metadata only)
|
||||
|
||||
Returns credential metadata for the current org. Secrets are never returned.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, CredentialsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListCredentialsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Filter by provider (e.g., aws) (optional)
|
||||
credentialProvider: credentialProvider_example,
|
||||
// string | Filter by kind (e.g., aws_access_key) (optional)
|
||||
kind: kind_example,
|
||||
// string | Filter by scope kind (credential_provider/service/resource) (optional)
|
||||
scopeKind: scopeKind_example,
|
||||
} satisfies ListCredentialsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listCredentials(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
| **credentialProvider** | `string` | Filter by provider (e.g., aws) | [Optional] [Defaults to `undefined`] |
|
||||
| **kind** | `string` | Filter by kind (e.g., aws_access_key) | [Optional] [Defaults to `undefined`] |
|
||||
| **scopeKind** | `string` | Filter by scope kind (credential_provider/service/resource) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoCredentialOut>**](DtoCredentialOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | internal server error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## revealCredential
|
||||
|
||||
> { [key: string]: any; } revealCredential(id, xOrgID, body)
|
||||
|
||||
Reveal decrypted secret (one-time read)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, CredentialsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { RevealCredentialRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Credential ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// object (optional)
|
||||
body: Object,
|
||||
} satisfies RevealCredentialRequest;
|
||||
|
||||
try {
|
||||
const data = await api.revealCredential(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Credential ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
| **body** | `object` | | [Optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**{ [key: string]: any; }**
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateCredential
|
||||
|
||||
> DtoCredentialOut updateCredential(id, dtoUpdateCredentialRequest, xOrgID)
|
||||
|
||||
Update credential metadata and/or rotate secret
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
CredentialsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateCredentialRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new CredentialsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Credential ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateCredentialRequest | Fields to update
|
||||
dtoUpdateCredentialRequest: ...,
|
||||
// string | Organization ID (UUID) (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateCredentialRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateCredential(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------------ | ----------------------------------------------------------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Credential ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateCredentialRequest** | [DtoUpdateCredentialRequest](DtoUpdateCredentialRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization ID (UUID) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoCredentialOut**](DtoCredentialOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **403** | X-Org-ID required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
721
sdk/ts/docs/DNSApi.md
Normal file
721
sdk/ts/docs/DNSApi.md
Normal file
@@ -0,0 +1,721 @@
|
||||
# DNSApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------------------------------------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| [**createDomain**](DNSApi.md#createdomain) | **POST** /dns/domains | Create a domain (org scoped) |
|
||||
| [**createRecordSet**](DNSApi.md#createrecordset) | **POST** /dns/domains/{domain_id}/records | Create a record set (pending; Archer will UPSERT to Route 53) |
|
||||
| [**deleteDomain**](DNSApi.md#deletedomain) | **DELETE** /dns/domains/{id} | Delete a domain |
|
||||
| [**deleteRecordSet**](DNSApi.md#deleterecordset) | **DELETE** /dns/records/{id} | Delete a record set (API removes row; worker can optionally handle external deletion policy) |
|
||||
| [**getDomain**](DNSApi.md#getdomain) | **GET** /dns/domains/{id} | Get a domain (org scoped) |
|
||||
| [**listDomains**](DNSApi.md#listdomains) | **GET** /dns/domains | List domains (org scoped) |
|
||||
| [**listRecordSets**](DNSApi.md#listrecordsets) | **GET** /dns/domains/{domain_id}/records | List record sets for a domain |
|
||||
| [**updateDomain**](DNSApi.md#updatedomain) | **PATCH** /dns/domains/{id} | Update a domain (org scoped) |
|
||||
| [**updateRecordSet**](DNSApi.md#updaterecordset) | **PATCH** /dns/records/{id} | Update a record set (flips to pending for reconciliation) |
|
||||
|
||||
## createDomain
|
||||
|
||||
> DtoDomainResponse createDomain(dtoCreateDomainRequest, xOrgID)
|
||||
|
||||
Create a domain (org scoped)
|
||||
|
||||
Creates a domain bound to a Route 53 scoped credential. Archer will backfill ZoneID if omitted.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
DNSApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateDomainRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateDomainRequest | Domain payload
|
||||
dtoCreateDomainRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateDomainRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createDomain(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------- | --------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **dtoCreateDomainRequest** | [DtoCreateDomainRequest](DtoCreateDomainRequest.md) | Domain payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoDomainResponse**](DtoDomainResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | validation error | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | db error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## createRecordSet
|
||||
|
||||
> DtoRecordSetResponse createRecordSet(domainId, dtoCreateRecordSetRequest, xOrgID)
|
||||
|
||||
Create a record set (pending; Archer will UPSERT to Route 53)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
DNSApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateRecordSetRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Domain ID (UUID)
|
||||
domainId: domainId_example,
|
||||
// DtoCreateRecordSetRequest | Record set payload
|
||||
dtoCreateRecordSetRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateRecordSetRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createRecordSet(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ----------------------------- | --------------------------------------------------------- | ------------------ | ------------------------------------ |
|
||||
| **domainId** | `string` | Domain ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoCreateRecordSetRequest** | [DtoCreateRecordSetRequest](DtoCreateRecordSetRequest.md) | Record set payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoRecordSetResponse**](DtoRecordSetResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | validation error | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | domain not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteDomain
|
||||
|
||||
> deleteDomain(id, xOrgID)
|
||||
|
||||
Delete a domain
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, DNSApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteDomainRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Domain ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteDomainRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteDomain(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Domain ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteRecordSet
|
||||
|
||||
> deleteRecordSet(id, xOrgID)
|
||||
|
||||
Delete a record set (API removes row; worker can optionally handle external deletion policy)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, DNSApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteRecordSetRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Record Set ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteRecordSetRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteRecordSet(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Record Set ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getDomain
|
||||
|
||||
> DtoDomainResponse getDomain(id, xOrgID)
|
||||
|
||||
Get a domain (org scoped)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, DNSApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetDomainRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Domain ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetDomainRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getDomain(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Domain ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoDomainResponse**](DtoDomainResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listDomains
|
||||
|
||||
> Array<DtoDomainResponse> listDomains(xOrgID, domainName, status, q)
|
||||
|
||||
List domains (org scoped)
|
||||
|
||||
Returns domains for X-Org-ID. Filters: `domain_name`, `status`, `q` (contains).
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, DNSApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListDomainsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Exact domain name (lowercase, no trailing dot) (optional)
|
||||
domainName: domainName_example,
|
||||
// string | pending|provisioning|ready|failed (optional)
|
||||
status: status_example,
|
||||
// string | Domain contains (case-insensitive) (optional)
|
||||
q: q_example,
|
||||
} satisfies ListDomainsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listDomains(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------- | -------- | ---------------------------------------------- | ------------------------------------ | ----- | ------ | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **domainName** | `string` | Exact domain name (lowercase, no trailing dot) | [Optional] [Defaults to `undefined`] |
|
||||
| **status** | `string` | pending | provisioning | ready | failed | [Optional] [Defaults to `undefined`] |
|
||||
| **q** | `string` | Domain contains (case-insensitive) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoDomainResponse>**](DtoDomainResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | db error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listRecordSets
|
||||
|
||||
> Array<DtoRecordSetResponse> listRecordSets(domainId, xOrgID, name, type, status)
|
||||
|
||||
List record sets for a domain
|
||||
|
||||
Filters: `name`, `type`, `status`.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, DNSApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListRecordSetsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Domain ID (UUID)
|
||||
domainId: domainId_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Exact relative name or FQDN (server normalizes) (optional)
|
||||
name: name_example,
|
||||
// string | RR type (A, AAAA, CNAME, TXT, MX, NS, SRV, CAA) (optional)
|
||||
type: type_example,
|
||||
// string | pending|provisioning|ready|failed (optional)
|
||||
status: status_example,
|
||||
} satisfies ListRecordSetsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listRecordSets(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------ | -------- | ----------------------------------------------- | ------------------------------------ | ----- | ------ | ------------------------------------ |
|
||||
| **domainId** | `string` | Domain ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **name** | `string` | Exact relative name or FQDN (server normalizes) | [Optional] [Defaults to `undefined`] |
|
||||
| **type** | `string` | RR type (A, AAAA, CNAME, TXT, MX, NS, SRV, CAA) | [Optional] [Defaults to `undefined`] |
|
||||
| **status** | `string` | pending | provisioning | ready | failed | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoRecordSetResponse>**](DtoRecordSetResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | domain not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateDomain
|
||||
|
||||
> DtoDomainResponse updateDomain(id, dtoUpdateDomainRequest, xOrgID)
|
||||
|
||||
Update a domain (org scoped)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
DNSApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateDomainRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Domain ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateDomainRequest | Fields to update
|
||||
dtoUpdateDomainRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateDomainRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateDomain(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------- | --------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Domain ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateDomainRequest** | [DtoUpdateDomainRequest](DtoUpdateDomainRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoDomainResponse**](DtoDomainResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | validation error | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateRecordSet
|
||||
|
||||
> DtoRecordSetResponse updateRecordSet(id, dtoUpdateRecordSetRequest, xOrgID)
|
||||
|
||||
Update a record set (flips to pending for reconciliation)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
DNSApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateRecordSetRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new DNSApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Record Set ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateRecordSetRequest | Fields to update
|
||||
dtoUpdateRecordSetRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateRecordSetRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateRecordSet(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ----------------------------- | --------------------------------------------------------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Record Set ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateRecordSetRequest** | [DtoUpdateRecordSetRequest](DtoUpdateRecordSetRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoRecordSetResponse**](DtoRecordSetResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | validation error | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
40
sdk/ts/docs/DtoAnnotationResponse.md
Normal file
40
sdk/ts/docs/DtoAnnotationResponse.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# DtoAnnotationResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `id` | string |
|
||||
| `key` | string |
|
||||
| `organization_id` | string |
|
||||
| `updated_at` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAnnotationResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
id: null,
|
||||
key: null,
|
||||
organization_id: null,
|
||||
updated_at: null,
|
||||
value: null,
|
||||
} satisfies DtoAnnotationResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAnnotationResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachAnnotationsRequest.md
Normal file
30
sdk/ts/docs/DtoAttachAnnotationsRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachAnnotationsRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ---------------- | ------------------- |
|
||||
| `annotation_ids` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachAnnotationsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
annotation_ids: null,
|
||||
} satisfies DtoAttachAnnotationsRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachAnnotationsRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachBastionRequest.md
Normal file
30
sdk/ts/docs/DtoAttachBastionRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachBastionRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | ------ |
|
||||
| `server_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachBastionRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
server_id: null,
|
||||
} satisfies DtoAttachBastionRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachBastionRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachCaptainDomainRequest.md
Normal file
30
sdk/ts/docs/DtoAttachCaptainDomainRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachCaptainDomainRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | ------ |
|
||||
| `domain_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachCaptainDomainRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
domain_id: null,
|
||||
} satisfies DtoAttachCaptainDomainRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachCaptainDomainRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachLabelsRequest.md
Normal file
30
sdk/ts/docs/DtoAttachLabelsRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachLabelsRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | ------------------- |
|
||||
| `label_ids` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachLabelsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
label_ids: null,
|
||||
} satisfies DtoAttachLabelsRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachLabelsRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachLoadBalancerRequest.md
Normal file
30
sdk/ts/docs/DtoAttachLoadBalancerRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachLoadBalancerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------------ | ------ |
|
||||
| `load_balancer_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachLoadBalancerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
load_balancer_id: null,
|
||||
} satisfies DtoAttachLoadBalancerRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachLoadBalancerRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachNodePoolRequest.md
Normal file
30
sdk/ts/docs/DtoAttachNodePoolRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachNodePoolRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------- | ------ |
|
||||
| `node_pool_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachNodePoolRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
node_pool_id: null,
|
||||
} satisfies DtoAttachNodePoolRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachNodePoolRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachRecordSetRequest.md
Normal file
30
sdk/ts/docs/DtoAttachRecordSetRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachRecordSetRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `record_set_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachRecordSetRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
record_set_id: null,
|
||||
} satisfies DtoAttachRecordSetRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachRecordSetRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachServersRequest.md
Normal file
30
sdk/ts/docs/DtoAttachServersRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachServersRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------ | ------------------- |
|
||||
| `server_ids` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachServersRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
server_ids: null,
|
||||
} satisfies DtoAttachServersRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachServersRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAttachTaintsRequest.md
Normal file
30
sdk/ts/docs/DtoAttachTaintsRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAttachTaintsRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | ------------------- |
|
||||
| `taint_ids` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAttachTaintsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
taint_ids: null,
|
||||
} satisfies DtoAttachTaintsRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAttachTaintsRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoAuthStartResponse.md
Normal file
30
sdk/ts/docs/DtoAuthStartResponse.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoAuthStartResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ---------- | ------ |
|
||||
| `auth_url` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoAuthStartResponse } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"auth_url": https://accounts.google.com/o/oauth2/v2/auth?client_id=...,
|
||||
} satisfies DtoAuthStartResponse
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoAuthStartResponse
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
62
sdk/ts/docs/DtoClusterResponse.md
Normal file
62
sdk/ts/docs/DtoClusterResponse.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# DtoClusterResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------------- | ---------------------------------------------------------- |
|
||||
| `apps_load_balancer` | [DtoLoadBalancerResponse](DtoLoadBalancerResponse.md) |
|
||||
| `bastion_server` | [DtoServerResponse](DtoServerResponse.md) |
|
||||
| `captain_domain` | [DtoDomainResponse](DtoDomainResponse.md) |
|
||||
| `certificate_key` | string |
|
||||
| `cluster_provider` | string |
|
||||
| `control_plane_fqdn` | string |
|
||||
| `control_plane_record_set` | [DtoRecordSetResponse](DtoRecordSetResponse.md) |
|
||||
| `created_at` | string |
|
||||
| `glueops_load_balancer` | [DtoLoadBalancerResponse](DtoLoadBalancerResponse.md) |
|
||||
| `id` | string |
|
||||
| `last_error` | string |
|
||||
| `name` | string |
|
||||
| `node_pools` | [Array<DtoNodePoolResponse>](DtoNodePoolResponse.md) |
|
||||
| `random_token` | string |
|
||||
| `region` | string |
|
||||
| `status` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoClusterResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
apps_load_balancer: null,
|
||||
bastion_server: null,
|
||||
captain_domain: null,
|
||||
certificate_key: null,
|
||||
cluster_provider: null,
|
||||
control_plane_fqdn: null,
|
||||
control_plane_record_set: null,
|
||||
created_at: null,
|
||||
glueops_load_balancer: null,
|
||||
id: null,
|
||||
last_error: null,
|
||||
name: null,
|
||||
node_pools: null,
|
||||
random_token: null,
|
||||
region: null,
|
||||
status: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoClusterResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoClusterResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoCreateAnnotationRequest.md
Normal file
32
sdk/ts/docs/DtoCreateAnnotationRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoCreateAnnotationRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------- | ------ |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateAnnotationRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoCreateAnnotationRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateAnnotationRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/DtoCreateClusterRequest.md
Normal file
34
sdk/ts/docs/DtoCreateClusterRequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# DtoCreateClusterRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------------ | ------ |
|
||||
| `cluster_provider` | string |
|
||||
| `name` | string |
|
||||
| `region` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateClusterRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
cluster_provider: null,
|
||||
name: null,
|
||||
region: null,
|
||||
} satisfies DtoCreateClusterRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateClusterRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
48
sdk/ts/docs/DtoCreateCredentialRequest.md
Normal file
48
sdk/ts/docs/DtoCreateCredentialRequest.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# DtoCreateCredentialRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------------- | ------ |
|
||||
| `account_id` | string |
|
||||
| `credential_provider` | string |
|
||||
| `kind` | string |
|
||||
| `name` | string |
|
||||
| `region` | string |
|
||||
| `schema_version` | number |
|
||||
| `scope` | object |
|
||||
| `scope_kind` | string |
|
||||
| `scope_version` | number |
|
||||
| `secret` | object |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateCredentialRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
account_id: null,
|
||||
credential_provider: null,
|
||||
kind: null,
|
||||
name: null,
|
||||
region: null,
|
||||
schema_version: null,
|
||||
scope: null,
|
||||
scope_kind: null,
|
||||
scope_version: null,
|
||||
secret: null,
|
||||
} satisfies DtoCreateCredentialRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateCredentialRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/DtoCreateDomainRequest.md
Normal file
34
sdk/ts/docs/DtoCreateDomainRequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# DtoCreateDomainRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `credential_id` | string |
|
||||
| `domain_name` | string |
|
||||
| `zone_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateDomainRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
credential_id: null,
|
||||
domain_name: null,
|
||||
zone_id: null,
|
||||
} satisfies DtoCreateDomainRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateDomainRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoCreateLabelRequest.md
Normal file
32
sdk/ts/docs/DtoCreateLabelRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoCreateLabelRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------- | ------ |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateLabelRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoCreateLabelRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateLabelRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoCreateLoadBalancerRequest.md
Normal file
36
sdk/ts/docs/DtoCreateLoadBalancerRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoCreateLoadBalancerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `kind` | string |
|
||||
| `name` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateLoadBalancerRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"kind": public,
|
||||
"name": glueops,
|
||||
"private_ip_address": 192.168.0.2,
|
||||
"public_ip_address": 8.8.8.8,
|
||||
} satisfies DtoCreateLoadBalancerRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateLoadBalancerRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoCreateNodePoolRequest.md
Normal file
32
sdk/ts/docs/DtoCreateNodePoolRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoCreateNodePoolRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `name` | string |
|
||||
| `role` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateNodePoolRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
name: null,
|
||||
role: null,
|
||||
} satisfies DtoCreateNodePoolRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateNodePoolRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoCreateRecordSetRequest.md
Normal file
36
sdk/ts/docs/DtoCreateRecordSetRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoCreateRecordSetRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------------------- |
|
||||
| `name` | string |
|
||||
| `ttl` | number |
|
||||
| `type` | string |
|
||||
| `values` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateRecordSetRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
name: null,
|
||||
ttl: null,
|
||||
type: null,
|
||||
values: null,
|
||||
} satisfies DtoCreateRecordSetRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateRecordSetRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoCreateSSHRequest.md
Normal file
36
sdk/ts/docs/DtoCreateSSHRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoCreateSSHRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------- | ------ |
|
||||
| `bits` | number |
|
||||
| `comment` | string |
|
||||
| `name` | string |
|
||||
| `type` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateSSHRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"bits": null,
|
||||
"comment": deploy@autoglue,
|
||||
"name": null,
|
||||
"type": null,
|
||||
} satisfies DtoCreateSSHRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateSSHRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoCreateServerRequest.md
Normal file
42
sdk/ts/docs/DtoCreateServerRequest.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoCreateServerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `hostname` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
| `role` | string |
|
||||
| `ssh_key_id` | string |
|
||||
| `ssh_user` | string |
|
||||
| `status` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateServerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
hostname: null,
|
||||
private_ip_address: null,
|
||||
public_ip_address: null,
|
||||
role: master | worker | bastion,
|
||||
ssh_key_id: null,
|
||||
ssh_user: null,
|
||||
status: pending | provisioning | ready | failed,
|
||||
} satisfies DtoCreateServerRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateServerRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/DtoCreateTaintRequest.md
Normal file
34
sdk/ts/docs/DtoCreateTaintRequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# DtoCreateTaintRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------ |
|
||||
| `effect` | string |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCreateTaintRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
effect: null,
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoCreateTaintRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCreateTaintRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
52
sdk/ts/docs/DtoCredentialOut.md
Normal file
52
sdk/ts/docs/DtoCredentialOut.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# DtoCredentialOut
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------------- | ------ |
|
||||
| `account_id` | string |
|
||||
| `created_at` | string |
|
||||
| `credential_provider` | string |
|
||||
| `id` | string |
|
||||
| `kind` | string |
|
||||
| `name` | string |
|
||||
| `region` | string |
|
||||
| `schema_version` | number |
|
||||
| `scope` | object |
|
||||
| `scope_kind` | string |
|
||||
| `scope_version` | number |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoCredentialOut } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
account_id: null,
|
||||
created_at: null,
|
||||
credential_provider: null,
|
||||
id: null,
|
||||
kind: null,
|
||||
name: null,
|
||||
region: null,
|
||||
schema_version: null,
|
||||
scope: null,
|
||||
scope_kind: null,
|
||||
scope_version: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoCredentialOut;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoCredentialOut;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
46
sdk/ts/docs/DtoDomainResponse.md
Normal file
46
sdk/ts/docs/DtoDomainResponse.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# DtoDomainResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `credential_id` | string |
|
||||
| `domain_name` | string |
|
||||
| `id` | string |
|
||||
| `last_error` | string |
|
||||
| `organization_id` | string |
|
||||
| `status` | string |
|
||||
| `updated_at` | string |
|
||||
| `zone_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoDomainResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
credential_id: null,
|
||||
domain_name: null,
|
||||
id: null,
|
||||
last_error: null,
|
||||
organization_id: null,
|
||||
status: null,
|
||||
updated_at: null,
|
||||
zone_id: null,
|
||||
} satisfies DtoDomainResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoDomainResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoEnqueueRequest.md
Normal file
36
sdk/ts/docs/DtoEnqueueRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoEnqueueRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------- | ------ |
|
||||
| `payload` | object |
|
||||
| `queue` | string |
|
||||
| `run_at` | string |
|
||||
| `type` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoEnqueueRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"payload": null,
|
||||
"queue": default,
|
||||
"run_at": 2025-11-05T08:00:00Z,
|
||||
"type": email.send,
|
||||
} satisfies DtoEnqueueRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoEnqueueRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoJWK.md
Normal file
42
sdk/ts/docs/DtoJWK.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoJWK
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----- | ------ |
|
||||
| `alg` | string |
|
||||
| `e` | string |
|
||||
| `kid` | string |
|
||||
| `kty` | string |
|
||||
| `n` | string |
|
||||
| `use` | string |
|
||||
| `x` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoJWK } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"alg": RS256,
|
||||
"e": AQAB,
|
||||
"kid": 7c6f1d0a-7a98-4e6a-9dbf-6b1af4b9f345,
|
||||
"kty": RSA,
|
||||
"n": null,
|
||||
"use": sig,
|
||||
"x": null,
|
||||
} satisfies DtoJWK
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoJWK
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoJWKS.md
Normal file
30
sdk/ts/docs/DtoJWKS.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoJWKS
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------ | -------------------------------- |
|
||||
| `keys` | [Array<DtoJWK>](DtoJWK.md) |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoJWKS } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
keys: null,
|
||||
} satisfies DtoJWKS;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoJWKS;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
50
sdk/ts/docs/DtoJob.md
Normal file
50
sdk/ts/docs/DtoJob.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# DtoJob
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------- | ------------------------------- |
|
||||
| `attempts` | number |
|
||||
| `created_at` | string |
|
||||
| `id` | string |
|
||||
| `last_error` | string |
|
||||
| `max_attempts` | number |
|
||||
| `payload` | any |
|
||||
| `queue` | string |
|
||||
| `run_at` | string |
|
||||
| `status` | [DtoJobStatus](DtoJobStatus.md) |
|
||||
| `type` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoJob } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"attempts": 0,
|
||||
"created_at": 2025-11-04T09:30:00Z,
|
||||
"id": 01HF7SZK8Z8WG1M3J7S2Z8M2N6,
|
||||
"last_error": error message,
|
||||
"max_attempts": 3,
|
||||
"payload": null,
|
||||
"queue": default,
|
||||
"run_at": 2025-11-04T09:30:00Z,
|
||||
"status": null,
|
||||
"type": email.send,
|
||||
"updated_at": 2025-11-04T09:30:00Z,
|
||||
} satisfies DtoJob
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoJob
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
27
sdk/ts/docs/DtoJobStatus.md
Normal file
27
sdk/ts/docs/DtoJobStatus.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# DtoJobStatus
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ---- | ---- |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoJobStatus } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {} satisfies DtoJobStatus;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoJobStatus;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
40
sdk/ts/docs/DtoLabelResponse.md
Normal file
40
sdk/ts/docs/DtoLabelResponse.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# DtoLabelResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `id` | string |
|
||||
| `key` | string |
|
||||
| `organization_id` | string |
|
||||
| `updated_at` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoLabelResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
id: null,
|
||||
key: null,
|
||||
organization_id: null,
|
||||
updated_at: null,
|
||||
value: null,
|
||||
} satisfies DtoLabelResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoLabelResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
44
sdk/ts/docs/DtoLoadBalancerResponse.md
Normal file
44
sdk/ts/docs/DtoLoadBalancerResponse.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# DtoLoadBalancerResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `id` | string |
|
||||
| `kind` | string |
|
||||
| `name` | string |
|
||||
| `organization_id` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoLoadBalancerResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
id: null,
|
||||
kind: null,
|
||||
name: null,
|
||||
organization_id: null,
|
||||
private_ip_address: null,
|
||||
public_ip_address: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoLoadBalancerResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoLoadBalancerResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoLogoutRequest.md
Normal file
30
sdk/ts/docs/DtoLogoutRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoLogoutRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `refresh_token` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoLogoutRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"refresh_token": m0l9o8rT3t0V8d3eFf...,
|
||||
} satisfies DtoLogoutRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoLogoutRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
48
sdk/ts/docs/DtoNodePoolResponse.md
Normal file
48
sdk/ts/docs/DtoNodePoolResponse.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# DtoNodePoolResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | -------------------------------------------------------------- |
|
||||
| `annotations` | [Array<DtoAnnotationResponse>](DtoAnnotationResponse.md) |
|
||||
| `created_at` | string |
|
||||
| `id` | string |
|
||||
| `labels` | [Array<DtoLabelResponse>](DtoLabelResponse.md) |
|
||||
| `name` | string |
|
||||
| `organization_id` | string |
|
||||
| `role` | string |
|
||||
| `servers` | [Array<DtoServerResponse>](DtoServerResponse.md) |
|
||||
| `taints` | [Array<DtoTaintResponse>](DtoTaintResponse.md) |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoNodePoolResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
annotations: null,
|
||||
created_at: null,
|
||||
id: null,
|
||||
labels: null,
|
||||
name: null,
|
||||
organization_id: null,
|
||||
role: null,
|
||||
servers: null,
|
||||
taints: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoNodePoolResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoNodePoolResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoPageJob.md
Normal file
36
sdk/ts/docs/DtoPageJob.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoPageJob
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | -------------------------------- |
|
||||
| `items` | [Array<DtoJob>](DtoJob.md) |
|
||||
| `page` | number |
|
||||
| `page_size` | number |
|
||||
| `total` | number |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoPageJob } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
items: null,
|
||||
page: 1,
|
||||
page_size: 25,
|
||||
total: 120,
|
||||
} satisfies DtoPageJob;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoPageJob;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
38
sdk/ts/docs/DtoQueueInfo.md
Normal file
38
sdk/ts/docs/DtoQueueInfo.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# DtoQueueInfo
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------- | ------ |
|
||||
| `failed` | number |
|
||||
| `name` | string |
|
||||
| `pending` | number |
|
||||
| `running` | number |
|
||||
| `scheduled` | number |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoQueueInfo } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"failed": 5,
|
||||
"name": default,
|
||||
"pending": 42,
|
||||
"running": 3,
|
||||
"scheduled": 7,
|
||||
} satisfies DtoQueueInfo
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoQueueInfo
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
52
sdk/ts/docs/DtoRecordSetResponse.md
Normal file
52
sdk/ts/docs/DtoRecordSetResponse.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# DtoRecordSetResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `domain_id` | string |
|
||||
| `fingerprint` | string |
|
||||
| `id` | string |
|
||||
| `last_error` | string |
|
||||
| `name` | string |
|
||||
| `owner` | string |
|
||||
| `status` | string |
|
||||
| `ttl` | number |
|
||||
| `type` | string |
|
||||
| `updated_at` | string |
|
||||
| `values` | object |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoRecordSetResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
domain_id: null,
|
||||
fingerprint: null,
|
||||
id: null,
|
||||
last_error: null,
|
||||
name: null,
|
||||
owner: null,
|
||||
status: null,
|
||||
ttl: null,
|
||||
type: null,
|
||||
updated_at: null,
|
||||
values: null,
|
||||
} satisfies DtoRecordSetResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoRecordSetResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoRefreshRequest.md
Normal file
30
sdk/ts/docs/DtoRefreshRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoRefreshRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `refresh_token` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoRefreshRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"refresh_token": m0l9o8rT3t0V8d3eFf...,
|
||||
} satisfies DtoRefreshRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoRefreshRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
50
sdk/ts/docs/DtoServerResponse.md
Normal file
50
sdk/ts/docs/DtoServerResponse.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# DtoServerResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `hostname` | string |
|
||||
| `id` | string |
|
||||
| `organization_id` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
| `role` | string |
|
||||
| `ssh_key_id` | string |
|
||||
| `ssh_user` | string |
|
||||
| `status` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoServerResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
hostname: null,
|
||||
id: null,
|
||||
organization_id: null,
|
||||
private_ip_address: null,
|
||||
public_ip_address: null,
|
||||
role: master | worker | bastion,
|
||||
ssh_key_id: null,
|
||||
ssh_user: null,
|
||||
status: pending | provisioning | ready | failed,
|
||||
updated_at: null,
|
||||
} satisfies DtoServerResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoServerResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/DtoSetKubeconfigRequest.md
Normal file
30
sdk/ts/docs/DtoSetKubeconfigRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DtoSetKubeconfigRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------ | ------ |
|
||||
| `kubeconfig` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoSetKubeconfigRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
kubeconfig: null,
|
||||
} satisfies DtoSetKubeconfigRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoSetKubeconfigRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoSshResponse.md
Normal file
42
sdk/ts/docs/DtoSshResponse.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoSshResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `fingerprint` | string |
|
||||
| `id` | string |
|
||||
| `name` | string |
|
||||
| `organization_id` | string |
|
||||
| `public_key` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoSshResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
fingerprint: null,
|
||||
id: null,
|
||||
name: null,
|
||||
organization_id: null,
|
||||
public_key: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoSshResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoSshResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
44
sdk/ts/docs/DtoSshRevealResponse.md
Normal file
44
sdk/ts/docs/DtoSshRevealResponse.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# DtoSshRevealResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `fingerprint` | string |
|
||||
| `id` | string |
|
||||
| `name` | string |
|
||||
| `organization_id` | string |
|
||||
| `private_key` | string |
|
||||
| `public_key` | string |
|
||||
| `updated_at` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoSshRevealResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
fingerprint: null,
|
||||
id: null,
|
||||
name: null,
|
||||
organization_id: null,
|
||||
private_key: null,
|
||||
public_key: null,
|
||||
updated_at: null,
|
||||
} satisfies DtoSshRevealResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoSshRevealResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoTaintResponse.md
Normal file
42
sdk/ts/docs/DtoTaintResponse.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoTaintResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `effect` | string |
|
||||
| `id` | string |
|
||||
| `key` | string |
|
||||
| `organization_id` | string |
|
||||
| `updated_at` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoTaintResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
effect: null,
|
||||
id: null,
|
||||
key: null,
|
||||
organization_id: null,
|
||||
updated_at: null,
|
||||
value: null,
|
||||
} satisfies DtoTaintResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoTaintResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoTokenPair.md
Normal file
36
sdk/ts/docs/DtoTokenPair.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoTokenPair
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `access_token` | string |
|
||||
| `expires_in` | number |
|
||||
| `refresh_token` | string |
|
||||
| `token_type` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoTokenPair } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"access_token": eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ij...,
|
||||
"expires_in": 3600,
|
||||
"refresh_token": m0l9o8rT3t0V8d3eFf....,
|
||||
"token_type": Bearer,
|
||||
} satisfies DtoTokenPair
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoTokenPair
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoUpdateAnnotationRequest.md
Normal file
32
sdk/ts/docs/DtoUpdateAnnotationRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoUpdateAnnotationRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------- | ------ |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateAnnotationRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoUpdateAnnotationRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateAnnotationRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/DtoUpdateClusterRequest.md
Normal file
34
sdk/ts/docs/DtoUpdateClusterRequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# DtoUpdateClusterRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------------ | ------ |
|
||||
| `cluster_provider` | string |
|
||||
| `name` | string |
|
||||
| `region` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateClusterRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
cluster_provider: null,
|
||||
name: null,
|
||||
region: null,
|
||||
} satisfies DtoUpdateClusterRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateClusterRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoUpdateCredentialRequest.md
Normal file
42
sdk/ts/docs/DtoUpdateCredentialRequest.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoUpdateCredentialRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `account_id` | string |
|
||||
| `name` | string |
|
||||
| `region` | string |
|
||||
| `scope` | object |
|
||||
| `scope_kind` | string |
|
||||
| `scope_version` | number |
|
||||
| `secret` | object |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateCredentialRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
account_id: null,
|
||||
name: null,
|
||||
region: null,
|
||||
scope: null,
|
||||
scope_kind: null,
|
||||
scope_version: null,
|
||||
secret: null,
|
||||
} satisfies DtoUpdateCredentialRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateCredentialRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoUpdateDomainRequest.md
Normal file
36
sdk/ts/docs/DtoUpdateDomainRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoUpdateDomainRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------ |
|
||||
| `credential_id` | string |
|
||||
| `domain_name` | string |
|
||||
| `status` | string |
|
||||
| `zone_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateDomainRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
credential_id: null,
|
||||
domain_name: null,
|
||||
status: null,
|
||||
zone_id: null,
|
||||
} satisfies DtoUpdateDomainRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateDomainRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoUpdateLabelRequest.md
Normal file
32
sdk/ts/docs/DtoUpdateLabelRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoUpdateLabelRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------- | ------ |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateLabelRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoUpdateLabelRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateLabelRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
36
sdk/ts/docs/DtoUpdateLoadBalancerRequest.md
Normal file
36
sdk/ts/docs/DtoUpdateLoadBalancerRequest.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# DtoUpdateLoadBalancerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `kind` | string |
|
||||
| `name` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateLoadBalancerRequest } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"kind": public,
|
||||
"name": glue,
|
||||
"private_ip_address": 192.168.0.2,
|
||||
"public_ip_address": 8.8.8.8,
|
||||
} satisfies DtoUpdateLoadBalancerRequest
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateLoadBalancerRequest
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/DtoUpdateNodePoolRequest.md
Normal file
32
sdk/ts/docs/DtoUpdateNodePoolRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DtoUpdateNodePoolRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `name` | string |
|
||||
| `role` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateNodePoolRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
name: null,
|
||||
role: null,
|
||||
} satisfies DtoUpdateNodePoolRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateNodePoolRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
38
sdk/ts/docs/DtoUpdateRecordSetRequest.md
Normal file
38
sdk/ts/docs/DtoUpdateRecordSetRequest.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# DtoUpdateRecordSetRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------------------- |
|
||||
| `name` | string |
|
||||
| `status` | string |
|
||||
| `ttl` | number |
|
||||
| `type` | string |
|
||||
| `values` | Array<string> |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateRecordSetRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
name: null,
|
||||
status: null,
|
||||
ttl: null,
|
||||
type: null,
|
||||
values: null,
|
||||
} satisfies DtoUpdateRecordSetRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateRecordSetRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/DtoUpdateServerRequest.md
Normal file
42
sdk/ts/docs/DtoUpdateServerRequest.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# DtoUpdateServerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------------- | ------ |
|
||||
| `hostname` | string |
|
||||
| `private_ip_address` | string |
|
||||
| `public_ip_address` | string |
|
||||
| `role` | string |
|
||||
| `ssh_key_id` | string |
|
||||
| `ssh_user` | string |
|
||||
| `status` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateServerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
hostname: null,
|
||||
private_ip_address: null,
|
||||
public_ip_address: null,
|
||||
role: master | worker | bastion,
|
||||
ssh_key_id: null,
|
||||
ssh_user: null,
|
||||
status: pending | provisioning | ready | failed,
|
||||
} satisfies DtoUpdateServerRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateServerRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/DtoUpdateTaintRequest.md
Normal file
34
sdk/ts/docs/DtoUpdateTaintRequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# DtoUpdateTaintRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------ |
|
||||
| `effect` | string |
|
||||
| `key` | string |
|
||||
| `value` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { DtoUpdateTaintRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
effect: null,
|
||||
key: null,
|
||||
value: null,
|
||||
} satisfies DtoUpdateTaintRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as DtoUpdateTaintRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
44
sdk/ts/docs/GetSSHKey200Response.md
Normal file
44
sdk/ts/docs/GetSSHKey200Response.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# GetSSHKey200Response
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ----------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `fingerprint` | string |
|
||||
| `id` | string |
|
||||
| `name` | string |
|
||||
| `organization_id` | string |
|
||||
| `public_key` | string |
|
||||
| `updated_at` | string |
|
||||
| `private_key` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { GetSSHKey200Response } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
fingerprint: null,
|
||||
id: null,
|
||||
name: null,
|
||||
organization_id: null,
|
||||
public_key: null,
|
||||
updated_at: null,
|
||||
private_key: null,
|
||||
} satisfies GetSSHKey200Response;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as GetSSHKey200Response;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/HandlersCreateUserKeyRequest.md
Normal file
32
sdk/ts/docs/HandlersCreateUserKeyRequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# HandlersCreateUserKeyRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------------ | ------ |
|
||||
| `expires_in_hours` | number |
|
||||
| `name` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersCreateUserKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
expires_in_hours: null,
|
||||
name: null,
|
||||
} satisfies HandlersCreateUserKeyRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersCreateUserKeyRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/HandlersHealthStatus.md
Normal file
30
sdk/ts/docs/HandlersHealthStatus.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HandlersHealthStatus
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------ |
|
||||
| `status` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersHealthStatus } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
status: ok,
|
||||
} satisfies HandlersHealthStatus;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersHealthStatus;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
48
sdk/ts/docs/HandlersMeResponse.md
Normal file
48
sdk/ts/docs/HandlersMeResponse.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# HandlersMeResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| `avatar_url` | string |
|
||||
| `created_at` | Date |
|
||||
| `display_name` | string |
|
||||
| `emails` | [Array<ModelsUserEmail>](ModelsUserEmail.md) |
|
||||
| `id` | string |
|
||||
| `is_admin` | boolean |
|
||||
| `is_disabled` | boolean |
|
||||
| `organizations` | [Array<ModelsOrganization>](ModelsOrganization.md) |
|
||||
| `primary_email` | string |
|
||||
| `updated_at` | Date |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersMeResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
avatar_url: null,
|
||||
created_at: null,
|
||||
display_name: null,
|
||||
emails: null,
|
||||
id: null,
|
||||
is_admin: null,
|
||||
is_disabled: null,
|
||||
organizations: null,
|
||||
primary_email: null,
|
||||
updated_at: null,
|
||||
} satisfies HandlersMeResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersMeResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
34
sdk/ts/docs/HandlersMemberOut.md
Normal file
34
sdk/ts/docs/HandlersMemberOut.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# HandlersMemberOut
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------- | ------ |
|
||||
| `email` | string |
|
||||
| `role` | string |
|
||||
| `user_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersMemberOut } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
email: null,
|
||||
role: null,
|
||||
user_id: null,
|
||||
} satisfies HandlersMemberOut;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersMemberOut;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/HandlersMemberUpsertReq.md
Normal file
32
sdk/ts/docs/HandlersMemberUpsertReq.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# HandlersMemberUpsertReq
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------- | ------ |
|
||||
| `role` | string |
|
||||
| `user_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersMemberUpsertReq } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
role: member,
|
||||
user_id: null,
|
||||
} satisfies HandlersMemberUpsertReq;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersMemberUpsertReq;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/HandlersOrgCreateReq.md
Normal file
32
sdk/ts/docs/HandlersOrgCreateReq.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# HandlersOrgCreateReq
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------ |
|
||||
| `domain` | string |
|
||||
| `name` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersOrgCreateReq } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"domain": acme.com,
|
||||
"name": Acme Corp,
|
||||
} satisfies HandlersOrgCreateReq
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersOrgCreateReq
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/HandlersOrgKeyCreateReq.md
Normal file
32
sdk/ts/docs/HandlersOrgKeyCreateReq.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# HandlersOrgKeyCreateReq
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------------ | ------ |
|
||||
| `expires_in_hours` | number |
|
||||
| `name` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersOrgKeyCreateReq } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
expires_in_hours: 720,
|
||||
name: automation - bot,
|
||||
} satisfies HandlersOrgKeyCreateReq;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersOrgKeyCreateReq;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/HandlersOrgKeyCreateResp.md
Normal file
42
sdk/ts/docs/HandlersOrgKeyCreateResp.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# HandlersOrgKeyCreateResp
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------ | ------ |
|
||||
| `created_at` | string |
|
||||
| `expires_at` | string |
|
||||
| `id` | string |
|
||||
| `name` | string |
|
||||
| `org_key` | string |
|
||||
| `org_secret` | string |
|
||||
| `scope` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersOrgKeyCreateResp } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
expires_at: null,
|
||||
id: null,
|
||||
name: null,
|
||||
org_key: null,
|
||||
org_secret: null,
|
||||
scope: null,
|
||||
} satisfies HandlersOrgKeyCreateResp;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersOrgKeyCreateResp;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/HandlersOrgUpdateReq.md
Normal file
32
sdk/ts/docs/HandlersOrgUpdateReq.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# HandlersOrgUpdateReq
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------- | ------ |
|
||||
| `domain` | string |
|
||||
| `name` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersOrgUpdateReq } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
domain: null,
|
||||
name: null,
|
||||
} satisfies HandlersOrgUpdateReq;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersOrgUpdateReq;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
30
sdk/ts/docs/HandlersUpdateMeRequest.md
Normal file
30
sdk/ts/docs/HandlersUpdateMeRequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# HandlersUpdateMeRequest
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------- | ------ |
|
||||
| `display_name` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersUpdateMeRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
display_name: null,
|
||||
} satisfies HandlersUpdateMeRequest;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersUpdateMeRequest;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
42
sdk/ts/docs/HandlersUserAPIKeyOut.md
Normal file
42
sdk/ts/docs/HandlersUserAPIKeyOut.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# HandlersUserAPIKeyOut
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------- | ------ |
|
||||
| `created_at` | string |
|
||||
| `expires_at` | string |
|
||||
| `id` | string |
|
||||
| `last_used_at` | string |
|
||||
| `name` | string |
|
||||
| `plain` | string |
|
||||
| `scope` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersUserAPIKeyOut } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
expires_at: null,
|
||||
id: null,
|
||||
last_used_at: null,
|
||||
name: null,
|
||||
plain: null,
|
||||
scope: null,
|
||||
} satisfies HandlersUserAPIKeyOut;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersUserAPIKeyOut;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
50
sdk/ts/docs/HandlersVersionResponse.md
Normal file
50
sdk/ts/docs/HandlersVersionResponse.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# HandlersVersionResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------ | ------- |
|
||||
| `built` | string |
|
||||
| `builtBy` | string |
|
||||
| `commit` | string |
|
||||
| `commitTime` | string |
|
||||
| `go` | string |
|
||||
| `goArch` | string |
|
||||
| `goOS` | string |
|
||||
| `modified` | boolean |
|
||||
| `revision` | string |
|
||||
| `vcs` | string |
|
||||
| `version` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { HandlersVersionResponse } from '@glueops/autoglue-sdk-go'
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
"built": 2025-11-08T12:34:56Z,
|
||||
"builtBy": ci,
|
||||
"commit": a1b2c3d,
|
||||
"commitTime": 2025-11-08T12:31:00Z,
|
||||
"go": go1.23.3,
|
||||
"goArch": amd64,
|
||||
"goOS": linux,
|
||||
"modified": false,
|
||||
"revision": a1b2c3d4e5f6abcdef,
|
||||
"vcs": git,
|
||||
"version": 1.4.2,
|
||||
} satisfies HandlersVersionResponse
|
||||
|
||||
console.log(example)
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example)
|
||||
console.log(exampleJSON)
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as HandlersVersionResponse
|
||||
console.log(exampleParsed)
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
62
sdk/ts/docs/HealthApi.md
Normal file
62
sdk/ts/docs/HealthApi.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# HealthApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ----------------------------------------------------------------- | ---------------- | ------------------ |
|
||||
| [**healthCheckOperationId**](HealthApi.md#healthcheckoperationid) | **GET** /healthz | Basic health check |
|
||||
|
||||
## healthCheckOperationId
|
||||
|
||||
> HandlersHealthStatus healthCheckOperationId()
|
||||
|
||||
Basic health check
|
||||
|
||||
Returns 200 OK when the service is up
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, HealthApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { HealthCheckOperationIdRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new HealthApi();
|
||||
|
||||
try {
|
||||
const data = await api.healthCheckOperationId();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersHealthStatus**](HandlersHealthStatus.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
412
sdk/ts/docs/LabelsApi.md
Normal file
412
sdk/ts/docs/LabelsApi.md
Normal file
@@ -0,0 +1,412 @@
|
||||
# LabelsApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------------------------------------------- | ----------------------- | ----------------------------- |
|
||||
| [**createLabel**](LabelsApi.md#createlabel) | **POST** /labels | Create label (org scoped) |
|
||||
| [**deleteLabel**](LabelsApi.md#deletelabel) | **DELETE** /labels/{id} | Delete label (org scoped) |
|
||||
| [**getLabel**](LabelsApi.md#getlabel) | **GET** /labels/{id} | Get label by ID (org scoped) |
|
||||
| [**listLabels**](LabelsApi.md#listlabels) | **GET** /labels | List node labels (org scoped) |
|
||||
| [**updateLabel**](LabelsApi.md#updatelabel) | **PATCH** /labels/{id} | Update label (org scoped) |
|
||||
|
||||
## createLabel
|
||||
|
||||
> DtoLabelResponse createLabel(dtoCreateLabelRequest, xOrgID)
|
||||
|
||||
Create label (org scoped)
|
||||
|
||||
Creates a label.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
LabelsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateLabelRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LabelsApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateLabelRequest | Label payload
|
||||
dtoCreateLabelRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateLabelRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createLabel(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------- | ------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **dtoCreateLabelRequest** | [DtoCreateLabelRequest](DtoCreateLabelRequest.md) | Label payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoLabelResponse**](DtoLabelResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------------------------------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | invalid json / missing fields / invalid node_pool_ids | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | create failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteLabel
|
||||
|
||||
> deleteLabel(id, xOrgID)
|
||||
|
||||
Delete label (org scoped)
|
||||
|
||||
Permanently deletes the label.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LabelsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteLabelRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LabelsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Label ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteLabelRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteLabel(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Label ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | delete failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getLabel
|
||||
|
||||
> DtoLabelResponse getLabel(id, xOrgID)
|
||||
|
||||
Get label by ID (org scoped)
|
||||
|
||||
Returns one label.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LabelsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetLabelRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LabelsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Label ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetLabelRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getLabel(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Label ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoLabelResponse**](DtoLabelResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | fetch failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listLabels
|
||||
|
||||
> Array<DtoLabelResponse> listLabels(xOrgID, key, value, q)
|
||||
|
||||
List node labels (org scoped)
|
||||
|
||||
Returns node labels for the organization in X-Org-ID. Filters: `key`, `value`, and `q` (key contains). Add `include=node_pools` to include linked node groups.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LabelsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListLabelsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LabelsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Exact key (optional)
|
||||
key: key_example,
|
||||
// string | Exact value (optional)
|
||||
value: value_example,
|
||||
// string | Key contains (case-insensitive) (optional)
|
||||
q: q_example,
|
||||
} satisfies ListLabelsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listLabels(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ------------------------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **key** | `string` | Exact key | [Optional] [Defaults to `undefined`] |
|
||||
| **value** | `string` | Exact value | [Optional] [Defaults to `undefined`] |
|
||||
| **q** | `string` | Key contains (case-insensitive) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoLabelResponse>**](DtoLabelResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | -------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list node taints | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateLabel
|
||||
|
||||
> DtoLabelResponse updateLabel(id, dtoUpdateLabelRequest, xOrgID)
|
||||
|
||||
Update label (org scoped)
|
||||
|
||||
Partially update label fields.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
LabelsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateLabelRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LabelsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Label ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateLabelRequest | Fields to update
|
||||
dtoUpdateLabelRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateLabelRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateLabel(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------- | ------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Label ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateLabelRequest** | [DtoUpdateLabelRequest](DtoUpdateLabelRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoLabelResponse**](DtoLabelResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id / invalid json | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | update failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
390
sdk/ts/docs/LoadBalancersApi.md
Normal file
390
sdk/ts/docs/LoadBalancersApi.md
Normal file
@@ -0,0 +1,390 @@
|
||||
# LoadBalancersApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ---------------------------------------------------------------- | ------------------------------- | ----------------------------------- |
|
||||
| [**createLoadBalancer**](LoadBalancersApi.md#createloadbalancer) | **POST** /load-balancers | Create a load balancer |
|
||||
| [**deleteLoadBalancer**](LoadBalancersApi.md#deleteloadbalancer) | **DELETE** /load-balancers/{id} | Delete a load balancer |
|
||||
| [**getLoadBalancers**](LoadBalancersApi.md#getloadbalancers) | **GET** /load-balancers/{id} | Get a load balancer (org scoped) |
|
||||
| [**listLoadBalancers**](LoadBalancersApi.md#listloadbalancers) | **GET** /load-balancers | List load balancers (org scoped) |
|
||||
| [**updateLoadBalancer**](LoadBalancersApi.md#updateloadbalancer) | **PATCH** /load-balancers/{id} | Update a load balancer (org scoped) |
|
||||
|
||||
## createLoadBalancer
|
||||
|
||||
> DtoLoadBalancerResponse createLoadBalancer(dtoCreateLoadBalancerRequest, xOrgID)
|
||||
|
||||
Create a load balancer
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
LoadBalancersApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateLoadBalancerRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LoadBalancersApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateLoadBalancerRequest | Record set payload
|
||||
dtoCreateLoadBalancerRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateLoadBalancerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createLoadBalancer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------------- | --------------------------------------------------------------- | ------------------ | ------------------------------------ |
|
||||
| **dtoCreateLoadBalancerRequest** | [DtoCreateLoadBalancerRequest](DtoCreateLoadBalancerRequest.md) | Record set payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoLoadBalancerResponse**](DtoLoadBalancerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | validation error | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | domain not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteLoadBalancer
|
||||
|
||||
> deleteLoadBalancer(id, xOrgID)
|
||||
|
||||
Delete a load balancer
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LoadBalancersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteLoadBalancerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LoadBalancersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Load Balancer ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteLoadBalancerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteLoadBalancer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Load Balancer ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getLoadBalancers
|
||||
|
||||
> Array<DtoLoadBalancerResponse> getLoadBalancers(id, xOrgID)
|
||||
|
||||
Get a load balancer (org scoped)
|
||||
|
||||
Returns load balancer for the organization in X-Org-ID.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LoadBalancersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetLoadBalancersRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LoadBalancersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | LoadBalancer ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetLoadBalancersRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getLoadBalancers(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | LoadBalancer ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoLoadBalancerResponse>**](DtoLoadBalancerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list clusters | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listLoadBalancers
|
||||
|
||||
> Array<DtoLoadBalancerResponse> listLoadBalancers(xOrgID)
|
||||
|
||||
List load balancers (org scoped)
|
||||
|
||||
Returns load balancers for the organization in X-Org-ID.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, LoadBalancersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListLoadBalancersRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LoadBalancersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies ListLoadBalancersRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listLoadBalancers(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoLoadBalancerResponse>**](DtoLoadBalancerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list clusters | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateLoadBalancer
|
||||
|
||||
> DtoLoadBalancerResponse updateLoadBalancer(id, dtoUpdateLoadBalancerRequest, xOrgID)
|
||||
|
||||
Update a load balancer (org scoped)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
LoadBalancersApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateLoadBalancerRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new LoadBalancersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Load Balancer ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateLoadBalancerRequest | Fields to update
|
||||
dtoUpdateLoadBalancerRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateLoadBalancerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateLoadBalancer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------------- | --------------------------------------------------------------- | ----------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Load Balancer ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateLoadBalancerRequest** | [DtoUpdateLoadBalancerRequest](DtoUpdateLoadBalancerRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoLoadBalancerResponse**](DtoLoadBalancerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | validation error | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
203
sdk/ts/docs/MeAPIKeysApi.md
Normal file
203
sdk/ts/docs/MeAPIKeysApi.md
Normal file
@@ -0,0 +1,203 @@
|
||||
# MeAPIKeysApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| -------------------------------------------------------- | ---------------------------- | ------------------------- |
|
||||
| [**createUserAPIKey**](MeAPIKeysApi.md#createuserapikey) | **POST** /me/api-keys | Create a new user API key |
|
||||
| [**deleteUserAPIKey**](MeAPIKeysApi.md#deleteuserapikey) | **DELETE** /me/api-keys/{id} | Delete a user API key |
|
||||
| [**listUserAPIKeys**](MeAPIKeysApi.md#listuserapikeys) | **GET** /me/api-keys | List my API keys |
|
||||
|
||||
## createUserAPIKey
|
||||
|
||||
> HandlersUserAPIKeyOut createUserAPIKey(handlersCreateUserKeyRequest)
|
||||
|
||||
Create a new user API key
|
||||
|
||||
Returns the plaintext key once. Store it securely on the client side.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
MeAPIKeysApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateUserAPIKeyRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeAPIKeysApi(config);
|
||||
|
||||
const body = {
|
||||
// HandlersCreateUserKeyRequest | Key options
|
||||
handlersCreateUserKeyRequest: ...,
|
||||
} satisfies CreateUserAPIKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createUserAPIKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------------- | --------------------------------------------------------------- | ----------- | ----- |
|
||||
| **handlersCreateUserKeyRequest** | [HandlersCreateUserKeyRequest](HandlersCreateUserKeyRequest.md) | Key options | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersUserAPIKeyOut**](HandlersUserAPIKeyOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteUserAPIKey
|
||||
|
||||
> deleteUserAPIKey(id)
|
||||
|
||||
Delete a user API key
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, MeAPIKeysApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteUserAPIKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeAPIKeysApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Key ID (UUID)
|
||||
id: id_example,
|
||||
} satisfies DeleteUserAPIKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteUserAPIKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------ | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Key ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listUserAPIKeys
|
||||
|
||||
> Array<HandlersUserAPIKeyOut> listUserAPIKeys()
|
||||
|
||||
List my API keys
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, MeAPIKeysApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListUserAPIKeysRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeAPIKeysApi(config);
|
||||
|
||||
try {
|
||||
const data = await api.listUserAPIKeys();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<HandlersUserAPIKeyOut>**](HandlersUserAPIKeyOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
136
sdk/ts/docs/MeApi.md
Normal file
136
sdk/ts/docs/MeApi.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# MeApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| --------------------------------- | ------------- | --------------------------- |
|
||||
| [**getMe**](MeApi.md#getme) | **GET** /me | Get current user profile |
|
||||
| [**updateMe**](MeApi.md#updateme) | **PATCH** /me | Update current user profile |
|
||||
|
||||
## getMe
|
||||
|
||||
> HandlersMeResponse getMe()
|
||||
|
||||
Get current user profile
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, MeApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetMeRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeApi(config);
|
||||
|
||||
try {
|
||||
const data = await api.getMe();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersMeResponse**](HandlersMeResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateMe
|
||||
|
||||
> ModelsUser updateMe(handlersUpdateMeRequest)
|
||||
|
||||
Update current user profile
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
MeApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateMeRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeApi(config);
|
||||
|
||||
const body = {
|
||||
// HandlersUpdateMeRequest | Patch profile
|
||||
handlersUpdateMeRequest: ...,
|
||||
} satisfies UpdateMeRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateMe(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------------- | ----------------------------------------------------- | ------------- | ----- |
|
||||
| **handlersUpdateMeRequest** | [HandlersUpdateMeRequest](HandlersUpdateMeRequest.md) | Patch profile | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsUser**](ModelsUser.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
62
sdk/ts/docs/MetaApi.md
Normal file
62
sdk/ts/docs/MetaApi.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# MetaApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------------------------------------------------------- | ---------------- | --------------------------- |
|
||||
| [**versionOperationId**](MetaApi.md#versionoperationid) | **GET** /version | Service version information |
|
||||
|
||||
## versionOperationId
|
||||
|
||||
> HandlersVersionResponse versionOperationId()
|
||||
|
||||
Service version information
|
||||
|
||||
Returns build/runtime metadata for the running service.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, MetaApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { VersionOperationIdRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const api = new MetaApi();
|
||||
|
||||
try {
|
||||
const data = await api.versionOperationId();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersVersionResponse**](HandlersVersionResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
50
sdk/ts/docs/ModelsAPIKey.md
Normal file
50
sdk/ts/docs/ModelsAPIKey.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# ModelsAPIKey
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| -------------- | ------- |
|
||||
| `created_at` | Date |
|
||||
| `expires_at` | Date |
|
||||
| `id` | string |
|
||||
| `last_used_at` | Date |
|
||||
| `name` | string |
|
||||
| `org_id` | string |
|
||||
| `prefix` | string |
|
||||
| `revoked` | boolean |
|
||||
| `scope` | string |
|
||||
| `updated_at` | Date |
|
||||
| `user_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { ModelsAPIKey } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
expires_at: null,
|
||||
id: null,
|
||||
last_used_at: null,
|
||||
name: null,
|
||||
org_id: null,
|
||||
prefix: null,
|
||||
revoked: null,
|
||||
scope: null,
|
||||
updated_at: null,
|
||||
user_id: null,
|
||||
} satisfies ModelsAPIKey;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as ModelsAPIKey;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
38
sdk/ts/docs/ModelsOrganization.md
Normal file
38
sdk/ts/docs/ModelsOrganization.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# ModelsOrganization
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------ | ------ |
|
||||
| `created_at` | Date |
|
||||
| `domain` | string |
|
||||
| `id` | string |
|
||||
| `name` | string |
|
||||
| `updated_at` | Date |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { ModelsOrganization } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
domain: null,
|
||||
id: null,
|
||||
name: null,
|
||||
updated_at: null,
|
||||
} satisfies ModelsOrganization;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as ModelsOrganization;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
44
sdk/ts/docs/ModelsUser.md
Normal file
44
sdk/ts/docs/ModelsUser.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# ModelsUser
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------------- | ------- |
|
||||
| `avatar_url` | string |
|
||||
| `created_at` | Date |
|
||||
| `display_name` | string |
|
||||
| `id` | string |
|
||||
| `is_admin` | boolean |
|
||||
| `is_disabled` | boolean |
|
||||
| `primary_email` | string |
|
||||
| `updated_at` | Date |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { ModelsUser } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
avatar_url: null,
|
||||
created_at: null,
|
||||
display_name: null,
|
||||
id: null,
|
||||
is_admin: null,
|
||||
is_disabled: null,
|
||||
primary_email: null,
|
||||
updated_at: null,
|
||||
} satisfies ModelsUser;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as ModelsUser;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
44
sdk/ts/docs/ModelsUserEmail.md
Normal file
44
sdk/ts/docs/ModelsUserEmail.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# ModelsUserEmail
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| ------------- | --------------------------- |
|
||||
| `created_at` | Date |
|
||||
| `email` | string |
|
||||
| `id` | string |
|
||||
| `is_primary` | boolean |
|
||||
| `is_verified` | boolean |
|
||||
| `updated_at` | Date |
|
||||
| `user` | [ModelsUser](ModelsUser.md) |
|
||||
| `user_id` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { ModelsUserEmail } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
created_at: null,
|
||||
email: null,
|
||||
id: null,
|
||||
is_primary: null,
|
||||
is_verified: null,
|
||||
updated_at: null,
|
||||
user: null,
|
||||
user_id: null,
|
||||
} satisfies ModelsUserEmail;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as ModelsUserEmail;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
1366
sdk/ts/docs/NodePoolsApi.md
Normal file
1366
sdk/ts/docs/NodePoolsApi.md
Normal file
File diff suppressed because it is too large
Load Diff
757
sdk/ts/docs/OrgsApi.md
Normal file
757
sdk/ts/docs/OrgsApi.md
Normal file
@@ -0,0 +1,757 @@
|
||||
# OrgsApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ----------------------------------------------------- | --------------------------------------- | ---------------------------------------- |
|
||||
| [**addOrUpdateMember**](OrgsApi.md#addorupdatemember) | **POST** /orgs/{id}/members | Add or update a member (owner/admin) |
|
||||
| [**createOrg**](OrgsApi.md#createorg) | **POST** /orgs | Create organization |
|
||||
| [**createOrgKey**](OrgsApi.md#createorgkey) | **POST** /orgs/{id}/api-keys | Create org key/secret pair (owner/admin) |
|
||||
| [**deleteOrg**](OrgsApi.md#deleteorg) | **DELETE** /orgs/{id} | Delete organization (owner) |
|
||||
| [**deleteOrgKey**](OrgsApi.md#deleteorgkey) | **DELETE** /orgs/{id}/api-keys/{key_id} | Delete org key (owner/admin) |
|
||||
| [**getOrg**](OrgsApi.md#getorg) | **GET** /orgs/{id} | Get organization |
|
||||
| [**listMembers**](OrgsApi.md#listmembers) | **GET** /orgs/{id}/members | List members in org |
|
||||
| [**listMyOrgs**](OrgsApi.md#listmyorgs) | **GET** /orgs | List organizations I belong to |
|
||||
| [**listOrgKeys**](OrgsApi.md#listorgkeys) | **GET** /orgs/{id}/api-keys | List org-scoped API keys (no secrets) |
|
||||
| [**removeMember**](OrgsApi.md#removemember) | **DELETE** /orgs/{id}/members/{user_id} | Remove a member (owner/admin) |
|
||||
| [**updateOrg**](OrgsApi.md#updateorg) | **PATCH** /orgs/{id} | Update organization (owner/admin) |
|
||||
|
||||
## addOrUpdateMember
|
||||
|
||||
> HandlersMemberOut addOrUpdateMember(id, handlersMemberUpsertReq)
|
||||
|
||||
Add or update a member (owner/admin)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
OrgsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { AddOrUpdateMemberRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
// HandlersMemberUpsertReq | User & role
|
||||
handlersMemberUpsertReq: ...,
|
||||
} satisfies AddOrUpdateMemberRequest;
|
||||
|
||||
try {
|
||||
const data = await api.addOrUpdateMember(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------------- | ----------------------------------------------------- | --------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
| **handlersMemberUpsertReq** | [HandlersMemberUpsertReq](HandlersMemberUpsertReq.md) | User & role | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersMemberOut**](HandlersMemberOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## createOrg
|
||||
|
||||
> ModelsOrganization createOrg(handlersOrgCreateReq)
|
||||
|
||||
Create organization
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
OrgsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateOrgRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// HandlersOrgCreateReq | Org payload
|
||||
handlersOrgCreateReq: ...,
|
||||
} satisfies CreateOrgRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createOrg(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------ | ----------------------------------------------- | ----------- | ----- |
|
||||
| **handlersOrgCreateReq** | [HandlersOrgCreateReq](HandlersOrgCreateReq.md) | Org payload | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsOrganization**](ModelsOrganization.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | Bad Request | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **409** | Conflict | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## createOrgKey
|
||||
|
||||
> HandlersOrgKeyCreateResp createOrgKey(id, handlersOrgKeyCreateReq)
|
||||
|
||||
Create org key/secret pair (owner/admin)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
OrgsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateOrgKeyRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
// HandlersOrgKeyCreateReq | Key name + optional expiry
|
||||
handlersOrgKeyCreateReq: ...,
|
||||
} satisfies CreateOrgKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createOrgKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------------- | ----------------------------------------------------- | -------------------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
| **handlersOrgKeyCreateReq** | [HandlersOrgKeyCreateReq](HandlersOrgKeyCreateReq.md) | Key name + optional expiry | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersOrgKeyCreateResp**](HandlersOrgKeyCreateResp.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteOrg
|
||||
|
||||
> deleteOrg(id)
|
||||
|
||||
Delete organization (owner)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteOrgRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
} satisfies DeleteOrgRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteOrg(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------ | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **204** | Deleted | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **404** | Not Found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteOrgKey
|
||||
|
||||
> deleteOrgKey(id, keyId)
|
||||
|
||||
Delete org key (owner/admin)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteOrgKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
// string | Key ID (UUID)
|
||||
keyId: keyId_example,
|
||||
} satisfies DeleteOrgKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteOrgKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------- | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
| **keyId** | `string` | Key ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **204** | Deleted | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getOrg
|
||||
|
||||
> ModelsOrganization getOrg(id)
|
||||
|
||||
Get organization
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetOrgRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
} satisfies GetOrgRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getOrg(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------ | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsOrganization**](ModelsOrganization.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **404** | Not Found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listMembers
|
||||
|
||||
> Array<HandlersMemberOut> listMembers(id)
|
||||
|
||||
List members in org
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListMembersRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
} satisfies ListMembersRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listMembers(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------ | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<HandlersMemberOut>**](HandlersMemberOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listMyOrgs
|
||||
|
||||
> Array<ModelsOrganization> listMyOrgs()
|
||||
|
||||
List organizations I belong to
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListMyOrgsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
try {
|
||||
const data = await api.listMyOrgs();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<ModelsOrganization>**](ModelsOrganization.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listOrgKeys
|
||||
|
||||
> Array<ModelsAPIKey> listOrgKeys(id)
|
||||
|
||||
List org-scoped API keys (no secrets)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListOrgKeysRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
} satisfies ListOrgKeysRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listOrgKeys(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------ | -------- | ------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<ModelsAPIKey>**](ModelsAPIKey.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## removeMember
|
||||
|
||||
> removeMember(id, userId)
|
||||
|
||||
Remove a member (owner/admin)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, OrgsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { RemoveMemberRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
// string | User ID (UUID)
|
||||
userId: userId_example,
|
||||
} satisfies RemoveMemberRequest;
|
||||
|
||||
try {
|
||||
const data = await api.removeMember(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
| **userId** | `string` | User ID (UUID) | [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **204** | Removed | - |
|
||||
| **401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateOrg
|
||||
|
||||
> ModelsOrganization updateOrg(id, handlersOrgUpdateReq)
|
||||
|
||||
Update organization (owner/admin)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
OrgsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateOrgRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new OrgsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Org ID (UUID)
|
||||
id: id_example,
|
||||
// HandlersOrgUpdateReq | Update payload
|
||||
handlersOrgUpdateReq: ...,
|
||||
} satisfies UpdateOrgRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateOrg(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------ | ----------------------------------------------- | -------------- | ------------------------- |
|
||||
| **id** | `string` | Org ID (UUID) | [Defaults to `undefined`] |
|
||||
| **handlersOrgUpdateReq** | [HandlersOrgUpdateReq](HandlersOrgUpdateReq.md) | Update payload | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsOrganization**](ModelsOrganization.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------ | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **404** | Not Found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
491
sdk/ts/docs/ServersApi.md
Normal file
491
sdk/ts/docs/ServersApi.md
Normal file
@@ -0,0 +1,491 @@
|
||||
# ServersApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ---------------------------------------------------------- | ------------------------------------ | ------------------------------- |
|
||||
| [**createServer**](ServersApi.md#createserver) | **POST** /servers | Create server (org scoped) |
|
||||
| [**deleteServer**](ServersApi.md#deleteserver) | **DELETE** /servers/{id} | Delete server (org scoped) |
|
||||
| [**getServer**](ServersApi.md#getserver) | **GET** /servers/{id} | Get server by ID (org scoped) |
|
||||
| [**listServers**](ServersApi.md#listservers) | **GET** /servers | List servers (org scoped) |
|
||||
| [**resetServerHostKey**](ServersApi.md#resetserverhostkey) | **POST** /servers/{id}/reset-hostkey | Reset SSH host key (org scoped) |
|
||||
| [**updateServer**](ServersApi.md#updateserver) | **PATCH** /servers/{id} | Update server (org scoped) |
|
||||
|
||||
## createServer
|
||||
|
||||
> DtoServerResponse createServer(dtoCreateServerRequest, xOrgID)
|
||||
|
||||
Create server (org scoped)
|
||||
|
||||
Creates a server bound to the org in X-Org-ID. Validates that ssh_key_id belongs to the org.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
ServersApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateServerRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateServerRequest | Server payload
|
||||
dtoCreateServerRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateServerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createServer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------- | --------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **dtoCreateServerRequest** | [DtoCreateServerRequest](DtoCreateServerRequest.md) | Server payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoServerResponse**](DtoServerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------------------------------------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | invalid json / missing fields / invalid status / invalid ssh_key_id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | create failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteServer
|
||||
|
||||
> deleteServer(id, xOrgID)
|
||||
|
||||
Delete server (org scoped)
|
||||
|
||||
Permanently deletes the server.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ServersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteServerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Server ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteServerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteServer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Server ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | delete failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getServer
|
||||
|
||||
> DtoServerResponse getServer(id, xOrgID)
|
||||
|
||||
Get server by ID (org scoped)
|
||||
|
||||
Returns one server in the given organization.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ServersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetServerRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Server ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetServerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getServer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Server ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoServerResponse**](DtoServerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | fetch failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listServers
|
||||
|
||||
> Array<DtoServerResponse> listServers(xOrgID, status, role)
|
||||
|
||||
List servers (org scoped)
|
||||
|
||||
Returns servers for the organization in X-Org-ID. Optional filters: status, role.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ServersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListServersRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Filter by status (pending|provisioning|ready|failed) (optional)
|
||||
status: status_example,
|
||||
// string | Filter by role (optional)
|
||||
role: role_example,
|
||||
} satisfies ListServersRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listServers(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ------------------------- | ------------------------------------ | ----- | ------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **status** | `string` | Filter by status (pending | provisioning | ready | failed) | [Optional] [Defaults to `undefined`] |
|
||||
| **role** | `string` | Filter by role | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoServerResponse>**](DtoServerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ---------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list servers | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## resetServerHostKey
|
||||
|
||||
> DtoServerResponse resetServerHostKey(id, xOrgID, body)
|
||||
|
||||
Reset SSH host key (org scoped)
|
||||
|
||||
Clears the stored SSH host key for this server. The next SSH connection will re-learn the host key (trust-on-first-use).
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, ServersApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ResetServerHostKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Server ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// object (optional)
|
||||
body: Object,
|
||||
} satisfies ResetServerHostKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.resetServerHostKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Server ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **body** | `object` | | [Optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoServerResponse**](DtoServerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | reset failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateServer
|
||||
|
||||
> DtoServerResponse updateServer(id, dtoUpdateServerRequest, xOrgID)
|
||||
|
||||
Update server (org scoped)
|
||||
|
||||
Partially update fields; changing ssh_key_id validates ownership.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
ServersApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateServerRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new ServersApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Server ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateServerRequest | Fields to update
|
||||
dtoUpdateServerRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateServerRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateServer(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------------------------- | --------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | Server ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateServerRequest** | [DtoUpdateServerRequest](DtoUpdateServerRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoServerResponse**](DtoServerResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------------------------------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id / invalid json / invalid status / invalid ssh_key_id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | update failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
403
sdk/ts/docs/SshApi.md
Normal file
403
sdk/ts/docs/SshApi.md
Normal file
@@ -0,0 +1,403 @@
|
||||
# SshApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ---------------------------------------------------- | -------------------------- | ----------------------------------------- |
|
||||
| [**createSSHKey**](SshApi.md#createsshkey) | **POST** /ssh | Create ssh keypair (org scoped) |
|
||||
| [**deleteSSHKey**](SshApi.md#deletesshkey) | **DELETE** /ssh/{id} | Delete ssh keypair (org scoped) |
|
||||
| [**downloadSSHKey**](SshApi.md#downloadsshkey) | **GET** /ssh/{id}/download | Download ssh key files by ID (org scoped) |
|
||||
| [**getSSHKey**](SshApi.md#getsshkey) | **GET** /ssh/{id} | Get ssh key by ID (org scoped) |
|
||||
| [**listPublicSshKeys**](SshApi.md#listpublicsshkeys) | **GET** /ssh | List ssh keys (org scoped) |
|
||||
|
||||
## createSSHKey
|
||||
|
||||
> DtoSshResponse createSSHKey(dtoCreateSSHRequest, xOrgID)
|
||||
|
||||
Create ssh keypair (org scoped)
|
||||
|
||||
Generates an RSA or ED25519 keypair, saves it, and returns metadata. For RSA you may set bits (2048/3072/4096). Default is 4096. ED25519 ignores bits.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
SshApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateSSHKeyRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new SshApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateSSHRequest | Key generation options
|
||||
dtoCreateSSHRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateSSHKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createSSHKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ----------------------- | --------------------------------------------- | ---------------------- | ------------------------------------ |
|
||||
| **dtoCreateSSHRequest** | [DtoCreateSSHRequest](DtoCreateSSHRequest.md) | Key generation options | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoSshResponse**](DtoSshResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | invalid json / invalid bits | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | generation/create failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteSSHKey
|
||||
|
||||
> deleteSSHKey(id, xOrgID)
|
||||
|
||||
Delete ssh keypair (org scoped)
|
||||
|
||||
Permanently deletes a keypair.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, SshApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteSSHKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new SshApi(config);
|
||||
|
||||
const body = {
|
||||
// string | SSH Key ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteSSHKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteSSHKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **id** | `string` | SSH Key ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | delete failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## downloadSSHKey
|
||||
|
||||
> string downloadSSHKey(xOrgID, id, part)
|
||||
|
||||
Download ssh key files by ID (org scoped)
|
||||
|
||||
Download `part=public|private|both` of the keypair. `both` returns a zip file.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, SshApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DownloadSSHKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new SshApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID
|
||||
xOrgID: xOrgID_example,
|
||||
// string | SSH Key ID (UUID)
|
||||
id: id_example,
|
||||
// 'public' | 'private' | 'both' | Which part to download
|
||||
part: part_example,
|
||||
} satisfies DownloadSSHKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.downloadSSHKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | --------------------------- | ---------------------- | ------------------------------------------------------- |
|
||||
| **xOrgID** | `string` | Organization UUID | [Defaults to `undefined`] |
|
||||
| **id** | `string` | SSH Key ID (UUID) | [Defaults to `undefined`] |
|
||||
| **part** | `public`, `private`, `both` | Which part to download | [Defaults to `undefined`] [Enum: public, private, both] |
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------- | ---------------- |
|
||||
| **200** | file content | - |
|
||||
| **400** | invalid id / invalid part | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | download failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getSSHKey
|
||||
|
||||
> GetSSHKey200Response getSSHKey(id, xOrgID, reveal)
|
||||
|
||||
Get ssh key by ID (org scoped)
|
||||
|
||||
Returns public key fields. Append `?reveal=true` to include the private key PEM.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, SshApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetSSHKeyRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new SshApi(config);
|
||||
|
||||
const body = {
|
||||
// string | SSH Key ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// boolean | Reveal private key PEM (optional)
|
||||
reveal: true,
|
||||
} satisfies GetSSHKeyRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getSSHKey(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | --------- | ---------------------- | ------------------------------------ |
|
||||
| **id** | `string` | SSH Key ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **reveal** | `boolean` | Reveal private key PEM | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetSSHKey200Response**](GetSSHKey200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | When reveal=true | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | fetch failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listPublicSshKeys
|
||||
|
||||
> Array<DtoSshResponse> listPublicSshKeys(xOrgID)
|
||||
|
||||
List ssh keys (org scoped)
|
||||
|
||||
Returns ssh keys for the organization in X-Org-ID.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, SshApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListPublicSshKeysRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new SshApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies ListPublicSshKeysRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listPublicSshKeys(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ----------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoSshResponse>**](DtoSshResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list keys | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
410
sdk/ts/docs/TaintsApi.md
Normal file
410
sdk/ts/docs/TaintsApi.md
Normal file
@@ -0,0 +1,410 @@
|
||||
# TaintsApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------------------------------------------- | ----------------------- | ---------------------------------- |
|
||||
| [**createTaint**](TaintsApi.md#createtaint) | **POST** /taints | Create node taint (org scoped) |
|
||||
| [**deleteTaint**](TaintsApi.md#deletetaint) | **DELETE** /taints/{id} | Delete taint (org scoped) |
|
||||
| [**getTaint**](TaintsApi.md#gettaint) | **GET** /taints/{id} | Get node taint by ID (org scoped) |
|
||||
| [**listTaints**](TaintsApi.md#listtaints) | **GET** /taints | List node pool taints (org scoped) |
|
||||
| [**updateTaint**](TaintsApi.md#updatetaint) | **PATCH** /taints/{id} | Update node taint (org scoped) |
|
||||
|
||||
## createTaint
|
||||
|
||||
> DtoTaintResponse createTaint(dtoCreateTaintRequest, xOrgID)
|
||||
|
||||
Create node taint (org scoped)
|
||||
|
||||
Creates a taint.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
TaintsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { CreateTaintRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new TaintsApi(config);
|
||||
|
||||
const body = {
|
||||
// DtoCreateTaintRequest | Taint payload
|
||||
dtoCreateTaintRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies CreateTaintRequest;
|
||||
|
||||
try {
|
||||
const data = await api.createTaint(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------- | ------------------------------------------------- | ----------------- | ------------------------------------ |
|
||||
| **dtoCreateTaintRequest** | [DtoCreateTaintRequest](DtoCreateTaintRequest.md) | Taint payload | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoTaintResponse**](DtoTaintResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------------------------------------------------- | ---------------- |
|
||||
| **201** | Created | - |
|
||||
| **400** | invalid json / missing fields / invalid node_pool_ids | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | create failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## deleteTaint
|
||||
|
||||
> deleteTaint(id, xOrgID)
|
||||
|
||||
Delete taint (org scoped)
|
||||
|
||||
Permanently deletes the taint.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, TaintsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { DeleteTaintRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new TaintsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Node Taint ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies DeleteTaintRequest;
|
||||
|
||||
try {
|
||||
const data = await api.deleteTaint(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Node Taint ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
`void` (Empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **204** | No Content | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | delete failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## getTaint
|
||||
|
||||
> DtoTaintResponse getTaint(id, xOrgID)
|
||||
|
||||
Get node taint by ID (org scoped)
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, TaintsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetTaintRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new TaintsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Node Taint ID (UUID)
|
||||
id: id_example,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies GetTaintRequest;
|
||||
|
||||
try {
|
||||
const data = await api.getTaint(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Node Taint ID (UUID) | [Defaults to `undefined`] |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoTaintResponse**](DtoTaintResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | --------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | fetch failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## listTaints
|
||||
|
||||
> Array<DtoTaintResponse> listTaints(xOrgID, key, value, q)
|
||||
|
||||
List node pool taints (org scoped)
|
||||
|
||||
Returns node taints for the organization in X-Org-ID. Filters: `key`, `value`, and `q` (key contains). Add `include=node_pools` to include linked node pools.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, TaintsApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { ListTaintsRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new TaintsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
// string | Exact key (optional)
|
||||
key: key_example,
|
||||
// string | Exact value (optional)
|
||||
value: value_example,
|
||||
// string | key contains (case-insensitive) (optional)
|
||||
q: q_example,
|
||||
} satisfies ListTaintsRequest;
|
||||
|
||||
try {
|
||||
const data = await api.listTaints(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | -------- | ------------------------------- | ------------------------------------ |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
| **key** | `string` | Exact key | [Optional] [Defaults to `undefined`] |
|
||||
| **value** | `string` | Exact value | [Optional] [Defaults to `undefined`] |
|
||||
| **q** | `string` | key contains (case-insensitive) | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Array<DtoTaintResponse>**](DtoTaintResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | -------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **500** | failed to list node taints | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateTaint
|
||||
|
||||
> DtoTaintResponse updateTaint(id, dtoUpdateTaintRequest, xOrgID)
|
||||
|
||||
Update node taint (org scoped)
|
||||
|
||||
Partially update taint fields.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
TaintsApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateTaintRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: OrgKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: OrgSecretAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new TaintsApi(config);
|
||||
|
||||
const body = {
|
||||
// string | Node Taint ID (UUID)
|
||||
id: id_example,
|
||||
// DtoUpdateTaintRequest | Fields to update
|
||||
dtoUpdateTaintRequest: ...,
|
||||
// string | Organization UUID (optional)
|
||||
xOrgID: xOrgID_example,
|
||||
} satisfies UpdateTaintRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateTaint(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------------------- | ------------------------------------------------- | -------------------- | ------------------------------------ |
|
||||
| **id** | `string` | Node Taint ID (UUID) | [Defaults to `undefined`] |
|
||||
| **dtoUpdateTaintRequest** | [DtoUpdateTaintRequest](DtoUpdateTaintRequest.md) | Fields to update | |
|
||||
| **xOrgID** | `string` | Organization UUID | [Optional] [Defaults to `undefined`] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoTaintResponse**](DtoTaintResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
| **400** | invalid id / invalid json | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | organization required | - |
|
||||
| **404** | not found | - |
|
||||
| **500** | update failed | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
32
sdk/ts/docs/UtilsErrorResponse.md
Normal file
32
sdk/ts/docs/UtilsErrorResponse.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# UtilsErrorResponse
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type |
|
||||
| --------- | ------ |
|
||||
| `code` | string |
|
||||
| `message` | string |
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import type { UtilsErrorResponse } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
// TODO: Update the object below with actual values
|
||||
const example = {
|
||||
code: null,
|
||||
message: null,
|
||||
} satisfies UtilsErrorResponse;
|
||||
|
||||
console.log(example);
|
||||
|
||||
// Convert the instance to a JSON string
|
||||
const exampleJSON: string = JSON.stringify(example);
|
||||
console.log(exampleJSON);
|
||||
|
||||
// Parse the JSON string back to an object
|
||||
const exampleParsed = JSON.parse(exampleJSON) as UtilsErrorResponse;
|
||||
console.log(exampleParsed);
|
||||
```
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
21
sdk/ts/package.json
Normal file
21
sdk/ts/package.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "@glueops/autoglue-sdk-go",
|
||||
"version": "0.1.0",
|
||||
"description": "OpenAPI client for @glueops/autoglue-sdk-go",
|
||||
"author": "OpenAPI-Generator",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"module": "./dist/esm/index.js",
|
||||
"sideEffects": false,
|
||||
"scripts": {
|
||||
"build": "tsc && tsc -p tsconfig.esm.json",
|
||||
"prepare": "npm run build"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^4.0 || ^5.0"
|
||||
}
|
||||
}
|
||||
432
sdk/ts/src/apis/AnnotationsApi.ts
Normal file
432
sdk/ts/src/apis/AnnotationsApi.ts
Normal file
@@ -0,0 +1,432 @@
|
||||
/* tslint:disable */
|
||||
/* eslint-disable */
|
||||
/**
|
||||
* AutoGlue API
|
||||
* API for managing K3s clusters across cloud providers
|
||||
*
|
||||
* The version of the OpenAPI document: dev
|
||||
*
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import * as runtime from "../runtime";
|
||||
import type {DtoAnnotationResponse, DtoCreateAnnotationRequest, DtoUpdateAnnotationRequest,} from "../models/index";
|
||||
import {
|
||||
DtoAnnotationResponseFromJSON,
|
||||
DtoCreateAnnotationRequestToJSON,
|
||||
DtoUpdateAnnotationRequestToJSON,
|
||||
} from "../models/index";
|
||||
|
||||
export interface CreateAnnotationRequest {
|
||||
dtoCreateAnnotationRequest: DtoCreateAnnotationRequest;
|
||||
xOrgID?: string;
|
||||
}
|
||||
|
||||
export interface DeleteAnnotationRequest {
|
||||
id: string;
|
||||
xOrgID?: string;
|
||||
}
|
||||
|
||||
export interface GetAnnotationRequest {
|
||||
id: string;
|
||||
xOrgID?: string;
|
||||
}
|
||||
|
||||
export interface ListAnnotationsRequest {
|
||||
xOrgID?: string;
|
||||
key?: string;
|
||||
value?: string;
|
||||
q?: string;
|
||||
}
|
||||
|
||||
export interface UpdateAnnotationRequest {
|
||||
id: string;
|
||||
dtoUpdateAnnotationRequest: DtoUpdateAnnotationRequest;
|
||||
xOrgID?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
export class AnnotationsApi extends runtime.BaseAPI {
|
||||
/**
|
||||
* Creates an annotation.
|
||||
* Create annotation (org scoped)
|
||||
*/
|
||||
async createAnnotationRaw(
|
||||
requestParameters: CreateAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoAnnotationResponse>> {
|
||||
if (requestParameters["dtoCreateAnnotationRequest"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"dtoCreateAnnotationRequest",
|
||||
'Required parameter "dtoCreateAnnotationRequest" was null or undefined when calling createAnnotation().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
if (requestParameters["xOrgID"] != null) {
|
||||
headerParameters["X-Org-ID"] = String(requestParameters["xOrgID"]);
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-KEY"] =
|
||||
await this.configuration.apiKey("X-ORG-KEY"); // OrgKeyAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-SECRET"] =
|
||||
await this.configuration.apiKey("X-ORG-SECRET"); // OrgSecretAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/annotations`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: DtoCreateAnnotationRequestToJSON(
|
||||
requestParameters["dtoCreateAnnotationRequest"],
|
||||
),
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoAnnotationResponseFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an annotation.
|
||||
* Create annotation (org scoped)
|
||||
*/
|
||||
async createAnnotation(
|
||||
requestParameters: CreateAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoAnnotationResponse> {
|
||||
const response = await this.createAnnotationRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Permanently deletes the annotation.
|
||||
* Delete annotation (org scoped)
|
||||
*/
|
||||
async deleteAnnotationRaw(
|
||||
requestParameters: DeleteAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<void>> {
|
||||
if (requestParameters["id"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"id",
|
||||
'Required parameter "id" was null or undefined when calling deleteAnnotation().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
if (requestParameters["xOrgID"] != null) {
|
||||
headerParameters["X-Org-ID"] = String(requestParameters["xOrgID"]);
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-KEY"] =
|
||||
await this.configuration.apiKey("X-ORG-KEY"); // OrgKeyAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-SECRET"] =
|
||||
await this.configuration.apiKey("X-ORG-SECRET"); // OrgSecretAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/annotations/{id}`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"id"}}`,
|
||||
encodeURIComponent(String(requestParameters["id"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "DELETE",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.VoidApiResponse(response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Permanently deletes the annotation.
|
||||
* Delete annotation (org scoped)
|
||||
*/
|
||||
async deleteAnnotation(
|
||||
requestParameters: DeleteAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<void> {
|
||||
await this.deleteAnnotationRaw(requestParameters, initOverrides);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns one annotation. Add `include=node_pools` to include node pools.
|
||||
* Get annotation by ID (org scoped)
|
||||
*/
|
||||
async getAnnotationRaw(
|
||||
requestParameters: GetAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoAnnotationResponse>> {
|
||||
if (requestParameters["id"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"id",
|
||||
'Required parameter "id" was null or undefined when calling getAnnotation().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
if (requestParameters["xOrgID"] != null) {
|
||||
headerParameters["X-Org-ID"] = String(requestParameters["xOrgID"]);
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-KEY"] =
|
||||
await this.configuration.apiKey("X-ORG-KEY"); // OrgKeyAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-SECRET"] =
|
||||
await this.configuration.apiKey("X-ORG-SECRET"); // OrgSecretAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/annotations/{id}`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"id"}}`,
|
||||
encodeURIComponent(String(requestParameters["id"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoAnnotationResponseFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns one annotation. Add `include=node_pools` to include node pools.
|
||||
* Get annotation by ID (org scoped)
|
||||
*/
|
||||
async getAnnotation(
|
||||
requestParameters: GetAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoAnnotationResponse> {
|
||||
const response = await this.getAnnotationRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns annotations for the organization in X-Org-ID. Filters: `key`, `value`, and `q` (key contains). Add `include=node_pools` to include linked node pools.
|
||||
* List annotations (org scoped)
|
||||
*/
|
||||
async listAnnotationsRaw(
|
||||
requestParameters: ListAnnotationsRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<Array<DtoAnnotationResponse>>> {
|
||||
const queryParameters: any = {};
|
||||
|
||||
if (requestParameters["key"] != null) {
|
||||
queryParameters["key"] = requestParameters["key"];
|
||||
}
|
||||
|
||||
if (requestParameters["value"] != null) {
|
||||
queryParameters["value"] = requestParameters["value"];
|
||||
}
|
||||
|
||||
if (requestParameters["q"] != null) {
|
||||
queryParameters["q"] = requestParameters["q"];
|
||||
}
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
if (requestParameters["xOrgID"] != null) {
|
||||
headerParameters["X-Org-ID"] = String(requestParameters["xOrgID"]);
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-KEY"] =
|
||||
await this.configuration.apiKey("X-ORG-KEY"); // OrgKeyAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-SECRET"] =
|
||||
await this.configuration.apiKey("X-ORG-SECRET"); // OrgSecretAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/annotations`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
jsonValue.map(DtoAnnotationResponseFromJSON),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns annotations for the organization in X-Org-ID. Filters: `key`, `value`, and `q` (key contains). Add `include=node_pools` to include linked node pools.
|
||||
* List annotations (org scoped)
|
||||
*/
|
||||
async listAnnotations(
|
||||
requestParameters: ListAnnotationsRequest = {},
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<Array<DtoAnnotationResponse>> {
|
||||
const response = await this.listAnnotationsRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Partially update annotation fields.
|
||||
* Update annotation (org scoped)
|
||||
*/
|
||||
async updateAnnotationRaw(
|
||||
requestParameters: UpdateAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoAnnotationResponse>> {
|
||||
if (requestParameters["id"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"id",
|
||||
'Required parameter "id" was null or undefined when calling updateAnnotation().',
|
||||
);
|
||||
}
|
||||
|
||||
if (requestParameters["dtoUpdateAnnotationRequest"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"dtoUpdateAnnotationRequest",
|
||||
'Required parameter "dtoUpdateAnnotationRequest" was null or undefined when calling updateAnnotation().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
if (requestParameters["xOrgID"] != null) {
|
||||
headerParameters["X-Org-ID"] = String(requestParameters["xOrgID"]);
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-KEY"] =
|
||||
await this.configuration.apiKey("X-ORG-KEY"); // OrgKeyAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["X-ORG-SECRET"] =
|
||||
await this.configuration.apiKey("X-ORG-SECRET"); // OrgSecretAuth authentication
|
||||
}
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/annotations/{id}`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"id"}}`,
|
||||
encodeURIComponent(String(requestParameters["id"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "PATCH",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: DtoUpdateAnnotationRequestToJSON(
|
||||
requestParameters["dtoUpdateAnnotationRequest"],
|
||||
),
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoAnnotationResponseFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Partially update annotation fields.
|
||||
* Update annotation (org scoped)
|
||||
*/
|
||||
async updateAnnotation(
|
||||
requestParameters: UpdateAnnotationRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoAnnotationResponse> {
|
||||
const response = await this.updateAnnotationRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
}
|
||||
357
sdk/ts/src/apis/ArcherAdminApi.ts
Normal file
357
sdk/ts/src/apis/ArcherAdminApi.ts
Normal file
@@ -0,0 +1,357 @@
|
||||
/* tslint:disable */
|
||||
/* eslint-disable */
|
||||
/**
|
||||
* AutoGlue API
|
||||
* API for managing K3s clusters across cloud providers
|
||||
*
|
||||
* The version of the OpenAPI document: dev
|
||||
*
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import * as runtime from "../runtime";
|
||||
import type {DtoEnqueueRequest, DtoJob, DtoPageJob, DtoQueueInfo,} from "../models/index";
|
||||
import {DtoEnqueueRequestToJSON, DtoJobFromJSON, DtoPageJobFromJSON, DtoQueueInfoFromJSON,} from "../models/index";
|
||||
|
||||
export interface AdminCancelArcherJobRequest {
|
||||
id: string;
|
||||
body?: object;
|
||||
}
|
||||
|
||||
export interface AdminEnqueueArcherJobRequest {
|
||||
dtoEnqueueRequest: DtoEnqueueRequest;
|
||||
}
|
||||
|
||||
export interface AdminListArcherJobsRequest {
|
||||
status?: AdminListArcherJobsStatusEnum;
|
||||
queue?: string;
|
||||
q?: string;
|
||||
page?: number;
|
||||
pageSize?: number;
|
||||
}
|
||||
|
||||
export interface AdminRetryArcherJobRequest {
|
||||
id: string;
|
||||
body?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
export class ArcherAdminApi extends runtime.BaseAPI {
|
||||
/**
|
||||
* Set job status to canceled if cancellable. For running jobs, this only affects future picks; wire to Archer if you need active kill.
|
||||
* Cancel an Archer job (admin)
|
||||
*/
|
||||
async adminCancelArcherJobRaw(
|
||||
requestParameters: AdminCancelArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoJob>> {
|
||||
if (requestParameters["id"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"id",
|
||||
'Required parameter "id" was null or undefined when calling adminCancelArcherJob().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/admin/archer/jobs/{id}/cancel`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"id"}}`,
|
||||
encodeURIComponent(String(requestParameters["id"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: requestParameters["body"] as any,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoJobFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set job status to canceled if cancellable. For running jobs, this only affects future picks; wire to Archer if you need active kill.
|
||||
* Cancel an Archer job (admin)
|
||||
*/
|
||||
async adminCancelArcherJob(
|
||||
requestParameters: AdminCancelArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoJob> {
|
||||
const response = await this.adminCancelArcherJobRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a job immediately or schedule it for the future via `run_at`.
|
||||
* Enqueue a new Archer job (admin)
|
||||
*/
|
||||
async adminEnqueueArcherJobRaw(
|
||||
requestParameters: AdminEnqueueArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoJob>> {
|
||||
if (requestParameters["dtoEnqueueRequest"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"dtoEnqueueRequest",
|
||||
'Required parameter "dtoEnqueueRequest" was null or undefined when calling adminEnqueueArcherJob().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/admin/archer/jobs`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: DtoEnqueueRequestToJSON(requestParameters["dtoEnqueueRequest"]),
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoJobFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a job immediately or schedule it for the future via `run_at`.
|
||||
* Enqueue a new Archer job (admin)
|
||||
*/
|
||||
async adminEnqueueArcherJob(
|
||||
requestParameters: AdminEnqueueArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoJob> {
|
||||
const response = await this.adminEnqueueArcherJobRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Paginated background jobs with optional filters. Search `q` may match id, type, error, payload (implementation-dependent).
|
||||
* List Archer jobs (admin)
|
||||
*/
|
||||
async adminListArcherJobsRaw(
|
||||
requestParameters: AdminListArcherJobsRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoPageJob>> {
|
||||
const queryParameters: any = {};
|
||||
|
||||
if (requestParameters["status"] != null) {
|
||||
queryParameters["status"] = requestParameters["status"];
|
||||
}
|
||||
|
||||
if (requestParameters["queue"] != null) {
|
||||
queryParameters["queue"] = requestParameters["queue"];
|
||||
}
|
||||
|
||||
if (requestParameters["q"] != null) {
|
||||
queryParameters["q"] = requestParameters["q"];
|
||||
}
|
||||
|
||||
if (requestParameters["page"] != null) {
|
||||
queryParameters["page"] = requestParameters["page"];
|
||||
}
|
||||
|
||||
if (requestParameters["pageSize"] != null) {
|
||||
queryParameters["page_size"] = requestParameters["pageSize"];
|
||||
}
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/admin/archer/jobs`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoPageJobFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Paginated background jobs with optional filters. Search `q` may match id, type, error, payload (implementation-dependent).
|
||||
* List Archer jobs (admin)
|
||||
*/
|
||||
async adminListArcherJobs(
|
||||
requestParameters: AdminListArcherJobsRequest = {},
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoPageJob> {
|
||||
const response = await this.adminListArcherJobsRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Summary metrics per queue (pending, running, failed, scheduled).
|
||||
* List Archer queues (admin)
|
||||
*/
|
||||
async adminListArcherQueuesRaw(
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<Array<DtoQueueInfo>>> {
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/admin/archer/queues`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
jsonValue.map(DtoQueueInfoFromJSON),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Summary metrics per queue (pending, running, failed, scheduled).
|
||||
* List Archer queues (admin)
|
||||
*/
|
||||
async adminListArcherQueues(
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<Array<DtoQueueInfo>> {
|
||||
const response = await this.adminListArcherQueuesRaw(initOverrides);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks the job retriable (DB flip). Swap this for an Archer admin call if you expose one.
|
||||
* Retry a failed/canceled Archer job (admin)
|
||||
*/
|
||||
async adminRetryArcherJobRaw(
|
||||
requestParameters: AdminRetryArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoJob>> {
|
||||
if (requestParameters["id"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"id",
|
||||
'Required parameter "id" was null or undefined when calling adminRetryArcherJob().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
if (this.configuration && this.configuration.apiKey) {
|
||||
headerParameters["Authorization"] =
|
||||
await this.configuration.apiKey("Authorization"); // BearerAuth authentication
|
||||
}
|
||||
|
||||
let urlPath = `/admin/archer/jobs/{id}/retry`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"id"}}`,
|
||||
encodeURIComponent(String(requestParameters["id"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: requestParameters["body"] as any,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoJobFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks the job retriable (DB flip). Swap this for an Archer admin call if you expose one.
|
||||
* Retry a failed/canceled Archer job (admin)
|
||||
*/
|
||||
async adminRetryArcherJob(
|
||||
requestParameters: AdminRetryArcherJobRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoJob> {
|
||||
const response = await this.adminRetryArcherJobRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @export
|
||||
*/
|
||||
export const AdminListArcherJobsStatusEnum = {
|
||||
queued: "queued",
|
||||
running: "running",
|
||||
succeeded: "succeeded",
|
||||
failed: "failed",
|
||||
canceled: "canceled",
|
||||
retrying: "retrying",
|
||||
scheduled: "scheduled",
|
||||
} as const;
|
||||
export type AdminListArcherJobsStatusEnum =
|
||||
(typeof AdminListArcherJobsStatusEnum)[keyof typeof AdminListArcherJobsStatusEnum];
|
||||
283
sdk/ts/src/apis/AuthApi.ts
Normal file
283
sdk/ts/src/apis/AuthApi.ts
Normal file
@@ -0,0 +1,283 @@
|
||||
/* tslint:disable */
|
||||
/* eslint-disable */
|
||||
/**
|
||||
* AutoGlue API
|
||||
* API for managing K3s clusters across cloud providers
|
||||
*
|
||||
* The version of the OpenAPI document: dev
|
||||
*
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import * as runtime from "../runtime";
|
||||
import type {DtoAuthStartResponse, DtoJWKS, DtoLogoutRequest, DtoRefreshRequest, DtoTokenPair,} from "../models/index";
|
||||
import {
|
||||
DtoAuthStartResponseFromJSON,
|
||||
DtoJWKSFromJSON,
|
||||
DtoLogoutRequestToJSON,
|
||||
DtoRefreshRequestToJSON,
|
||||
DtoTokenPairFromJSON,
|
||||
} from "../models/index";
|
||||
|
||||
export interface AuthCallbackRequest {
|
||||
provider: string;
|
||||
}
|
||||
|
||||
export interface AuthStartRequest {
|
||||
provider: string;
|
||||
}
|
||||
|
||||
export interface LogoutRequest {
|
||||
dtoLogoutRequest: DtoLogoutRequest;
|
||||
}
|
||||
|
||||
export interface RefreshRequest {
|
||||
dtoRefreshRequest: DtoRefreshRequest;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
export class AuthApi extends runtime.BaseAPI {
|
||||
/**
|
||||
* Handle social login callback
|
||||
*/
|
||||
async authCallbackRaw(
|
||||
requestParameters: AuthCallbackRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoTokenPair>> {
|
||||
if (requestParameters["provider"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"provider",
|
||||
'Required parameter "provider" was null or undefined when calling authCallback().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
let urlPath = `/auth/{provider}/callback`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"provider"}}`,
|
||||
encodeURIComponent(String(requestParameters["provider"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoTokenPairFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle social login callback
|
||||
*/
|
||||
async authCallback(
|
||||
requestParameters: AuthCallbackRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoTokenPair> {
|
||||
const response = await this.authCallbackRaw(
|
||||
requestParameters,
|
||||
initOverrides,
|
||||
);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns provider authorization URL for the frontend to redirect
|
||||
* Begin social login
|
||||
*/
|
||||
async authStartRaw(
|
||||
requestParameters: AuthStartRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoAuthStartResponse>> {
|
||||
if (requestParameters["provider"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"provider",
|
||||
'Required parameter "provider" was null or undefined when calling authStart().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
let urlPath = `/auth/{provider}/start`;
|
||||
urlPath = urlPath.replace(
|
||||
`{${"provider"}}`,
|
||||
encodeURIComponent(String(requestParameters["provider"])),
|
||||
);
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoAuthStartResponseFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns provider authorization URL for the frontend to redirect
|
||||
* Begin social login
|
||||
*/
|
||||
async authStart(
|
||||
requestParameters: AuthStartRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoAuthStartResponse> {
|
||||
const response = await this.authStartRaw(requestParameters, initOverrides);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the JSON Web Key Set for token verification
|
||||
* Get JWKS
|
||||
*/
|
||||
async getJWKSRaw(
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoJWKS>> {
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
let urlPath = `/.well-known/jwks.json`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "GET",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoJWKSFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the JSON Web Key Set for token verification
|
||||
* Get JWKS
|
||||
*/
|
||||
async getJWKS(
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoJWKS> {
|
||||
const response = await this.getJWKSRaw(initOverrides);
|
||||
return await response.value();
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke refresh token family (logout everywhere)
|
||||
*/
|
||||
async logoutRaw(
|
||||
requestParameters: LogoutRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<void>> {
|
||||
if (requestParameters["dtoLogoutRequest"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"dtoLogoutRequest",
|
||||
'Required parameter "dtoLogoutRequest" was null or undefined when calling logout().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
let urlPath = `/auth/logout`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: DtoLogoutRequestToJSON(requestParameters["dtoLogoutRequest"]),
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.VoidApiResponse(response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke refresh token family (logout everywhere)
|
||||
*/
|
||||
async logout(
|
||||
requestParameters: LogoutRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<void> {
|
||||
await this.logoutRaw(requestParameters, initOverrides);
|
||||
}
|
||||
|
||||
/**
|
||||
* Rotate refresh token
|
||||
*/
|
||||
async refreshRaw(
|
||||
requestParameters: RefreshRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<runtime.ApiResponse<DtoTokenPair>> {
|
||||
if (requestParameters["dtoRefreshRequest"] == null) {
|
||||
throw new runtime.RequiredError(
|
||||
"dtoRefreshRequest",
|
||||
'Required parameter "dtoRefreshRequest" was null or undefined when calling refresh().',
|
||||
);
|
||||
}
|
||||
|
||||
const queryParameters: any = {};
|
||||
|
||||
const headerParameters: runtime.HTTPHeaders = {};
|
||||
|
||||
headerParameters["Content-Type"] = "application/json";
|
||||
|
||||
let urlPath = `/auth/refresh`;
|
||||
|
||||
const response = await this.request(
|
||||
{
|
||||
path: urlPath,
|
||||
method: "POST",
|
||||
headers: headerParameters,
|
||||
query: queryParameters,
|
||||
body: DtoRefreshRequestToJSON(requestParameters["dtoRefreshRequest"]),
|
||||
},
|
||||
initOverrides,
|
||||
);
|
||||
|
||||
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
||||
DtoTokenPairFromJSON(jsonValue),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Rotate refresh token
|
||||
*/
|
||||
async refresh(
|
||||
requestParameters: RefreshRequest,
|
||||
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
||||
): Promise<DtoTokenPair> {
|
||||
const response = await this.refreshRaw(requestParameters, initOverrides);
|
||||
return await response.value();
|
||||
}
|
||||
}
|
||||
1652
sdk/ts/src/apis/ClustersApi.ts
Normal file
1652
sdk/ts/src/apis/ClustersApi.ts
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user