diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 7168e60..5b88f4c 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,6 +1,5 @@ .gitignore .npmignore -.openapi-generator-ignore README.md docs/ApiErrorDetail.md docs/ApiErrorResponse.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/README.md b/README.md index 0e3bd0c..6efb07f 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,306 @@ -# @hotdata/sdk +# @hotdata/sdk@1.0.0 -Official TypeScript client for the [Hotdata](https://app.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context. +A TypeScript SDK client for the api.hotdata.dev API. -The package is produced with [OpenAPI Generator](https://openapi-generator.tech) from the Hotdata OpenAPI spec. For the Python client, see [hotdata-dev/sdk-python](https://github.com/hotdata-dev/sdk-python). +## Usage -## Requirements +First, install the SDK from npm. -A JavaScript runtime with a global **`fetch`** (for example Node.js 18+). +```bash +npm install @hotdata/sdk --save +``` -## Install +Next, try it out. -From npm (when published): -```sh -npm install @hotdata/sdk -``` +```ts +import { + Configuration, + ConnectionTypesApi, +} from '@hotdata/sdk'; +import type { GetConnectionTypeRequest } from '@hotdata/sdk'; -From the GitHub repository: +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", + }); + const api = new ConnectionTypesApi(config); -```sh -npm install github:hotdata-dev/sdk-typescript -``` + const body = { + // string | Connection type name (e.g. postgres, mysql, snowflake) + name: name_example, + } satisfies GetConnectionTypeRequest; -From a local checkout: + try { + const data = await api.getConnectionType(body); + console.log(data); + } catch (error) { + console.error(error); + } +} -```sh -npm install -npm run build +// Run the test +example().catch(console.error); ``` -## Authentication -The API uses **Bearer** JWTs and an **`X-Workspace-Id`** header on requests that are scoped to a workspace. +## Documentation -```ts -import { Configuration } from "@hotdata/sdk"; - -const configuration = new Configuration({ - accessToken: "YOUR_ACCESS_TOKEN", - headers: { - "X-Workspace-Id": "YOUR_WORKSPACE_ID", - }, -}); -``` +### API Endpoints -`basePath` defaults to `https://app.hotdata.dev`. Pass `basePath` in the configuration if you target another environment. +All URIs are relative to *https://api.hotdata.dev* -## Usage +| Class | Method | HTTP request | Description +| ----- | ------ | ------------ | ------------- +*ConnectionTypesApi* | [**getConnectionType**](docs/ConnectionTypesApi.md#getconnectiontype) | **GET** /v1/connection-types/{name} | Get connection type details +*ConnectionTypesApi* | [**listConnectionTypes**](docs/ConnectionTypesApi.md#listconnectiontypes) | **GET** /v1/connection-types | List connection types +*ConnectionsApi* | [**checkConnectionHealth**](docs/ConnectionsApi.md#checkconnectionhealth) | **GET** /v1/connections/{connection_id}/health | Check connection health +*ConnectionsApi* | [**createConnection**](docs/ConnectionsApi.md#createconnectionoperation) | **POST** /v1/connections | Create connection +*ConnectionsApi* | [**deleteConnection**](docs/ConnectionsApi.md#deleteconnection) | **DELETE** /v1/connections/{connection_id} | Delete connection +*ConnectionsApi* | [**getConnection**](docs/ConnectionsApi.md#getconnection) | **GET** /v1/connections/{connection_id} | Get connection +*ConnectionsApi* | [**getTableProfile**](docs/ConnectionsApi.md#gettableprofile) | **GET** /v1/connections/{connection_id}/tables/{schema}/{table}/profile | Get table profile +*ConnectionsApi* | [**listConnections**](docs/ConnectionsApi.md#listconnections) | **GET** /v1/connections | List connections +*ConnectionsApi* | [**purgeConnectionCache**](docs/ConnectionsApi.md#purgeconnectioncache) | **DELETE** /v1/connections/{connection_id}/cache | Purge connection cache +*ConnectionsApi* | [**purgeTableCache**](docs/ConnectionsApi.md#purgetablecache) | **DELETE** /v1/connections/{connection_id}/tables/{schema}/{table}/cache | Purge table cache +*DatasetsApi* | [**createDataset**](docs/DatasetsApi.md#createdatasetoperation) | **POST** /v1/datasets | Create dataset +*DatasetsApi* | [**deleteDataset**](docs/DatasetsApi.md#deletedataset) | **DELETE** /v1/datasets/{id} | Delete dataset +*DatasetsApi* | [**getDataset**](docs/DatasetsApi.md#getdataset) | **GET** /v1/datasets/{id} | Get dataset +*DatasetsApi* | [**listDatasetVersions**](docs/DatasetsApi.md#listdatasetversions) | **GET** /v1/datasets/{id}/versions | List dataset versions +*DatasetsApi* | [**listDatasets**](docs/DatasetsApi.md#listdatasets) | **GET** /v1/datasets | List datasets +*DatasetsApi* | [**updateDataset**](docs/DatasetsApi.md#updatedatasetoperation) | **PUT** /v1/datasets/{id} | Update dataset +*EmbeddingProvidersApi* | [**createEmbeddingProvider**](docs/EmbeddingProvidersApi.md#createembeddingprovideroperation) | **POST** /v1/embedding-providers | Create embedding provider +*EmbeddingProvidersApi* | [**deleteEmbeddingProvider**](docs/EmbeddingProvidersApi.md#deleteembeddingprovider) | **DELETE** /v1/embedding-providers/{id} | Delete embedding provider +*EmbeddingProvidersApi* | [**getEmbeddingProvider**](docs/EmbeddingProvidersApi.md#getembeddingprovider) | **GET** /v1/embedding-providers/{id} | Get embedding provider +*EmbeddingProvidersApi* | [**listEmbeddingProviders**](docs/EmbeddingProvidersApi.md#listembeddingproviders) | **GET** /v1/embedding-providers | List embedding providers +*EmbeddingProvidersApi* | [**updateEmbeddingProvider**](docs/EmbeddingProvidersApi.md#updateembeddingprovideroperation) | **PUT** /v1/embedding-providers/{id} | Update embedding provider +*IndexesApi* | [**createIndex**](docs/IndexesApi.md#createindexoperation) | **POST** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes | Create an index on a table +*IndexesApi* | [**deleteIndex**](docs/IndexesApi.md#deleteindex) | **DELETE** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes/{index_name} | Delete an index +*IndexesApi* | [**listIndexes**](docs/IndexesApi.md#listindexes) | **GET** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes | List indexes on a table +*InformationSchemaApi* | [**informationSchema**](docs/InformationSchemaApi.md#informationschema) | **GET** /v1/information_schema | List tables +*JobsApi* | [**getJob**](docs/JobsApi.md#getjob) | **GET** /v1/jobs/{id} | Get job status +*JobsApi* | [**listJobs**](docs/JobsApi.md#listjobs) | **GET** /v1/jobs | List jobs +*QueryApi* | [**query**](docs/QueryApi.md#queryoperation) | **POST** /v1/query | Execute SQL query +*QueryRunsApi* | [**getQueryRun**](docs/QueryRunsApi.md#getqueryrun) | **GET** /v1/query-runs/{id} | Get query run +*QueryRunsApi* | [**listQueryRuns**](docs/QueryRunsApi.md#listqueryruns) | **GET** /v1/query-runs | List query runs +*RefreshApi* | [**refresh**](docs/RefreshApi.md#refreshoperation) | **POST** /v1/refresh | Refresh connection data +*ResultsApi* | [**getResult**](docs/ResultsApi.md#getresult) | **GET** /v1/results/{id} | Get result +*ResultsApi* | [**listResults**](docs/ResultsApi.md#listresults) | **GET** /v1/results | List results +*SandboxesApi* | [**createSandbox**](docs/SandboxesApi.md#createsandboxoperation) | **POST** /v1/sandboxes | Create a sandbox +*SandboxesApi* | [**deleteSandbox**](docs/SandboxesApi.md#deletesandbox) | **DELETE** /v1/sandboxes/{public_id} | Delete sandbox +*SandboxesApi* | [**getSandbox**](docs/SandboxesApi.md#getsandbox) | **GET** /v1/sandboxes/{public_id} | Get sandbox +*SandboxesApi* | [**listSandboxes**](docs/SandboxesApi.md#listsandboxes) | **GET** /v1/sandboxes | List sandboxes +*SandboxesApi* | [**updateSandbox**](docs/SandboxesApi.md#updatesandboxoperation) | **PATCH** /v1/sandboxes/{public_id} | Update sandbox +*SavedQueriesApi* | [**createSavedQuery**](docs/SavedQueriesApi.md#createsavedqueryoperation) | **POST** /v1/queries | Create saved query +*SavedQueriesApi* | [**deleteSavedQuery**](docs/SavedQueriesApi.md#deletesavedquery) | **DELETE** /v1/queries/{id} | Delete saved query +*SavedQueriesApi* | [**executeSavedQuery**](docs/SavedQueriesApi.md#executesavedqueryoperation) | **POST** /v1/queries/{id}/execute | Execute saved query +*SavedQueriesApi* | [**getSavedQuery**](docs/SavedQueriesApi.md#getsavedquery) | **GET** /v1/queries/{id} | Get saved query +*SavedQueriesApi* | [**listSavedQueries**](docs/SavedQueriesApi.md#listsavedqueries) | **GET** /v1/queries | List saved queries +*SavedQueriesApi* | [**listSavedQueryVersions**](docs/SavedQueriesApi.md#listsavedqueryversions) | **GET** /v1/queries/{id}/versions | List saved query versions +*SavedQueriesApi* | [**updateSavedQuery**](docs/SavedQueriesApi.md#updatesavedqueryoperation) | **PUT** /v1/queries/{id} | Update saved query +*SecretsApi* | [**createSecret**](docs/SecretsApi.md#createsecretoperation) | **POST** /v1/secrets | Create secret +*SecretsApi* | [**deleteSecret**](docs/SecretsApi.md#deletesecret) | **DELETE** /v1/secrets/{name} | Delete secret +*SecretsApi* | [**getSecret**](docs/SecretsApi.md#getsecret) | **GET** /v1/secrets/{name} | Get secret +*SecretsApi* | [**listSecrets**](docs/SecretsApi.md#listsecrets) | **GET** /v1/secrets | List secrets +*SecretsApi* | [**updateSecret**](docs/SecretsApi.md#updatesecretoperation) | **PUT** /v1/secrets/{name} | Update secret +*UploadsApi* | [**listUploads**](docs/UploadsApi.md#listuploads) | **GET** /v1/files | List uploads +*UploadsApi* | [**uploadFile**](docs/UploadsApi.md#uploadfile) | **POST** /v1/files | Upload file +*WorkspaceContextApi* | [**getWorkspaceContext**](docs/WorkspaceContextApi.md#getworkspacecontext) | **GET** /v1/context/{name} | Get one workspace context +*WorkspaceContextApi* | [**listWorkspaceContexts**](docs/WorkspaceContextApi.md#listworkspacecontexts) | **GET** /v1/context | List workspace contexts +*WorkspaceContextApi* | [**upsertWorkspaceContext**](docs/WorkspaceContextApi.md#upsertworkspacecontextoperation) | **POST** /v1/context | Create or update workspace context +*WorkspacesApi* | [**createWorkspace**](docs/WorkspacesApi.md#createworkspaceoperation) | **POST** /v1/workspaces | Create a workspace +*WorkspacesApi* | [**listWorkspaces**](docs/WorkspacesApi.md#listworkspaces) | **GET** /v1/workspaces | List workspaces + + +### Models + +- [ApiErrorDetail](docs/ApiErrorDetail.md) +- [ApiErrorResponse](docs/ApiErrorResponse.md) +- [AsyncQueryResponse](docs/AsyncQueryResponse.md) +- [BooleanProfileDetail](docs/BooleanProfileDetail.md) +- [CategoricalProfileDetail](docs/CategoricalProfileDetail.md) +- [CategoryValueInfo](docs/CategoryValueInfo.md) +- [ColumnInfo](docs/ColumnInfo.md) +- [ColumnProfileDetail](docs/ColumnProfileDetail.md) +- [ColumnProfileDetailOneOf](docs/ColumnProfileDetailOneOf.md) +- [ColumnProfileDetailOneOf1](docs/ColumnProfileDetailOneOf1.md) +- [ColumnProfileDetailOneOf2](docs/ColumnProfileDetailOneOf2.md) +- [ColumnProfileDetailOneOf3](docs/ColumnProfileDetailOneOf3.md) +- [ColumnProfileDetailOneOf4](docs/ColumnProfileDetailOneOf4.md) +- [ColumnProfileInfo](docs/ColumnProfileInfo.md) +- [ColumnTypeSpec](docs/ColumnTypeSpec.md) +- [ConnectionHealthResponse](docs/ConnectionHealthResponse.md) +- [ConnectionInfo](docs/ConnectionInfo.md) +- [ConnectionRefreshResult](docs/ConnectionRefreshResult.md) +- [ConnectionSchemaError](docs/ConnectionSchemaError.md) +- [ConnectionTypeDetail](docs/ConnectionTypeDetail.md) +- [ConnectionTypeSummary](docs/ConnectionTypeSummary.md) +- [CreateConnectionRequest](docs/CreateConnectionRequest.md) +- [CreateConnectionResponse](docs/CreateConnectionResponse.md) +- [CreateDatasetRequest](docs/CreateDatasetRequest.md) +- [CreateDatasetResponse](docs/CreateDatasetResponse.md) +- [CreateEmbeddingProviderRequest](docs/CreateEmbeddingProviderRequest.md) +- [CreateEmbeddingProviderResponse](docs/CreateEmbeddingProviderResponse.md) +- [CreateIndexRequest](docs/CreateIndexRequest.md) +- [CreateSandboxRequest](docs/CreateSandboxRequest.md) +- [CreateSavedQueryRequest](docs/CreateSavedQueryRequest.md) +- [CreateSecretRequest](docs/CreateSecretRequest.md) +- [CreateSecretResponse](docs/CreateSecretResponse.md) +- [CreateWorkspaceRequest](docs/CreateWorkspaceRequest.md) +- [CreateWorkspaceResponse](docs/CreateWorkspaceResponse.md) +- [DatasetSource](docs/DatasetSource.md) +- [DatasetSummary](docs/DatasetSummary.md) +- [DatasetVersionSummary](docs/DatasetVersionSummary.md) +- [DeleteSandboxResponse](docs/DeleteSandboxResponse.md) +- [DiscoveryStatus](docs/DiscoveryStatus.md) +- [EmbeddingProviderResponse](docs/EmbeddingProviderResponse.md) +- [ExecuteSavedQueryRequest](docs/ExecuteSavedQueryRequest.md) +- [GetConnectionResponse](docs/GetConnectionResponse.md) +- [GetDatasetResponse](docs/GetDatasetResponse.md) +- [GetResultResponse](docs/GetResultResponse.md) +- [GetSecretResponse](docs/GetSecretResponse.md) +- [GetWorkspaceContextResponse](docs/GetWorkspaceContextResponse.md) +- [IndexInfoResponse](docs/IndexInfoResponse.md) +- [IndexStatus](docs/IndexStatus.md) +- [InformationSchemaResponse](docs/InformationSchemaResponse.md) +- [InlineData](docs/InlineData.md) +- [InlineDatasetSource](docs/InlineDatasetSource.md) +- [JobResult](docs/JobResult.md) +- [JobStatus](docs/JobStatus.md) +- [JobStatusResponse](docs/JobStatusResponse.md) +- [JobType](docs/JobType.md) +- [ListConnectionTypesResponse](docs/ListConnectionTypesResponse.md) +- [ListConnectionsResponse](docs/ListConnectionsResponse.md) +- [ListDatasetVersionsResponse](docs/ListDatasetVersionsResponse.md) +- [ListDatasetsResponse](docs/ListDatasetsResponse.md) +- [ListEmbeddingProvidersResponse](docs/ListEmbeddingProvidersResponse.md) +- [ListIndexesResponse](docs/ListIndexesResponse.md) +- [ListJobsResponse](docs/ListJobsResponse.md) +- [ListQueryRunsResponse](docs/ListQueryRunsResponse.md) +- [ListResultsResponse](docs/ListResultsResponse.md) +- [ListSandboxesResponse](docs/ListSandboxesResponse.md) +- [ListSavedQueriesResponse](docs/ListSavedQueriesResponse.md) +- [ListSavedQueryVersionsResponse](docs/ListSavedQueryVersionsResponse.md) +- [ListSecretsResponse](docs/ListSecretsResponse.md) +- [ListUploadsResponse](docs/ListUploadsResponse.md) +- [ListWorkspaceContextsResponse](docs/ListWorkspaceContextsResponse.md) +- [ListWorkspacesResponse](docs/ListWorkspacesResponse.md) +- [ModelError](docs/ModelError.md) +- [NumericProfileDetail](docs/NumericProfileDetail.md) +- [QueryRequest](docs/QueryRequest.md) +- [QueryResponse](docs/QueryResponse.md) +- [QueryRunInfo](docs/QueryRunInfo.md) +- [RefreshDatasetResponse](docs/RefreshDatasetResponse.md) +- [RefreshRequest](docs/RefreshRequest.md) +- [RefreshResponse](docs/RefreshResponse.md) +- [RefreshWarning](docs/RefreshWarning.md) +- [ResultInfo](docs/ResultInfo.md) +- [Sandbox](docs/Sandbox.md) +- [SandboxResponse](docs/SandboxResponse.md) +- [SavedQueryDatasetSource](docs/SavedQueryDatasetSource.md) +- [SavedQueryDetail](docs/SavedQueryDetail.md) +- [SavedQuerySummary](docs/SavedQuerySummary.md) +- [SavedQueryVersionInfo](docs/SavedQueryVersionInfo.md) +- [SchemaRefreshResult](docs/SchemaRefreshResult.md) +- [SecretMetadataResponse](docs/SecretMetadataResponse.md) +- [SqlQueryDatasetSource](docs/SqlQueryDatasetSource.md) +- [SubmitJobResponse](docs/SubmitJobResponse.md) +- [TableInfo](docs/TableInfo.md) +- [TableProfileResponse](docs/TableProfileResponse.md) +- [TableRefreshError](docs/TableRefreshError.md) +- [TableRefreshResult](docs/TableRefreshResult.md) +- [TemporalProfileDetail](docs/TemporalProfileDetail.md) +- [TextProfileDetail](docs/TextProfileDetail.md) +- [UpdateDatasetRequest](docs/UpdateDatasetRequest.md) +- [UpdateDatasetResponse](docs/UpdateDatasetResponse.md) +- [UpdateEmbeddingProviderRequest](docs/UpdateEmbeddingProviderRequest.md) +- [UpdateEmbeddingProviderResponse](docs/UpdateEmbeddingProviderResponse.md) +- [UpdateSandboxRequest](docs/UpdateSandboxRequest.md) +- [UpdateSavedQueryRequest](docs/UpdateSavedQueryRequest.md) +- [UpdateSecretRequest](docs/UpdateSecretRequest.md) +- [UpdateSecretResponse](docs/UpdateSecretResponse.md) +- [UploadDatasetSource](docs/UploadDatasetSource.md) +- [UploadInfo](docs/UploadInfo.md) +- [UploadResponse](docs/UploadResponse.md) +- [UpsertWorkspaceContextRequest](docs/UpsertWorkspaceContextRequest.md) +- [UpsertWorkspaceContextResponse](docs/UpsertWorkspaceContextResponse.md) +- [UrlDatasetSource](docs/UrlDatasetSource.md) +- [WorkspaceContextEntry](docs/WorkspaceContextEntry.md) +- [WorkspaceDetail](docs/WorkspaceDetail.md) +- [WorkspaceListItem](docs/WorkspaceListItem.md) + +### Authorization -```ts -import { Configuration, ResponseError, WorkspacesApi } from "@hotdata/sdk"; - -const configuration = new Configuration({ - accessToken: "YOUR_ACCESS_TOKEN", - headers: { - "X-Workspace-Id": "YOUR_WORKSPACE_ID", - }, -}); - -const workspaces = new WorkspacesApi(configuration); -try { - const response = await workspaces.listWorkspaces(); - console.log(response); -} catch (e) { - if (e instanceof ResponseError) { - console.error(`${e.response.status} ${e.response.statusText}\n${await e.response.text()}`); - } else { - throw e; - } -} -``` -Each `*Api` class groups endpoints by resource. Construct a `Configuration`, pass it into the API class you need, then call the typed methods. +Authentication schemes defined for the API: + +#### BearerAuth -## API reference -Generated Markdown for every operation and model is in [`docs/`](docs/): +- **Type**: HTTP Bearer Token authentication + +#### WorkspaceId -- Resource APIs: `docs/*Api.md` (for example [`docs/QueryApi.md`](docs/QueryApi.md)) -- Request and response models: `docs/.md` -Use your editor or GitHub file search there instead of duplicating large tables in this file. +- **Type**: API key +- **API key parameter name**: `X-Workspace-Id` +- **Location**: HTTP header + +#### SessionId + + +- **Type**: API key +- **API key parameter name**: `X-Session-Id` +- **Location**: HTTP header + +## About + +This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/) +and is automatically generated by the +[OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: `1.0.0` +- Package version: `1.0.0` +- Generator version: `7.21.0` +- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen` + +The generated npm module supports the following: + +- Environments + * Node.js + * Webpack + * Browserify +- Language levels + * ES5 - you must have a Promises/A+ library installed + * ES6 +- Module systems + * CommonJS + * ES6 module system + + +## Development + +### Building + +To build the TypeScript source code, you need to have Node.js and npm installed. +After cloning the repository, navigate to the project directory and run: + +```bash +npm install +npm run build +``` + +### Publishing + +Once you've built the package, you can publish it to npm: + +```bash +npm publish +``` -## Support +## License -Questions and issues: [github.com/hotdata-dev/sdk-typescript](https://github.com/hotdata-dev/sdk-typescript). +[MIT]() diff --git a/docs/ConnectionTypesApi.md b/docs/ConnectionTypesApi.md index 6f0dc6f..ae49cfa 100644 --- a/docs/ConnectionTypesApi.md +++ b/docs/ConnectionTypesApi.md @@ -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 | |------------- | ------------- | -------------| @@ -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", }); @@ -64,7 +66,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -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 diff --git a/docs/ConnectionsApi.md b/docs/ConnectionsApi.md index 7f3d85a..184a127 100644 --- a/docs/ConnectionsApi.md +++ b/docs/ConnectionsApi.md @@ -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 | |------------- | ------------- | -------------| @@ -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", }); @@ -70,7 +72,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -142,7 +146,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -215,7 +221,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -287,7 +295,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -365,7 +375,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -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 @@ -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", }); @@ -500,7 +514,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -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", }); @@ -578,7 +594,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/CreateSandboxRequest.md b/docs/CreateSandboxRequest.md new file mode 100644 index 0000000..558da68 --- /dev/null +++ b/docs/CreateSandboxRequest.md @@ -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) + + diff --git a/docs/DatasetsApi.md b/docs/DatasetsApi.md index 7b10f75..4a44c29 100644 --- a/docs/DatasetsApi.md +++ b/docs/DatasetsApi.md @@ -1,6 +1,6 @@ # DatasetsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -33,6 +33,10 @@ import type { CreateDatasetOperationRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -68,7 +72,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -104,6 +108,10 @@ import type { DeleteDatasetRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -139,7 +147,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -174,6 +182,8 @@ import type { GetDatasetRequest } 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", }); @@ -209,7 +219,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -244,6 +254,8 @@ import type { ListDatasetVersionsRequest } 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", }); @@ -285,7 +297,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -320,6 +332,10 @@ import type { ListDatasetsRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -358,7 +374,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -392,6 +408,10 @@ import type { UpdateDatasetOperationRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -430,7 +450,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/DeleteSandboxResponse.md b/docs/DeleteSandboxResponse.md new file mode 100644 index 0000000..3797e3e --- /dev/null +++ b/docs/DeleteSandboxResponse.md @@ -0,0 +1,36 @@ + +# DeleteSandboxResponse + + +## Properties + +Name | Type +------------ | ------------- +`ok` | boolean +`deleted` | boolean + +## Example + +```typescript +import type { DeleteSandboxResponse } from '@hotdata/sdk' + +// TODO: Update the object below with actual values +const example = { + "ok": true, + "deleted": true, +} satisfies DeleteSandboxResponse + +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 DeleteSandboxResponse +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) + + diff --git a/docs/EmbeddingProvidersApi.md b/docs/EmbeddingProvidersApi.md index 4020a1a..d71ffb9 100644 --- a/docs/EmbeddingProvidersApi.md +++ b/docs/EmbeddingProvidersApi.md @@ -1,6 +1,6 @@ # EmbeddingProvidersApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -32,6 +32,8 @@ import type { CreateEmbeddingProviderOperationRequest } 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", }); @@ -67,7 +69,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -103,6 +105,8 @@ import type { DeleteEmbeddingProviderRequest } 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", }); @@ -138,7 +142,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -173,6 +177,8 @@ import type { GetEmbeddingProviderRequest } 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", }); @@ -208,7 +214,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -245,6 +251,8 @@ import type { ListEmbeddingProvidersRequest } 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", }); @@ -272,7 +280,7 @@ This endpoint does not need any parameter. ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -306,6 +314,8 @@ import type { UpdateEmbeddingProviderOperationRequest } 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", }); @@ -344,7 +354,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/IndexesApi.md b/docs/IndexesApi.md index 0ce2c13..618b214 100644 --- a/docs/IndexesApi.md +++ b/docs/IndexesApi.md @@ -1,6 +1,6 @@ # IndexesApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -30,6 +30,8 @@ import type { CreateIndexOperationRequest } 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", }); @@ -74,7 +76,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -113,6 +115,8 @@ import type { DeleteIndexRequest } 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", }); @@ -157,7 +161,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -195,6 +199,8 @@ import type { ListIndexesRequest } 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", }); @@ -236,7 +242,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/InformationSchemaApi.md b/docs/InformationSchemaApi.md index d302711..6e556e1 100644 --- a/docs/InformationSchemaApi.md +++ b/docs/InformationSchemaApi.md @@ -1,6 +1,6 @@ # InformationSchemaApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -28,6 +28,8 @@ import type { InformationSchemaRequest } 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", }); @@ -78,7 +80,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/JobsApi.md b/docs/JobsApi.md index 5668327..9ac80ab 100644 --- a/docs/JobsApi.md +++ b/docs/JobsApi.md @@ -1,6 +1,6 @@ # JobsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -29,6 +29,8 @@ import type { GetJobRequest } 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", }); @@ -64,7 +66,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -101,6 +103,8 @@ import type { ListJobsRequest } 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", }); @@ -145,7 +149,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/ListSandboxesResponse.md b/docs/ListSandboxesResponse.md new file mode 100644 index 0000000..cb24b48 --- /dev/null +++ b/docs/ListSandboxesResponse.md @@ -0,0 +1,36 @@ + +# ListSandboxesResponse + + +## Properties + +Name | Type +------------ | ------------- +`ok` | boolean +`sandboxes` | [Array<Sandbox>](Sandbox.md) + +## Example + +```typescript +import type { ListSandboxesResponse } from '@hotdata/sdk' + +// TODO: Update the object below with actual values +const example = { + "ok": true, + "sandboxes": null, +} satisfies ListSandboxesResponse + +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 ListSandboxesResponse +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) + + diff --git a/docs/QueryApi.md b/docs/QueryApi.md index a070f7d..5c5ff00 100644 --- a/docs/QueryApi.md +++ b/docs/QueryApi.md @@ -1,6 +1,6 @@ # QueryApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -28,6 +28,10 @@ import type { QueryOperationRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -63,7 +67,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/QueryRunsApi.md b/docs/QueryRunsApi.md index 9a82bd3..b6b8e86 100644 --- a/docs/QueryRunsApi.md +++ b/docs/QueryRunsApi.md @@ -1,6 +1,6 @@ # QueryRunsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -29,6 +29,8 @@ import type { GetQueryRunRequest } 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", }); @@ -64,7 +66,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -99,6 +101,8 @@ import type { ListQueryRunsRequest } 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", }); @@ -143,7 +147,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/RefreshApi.md b/docs/RefreshApi.md index ab4fb9e..a9f65d7 100644 --- a/docs/RefreshApi.md +++ b/docs/RefreshApi.md @@ -1,6 +1,6 @@ # RefreshApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -28,6 +28,8 @@ import type { RefreshOperationRequest } 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", }); @@ -63,7 +65,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/ResultsApi.md b/docs/ResultsApi.md index 74152b2..e1b3fd9 100644 --- a/docs/ResultsApi.md +++ b/docs/ResultsApi.md @@ -1,6 +1,6 @@ # ResultsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -29,6 +29,10 @@ import type { GetResultRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -64,7 +68,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -99,6 +103,10 @@ import type { ListResultsRequest } 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", + // To configure API key authorization: SessionId + apiKey: "YOUR API KEY", // Configure HTTP bearer authorization: BearerAuth accessToken: "YOUR BEARER TOKEN", }); @@ -137,7 +145,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/Sandbox.md b/docs/Sandbox.md new file mode 100644 index 0000000..66b5e18 --- /dev/null +++ b/docs/Sandbox.md @@ -0,0 +1,42 @@ + +# Sandbox + + +## Properties + +Name | Type +------------ | ------------- +`publicId` | string +`name` | string +`markdown` | string +`createdAt` | Date +`updatedAt` | Date + +## Example + +```typescript +import type { Sandbox } from '@hotdata/sdk' + +// TODO: Update the object below with actual values +const example = { + "publicId": sb_abc123, + "name": null, + "markdown": null, + "createdAt": null, + "updatedAt": null, +} satisfies Sandbox + +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 Sandbox +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) + + diff --git a/docs/SandboxResponse.md b/docs/SandboxResponse.md new file mode 100644 index 0000000..18db1f9 --- /dev/null +++ b/docs/SandboxResponse.md @@ -0,0 +1,36 @@ + +# SandboxResponse + + +## Properties + +Name | Type +------------ | ------------- +`ok` | boolean +`sandbox` | [Sandbox](Sandbox.md) + +## Example + +```typescript +import type { SandboxResponse } from '@hotdata/sdk' + +// TODO: Update the object below with actual values +const example = { + "ok": true, + "sandbox": null, +} satisfies SandboxResponse + +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 SandboxResponse +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) + + diff --git a/docs/SandboxesApi.md b/docs/SandboxesApi.md new file mode 100644 index 0000000..7d17fae --- /dev/null +++ b/docs/SandboxesApi.md @@ -0,0 +1,387 @@ +# SandboxesApi + +All URIs are relative to *https://api.hotdata.dev* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**createSandbox**](SandboxesApi.md#createsandboxoperation) | **POST** /v1/sandboxes | Create a sandbox | +| [**deleteSandbox**](SandboxesApi.md#deletesandbox) | **DELETE** /v1/sandboxes/{public_id} | Delete sandbox | +| [**getSandbox**](SandboxesApi.md#getsandbox) | **GET** /v1/sandboxes/{public_id} | Get sandbox | +| [**listSandboxes**](SandboxesApi.md#listsandboxes) | **GET** /v1/sandboxes | List sandboxes | +| [**updateSandbox**](SandboxesApi.md#updatesandboxoperation) | **PATCH** /v1/sandboxes/{public_id} | Update sandbox | + + + +## createSandbox + +> SandboxResponse createSandbox(createSandboxRequest) + +Create a sandbox + +Creates a sandbox in the requested workspace. The returned `public_id` is the value to pass as `X-Session-Id` on scoped ops. + +### Example + +```ts +import { + Configuration, + SandboxesApi, +} from '@hotdata/sdk'; +import type { CreateSandboxOperationRequest } 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", + }); + const api = new SandboxesApi(config); + + const body = { + // CreateSandboxRequest + createSandboxRequest: ..., + } satisfies CreateSandboxOperationRequest; + + try { + const data = await api.createSandbox(body); + console.log(data); + } catch (error) { + console.error(error); + } +} + +// Run the test +example().catch(console.error); +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **createSandboxRequest** | [CreateSandboxRequest](CreateSandboxRequest.md) | | | + +### Return type + +[**SandboxResponse**](SandboxResponse.md) + +### Authorization + +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: `application/json` +- **Accept**: `application/json` + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **201** | Sandbox created | - | +| **400** | Invalid JSON body or missing X-Workspace-Id header | - | +| **401** | Missing or invalid authorization | - | +| **403** | Not a member of the target workspace\'s organization | - | +| **404** | Workspace 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) + + +## deleteSandbox + +> DeleteSandboxResponse deleteSandbox(publicId) + +Delete sandbox + +### Example + +```ts +import { + Configuration, + SandboxesApi, +} from '@hotdata/sdk'; +import type { DeleteSandboxRequest } 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", + }); + const api = new SandboxesApi(config); + + const body = { + // string | Public id of the sandbox. + publicId: publicId_example, + } satisfies DeleteSandboxRequest; + + try { + const data = await api.deleteSandbox(body); + console.log(data); + } catch (error) { + console.error(error); + } +} + +// Run the test +example().catch(console.error); +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **publicId** | `string` | Public id of the sandbox. | [Defaults to `undefined`] | + +### Return type + +[**DeleteSandboxResponse**](DeleteSandboxResponse.md) + +### Authorization + +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Sandbox deleted | - | +| **401** | Missing or invalid authorization | - | +| **403** | Not a member of the target workspace\'s organization | - | +| **404** | Sandbox 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) + + +## getSandbox + +> SandboxResponse getSandbox(publicId) + +Get sandbox + +### Example + +```ts +import { + Configuration, + SandboxesApi, +} from '@hotdata/sdk'; +import type { GetSandboxRequest } 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", + }); + const api = new SandboxesApi(config); + + const body = { + // string | Public id of the sandbox. + publicId: publicId_example, + } satisfies GetSandboxRequest; + + try { + const data = await api.getSandbox(body); + console.log(data); + } catch (error) { + console.error(error); + } +} + +// Run the test +example().catch(console.error); +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **publicId** | `string` | Public id of the sandbox. | [Defaults to `undefined`] | + +### Return type + +[**SandboxResponse**](SandboxResponse.md) + +### Authorization + +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Successful response | - | +| **401** | Missing or invalid authorization | - | +| **403** | Not a member of the target workspace\'s organization | - | +| **404** | Sandbox 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) + + +## listSandboxes + +> ListSandboxesResponse listSandboxes() + +List sandboxes + +Lists sandboxes for the caller in the requested workspace. + +### Example + +```ts +import { + Configuration, + SandboxesApi, +} from '@hotdata/sdk'; +import type { ListSandboxesRequest } 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", + }); + const api = new SandboxesApi(config); + + try { + const data = await api.listSandboxes(); + 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 + +[**ListSandboxesResponse**](ListSandboxesResponse.md) + +### Authorization + +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Successful response | - | +| **400** | Missing or invalid X-Workspace-Id header | - | +| **401** | Missing or invalid authorization | - | +| **403** | Not a member of the target workspace\'s organization | - | +| **404** | Workspace 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) + + +## updateSandbox + +> SandboxResponse updateSandbox(publicId, updateSandboxRequest) + +Update sandbox + +Partial update. Only the provided fields are changed. + +### Example + +```ts +import { + Configuration, + SandboxesApi, +} from '@hotdata/sdk'; +import type { UpdateSandboxOperationRequest } 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", + }); + const api = new SandboxesApi(config); + + const body = { + // string | Public id of the sandbox. + publicId: publicId_example, + // UpdateSandboxRequest + updateSandboxRequest: ..., + } satisfies UpdateSandboxOperationRequest; + + try { + const data = await api.updateSandbox(body); + console.log(data); + } catch (error) { + console.error(error); + } +} + +// Run the test +example().catch(console.error); +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **publicId** | `string` | Public id of the sandbox. | [Defaults to `undefined`] | +| **updateSandboxRequest** | [UpdateSandboxRequest](UpdateSandboxRequest.md) | | | + +### Return type + +[**SandboxResponse**](SandboxResponse.md) + +### Authorization + +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: `application/json` +- **Accept**: `application/json` + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Sandbox updated | - | +| **400** | Invalid JSON body | - | +| **401** | Missing or invalid authorization | - | +| **403** | Not a member of the target workspace\'s organization | - | +| **404** | Sandbox 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) + diff --git a/docs/SavedQueriesApi.md b/docs/SavedQueriesApi.md index 21c1430..09d0134 100644 --- a/docs/SavedQueriesApi.md +++ b/docs/SavedQueriesApi.md @@ -1,6 +1,6 @@ # SavedQueriesApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -34,6 +34,8 @@ import type { CreateSavedQueryOperationRequest } 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", }); @@ -69,7 +71,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -104,6 +106,8 @@ import type { DeleteSavedQueryRequest } 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", }); @@ -139,7 +143,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -176,6 +180,8 @@ import type { ExecuteSavedQueryOperationRequest } 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", }); @@ -214,7 +220,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -249,6 +255,8 @@ import type { GetSavedQueryRequest } 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", }); @@ -284,7 +292,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -319,6 +327,8 @@ import type { ListSavedQueriesRequest } 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", }); @@ -357,7 +367,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -391,6 +401,8 @@ import type { ListSavedQueryVersionsRequest } 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", }); @@ -432,7 +444,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -469,6 +481,8 @@ import type { UpdateSavedQueryOperationRequest } 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", }); @@ -507,7 +521,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/SecretsApi.md b/docs/SecretsApi.md index baa2f4a..6dd021e 100644 --- a/docs/SecretsApi.md +++ b/docs/SecretsApi.md @@ -1,6 +1,6 @@ # SecretsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -32,6 +32,8 @@ import type { CreateSecretOperationRequest } 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", }); @@ -67,7 +69,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -102,6 +104,8 @@ import type { DeleteSecretRequest } 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", }); @@ -137,7 +141,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -174,6 +178,8 @@ import type { GetSecretRequest } 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", }); @@ -209,7 +215,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -246,6 +252,8 @@ import type { ListSecretsRequest } 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", }); @@ -273,7 +281,7 @@ This endpoint does not need any parameter. ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -307,6 +315,8 @@ import type { UpdateSecretOperationRequest } 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", }); @@ -345,7 +355,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/UpdateSandboxRequest.md b/docs/UpdateSandboxRequest.md new file mode 100644 index 0000000..0c61fa6 --- /dev/null +++ b/docs/UpdateSandboxRequest.md @@ -0,0 +1,37 @@ + +# UpdateSandboxRequest + +Partial update — only the provided fields are changed. + +## Properties + +Name | Type +------------ | ------------- +`name` | string +`markdown` | string + +## Example + +```typescript +import type { UpdateSandboxRequest } from '@hotdata/sdk' + +// TODO: Update the object below with actual values +const example = { + "name": null, + "markdown": null, +} satisfies UpdateSandboxRequest + +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 UpdateSandboxRequest +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) + + diff --git a/docs/UploadsApi.md b/docs/UploadsApi.md index f375993..c1d031c 100644 --- a/docs/UploadsApi.md +++ b/docs/UploadsApi.md @@ -1,6 +1,6 @@ # UploadsApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -27,6 +27,8 @@ import type { ListUploadsRequest } 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", }); @@ -62,7 +64,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -80,7 +82,7 @@ example().catch(console.error); ## uploadFile -> UploadResponse uploadFile(requestBody, streaming) +> UploadResponse uploadFile(body, streaming) Upload file @@ -98,14 +100,16 @@ import type { UploadFileRequest } 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", }); const api = new UploadsApi(config); const body = { - // Array - requestBody: ..., + // Blob + body: BINARY_DATA_HERE, // boolean | Stream upload to disk for large files (up to 20GB) (optional) streaming: true, } satisfies UploadFileRequest; @@ -127,7 +131,7 @@ example().catch(console.error); | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **requestBody** | `Array` | | | +| **body** | `Blob` | | | | **streaming** | `boolean` | Stream upload to disk for large files (up to 20GB) | [Optional] [Defaults to `undefined`] | ### Return type @@ -136,7 +140,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/WorkspaceContextApi.md b/docs/WorkspaceContextApi.md index cded5e3..e7cf181 100644 --- a/docs/WorkspaceContextApi.md +++ b/docs/WorkspaceContextApi.md @@ -1,6 +1,6 @@ # WorkspaceContextApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| @@ -28,13 +28,15 @@ import type { GetWorkspaceContextRequest } 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", }); const api = new WorkspaceContextApi(config); const body = { - // string | Name of the context (unique within the catalog) + // string | Context key: same character rules as a dataset table name (letter or underscore first; no hyphens) name: name_example, } satisfies GetWorkspaceContextRequest; @@ -55,7 +57,7 @@ example().catch(console.error); | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **name** | `string` | Name of the context (unique within the catalog) | [Defaults to `undefined`] | +| **name** | `string` | Context key: same character rules as a dataset table name (letter or underscore first; no hyphens) | [Defaults to `undefined`] | ### Return type @@ -63,7 +65,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -99,6 +101,8 @@ import type { ListWorkspaceContextsRequest } 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", }); @@ -126,7 +130,7 @@ This endpoint does not need any parameter. ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers @@ -163,6 +167,8 @@ import type { UpsertWorkspaceContextOperationRequest } 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", }); @@ -198,7 +204,7 @@ example().catch(console.error); ### Authorization -[BearerAuth](../README.md#BearerAuth) +[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth) ### HTTP request headers diff --git a/docs/WorkspacesApi.md b/docs/WorkspacesApi.md index 08c6cae..79a079c 100644 --- a/docs/WorkspacesApi.md +++ b/docs/WorkspacesApi.md @@ -1,6 +1,6 @@ # WorkspacesApi -All URIs are relative to *https://app.hotdata.dev* +All URIs are relative to *https://api.hotdata.dev* | Method | HTTP request | Description | |------------- | ------------- | -------------| diff --git a/src/apis/ConnectionTypesApi.ts b/src/apis/ConnectionTypesApi.ts index 8d124f3..4ea25b1 100644 --- a/src/apis/ConnectionTypesApi.ts +++ b/src/apis/ConnectionTypesApi.ts @@ -52,6 +52,10 @@ export class ConnectionTypesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -100,6 +104,10 @@ export class ConnectionTypesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/ConnectionsApi.ts b/src/apis/ConnectionsApi.ts index 6b51c6a..e48ed76 100644 --- a/src/apis/ConnectionsApi.ts +++ b/src/apis/ConnectionsApi.ts @@ -92,6 +92,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -149,6 +153,10 @@ export class ConnectionsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -204,6 +212,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -258,6 +270,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -327,6 +343,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -377,6 +397,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -431,6 +455,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -499,6 +527,10 @@ export class ConnectionsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/DatasetsApi.ts b/src/apis/DatasetsApi.ts index b4c3b2c..feee5a8 100644 --- a/src/apis/DatasetsApi.ts +++ b/src/apis/DatasetsApi.ts @@ -93,6 +93,14 @@ export class DatasetsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -148,6 +156,14 @@ export class DatasetsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -200,6 +216,10 @@ export class DatasetsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -261,6 +281,10 @@ export class DatasetsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -315,6 +339,14 @@ export class DatasetsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -376,6 +408,14 @@ export class DatasetsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/EmbeddingProvidersApi.ts b/src/apis/EmbeddingProvidersApi.ts index 36442b5..c6d1f3d 100644 --- a/src/apis/EmbeddingProvidersApi.ts +++ b/src/apis/EmbeddingProvidersApi.ts @@ -79,6 +79,10 @@ export class EmbeddingProvidersApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -134,6 +138,10 @@ export class EmbeddingProvidersApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -186,6 +194,10 @@ export class EmbeddingProvidersApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -232,6 +244,10 @@ export class EmbeddingProvidersApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -295,6 +311,10 @@ export class EmbeddingProvidersApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/IndexesApi.ts b/src/apis/IndexesApi.ts index 9327219..f8d426b 100644 --- a/src/apis/IndexesApi.ts +++ b/src/apis/IndexesApi.ts @@ -94,6 +94,10 @@ export class IndexesApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -173,6 +177,10 @@ export class IndexesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -244,6 +252,10 @@ export class IndexesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/InformationSchemaApi.ts b/src/apis/InformationSchemaApi.ts index 5e43756..f121336 100644 --- a/src/apis/InformationSchemaApi.ts +++ b/src/apis/InformationSchemaApi.ts @@ -71,6 +71,10 @@ export class InformationSchemaApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/JobsApi.ts b/src/apis/JobsApi.ts index da927ff..5707b1a 100644 --- a/src/apis/JobsApi.ts +++ b/src/apis/JobsApi.ts @@ -62,6 +62,10 @@ export class JobsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -126,6 +130,10 @@ export class JobsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/QueryApi.ts b/src/apis/QueryApi.ts index 88da0fb..b4e949f 100644 --- a/src/apis/QueryApi.ts +++ b/src/apis/QueryApi.ts @@ -57,6 +57,14 @@ export class QueryApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/QueryRunsApi.ts b/src/apis/QueryRunsApi.ts index d1b84b3..74d1feb 100644 --- a/src/apis/QueryRunsApi.ts +++ b/src/apis/QueryRunsApi.ts @@ -59,6 +59,10 @@ export class QueryRunsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -123,6 +127,10 @@ export class QueryRunsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/RefreshApi.ts b/src/apis/RefreshApi.ts index e78e12e..23d0822 100644 --- a/src/apis/RefreshApi.ts +++ b/src/apis/RefreshApi.ts @@ -54,6 +54,10 @@ export class RefreshApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/ResultsApi.ts b/src/apis/ResultsApi.ts index 7b5c7bc..fb96b10 100644 --- a/src/apis/ResultsApi.ts +++ b/src/apis/ResultsApi.ts @@ -57,6 +57,14 @@ export class ResultsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -113,6 +121,14 @@ export class ResultsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Session-Id"] = await this.configuration.apiKey("X-Session-Id"); // SessionId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/SandboxesApi.ts b/src/apis/SandboxesApi.ts new file mode 100644 index 0000000..fcfac05 --- /dev/null +++ b/src/apis/SandboxesApi.ts @@ -0,0 +1,354 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import * as runtime from '../runtime'; +import type { + CreateSandboxRequest, + DeleteSandboxResponse, + ListSandboxesResponse, + SandboxResponse, + UpdateSandboxRequest, +} from '../models/index'; +import { + CreateSandboxRequestFromJSON, + CreateSandboxRequestToJSON, + DeleteSandboxResponseFromJSON, + DeleteSandboxResponseToJSON, + ListSandboxesResponseFromJSON, + ListSandboxesResponseToJSON, + SandboxResponseFromJSON, + SandboxResponseToJSON, + UpdateSandboxRequestFromJSON, + UpdateSandboxRequestToJSON, +} from '../models/index'; + +export interface CreateSandboxOperationRequest { + createSandboxRequest: CreateSandboxRequest; +} + +export interface DeleteSandboxRequest { + publicId: string; +} + +export interface GetSandboxRequest { + publicId: string; +} + +export interface UpdateSandboxOperationRequest { + publicId: string; + updateSandboxRequest: UpdateSandboxRequest; +} + +/** + * + */ +export class SandboxesApi extends runtime.BaseAPI { + + /** + * Creates request options for createSandbox without sending the request + */ + async createSandboxRequestOpts(requestParameters: CreateSandboxOperationRequest): Promise { + if (requestParameters['createSandboxRequest'] == null) { + throw new runtime.RequiredError( + 'createSandboxRequest', + 'Required parameter "createSandboxRequest" was null or undefined when calling createSandbox().' + ); + } + + const queryParameters: any = {}; + + const headerParameters: runtime.HTTPHeaders = {}; + + headerParameters['Content-Type'] = 'application/json'; + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.accessToken) { + const token = this.configuration.accessToken; + const tokenString = await token("BearerAuth", []); + + if (tokenString) { + headerParameters["Authorization"] = `Bearer ${tokenString}`; + } + } + + let urlPath = `/v1/sandboxes`; + + return { + path: urlPath, + method: 'POST', + headers: headerParameters, + query: queryParameters, + body: CreateSandboxRequestToJSON(requestParameters['createSandboxRequest']), + }; + } + + /** + * Creates a sandbox in the requested workspace. The returned `public_id` is the value to pass as `X-Session-Id` on scoped ops. + * Create a sandbox + */ + async createSandboxRaw(requestParameters: CreateSandboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { + const requestOptions = await this.createSandboxRequestOpts(requestParameters); + const response = await this.request(requestOptions, initOverrides); + + return new runtime.JSONApiResponse(response, (jsonValue) => SandboxResponseFromJSON(jsonValue)); + } + + /** + * Creates a sandbox in the requested workspace. The returned `public_id` is the value to pass as `X-Session-Id` on scoped ops. + * Create a sandbox + */ + async createSandbox(requestParameters: CreateSandboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { + const response = await this.createSandboxRaw(requestParameters, initOverrides); + return await response.value(); + } + + /** + * Creates request options for deleteSandbox without sending the request + */ + async deleteSandboxRequestOpts(requestParameters: DeleteSandboxRequest): Promise { + if (requestParameters['publicId'] == null) { + throw new runtime.RequiredError( + 'publicId', + 'Required parameter "publicId" was null or undefined when calling deleteSandbox().' + ); + } + + const queryParameters: any = {}; + + const headerParameters: runtime.HTTPHeaders = {}; + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.accessToken) { + const token = this.configuration.accessToken; + const tokenString = await token("BearerAuth", []); + + if (tokenString) { + headerParameters["Authorization"] = `Bearer ${tokenString}`; + } + } + + let urlPath = `/v1/sandboxes/{public_id}`; + urlPath = urlPath.replace(`{${"public_id"}}`, encodeURIComponent(String(requestParameters['publicId']))); + + return { + path: urlPath, + method: 'DELETE', + headers: headerParameters, + query: queryParameters, + }; + } + + /** + * Delete sandbox + */ + async deleteSandboxRaw(requestParameters: DeleteSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { + const requestOptions = await this.deleteSandboxRequestOpts(requestParameters); + const response = await this.request(requestOptions, initOverrides); + + return new runtime.JSONApiResponse(response, (jsonValue) => DeleteSandboxResponseFromJSON(jsonValue)); + } + + /** + * Delete sandbox + */ + async deleteSandbox(requestParameters: DeleteSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { + const response = await this.deleteSandboxRaw(requestParameters, initOverrides); + return await response.value(); + } + + /** + * Creates request options for getSandbox without sending the request + */ + async getSandboxRequestOpts(requestParameters: GetSandboxRequest): Promise { + if (requestParameters['publicId'] == null) { + throw new runtime.RequiredError( + 'publicId', + 'Required parameter "publicId" was null or undefined when calling getSandbox().' + ); + } + + const queryParameters: any = {}; + + const headerParameters: runtime.HTTPHeaders = {}; + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.accessToken) { + const token = this.configuration.accessToken; + const tokenString = await token("BearerAuth", []); + + if (tokenString) { + headerParameters["Authorization"] = `Bearer ${tokenString}`; + } + } + + let urlPath = `/v1/sandboxes/{public_id}`; + urlPath = urlPath.replace(`{${"public_id"}}`, encodeURIComponent(String(requestParameters['publicId']))); + + return { + path: urlPath, + method: 'GET', + headers: headerParameters, + query: queryParameters, + }; + } + + /** + * Get sandbox + */ + async getSandboxRaw(requestParameters: GetSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { + const requestOptions = await this.getSandboxRequestOpts(requestParameters); + const response = await this.request(requestOptions, initOverrides); + + return new runtime.JSONApiResponse(response, (jsonValue) => SandboxResponseFromJSON(jsonValue)); + } + + /** + * Get sandbox + */ + async getSandbox(requestParameters: GetSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { + const response = await this.getSandboxRaw(requestParameters, initOverrides); + return await response.value(); + } + + /** + * Creates request options for listSandboxes without sending the request + */ + async listSandboxesRequestOpts(): Promise { + const queryParameters: any = {}; + + const headerParameters: runtime.HTTPHeaders = {}; + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.accessToken) { + const token = this.configuration.accessToken; + const tokenString = await token("BearerAuth", []); + + if (tokenString) { + headerParameters["Authorization"] = `Bearer ${tokenString}`; + } + } + + let urlPath = `/v1/sandboxes`; + + return { + path: urlPath, + method: 'GET', + headers: headerParameters, + query: queryParameters, + }; + } + + /** + * Lists sandboxes for the caller in the requested workspace. + * List sandboxes + */ + async listSandboxesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { + const requestOptions = await this.listSandboxesRequestOpts(); + const response = await this.request(requestOptions, initOverrides); + + return new runtime.JSONApiResponse(response, (jsonValue) => ListSandboxesResponseFromJSON(jsonValue)); + } + + /** + * Lists sandboxes for the caller in the requested workspace. + * List sandboxes + */ + async listSandboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { + const response = await this.listSandboxesRaw(initOverrides); + return await response.value(); + } + + /** + * Creates request options for updateSandbox without sending the request + */ + async updateSandboxRequestOpts(requestParameters: UpdateSandboxOperationRequest): Promise { + if (requestParameters['publicId'] == null) { + throw new runtime.RequiredError( + 'publicId', + 'Required parameter "publicId" was null or undefined when calling updateSandbox().' + ); + } + + if (requestParameters['updateSandboxRequest'] == null) { + throw new runtime.RequiredError( + 'updateSandboxRequest', + 'Required parameter "updateSandboxRequest" was null or undefined when calling updateSandbox().' + ); + } + + const queryParameters: any = {}; + + const headerParameters: runtime.HTTPHeaders = {}; + + headerParameters['Content-Type'] = 'application/json'; + + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + + if (this.configuration && this.configuration.accessToken) { + const token = this.configuration.accessToken; + const tokenString = await token("BearerAuth", []); + + if (tokenString) { + headerParameters["Authorization"] = `Bearer ${tokenString}`; + } + } + + let urlPath = `/v1/sandboxes/{public_id}`; + urlPath = urlPath.replace(`{${"public_id"}}`, encodeURIComponent(String(requestParameters['publicId']))); + + return { + path: urlPath, + method: 'PATCH', + headers: headerParameters, + query: queryParameters, + body: UpdateSandboxRequestToJSON(requestParameters['updateSandboxRequest']), + }; + } + + /** + * Partial update. Only the provided fields are changed. + * Update sandbox + */ + async updateSandboxRaw(requestParameters: UpdateSandboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { + const requestOptions = await this.updateSandboxRequestOpts(requestParameters); + const response = await this.request(requestOptions, initOverrides); + + return new runtime.JSONApiResponse(response, (jsonValue) => SandboxResponseFromJSON(jsonValue)); + } + + /** + * Partial update. Only the provided fields are changed. + * Update sandbox + */ + async updateSandbox(requestParameters: UpdateSandboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { + const response = await this.updateSandboxRaw(requestParameters, initOverrides); + return await response.value(); + } + +} diff --git a/src/apis/SavedQueriesApi.ts b/src/apis/SavedQueriesApi.ts index 194ac67..fda1ef1 100644 --- a/src/apis/SavedQueriesApi.ts +++ b/src/apis/SavedQueriesApi.ts @@ -98,6 +98,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -153,6 +157,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -207,6 +215,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -263,6 +275,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -317,6 +333,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -377,6 +397,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -439,6 +463,10 @@ export class SavedQueriesApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/SecretsApi.ts b/src/apis/SecretsApi.ts index c7ddbca..17b3013 100644 --- a/src/apis/SecretsApi.ts +++ b/src/apis/SecretsApi.ts @@ -79,6 +79,10 @@ export class SecretsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -134,6 +138,10 @@ export class SecretsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -186,6 +194,10 @@ export class SecretsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -234,6 +246,10 @@ export class SecretsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -297,6 +313,10 @@ export class SecretsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/UploadsApi.ts b/src/apis/UploadsApi.ts index 4a60be7..5150731 100644 --- a/src/apis/UploadsApi.ts +++ b/src/apis/UploadsApi.ts @@ -33,7 +33,7 @@ export interface ListUploadsRequest { } export interface UploadFileRequest { - requestBody: Array; + body: Blob; streaming?: boolean; } @@ -54,6 +54,10 @@ export class UploadsApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -95,10 +99,10 @@ export class UploadsApi extends runtime.BaseAPI { * Creates request options for uploadFile without sending the request */ async uploadFileRequestOpts(requestParameters: UploadFileRequest): Promise { - if (requestParameters['requestBody'] == null) { + if (requestParameters['body'] == null) { throw new runtime.RequiredError( - 'requestBody', - 'Required parameter "requestBody" was null or undefined when calling uploadFile().' + 'body', + 'Required parameter "body" was null or undefined when calling uploadFile().' ); } @@ -112,6 +116,10 @@ export class UploadsApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/octet-stream'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -128,7 +136,7 @@ export class UploadsApi extends runtime.BaseAPI { method: 'POST', headers: headerParameters, query: queryParameters, - body: requestParameters['requestBody'], + body: requestParameters['body'] as any, }; } diff --git a/src/apis/WorkspaceContextApi.ts b/src/apis/WorkspaceContextApi.ts index 3d81bd8..4aa5e4f 100644 --- a/src/apis/WorkspaceContextApi.ts +++ b/src/apis/WorkspaceContextApi.ts @@ -62,6 +62,10 @@ export class WorkspaceContextApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -108,6 +112,10 @@ export class WorkspaceContextApi extends runtime.BaseAPI { const headerParameters: runtime.HTTPHeaders = {}; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); @@ -162,6 +170,10 @@ export class WorkspaceContextApi extends runtime.BaseAPI { headerParameters['Content-Type'] = 'application/json'; + if (this.configuration && this.configuration.apiKey) { + headerParameters["X-Workspace-Id"] = await this.configuration.apiKey("X-Workspace-Id"); // WorkspaceId authentication + } + if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); diff --git a/src/apis/index.ts b/src/apis/index.ts index 57b8964..9b3dd52 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -11,6 +11,7 @@ export * from './QueryApi'; export * from './QueryRunsApi'; export * from './RefreshApi'; export * from './ResultsApi'; +export * from './SandboxesApi'; export * from './SavedQueriesApi'; export * from './SecretsApi'; export * from './UploadsApi'; diff --git a/src/models/CreateSandboxRequest.ts b/src/models/CreateSandboxRequest.ts new file mode 100644 index 0000000..c324ab8 --- /dev/null +++ b/src/models/CreateSandboxRequest.ts @@ -0,0 +1,73 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +/** + * + * @export + * @interface CreateSandboxRequest + */ +export interface CreateSandboxRequest { + /** + * Human-readable name for the sandbox. + * @type {string} + * @memberof CreateSandboxRequest + */ + name?: string; + /** + * Optional markdown notes. + * @type {string} + * @memberof CreateSandboxRequest + */ + markdown?: string; +} + +/** + * Check if a given object implements the CreateSandboxRequest interface. + */ +export function instanceOfCreateSandboxRequest(value: object): value is CreateSandboxRequest { + return true; +} + +export function CreateSandboxRequestFromJSON(json: any): CreateSandboxRequest { + return CreateSandboxRequestFromJSONTyped(json, false); +} + +export function CreateSandboxRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSandboxRequest { + if (json == null) { + return json; + } + return { + + 'name': json['name'] == null ? undefined : json['name'], + 'markdown': json['markdown'] == null ? undefined : json['markdown'], + }; +} + +export function CreateSandboxRequestToJSON(json: any): CreateSandboxRequest { + return CreateSandboxRequestToJSONTyped(json, false); +} + +export function CreateSandboxRequestToJSONTyped(value?: CreateSandboxRequest | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'name': value['name'], + 'markdown': value['markdown'], + }; +} + diff --git a/src/models/DeleteSandboxResponse.ts b/src/models/DeleteSandboxResponse.ts new file mode 100644 index 0000000..9daf27b --- /dev/null +++ b/src/models/DeleteSandboxResponse.ts @@ -0,0 +1,75 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +/** + * + * @export + * @interface DeleteSandboxResponse + */ +export interface DeleteSandboxResponse { + /** + * + * @type {boolean} + * @memberof DeleteSandboxResponse + */ + ok: boolean; + /** + * + * @type {boolean} + * @memberof DeleteSandboxResponse + */ + deleted: boolean; +} + +/** + * Check if a given object implements the DeleteSandboxResponse interface. + */ +export function instanceOfDeleteSandboxResponse(value: object): value is DeleteSandboxResponse { + if (!('ok' in value) || value['ok'] === undefined) return false; + if (!('deleted' in value) || value['deleted'] === undefined) return false; + return true; +} + +export function DeleteSandboxResponseFromJSON(json: any): DeleteSandboxResponse { + return DeleteSandboxResponseFromJSONTyped(json, false); +} + +export function DeleteSandboxResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteSandboxResponse { + if (json == null) { + return json; + } + return { + + 'ok': json['ok'], + 'deleted': json['deleted'], + }; +} + +export function DeleteSandboxResponseToJSON(json: any): DeleteSandboxResponse { + return DeleteSandboxResponseToJSONTyped(json, false); +} + +export function DeleteSandboxResponseToJSONTyped(value?: DeleteSandboxResponse | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'ok': value['ok'], + 'deleted': value['deleted'], + }; +} + diff --git a/src/models/JobResult.ts b/src/models/JobResult.ts index 012cd64..cec3cb0 100644 --- a/src/models/JobResult.ts +++ b/src/models/JobResult.ts @@ -12,25 +12,6 @@ * Do not edit the class manually. */ -import type { ConnectionRefreshResult } from './ConnectionRefreshResult'; -import { - ConnectionRefreshResultFromJSONTyped, - ConnectionRefreshResultToJSON, - instanceOfConnectionRefreshResult, -} from './ConnectionRefreshResult'; -import type { IndexInfoResponse } from './IndexInfoResponse'; -import { - IndexInfoResponseFromJSONTyped, - IndexInfoResponseToJSON, - instanceOfIndexInfoResponse, -} from './IndexInfoResponse'; -import type { TableRefreshResult } from './TableRefreshResult'; -import { - TableRefreshResultFromJSONTyped, - TableRefreshResultToJSON, - instanceOfTableRefreshResult, -} from './TableRefreshResult'; - /** * @type JobResult * Job-specific result payload. The shape depends on the job type. diff --git a/src/models/ListSandboxesResponse.ts b/src/models/ListSandboxesResponse.ts new file mode 100644 index 0000000..81c9e5f --- /dev/null +++ b/src/models/ListSandboxesResponse.ts @@ -0,0 +1,83 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +import type { Sandbox } from './Sandbox'; +import { + SandboxFromJSON, + SandboxFromJSONTyped, + SandboxToJSON, + SandboxToJSONTyped, +} from './Sandbox'; + +/** + * + * @export + * @interface ListSandboxesResponse + */ +export interface ListSandboxesResponse { + /** + * + * @type {boolean} + * @memberof ListSandboxesResponse + */ + ok: boolean; + /** + * + * @type {Array} + * @memberof ListSandboxesResponse + */ + sandboxes: Array; +} + +/** + * Check if a given object implements the ListSandboxesResponse interface. + */ +export function instanceOfListSandboxesResponse(value: object): value is ListSandboxesResponse { + if (!('ok' in value) || value['ok'] === undefined) return false; + if (!('sandboxes' in value) || value['sandboxes'] === undefined) return false; + return true; +} + +export function ListSandboxesResponseFromJSON(json: any): ListSandboxesResponse { + return ListSandboxesResponseFromJSONTyped(json, false); +} + +export function ListSandboxesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListSandboxesResponse { + if (json == null) { + return json; + } + return { + + 'ok': json['ok'], + 'sandboxes': ((json['sandboxes'] as Array).map(SandboxFromJSON)), + }; +} + +export function ListSandboxesResponseToJSON(json: any): ListSandboxesResponse { + return ListSandboxesResponseToJSONTyped(json, false); +} + +export function ListSandboxesResponseToJSONTyped(value?: ListSandboxesResponse | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'ok': value['ok'], + 'sandboxes': ((value['sandboxes'] as Array).map(SandboxToJSON)), + }; +} + diff --git a/src/models/Sandbox.ts b/src/models/Sandbox.ts new file mode 100644 index 0000000..42ca015 --- /dev/null +++ b/src/models/Sandbox.ts @@ -0,0 +1,102 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +/** + * + * @export + * @interface Sandbox + */ +export interface Sandbox { + /** + * + * @type {string} + * @memberof Sandbox + */ + publicId: string; + /** + * + * @type {string} + * @memberof Sandbox + */ + name: string; + /** + * Freeform markdown notes attached to the sandbox. + * @type {string} + * @memberof Sandbox + */ + markdown: string; + /** + * + * @type {Date} + * @memberof Sandbox + */ + createdAt: Date; + /** + * + * @type {Date} + * @memberof Sandbox + */ + updatedAt: Date; +} + +/** + * Check if a given object implements the Sandbox interface. + */ +export function instanceOfSandbox(value: object): value is Sandbox { + if (!('publicId' in value) || value['publicId'] === undefined) return false; + if (!('name' in value) || value['name'] === undefined) return false; + if (!('markdown' in value) || value['markdown'] === undefined) return false; + if (!('createdAt' in value) || value['createdAt'] === undefined) return false; + if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false; + return true; +} + +export function SandboxFromJSON(json: any): Sandbox { + return SandboxFromJSONTyped(json, false); +} + +export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sandbox { + if (json == null) { + return json; + } + return { + + 'publicId': json['public_id'], + 'name': json['name'], + 'markdown': json['markdown'], + 'createdAt': (new Date(json['created_at'])), + 'updatedAt': (new Date(json['updated_at'])), + }; +} + +export function SandboxToJSON(json: any): Sandbox { + return SandboxToJSONTyped(json, false); +} + +export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'public_id': value['publicId'], + 'name': value['name'], + 'markdown': value['markdown'], + 'created_at': value['createdAt'].toISOString(), + 'updated_at': value['updatedAt'].toISOString(), + }; +} + diff --git a/src/models/SandboxResponse.ts b/src/models/SandboxResponse.ts new file mode 100644 index 0000000..f32ea2a --- /dev/null +++ b/src/models/SandboxResponse.ts @@ -0,0 +1,83 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +import type { Sandbox } from './Sandbox'; +import { + SandboxFromJSON, + SandboxFromJSONTyped, + SandboxToJSON, + SandboxToJSONTyped, +} from './Sandbox'; + +/** + * + * @export + * @interface SandboxResponse + */ +export interface SandboxResponse { + /** + * + * @type {boolean} + * @memberof SandboxResponse + */ + ok: boolean; + /** + * + * @type {Sandbox} + * @memberof SandboxResponse + */ + sandbox: Sandbox; +} + +/** + * Check if a given object implements the SandboxResponse interface. + */ +export function instanceOfSandboxResponse(value: object): value is SandboxResponse { + if (!('ok' in value) || value['ok'] === undefined) return false; + if (!('sandbox' in value) || value['sandbox'] === undefined) return false; + return true; +} + +export function SandboxResponseFromJSON(json: any): SandboxResponse { + return SandboxResponseFromJSONTyped(json, false); +} + +export function SandboxResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxResponse { + if (json == null) { + return json; + } + return { + + 'ok': json['ok'], + 'sandbox': SandboxFromJSON(json['sandbox']), + }; +} + +export function SandboxResponseToJSON(json: any): SandboxResponse { + return SandboxResponseToJSONTyped(json, false); +} + +export function SandboxResponseToJSONTyped(value?: SandboxResponse | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'ok': value['ok'], + 'sandbox': SandboxToJSON(value['sandbox']), + }; +} + diff --git a/src/models/UpdateSandboxRequest.ts b/src/models/UpdateSandboxRequest.ts new file mode 100644 index 0000000..c792cd0 --- /dev/null +++ b/src/models/UpdateSandboxRequest.ts @@ -0,0 +1,73 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Hotdata API + * Powerful data platform API for datasets, queries, and analytics. + * + * The version of the OpenAPI document: 1.0.0 + * Contact: developers@hotdata.dev + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { mapValues } from '../runtime'; +/** + * Partial update — only the provided fields are changed. + * @export + * @interface UpdateSandboxRequest + */ +export interface UpdateSandboxRequest { + /** + * + * @type {string} + * @memberof UpdateSandboxRequest + */ + name?: string; + /** + * + * @type {string} + * @memberof UpdateSandboxRequest + */ + markdown?: string; +} + +/** + * Check if a given object implements the UpdateSandboxRequest interface. + */ +export function instanceOfUpdateSandboxRequest(value: object): value is UpdateSandboxRequest { + return true; +} + +export function UpdateSandboxRequestFromJSON(json: any): UpdateSandboxRequest { + return UpdateSandboxRequestFromJSONTyped(json, false); +} + +export function UpdateSandboxRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSandboxRequest { + if (json == null) { + return json; + } + return { + + 'name': json['name'] == null ? undefined : json['name'], + 'markdown': json['markdown'] == null ? undefined : json['markdown'], + }; +} + +export function UpdateSandboxRequestToJSON(json: any): UpdateSandboxRequest { + return UpdateSandboxRequestToJSONTyped(json, false); +} + +export function UpdateSandboxRequestToJSONTyped(value?: UpdateSandboxRequest | null, ignoreDiscriminator: boolean = false): any { + if (value == null) { + return value; + } + + return { + + 'name': value['name'], + 'markdown': value['markdown'], + }; +} + diff --git a/src/models/UpsertWorkspaceContextRequest.ts b/src/models/UpsertWorkspaceContextRequest.ts index 99bc03a..242e963 100644 --- a/src/models/UpsertWorkspaceContextRequest.ts +++ b/src/models/UpsertWorkspaceContextRequest.ts @@ -26,7 +26,8 @@ export interface UpsertWorkspaceContextRequest { */ content: string; /** - * Unique name in the catalog (upsert key). Same field as in list/get responses. + * Upsert key in the catalog. Validated with dataset table-name rules (preserves case): + * ASCII letter or `_` first; then alphanumeric or `_` only; 1–128 chars; not a SQL reserved word. * @type {string} * @memberof UpsertWorkspaceContextRequest */ diff --git a/src/models/index.ts b/src/models/index.ts index 91ead21..96816f8 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -28,6 +28,7 @@ export * from './CreateDatasetResponse'; export * from './CreateEmbeddingProviderRequest'; export * from './CreateEmbeddingProviderResponse'; export * from './CreateIndexRequest'; +export * from './CreateSandboxRequest'; export * from './CreateSavedQueryRequest'; export * from './CreateSecretRequest'; export * from './CreateSecretResponse'; @@ -36,6 +37,7 @@ export * from './CreateWorkspaceResponse'; export * from './DatasetSource'; export * from './DatasetSummary'; export * from './DatasetVersionSummary'; +export * from './DeleteSandboxResponse'; export * from './DiscoveryStatus'; export * from './EmbeddingProviderResponse'; export * from './ExecuteSavedQueryRequest'; @@ -62,6 +64,7 @@ export * from './ListIndexesResponse'; export * from './ListJobsResponse'; export * from './ListQueryRunsResponse'; export * from './ListResultsResponse'; +export * from './ListSandboxesResponse'; export * from './ListSavedQueriesResponse'; export * from './ListSavedQueryVersionsResponse'; export * from './ListSecretsResponse'; @@ -78,6 +81,8 @@ export * from './RefreshRequest'; export * from './RefreshResponse'; export * from './RefreshWarning'; export * from './ResultInfo'; +export * from './Sandbox'; +export * from './SandboxResponse'; export * from './SavedQueryDatasetSource'; export * from './SavedQueryDetail'; export * from './SavedQuerySummary'; @@ -96,6 +101,7 @@ export * from './UpdateDatasetRequest'; export * from './UpdateDatasetResponse'; export * from './UpdateEmbeddingProviderRequest'; export * from './UpdateEmbeddingProviderResponse'; +export * from './UpdateSandboxRequest'; export * from './UpdateSavedQueryRequest'; export * from './UpdateSecretRequest'; export * from './UpdateSecretResponse'; diff --git a/src/runtime.ts b/src/runtime.ts index 7e81145..903d416 100644 --- a/src/runtime.ts +++ b/src/runtime.ts @@ -13,7 +13,7 @@ */ -export const BASE_PATH = "https://app.hotdata.dev".replace(/\/+$/, ""); +export const BASE_PATH = "https://api.hotdata.dev".replace(/\/+$/, ""); export interface ConfigurationParameters { basePath?: string; // override base path