Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.gitignore
.npmignore
.openapi-generator-ignore
README.md
docs/ApiErrorDetail.md
docs/ApiErrorResponse.md
Expand Down Expand Up @@ -32,6 +31,7 @@ docs/CreateDatasetResponse.md
docs/CreateEmbeddingProviderRequest.md
docs/CreateEmbeddingProviderResponse.md
docs/CreateIndexRequest.md
docs/CreateSandboxRequest.md
docs/CreateSavedQueryRequest.md
docs/CreateSecretRequest.md
docs/CreateSecretResponse.md
Expand All @@ -41,6 +41,7 @@ docs/DatasetSource.md
docs/DatasetSummary.md
docs/DatasetVersionSummary.md
docs/DatasetsApi.md
docs/DeleteSandboxResponse.md
docs/DiscoveryStatus.md
docs/EmbeddingProviderResponse.md
docs/EmbeddingProvidersApi.md
Expand Down Expand Up @@ -71,6 +72,7 @@ docs/ListIndexesResponse.md
docs/ListJobsResponse.md
docs/ListQueryRunsResponse.md
docs/ListResultsResponse.md
docs/ListSandboxesResponse.md
docs/ListSavedQueriesResponse.md
docs/ListSavedQueryVersionsResponse.md
docs/ListSecretsResponse.md
Expand All @@ -91,6 +93,9 @@ docs/RefreshResponse.md
docs/RefreshWarning.md
docs/ResultInfo.md
docs/ResultsApi.md
docs/Sandbox.md
docs/SandboxResponse.md
docs/SandboxesApi.md
docs/SavedQueriesApi.md
docs/SavedQueryDatasetSource.md
docs/SavedQueryDetail.md
Expand All @@ -111,6 +116,7 @@ docs/UpdateDatasetRequest.md
docs/UpdateDatasetResponse.md
docs/UpdateEmbeddingProviderRequest.md
docs/UpdateEmbeddingProviderResponse.md
docs/UpdateSandboxRequest.md
docs/UpdateSavedQueryRequest.md
docs/UpdateSecretRequest.md
docs/UpdateSecretResponse.md
Expand Down Expand Up @@ -138,6 +144,7 @@ src/apis/QueryApi.ts
src/apis/QueryRunsApi.ts
src/apis/RefreshApi.ts
src/apis/ResultsApi.ts
src/apis/SandboxesApi.ts
src/apis/SavedQueriesApi.ts
src/apis/SecretsApi.ts
src/apis/UploadsApi.ts
Expand Down Expand Up @@ -173,6 +180,7 @@ src/models/CreateDatasetResponse.ts
src/models/CreateEmbeddingProviderRequest.ts
src/models/CreateEmbeddingProviderResponse.ts
src/models/CreateIndexRequest.ts
src/models/CreateSandboxRequest.ts
src/models/CreateSavedQueryRequest.ts
src/models/CreateSecretRequest.ts
src/models/CreateSecretResponse.ts
Expand All @@ -181,6 +189,7 @@ src/models/CreateWorkspaceResponse.ts
src/models/DatasetSource.ts
src/models/DatasetSummary.ts
src/models/DatasetVersionSummary.ts
src/models/DeleteSandboxResponse.ts
src/models/DiscoveryStatus.ts
src/models/EmbeddingProviderResponse.ts
src/models/ExecuteSavedQueryRequest.ts
Expand All @@ -207,6 +216,7 @@ src/models/ListIndexesResponse.ts
src/models/ListJobsResponse.ts
src/models/ListQueryRunsResponse.ts
src/models/ListResultsResponse.ts
src/models/ListSandboxesResponse.ts
src/models/ListSavedQueriesResponse.ts
src/models/ListSavedQueryVersionsResponse.ts
src/models/ListSecretsResponse.ts
Expand All @@ -223,6 +233,8 @@ src/models/RefreshRequest.ts
src/models/RefreshResponse.ts
src/models/RefreshWarning.ts
src/models/ResultInfo.ts
src/models/Sandbox.ts
src/models/SandboxResponse.ts
src/models/SavedQueryDatasetSource.ts
src/models/SavedQueryDetail.ts
src/models/SavedQuerySummary.ts
Expand All @@ -241,6 +253,7 @@ src/models/UpdateDatasetRequest.ts
src/models/UpdateDatasetResponse.ts
src/models/UpdateEmbeddingProviderRequest.ts
src/models/UpdateEmbeddingProviderResponse.ts
src/models/UpdateSandboxRequest.ts
src/models/UpdateSavedQueryRequest.ts
src/models/UpdateSecretRequest.ts
src/models/UpdateSecretResponse.ts
Expand Down
343 changes: 281 additions & 62 deletions README.md

Large diffs are not rendered by default.

10 changes: 7 additions & 3 deletions docs/ConnectionTypesApi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ConnectionTypesApi

All URIs are relative to *https://app.hotdata.dev*
All URIs are relative to *https://api.hotdata.dev*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
Expand Down Expand Up @@ -29,6 +29,8 @@ import type { GetConnectionTypeRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -64,7 +66,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -101,6 +103,8 @@ import type { ListConnectionTypesRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -128,7 +132,7 @@ This endpoint does not need any parameter.

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down
34 changes: 25 additions & 9 deletions docs/ConnectionsApi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ConnectionsApi

All URIs are relative to *https://app.hotdata.dev*
All URIs are relative to *https://api.hotdata.dev*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
Expand Down Expand Up @@ -35,6 +35,8 @@ import type { CheckConnectionHealthRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -70,7 +72,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -107,6 +109,8 @@ import type { CreateConnectionOperationRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -142,7 +146,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -180,6 +184,8 @@ import type { DeleteConnectionRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -215,7 +221,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -252,6 +258,8 @@ import type { GetConnectionRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -287,7 +295,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -324,6 +332,8 @@ import type { GetTableProfileRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -365,7 +375,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -402,6 +412,8 @@ import type { ListConnectionsRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -429,7 +441,7 @@ This endpoint does not need any parameter.

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -465,6 +477,8 @@ import type { PurgeConnectionCacheRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -500,7 +514,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down Expand Up @@ -537,6 +551,8 @@ import type { PurgeTableCacheRequest } from '@hotdata/sdk';
async function example() {
console.log("🚀 Testing @hotdata/sdk SDK...");
const config = new Configuration({
// To configure API key authorization: WorkspaceId
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
});
Expand Down Expand Up @@ -578,7 +594,7 @@ example().catch(console.error);

### Authorization

[BearerAuth](../README.md#BearerAuth)
[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

Expand Down
36 changes: 36 additions & 0 deletions docs/CreateSandboxRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

# CreateSandboxRequest


## Properties

Name | Type
------------ | -------------
`name` | string
`markdown` | string

## Example

```typescript
import type { CreateSandboxRequest } from '@hotdata/sdk'

// TODO: Update the object below with actual values
const example = {
"name": null,
"markdown": null,
} satisfies CreateSandboxRequest

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 CreateSandboxRequest
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)


Loading