GlueOps/autoglue
1
0
Fork 0
mirror of https://github.com/GlueOps/autoglue.git synced 2026-02-13 04:40:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: sdk migration in progress

Browse Source
This commit is contained in:
allanice001
2025-11-02 13:19:30 +00:00
commit 0d10d42442
492 changed files with 71067 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

314
sdk/ts/docs/AuthApi.md Normal file
View File

@@ -0,0 +1,314 @@
# AuthApi
All URIs are relative to _http://localhost:8080/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";
import type { AuthCallbackRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { AuthStartRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { GetJWKSRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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(body)
Revoke refresh token family (logout everywhere)
### Example
```ts
import {
Configuration,
AuthApi,
} from '@glueops/autoglue-sdk';
import type { LogoutRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk SDK...");
const api = new AuthApi();
const body = {
// DtoLogoutRequest | Refresh token
body: ...,
} 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 |
| -------- | --------------------------------------- | ------------- | ----- |
| **body** | [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(body)
Rotate refresh token
### Example
```ts
import {
Configuration,
AuthApi,
} from '@glueops/autoglue-sdk';
import type { RefreshRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk SDK...");
const api = new AuthApi();
const body = {
// DtoRefreshRequest | Refresh token
body: ...,
} 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 |
| -------- | ----------------------------------------- | ------------- | ----- |
| **body** | [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)

30
sdk/ts/docs/DtoAuthStartResponse.md Normal file
View File

@@ -0,0 +1,30 @@
# DtoAuthStartResponse
## Properties
| Name | Type |
| ---------- | ------ |
| `auth_url` | string |
## Example
```typescript
import type { DtoAuthStartResponse } from '@glueops/autoglue-sdk'
// 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)

36
sdk/ts/docs/DtoCreateSSHRequest.md Normal file
View 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'
// 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
View 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";
// 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
View File

@@ -0,0 +1,34 @@
# DtoCreateTaintRequest
## Properties
| Name | Type |
| -------- | ------ |
| `effect` | string |
| `key` | string |
| `value` | string |
## Example
```typescript
import type { DtoCreateTaintRequest } from "@glueops/autoglue-sdk";
// 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)

42
sdk/ts/docs/DtoJWK.md Normal file
View 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'
// 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
View File

@@ -0,0 +1,30 @@
# DtoJWKS
## Properties
| Name | Type |
| ------ | -------------------------------- |
| `keys` | [Array<DtoJWK>](DtoJWK.md) |
## Example
```typescript
import type { DtoJWKS } from "@glueops/autoglue-sdk";
// 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)

30
sdk/ts/docs/DtoLogoutRequest.md Normal file
View File

@@ -0,0 +1,30 @@
# DtoLogoutRequest
## Properties
| Name | Type |
| --------------- | ------ |
| `refresh_token` | string |
## Example
```typescript
import type { DtoLogoutRequest } from '@glueops/autoglue-sdk'
// 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)

30
sdk/ts/docs/DtoRefreshRequest.md Normal file
View File

@@ -0,0 +1,30 @@
# DtoRefreshRequest
## Properties
| Name | Type |
| --------------- | ------ |
| `refresh_token` | string |
## Example
```typescript
import type { DtoRefreshRequest } from '@glueops/autoglue-sdk'
// 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
View 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";
// 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: null,
ssh_key_id: null,
ssh_user: null,
status: null,
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)

42
sdk/ts/docs/DtoSshResponse.md Normal file
View 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";
// 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
View 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";
// 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)

36
sdk/ts/docs/DtoTaintResponse.md Normal file
View File

@@ -0,0 +1,36 @@
# DtoTaintResponse
## Properties
| Name | Type |
| -------- | ------ |
| `effect` | string |
| `id` | string |
| `key` | string |
| `value` | string |
## Example
```typescript
import type { DtoTaintResponse } from "@glueops/autoglue-sdk";
// TODO: Update the object below with actual values
const example = {
effect: null,
id: null,
key: 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
View 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'
// 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)

42
sdk/ts/docs/DtoUpdateServerRequest.md Normal file
View 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";
// 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
View File

@@ -0,0 +1,34 @@
# DtoUpdateTaintRequest
## Properties
| Name | Type |
| -------- | ------ |
| `effect` | string |
| `key` | string |
| `value` | string |
## Example
```typescript
import type { DtoUpdateTaintRequest } from "@glueops/autoglue-sdk";
// 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)

32
sdk/ts/docs/HandlersCreateUserKeyRequest.md Normal file
View File

@@ -0,0 +1,32 @@
# HandlersCreateUserKeyRequest
## Properties
| Name | Type |
| ------------------ | ------ |
| `expires_in_hours` | number |
| `name` | string |
## Example
```typescript
import type { HandlersCreateUserKeyRequest } from "@glueops/autoglue-sdk";
// 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)

46
sdk/ts/docs/HandlersMeResponse.md Normal file
View File

@@ -0,0 +1,46 @@
# HandlersMeResponse
## Properties
| Name | Type |
| --------------- | -------------------------------------------------------- |
| `avatar_url` | string |
| `created_at` | Date |
| `display_name` | string |
| `emails` | [Array<ModelsUserEmail>](ModelsUserEmail.md) |
| `id` | string |
| `is_disabled` | boolean |
| `organizations` | [Array<ModelsOrganization>](ModelsOrganization.md) |
| `primary_email` | string |
| `updated_at` | Date |
## Example
```typescript
import type { HandlersMeResponse } from "@glueops/autoglue-sdk";
// TODO: Update the object below with actual values
const example = {
avatar_url: null,
created_at: null,
display_name: null,
emails: null,
id: 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
View 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";
// 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
View File

@@ -0,0 +1,32 @@
# HandlersMemberUpsertReq
## Properties
| Name | Type |
| --------- | ------ |
| `role` | string |
| `user_id` | string |
## Example
```typescript
import type { HandlersMemberUpsertReq } from "@glueops/autoglue-sdk";
// 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
View File

@@ -0,0 +1,32 @@
# HandlersOrgCreateReq
## Properties
| Name | Type |
| -------- | ------ |
| `domain` | string |
| `name` | string |
## Example
```typescript
import type { HandlersOrgCreateReq } from '@glueops/autoglue-sdk'
// 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
View File

@@ -0,0 +1,32 @@
# HandlersOrgKeyCreateReq
## Properties
| Name | Type |
| ------------------ | ------ |
| `expires_in_hours` | number |
| `name` | string |
## Example
```typescript
import type { HandlersOrgKeyCreateReq } from "@glueops/autoglue-sdk";
// 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
View 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";
// 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
View File

@@ -0,0 +1,32 @@
# HandlersOrgUpdateReq
## Properties
| Name | Type |
| -------- | ------ |
| `domain` | string |
| `name` | string |
## Example
```typescript
import type { HandlersOrgUpdateReq } from "@glueops/autoglue-sdk";
// 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
View File

@@ -0,0 +1,30 @@
# HandlersUpdateMeRequest
## Properties
| Name | Type |
| -------------- | ------ |
| `display_name` | string |
## Example
```typescript
import type { HandlersUpdateMeRequest } from "@glueops/autoglue-sdk";
// 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
View 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";
// 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)

203
sdk/ts/docs/MeAPIKeysApi.md Normal file
View File

@@ -0,0 +1,203 @@
# MeAPIKeysApi
All URIs are relative to _http://localhost:8080/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(body)
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';
import type { CreateUserAPIKeyRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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 |
| -------- | --------------------------------------------------------------- | ----------- | ----- |
| **body** | [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";
import type { DeleteUserAPIKeyRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListUserAPIKeysRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
View File

@@ -0,0 +1,136 @@
# MeApi
All URIs are relative to _http://localhost:8080/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";
import type { GetMeRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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(body)
Update current user profile
### Example
```ts
import {
Configuration,
MeApi,
} from '@glueops/autoglue-sdk';
import type { UpdateMeRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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 |
| -------- | ----------------------------------------------------- | ------------- | ----- |
| **body** | [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)

50
sdk/ts/docs/ModelsAPIKey.md Normal file
View 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";
// 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
View 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";
// 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)

42
sdk/ts/docs/ModelsUser.md Normal file
View File

@@ -0,0 +1,42 @@
# ModelsUser
## Properties
| Name | Type |
| --------------- | ------- |
| `avatar_url` | string |
| `created_at` | Date |
| `display_name` | string |
| `id` | string |
| `is_disabled` | boolean |
| `primary_email` | string |
| `updated_at` | Date |
## Example
```typescript
import type { ModelsUser } from "@glueops/autoglue-sdk";
// TODO: Update the object below with actual values
const example = {
avatar_url: null,
created_at: null,
display_name: null,
id: 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
View 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";
// 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)

757
sdk/ts/docs/OrgsApi.md Normal file
View File

@@ -0,0 +1,757 @@
# OrgsApi
All URIs are relative to _http://localhost:8080/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, body)
Add or update a member (owner/admin)
### Example
```ts
import {
Configuration,
OrgsApi,
} from '@glueops/autoglue-sdk';
import type { AddOrUpdateMemberRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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`] |
| **body** | [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(body)
Create organization
### Example
```ts
import {
Configuration,
OrgsApi,
} from '@glueops/autoglue-sdk';
import type { CreateOrgRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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 |
| -------- | ----------------------------------------------- | ----------- | ----- |
| **body** | [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, body)
Create org key/secret pair (owner/admin)
### Example
```ts
import {
Configuration,
OrgsApi,
} from '@glueops/autoglue-sdk';
import type { CreateOrgKeyRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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`] |
| **body** | [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";
import type { DeleteOrgRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { DeleteOrgKeyRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { GetOrgRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListMembersRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListMyOrgsRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListOrgKeysRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { RemoveMemberRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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, body)
Update organization (owner/admin)
### Example
```ts
import {
Configuration,
OrgsApi,
} from '@glueops/autoglue-sdk';
import type { UpdateOrgRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
} 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`] |
| **body** | [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)

409
sdk/ts/docs/ServersApi.md Normal file
View File

@@ -0,0 +1,409 @@
# ServersApi
All URIs are relative to _http://localhost:8080/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) |
| [**updateServer**](ServersApi.md#updateserver) | **PATCH** /servers/{id} | Update server (org scoped) |
## createServer
> DtoServerResponse createServer(body, 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';
import type { CreateServerRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
// 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 |
| ---------- | --------------------------------------------------- | ----------------- | ------------------------------------ |
| **body** | [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
> string deleteServer(id, xOrgID)
Delete server (org scoped)
Permanently deletes the server.
### Example
```ts
import { Configuration, ServersApi } from "@glueops/autoglue-sdk";
import type { DeleteServerRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
**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 |
| ----------- | --------------------- | ---------------- |
| **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";
import type { GetServerRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListServersRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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)
## updateServer
> DtoServerResponse updateServer(id, body, xOrgID)
Update server (org scoped)
Partially update fields; changing ssh_key_id validates ownership.
### Example
```ts
import {
Configuration,
ServersApi,
} from '@glueops/autoglue-sdk';
import type { UpdateServerRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
// 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`] |
| **body** | [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
View File

@@ -0,0 +1,403 @@
# SshApi
All URIs are relative to _http://localhost:8080/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(body, 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';
import type { CreateSSHKeyRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
// 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 |
| ---------- | --------------------------------------------- | ---------------------- | ------------------------------------ |
| **body** | [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
> string deleteSSHKey(id, xOrgID)
Delete ssh keypair (org scoped)
Permanently deletes a keypair.
### Example
```ts
import { Configuration, SshApi } from "@glueops/autoglue-sdk";
import type { DeleteSSHKeyRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
**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 |
| ----------- | --------------------- | ---------------- |
| **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";
import type { DownloadSSHKeyRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
> DtoSshRevealResponse 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";
import type { GetSSHKeyRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
[**DtoSshRevealResponse**](DtoSshRevealResponse.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";
import type { ListPublicSshKeysRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
View File

@@ -0,0 +1,410 @@
# TaintsApi
All URIs are relative to _http://localhost:8080/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(body, xOrgID)
Create node taint (org scoped)
Creates a taint.
### Example
```ts
import {
Configuration,
TaintsApi,
} from '@glueops/autoglue-sdk';
import type { CreateTaintRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
// 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 |
| ---------- | ------------------------------------------------- | ----------------- | ------------------------------------ |
| **body** | [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
> string deleteTaint(id, xOrgID)
Delete taint (org scoped)
Permanently deletes the taint.
### Example
```ts
import { Configuration, TaintsApi } from "@glueops/autoglue-sdk";
import type { DeleteTaintRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
**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 |
| ----------- | --------------------- | ---------------- |
| **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";
import type { GetTaintRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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";
import type { ListTaintsRequest } from "@glueops/autoglue-sdk";
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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, body, xOrgID)
Update node taint (org scoped)
Partially update taint fields.
### Example
```ts
import {
Configuration,
TaintsApi,
} from '@glueops/autoglue-sdk';
import type { UpdateTaintRequest } from '@glueops/autoglue-sdk';
async function example() {
console.log("🚀 Testing @glueops/autoglue-sdk 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
body: ...,
// 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`] |
| **body** | [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
View File

@@ -0,0 +1,32 @@
# UtilsErrorResponse
## Properties
| Name | Type |
| --------- | ------ |
| `code` | string |
| `message` | string |
## Example
```typescript
import type { UtilsErrorResponse } from "@glueops/autoglue-sdk";
// 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)