@vertracloud/api-types 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -40
- package/common/v1.d.ts +23 -7
- package/common/v1.js.map +1 -1
- package/package.json +5 -5
- package/payloads/v1/activity.d.ts +22 -10
- package/payloads/v1/activity.js +9 -0
- package/payloads/v1/activity.js.map +1 -1
- package/payloads/v1/activity.mjs +8 -0
- package/payloads/v1/api-error.d.ts +302 -0
- package/payloads/v1/api-error.js +216 -0
- package/payloads/v1/api-error.js.map +1 -0
- package/payloads/v1/api-error.mjs +188 -0
- package/payloads/v1/api-key.d.ts +88 -0
- package/payloads/v1/api-key.js +267 -0
- package/payloads/v1/api-key.js.map +1 -0
- package/payloads/v1/api-key.mjs +235 -0
- package/payloads/v1/application.d.ts +234 -47
- package/payloads/v1/application.js +34 -3
- package/payloads/v1/application.js.map +1 -1
- package/payloads/v1/application.mjs +28 -2
- package/payloads/v1/database-data.d.ts +329 -0
- package/payloads/v1/database-data.js +63 -0
- package/payloads/v1/database-data.js.map +1 -0
- package/payloads/v1/database-data.mjs +35 -0
- package/payloads/v1/database.d.ts +29 -31
- package/payloads/v1/database.js.map +1 -1
- package/payloads/v1/github.d.ts +20 -0
- package/{rest/v1/credits.js → payloads/v1/github.js} +4 -4
- package/payloads/v1/github.js.map +1 -0
- package/payloads/v1/github.mjs +1 -0
- package/payloads/v1/index.d.ts +12 -9
- package/payloads/v1/index.js +630 -10
- package/payloads/v1/index.js.map +1 -1
- package/payloads/v1/index.mjs +590 -9
- package/payloads/v1/notification.d.ts +2 -3
- package/payloads/v1/notification.js.map +1 -1
- package/payloads/v1/oauth.d.ts +27 -0
- package/payloads/v1/oauth.js +34 -0
- package/payloads/v1/oauth.js.map +1 -0
- package/payloads/v1/oauth.mjs +8 -0
- package/payloads/v1/orders.d.ts +52 -27
- package/payloads/v1/orders.js +30 -0
- package/payloads/v1/orders.js.map +1 -1
- package/payloads/v1/orders.mjs +21 -0
- package/payloads/v1/redeem.d.ts +1 -1
- package/payloads/v1/redeem.js.map +1 -1
- package/payloads/v1/snapshot.d.ts +37 -7
- package/payloads/v1/snapshot.js +8 -2
- package/payloads/v1/snapshot.js.map +1 -1
- package/payloads/v1/snapshot.mjs +6 -1
- package/payloads/v1/status.d.ts +2 -2
- package/payloads/v1/status.js.map +1 -1
- package/payloads/v1/user.d.ts +54 -20
- package/payloads/v1/user.js +16 -0
- package/payloads/v1/user.js.map +1 -1
- package/payloads/v1/user.mjs +9 -0
- package/payloads/v1/workspace.d.ts +296 -25
- package/payloads/v1/workspace.js +128 -8
- package/payloads/v1/workspace.js.map +1 -1
- package/payloads/v1/workspace.mjs +115 -7
- package/rest/v1/activity.d.ts +20 -9
- package/rest/v1/activity.js.map +1 -1
- package/rest/v1/api-key.d.ts +26 -0
- package/{payloads/v1/credits.js → rest/v1/api-key.js} +4 -4
- package/rest/v1/api-key.js.map +1 -0
- package/rest/v1/api-key.mjs +1 -0
- package/rest/v1/application.d.ts +302 -30
- package/rest/v1/application.js.map +1 -1
- package/rest/v1/database-data.d.ts +234 -0
- package/rest/v1/database-data.js +19 -0
- package/rest/v1/database-data.js.map +1 -0
- package/rest/v1/database-data.mjs +1 -0
- package/rest/v1/database.d.ts +55 -14
- package/rest/v1/database.js.map +1 -1
- package/rest/v1/github.d.ts +22 -0
- package/rest/v1/{wing.js → github.js} +4 -4
- package/rest/v1/github.js.map +1 -0
- package/rest/v1/github.mjs +1 -0
- package/rest/v1/index.d.ts +16 -11
- package/rest/v1/index.js.map +1 -1
- package/rest/v1/notification.d.ts +2 -3
- package/rest/v1/notification.js.map +1 -1
- package/rest/v1/oauth.d.ts +60 -0
- package/{payloads/v1/wing.js → rest/v1/oauth.js} +4 -4
- package/rest/v1/oauth.js.map +1 -0
- package/rest/v1/oauth.mjs +1 -0
- package/rest/v1/orders.d.ts +28 -7
- package/rest/v1/orders.js.map +1 -1
- package/rest/v1/redeem.d.ts +2 -1
- package/rest/v1/redeem.js.map +1 -1
- package/rest/v1/snapshot.d.ts +45 -10
- package/rest/v1/snapshot.js.map +1 -1
- package/rest/v1/status.d.ts +1 -0
- package/rest/v1/user.d.ts +56 -7
- package/rest/v1/user.js.map +1 -1
- package/rest/v1/workspace.d.ts +186 -18
- package/rest/v1/workspace.js.map +1 -1
- package/v1.d.ts +24 -19
- package/v1.js +630 -10
- package/v1.js.map +1 -1
- package/v1.mjs +590 -9
- package/payloads/v1/credits.d.ts +0 -56
- package/payloads/v1/credits.js.map +0 -1
- package/payloads/v1/credits.mjs +0 -1
- package/payloads/v1/wing.d.ts +0 -133
- package/payloads/v1/wing.js.map +0 -1
- package/payloads/v1/wing.mjs +0 -1
- package/rest/v1/credits.d.ts +0 -17
- package/rest/v1/credits.js.map +0 -1
- package/rest/v1/credits.mjs +0 -1
- package/rest/v1/wing.d.ts +0 -38
- package/rest/v1/wing.js.map +0 -1
- package/rest/v1/wing.mjs +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["application.ts"],"sourcesContent":["import type {\n\tAPIApplication,\n\tAPIApplicationDeployment,\n\tAPIApplicationEnvironment,\n\tAPIApplicationFile,\n\tAPIApplicationFileContent,\n\tAPIApplicationMetric,\n\tAPIApplicationOperationResponse,\n\tAPIApplicationStatus,\n\tAPIApplicationStatusShort,\n\tAPICustomDomainResponse,\n\tAPIDnsRecord,\n\tAPIPayload,\n\tAPISubdomainResponse,\n\tAPIWebhookUrl,\n} from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type RESTGetAPIApplicationResponse = APIPayload<APIApplication>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/status\n */\nexport type RESTGetAPIApplicationStatusResponse = APIPayload<APIApplicationStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/allstatus\n */\nexport type RESTGetAPIApplicationStatusShortResponse = APIPayload<APIApplicationStatusShort>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/logs\n */\nexport type RESTGetAPIApplicationLogsResponse = APIPayload<string>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics\n */\nexport type RESTGetAPIApplicationMetricsResponse = APIPayload<APIApplicationMetric[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files\n */\nexport type RESTGetAPIApplicationFilesResponse = APIPayload<APIApplicationFile[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content\n */\nexport type RESTGetAPIApplicationFileContentResponse = APIPayload<APIApplicationFileContent>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start\n */\nexport type RESTGetAPIApplicationStartResponse = APIPayload<boolean>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart\n */\nexport type RESTGetAPIApplicationRestartResponse = APIPayload<boolean>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/stop\n */\nexport type RESTGetAPIApplicationStopResponse = APIPayload<boolean>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/get\n */\nexport type RESTGetAPIApplicationEnvironmentResponse = APIPayload<APIApplicationEnvironment[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create\n */\nexport type RESTPostAPIApplicationCreateResponse = APIPayload<APIApplication>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/delete\n */\nexport type RESTDeleteAPIApplicationResponse = APIPayload<void>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/download\n */\nexport type RESTGetAPIApplicationDownloadResponse = ArrayBuffer;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime\n */\nexport type RESTGetAPIApplicationRealtimeResponse = EventSource;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start\n */\nexport type RESTPostAPIApplicationStartResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/stop\n */\nexport type RESTPostAPIApplicationStopResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart\n */\nexport type RESTPostAPIApplicationRestartResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/updateconfig\n */\nexport type RESTPostAPIApplicationUpdateConfigResponse = APIPayload<string>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/dnsrecords\n */\nexport type RESTGetAPIApplicationDnsRecordsResponse = APIPayload<APIDnsRecord[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/customdomain\n */\nexport type RESTPostAPIApplicationCustomDomainResponse = APIPayload<APICustomDomainResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/subdomain\n */\nexport type RESTPatchAPIApplicationSubdomainResponse = APIPayload<APISubdomainResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/webhook\n */\nexport type RESTGetAPIApplicationWebhookUrlResponse = APIPayload<APIWebhookUrl>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deployments\n */\nexport type RESTGetAPIApplicationDeploymentsResponse = APIPayload<APIApplicationDeployment[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/applications\n */\nexport type RESTPostAPIApplicationInstallDependenciesBody = {\n\tdependencies: string[];\n};\n\n/**\n * @see https://docs.vertracloud.app/api-reference/applications\n */\nexport type RESTPostAPIApplicationInstallDependenciesResponse = APIPayload<APIApplication>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
1
|
+
{"version":3,"sources":["application.ts"],"sourcesContent":["import type {\n\tAPIApplication,\n\tAPIApplicationCustomDomain,\n\tAPIApplicationDeployment,\n\tAPIApplicationDnsRecord,\n\tAPIApplicationEnvironment,\n\tAPIApplicationFile,\n\tAPIApplicationFileContent,\n\tAPIApplicationFileTree,\n\tAPIApplicationFileUpload,\n\tAPIApplicationMetric,\n\tAPIApplicationOperationResponse,\n\tAPIApplicationRealtimeEvent,\n\tAPIApplicationRuntimes,\n\tAPIApplicationScanSuggestions,\n\tAPIApplicationStatus,\n\tAPIApplicationStatusShort,\n\tAPIApplicationSubdomain,\n\tAPIApplicationWebPublish,\n\tAPIApplicationWebhook,\n\tAPIApplicationWebhookUrl,\n\tAPIPayload,\n\tApplicationLanguage,\n\tISODateString,\n\tRESTAPIWorkspaceQuery,\n} from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes\n */\nexport type RESTGetAPIApplicationRuntimesResponse = APIPayload<APIApplicationRuntimes>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type RESTGetAPIApplicationResponse = APIPayload<APIApplication>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/status\n */\nexport type RESTGetAPIApplicationStatusResponse = APIPayload<APIApplicationStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/allstatus\n */\nexport type RESTGetAPIApplicationStatusShortResponse = APIPayload<APIApplicationStatusShort[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/logs\n */\nexport type RESTGetAPIApplicationLogsResponse = APIPayload<string>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics\n */\nexport interface RESTGetAPIApplicationMetricsQuery extends RESTAPIWorkspaceQuery {\n\trange?: \"10m\" | \"30m\" | \"24h\";\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics\n */\nexport type RESTGetAPIApplicationMetricsResponse = APIPayload<APIApplicationMetric[]>;\n\n/**\n * `GET /v1/apps/:id/files`. `path` absent = the application root.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files\n */\nexport interface RESTGetAPIApplicationFilesQuery extends RESTAPIWorkspaceQuery {\n\tpath?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files\n */\nexport type RESTGetAPIApplicationFilesResponse = APIPayload<APIApplicationFile[]>;\n\n/**\n * `GET /v1/apps/:id/files/tree` — the whole file tree (depth-limited), as a list of root entries.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/tree\n */\nexport type RESTGetAPIApplicationFileTreeResponse = APIPayload<APIApplicationFileTree[]>;\n\n/**\n * `GET /v1/apps/:id/files/content`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content\n */\nexport interface RESTGetAPIApplicationFileContentQuery extends RESTAPIWorkspaceQuery {\n\tpath: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content\n */\nexport type RESTGetAPIApplicationFileContentResponse = APIPayload<APIApplicationFileContent>;\n\n/**\n * `POST /v1/apps/:id/files/upload` (multipart zip). `restart: \"true\"` restarts the app after the upload.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload\n */\nexport interface RESTPostAPIApplicationFileUploadQuery extends RESTAPIWorkspaceQuery {\n\trestart?: \"true\" | \"false\";\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload\n */\nexport type RESTPostAPIApplicationFileUploadResponse = APIPayload<APIApplicationFileUpload>;\n\n/**\n * Creates or overwrites a file. Without `content`, creates (or truncates to) an empty file.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/save\n */\nexport interface RESTPutAPIApplicationFileBody {\n\tpath: string;\n\tcontent?: string;\n\t/** ISO 8601 datetime from the last read; a mismatch returns `409 FILE_MODIFIED`. */\n\tlast_modified?: ISODateString;\n\tworkspace_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/save\n */\nexport type RESTPutAPIApplicationFileResponse = APIPayload<null>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/delete\n */\nexport interface RESTDeleteAPIApplicationFileBody {\n\tpath: string;\n\tworkspace_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/delete\n */\nexport type RESTDeleteAPIApplicationFileResponse = APIPayload<null>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/move\n */\nexport interface RESTPatchAPIApplicationFileMoveBody {\n\tpath: string;\n\tto: string;\n\tworkspace_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/move\n */\nexport type RESTPatchAPIApplicationFileMoveResponse = APIPayload<null>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/get\n */\nexport type RESTGetAPIApplicationEnvironmentResponse = APIPayload<APIApplicationEnvironment[]>;\n\n/**\n * One variable of the `POST /apps/:id/envs` body. `note: null` clears the existing note.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit\n */\nexport interface RESTPostAPIApplicationEnvironmentVariableBody {\n\tkey: string;\n\tvalue: string;\n\tnote?: string | null;\n}\n\n/**\n * Body of `POST /apps/:id/envs`: a single object (one variable) or an array (batch), with no repeated keys.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit\n */\nexport type RESTPostAPIApplicationEnvironmentBody = RESTPostAPIApplicationEnvironmentVariableBody | RESTPostAPIApplicationEnvironmentVariableBody[];\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit\n */\nexport type RESTPostAPIApplicationEnvironmentResponse = APIPayload<APIApplicationEnvironment[]>;\n\n/**\n * `DELETE /v1/apps/:id/envs/:envId`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/delete\n */\nexport type RESTDeleteAPIApplicationEnvironmentResponse = APIPayload<null>;\n\n/**\n * Body of `POST /apps` — **`multipart/form-data`**, not JSON. Each field below is one multipart\n * part: `file` as a file and **every other field as a text field** (including `snapshot_id`,\n * `memory` and `envs`, the latter as a JSON-serialized string).\n *\n * The application has **two mutually exclusive sources**:\n *\n * - `file` — the zip uploaded by the user;\n * - `snapshot_id` — alternative to `file`: the app is created from that snapshot (which already\n * includes its `vertracloud.config`).\n *\n * **Exactly one of them must be present.** Neither → `SOURCE_REQUIRED`; both →\n * `SOURCE_CONFLICT`.\n *\n * Error codes:\n *\n * - `SOURCE_REQUIRED` — neither `file` nor `snapshot_id`.\n * - `SOURCE_CONFLICT` — `file` and `snapshot_id` together.\n * - `SNAPSHOT_NOT_FOUND` — the snapshot does not exist or does not belong to the user.\n * - `SNAPSHOT_TYPE_MISMATCH` — the snapshot is from a database, not an application.\n * - `SNAPSHOT_TOO_LARGE` — the snapshot exceeds the size limit for creation.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create\n */\nexport interface RESTPostAPIApplicationCreateBody {\n\t/** Application zip. Absent when the source is `snapshot_id`. */\n\tfile?: unknown;\n\t/**\n\t * Alternative to `file`: id of the **application** snapshot to create the app from. Sent as a\n\t * multipart text field. Exactly one of `file` and `snapshot_id`.\n\t */\n\tsnapshot_id?: string;\n\tname: string;\n\tdescription?: string | null;\n\t/** RAM in MB. Multipart text field. Required with `file`; with `snapshot_id` defaults to the snapshot's config. */\n\tmemory?: number;\n\t/** Required with `file`; with `snapshot_id` defaults to the snapshot's config. */\n\tmain?: string;\n\t/** Required with `file`; with `snapshot_id` defaults to the snapshot's config. */\n\tversion?: string;\n\tstart?: string;\n\t/** Build command (see `APIApplication.build_command`). */\n\tbuild?: string;\n\t/** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */\n\tautorestart?: boolean;\n\t/** `\"random\"` = the platform picks one at random. */\n\tsubdomain?: string;\n\tworkspace_id?: string;\n\t/** JSON-serialized string in the multipart body. */\n\tenvs?: RESTPostAPIApplicationEnvironmentVariableBody[];\n}\n\n/**\n * The created application, plus the directories removed from the uploaded zip.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create\n */\nexport type RESTPostAPIApplicationCreateResponse = APIPayload<APIApplication & { removed_directories: string[] }>;\n\n/**\n * Scans a zip before creating the application and returns suggestions (start/build command,\n * memory). Creates nothing.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan\n */\nexport interface RESTPostAPIApplicationScanBody {\n\t/** Application zip. */\n\tfile: unknown;\n\t/** Main file of the application — used only to infer the language, as on create. */\n\tmain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan\n */\nexport type RESTPostAPIApplicationScanResponse = APIPayload<APIApplicationScanSuggestions>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/delete\n */\nexport type RESTDeleteAPIApplicationResponse = APIPayload<null>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/download\n */\nexport type RESTGetAPIApplicationDownloadResponse = ArrayBuffer;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime\n */\nexport interface RESTGetAPIApplicationRealtimeQuery extends RESTAPIWorkspaceQuery {\n\tsince?: number;\n}\n\n/**\n * The route answers with a `text/event-stream`; this is the shape of each event in it.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime\n */\nexport type RESTGetAPIApplicationRealtimeResponse = APIApplicationRealtimeEvent;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start\n */\nexport type RESTPostAPIApplicationStartResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/stop\n */\nexport type RESTPostAPIApplicationStopResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * Optional restart body. No body = regular restart, reusing the install and build cache.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart\n */\nexport interface RESTPostAPIApplicationRestartBody {\n\t/** Reinstalls dependencies from scratch, ignoring the install cache. */\n\treinstall_dependencies?: boolean;\n\t/** Runs the build command again even without code changes. Counts as a deploy toward the hourly limit. */\n\tforce_build?: boolean;\n\t/**\n\t * After changing the app's language, removes the dependencies left by the previous runtime.\n\t * Must differ from the current language (`CLEANUP_LANGUAGE_SAME_AS_CURRENT`).\n\t */\n\tcleanup_old_runtime_language?: ApplicationLanguage;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart\n */\nexport type RESTPostAPIApplicationRestartResponse = APIPayload<APIApplicationOperationResponse>;\n\n/**\n * Body for updating the app configuration. Every field is optional, but at least one must be\n * provided.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/updateconfig\n */\nexport interface RESTPatchAPIApplicationUpdateConfigBody {\n\tname?: string;\n\tdescription?: string | null;\n\tmain_file?: string;\n\tversion?: string;\n\tauto_restart?: boolean;\n\tstart_command?: string | null;\n\tbuild_command?: string | null;\n\tram?: number;\n\tlanguage?: ApplicationLanguage;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/updateconfig\n */\nexport type RESTPatchAPIApplicationUpdateConfigResponse = APIPayload<string>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns\n */\nexport type RESTGetAPIApplicationDnsRecordsResponse = APIPayload<APIApplicationDnsRecord[]>;\n\n/**\n * Purges the edge cache of a published application.\n *\n * `hostnames` absent or empty = every host of the application (subdomain and custom domain).\n * When provided, each host must belong to the application. `paths` narrows the purge to\n * specific URLs within those hosts.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/purgecache\n */\nexport interface RESTPostAPIApplicationPurgeCacheBody {\n\thostnames?: string[];\n\tpaths?: string[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/purgecache\n */\nexport type RESTPostAPIApplicationPurgeCacheResponse = APIPayload<null>;\n\n/**\n * `GET /v1/apps/:id/network/custom` — `404 NO_CUSTOM_DOMAIN` when the application has none.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain\n */\nexport type RESTGetAPIApplicationCustomDomainResponse = APIPayload<APIApplicationCustomDomain>;\n\n/**\n * `POST /v1/apps/:id/network/custom`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain\n */\nexport interface RESTPostAPIApplicationCustomDomainBody {\n\tdomain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain\n */\nexport type RESTPostAPIApplicationCustomDomainResponse = APIPayload<APIApplicationCustomDomain>;\n\n/**\n * `DELETE /v1/apps/:id/network/custom`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain\n */\nexport type RESTDeleteAPIApplicationCustomDomainResponse = APIPayload<null>;\n\n/**\n * `PATCH /v1/apps/:id/network/subdomain`. Only the label (`my-app`), 3–50 characters.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain\n */\nexport interface RESTPatchAPIApplicationSubdomainBody {\n\tsubdomain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain\n */\nexport type RESTPatchAPIApplicationSubdomainResponse = APIPayload<APIApplicationSubdomain>;\n\n/**\n * Turns on web publishing for an application created without it.\n * `subdomain` absent = the platform picks one at random; choosing one requires a plan with custom subdomains.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish\n */\nexport interface RESTPostAPIApplicationWebPublishBody {\n\tsubdomain?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish\n */\nexport type RESTPostAPIApplicationWebPublishResponse = APIPayload<APIApplicationWebPublish>;\n\n/**\n * Turns off web publishing: releases the subdomain, removes the custom domain and makes the application private again.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish\n */\nexport type RESTDeleteAPIApplicationWebPublishResponse = APIPayload<APIApplicationWebPublish>;\n\n/**\n * `GET /v1/apps/:id/deploys/webhook`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/webhookurl\n */\nexport type RESTGetAPIApplicationWebhookUrlResponse = APIPayload<APIApplicationWebhook>;\n\n/**\n * Creates the auto-deploy webhook from an already connected repository.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create\n */\nexport interface RESTPostAPIApplicationWebhookCreateBody {\n\towner: string;\n\trepo_name: string;\n\trepo_id: string;\n\taccount_id: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create\n */\nexport type RESTPostAPIApplicationWebhookCreateResponse = APIPayload<APIApplicationWebhookUrl>;\n\n/**\n * `DELETE /v1/apps/:id/deploys/webhook`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/delete\n */\nexport type RESTDeleteAPIApplicationWebhookResponse = APIPayload<null>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/recents\n */\nexport type RESTGetAPIApplicationDeploymentsResponse = APIPayload<APIApplicationDeployment[]>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
import { APIDatabaseMongoIndex, APIDatabaseCollection, APIDatabaseDataOverview, APIDatabaseDocumentsPage, APIDatabaseRedisInfo, APIDatabaseRedisKeyValue, APIDatabaseRedisKeysPage, APIDatabaseSchema, APIDatabaseColumn, APIDatabaseIndex, APIDatabaseRowsPage, APIDatabaseTable, APIDatabaseQueryResult, DatabaseRedisKeyType } from '../../payloads/v1/database-data.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Envelopes of the database **Data** tab.
|
|
5
|
+
*
|
|
6
|
+
* **`Result`** suffix (not `Response`): these routes return `{ response }` with a **required**
|
|
7
|
+
* `response` — never `{ code }` on a 2xx. `APIPayload<T>` marks `response` as optional. This is
|
|
8
|
+
* the only endpoint family with that guarantee; the rest of the contract uses
|
|
9
|
+
* `REST…Response = APIPayload<T>`.
|
|
10
|
+
*
|
|
11
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* `GET /v1/databases/:id/data/overview`
|
|
15
|
+
*
|
|
16
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview
|
|
17
|
+
*/
|
|
18
|
+
interface RESTGetAPIDatabaseDataOverviewResult {
|
|
19
|
+
response: APIDatabaseDataOverview;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* `GET /v1/databases/:id/data/schemas`
|
|
23
|
+
*
|
|
24
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/schemas
|
|
25
|
+
*/
|
|
26
|
+
interface RESTGetAPIDatabaseSchemasResult {
|
|
27
|
+
response: APIDatabaseSchema[];
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* `GET /v1/databases/:id/data/tables?schema=`
|
|
31
|
+
*
|
|
32
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
|
|
33
|
+
*/
|
|
34
|
+
interface RESTGetAPIDatabaseTablesResult {
|
|
35
|
+
response: APIDatabaseTable[];
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* `GET /v1/databases/:id/data/tables/:table/columns?schema=`
|
|
39
|
+
*
|
|
40
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
|
|
41
|
+
*/
|
|
42
|
+
interface RESTGetAPIDatabaseTableColumnsResult {
|
|
43
|
+
response: {
|
|
44
|
+
columns: APIDatabaseColumn[];
|
|
45
|
+
indexes: APIDatabaseIndex[];
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* `GET /v1/databases/:id/data/tables/:table/rows?schema=&page=&per_page=&filter=&sort=&direction=`
|
|
50
|
+
*
|
|
51
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
|
|
52
|
+
*/
|
|
53
|
+
interface RESTGetAPIDatabaseTableRowsResult {
|
|
54
|
+
response: APIDatabaseRowsPage;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* `POST /v1/databases/:id/data/query` — SQL console. Runs as the database's own user, with a
|
|
58
|
+
* time limit (10 s), a row limit (`limit`) and a serialized size limit.
|
|
59
|
+
*
|
|
60
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query
|
|
61
|
+
*/
|
|
62
|
+
interface RESTPostAPIDatabaseQueryBody {
|
|
63
|
+
sql: string;
|
|
64
|
+
/** Maximum rows returned. The result is cut and marked `truncated`. */
|
|
65
|
+
limit?: number;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query
|
|
69
|
+
*/
|
|
70
|
+
interface RESTPostAPIDatabaseQueryResult {
|
|
71
|
+
response: APIDatabaseQueryResult;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* `POST /v1/databases/:id/data/rows` — new row. No `primary_key`, since it does not exist yet.
|
|
75
|
+
*
|
|
76
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
|
|
77
|
+
*/
|
|
78
|
+
interface RESTPostAPIDatabaseRowCreateBody {
|
|
79
|
+
schema: string;
|
|
80
|
+
table: string;
|
|
81
|
+
values: Record<string, unknown>;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* `PUT /v1/databases/:id/data/rows` — an existing row is **always** identified by its full
|
|
85
|
+
* primary key (`{ id: 42 }` or composite `{ tenant_id: 1, user_id: 9 }`), never by its
|
|
86
|
+
* position on the page.
|
|
87
|
+
*
|
|
88
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
|
|
89
|
+
*/
|
|
90
|
+
interface RESTPutAPIDatabaseRowUpdateBody {
|
|
91
|
+
schema: string;
|
|
92
|
+
table: string;
|
|
93
|
+
primary_key: Record<string, unknown>;
|
|
94
|
+
values: Record<string, unknown>;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* `DELETE /v1/databases/:id/data/rows`
|
|
98
|
+
*
|
|
99
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
|
|
100
|
+
*/
|
|
101
|
+
interface RESTDeleteAPIDatabaseRowsBody {
|
|
102
|
+
schema: string;
|
|
103
|
+
table: string;
|
|
104
|
+
primary_keys: Record<string, unknown>[];
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
|
|
108
|
+
*/
|
|
109
|
+
interface RESTMutateAPIDatabaseRowsResult {
|
|
110
|
+
response: {
|
|
111
|
+
affected: number;
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* `GET /v1/databases/:id/data/collections`
|
|
116
|
+
*
|
|
117
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections
|
|
118
|
+
*/
|
|
119
|
+
interface RESTGetAPIDatabaseCollectionsResult {
|
|
120
|
+
response: APIDatabaseCollection[];
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* `GET /v1/databases/:id/data/collections/:name/indexes`
|
|
124
|
+
*
|
|
125
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections
|
|
126
|
+
*/
|
|
127
|
+
interface RESTGetAPIDatabaseCollectionIndexesResult {
|
|
128
|
+
response: APIDatabaseMongoIndex[];
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* `GET /v1/databases/:id/data/collections/:name/documents?page=&per_page=&filter=&sort=`
|
|
132
|
+
*
|
|
133
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
|
|
134
|
+
*/
|
|
135
|
+
interface RESTGetAPIDatabaseDocumentsResult {
|
|
136
|
+
response: APIDatabaseDocumentsPage;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* `POST /v1/databases/:id/data/collections/:name/documents` — the collection goes in the path.
|
|
140
|
+
*
|
|
141
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
|
|
142
|
+
*/
|
|
143
|
+
interface RESTPostAPIDatabaseDocumentCreateBody {
|
|
144
|
+
document: Record<string, unknown>;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* `PUT /v1/databases/:id/data/collections/:name/documents/:doc_id` — collection and `doc_id`
|
|
148
|
+
* come from the path.
|
|
149
|
+
*
|
|
150
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
|
|
151
|
+
*/
|
|
152
|
+
interface RESTPutAPIDatabaseDocumentUpdateBody {
|
|
153
|
+
document: Record<string, unknown>;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* `DELETE /v1/databases/:id/data/collections/:name/documents` — the collection goes in the path.
|
|
157
|
+
*
|
|
158
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
|
|
159
|
+
*/
|
|
160
|
+
interface RESTDeleteAPIDatabaseDocumentsBody {
|
|
161
|
+
ids: string[];
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
|
|
165
|
+
*/
|
|
166
|
+
interface RESTMutateAPIDatabaseDocumentsResult {
|
|
167
|
+
response: {
|
|
168
|
+
affected: number;
|
|
169
|
+
};
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* `GET /v1/databases/:id/data/keys?pattern=&cursor=&count=` — uses `SCAN`, never `KEYS`.
|
|
173
|
+
*
|
|
174
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
175
|
+
*/
|
|
176
|
+
interface RESTGetAPIDatabaseRedisKeysResult {
|
|
177
|
+
response: APIDatabaseRedisKeysPage;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* `GET /v1/databases/:id/data/keys/:key`
|
|
181
|
+
*
|
|
182
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
183
|
+
*/
|
|
184
|
+
interface RESTGetAPIDatabaseRedisKeyValueResult {
|
|
185
|
+
response: APIDatabaseRedisKeyValue;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* `GET /v1/databases/:id/data/info`
|
|
189
|
+
*
|
|
190
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/info
|
|
191
|
+
*/
|
|
192
|
+
interface RESTGetAPIDatabaseRedisInfoResult {
|
|
193
|
+
response: APIDatabaseRedisInfo;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* `PUT /v1/databases/:id/data/keys/:key`
|
|
197
|
+
*
|
|
198
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
199
|
+
*/
|
|
200
|
+
interface RESTPutAPIDatabaseRedisKeyBody {
|
|
201
|
+
/** The key also goes in the path (`:key`); the path wins — this field is redundant by design. */
|
|
202
|
+
key: string;
|
|
203
|
+
type: DatabaseRedisKeyType;
|
|
204
|
+
value: APIDatabaseRedisKeyValue["value"];
|
|
205
|
+
/** `null` = remove the TTL; absent = keep the current one. */
|
|
206
|
+
ttl_seconds?: number | null;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* `DELETE /v1/databases/:id/data/keys`
|
|
210
|
+
*
|
|
211
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
212
|
+
*/
|
|
213
|
+
interface RESTDeleteAPIDatabaseRedisKeysBody {
|
|
214
|
+
keys: string[];
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* `PUT /v1/databases/:id/data/keys/:key/expire` — `ttl_seconds: null` = `PERSIST`.
|
|
218
|
+
*
|
|
219
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
220
|
+
*/
|
|
221
|
+
interface RESTPutAPIDatabaseRedisKeyExpireBody {
|
|
222
|
+
/** `null` = `PERSIST`. */
|
|
223
|
+
ttl_seconds: number | null;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
|
|
227
|
+
*/
|
|
228
|
+
interface RESTMutateAPIDatabaseRedisKeysResult {
|
|
229
|
+
response: {
|
|
230
|
+
affected: number;
|
|
231
|
+
};
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
export type { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody };
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// rest/v1/database-data.ts
|
|
17
|
+
var database_data_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(database_data_exports);
|
|
19
|
+
//# sourceMappingURL=database-data.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["database-data.ts"],"sourcesContent":["import type {\n\tAPIDatabaseCollection,\n\tAPIDatabaseColumn,\n\tAPIDatabaseDataOverview,\n\tAPIDatabaseDocumentsPage,\n\tAPIDatabaseIndex,\n\tAPIDatabaseMongoIndex,\n\tAPIDatabaseQueryResult,\n\tAPIDatabaseRedisInfo,\n\tAPIDatabaseRedisKeyValue,\n\tAPIDatabaseRedisKeysPage,\n\tAPIDatabaseRowsPage,\n\tAPIDatabaseSchema,\n\tAPIDatabaseTable,\n\tDatabaseRedisKeyType,\n} from \"../../v1\";\n\n/**\n * Envelopes of the database **Data** tab.\n *\n * **`Result`** suffix (not `Response`): these routes return `{ response }` with a **required**\n * `response` — never `{ code }` on a 2xx. `APIPayload<T>` marks `response` as optional. This is\n * the only endpoint family with that guarantee; the rest of the contract uses\n * `REST…Response = APIPayload<T>`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview\n */\n\n// ---------------------------------------------------------------------------\n// Common\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/databases/:id/data/overview`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview\n */\nexport interface RESTGetAPIDatabaseDataOverviewResult {\n\tresponse: APIDatabaseDataOverview;\n}\n\n// ---------------------------------------------------------------------------\n// SQL (PostgreSQL / MySQL)\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/databases/:id/data/schemas`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/schemas\n */\nexport interface RESTGetAPIDatabaseSchemasResult {\n\tresponse: APIDatabaseSchema[];\n}\n\n/**\n * `GET /v1/databases/:id/data/tables?schema=`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface RESTGetAPIDatabaseTablesResult {\n\tresponse: APIDatabaseTable[];\n}\n\n/**\n * `GET /v1/databases/:id/data/tables/:table/columns?schema=`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface RESTGetAPIDatabaseTableColumnsResult {\n\tresponse: { columns: APIDatabaseColumn[]; indexes: APIDatabaseIndex[] };\n}\n\n/**\n * `GET /v1/databases/:id/data/tables/:table/rows?schema=&page=&per_page=&filter=&sort=&direction=`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface RESTGetAPIDatabaseTableRowsResult {\n\tresponse: APIDatabaseRowsPage;\n}\n\n/**\n * `POST /v1/databases/:id/data/query` — SQL console. Runs as the database's own user, with a\n * time limit (10 s), a row limit (`limit`) and a serialized size limit.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query\n */\nexport interface RESTPostAPIDatabaseQueryBody {\n\tsql: string;\n\t/** Maximum rows returned. The result is cut and marked `truncated`. */\n\tlimit?: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query\n */\nexport interface RESTPostAPIDatabaseQueryResult {\n\tresponse: APIDatabaseQueryResult;\n}\n\n/**\n * `POST /v1/databases/:id/data/rows` — new row. No `primary_key`, since it does not exist yet.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface RESTPostAPIDatabaseRowCreateBody {\n\tschema: string;\n\ttable: string;\n\tvalues: Record<string, unknown>;\n}\n\n/**\n * `PUT /v1/databases/:id/data/rows` — an existing row is **always** identified by its full\n * primary key (`{ id: 42 }` or composite `{ tenant_id: 1, user_id: 9 }`), never by its\n * position on the page.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface RESTPutAPIDatabaseRowUpdateBody {\n\tschema: string;\n\ttable: string;\n\tprimary_key: Record<string, unknown>;\n\tvalues: Record<string, unknown>;\n}\n\n/**\n * `DELETE /v1/databases/:id/data/rows`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface RESTDeleteAPIDatabaseRowsBody {\n\tschema: string;\n\ttable: string;\n\tprimary_keys: Record<string, unknown>[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface RESTMutateAPIDatabaseRowsResult {\n\tresponse: { affected: number };\n}\n\n// ---------------------------------------------------------------------------\n// MongoDB\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/databases/:id/data/collections`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections\n */\nexport interface RESTGetAPIDatabaseCollectionsResult {\n\tresponse: APIDatabaseCollection[];\n}\n\n/**\n * `GET /v1/databases/:id/data/collections/:name/indexes`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections\n */\nexport interface RESTGetAPIDatabaseCollectionIndexesResult {\n\tresponse: APIDatabaseMongoIndex[];\n}\n\n/**\n * `GET /v1/databases/:id/data/collections/:name/documents?page=&per_page=&filter=&sort=`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface RESTGetAPIDatabaseDocumentsResult {\n\tresponse: APIDatabaseDocumentsPage;\n}\n\n/**\n * `POST /v1/databases/:id/data/collections/:name/documents` — the collection goes in the path.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface RESTPostAPIDatabaseDocumentCreateBody {\n\tdocument: Record<string, unknown>;\n}\n\n/**\n * `PUT /v1/databases/:id/data/collections/:name/documents/:doc_id` — collection and `doc_id`\n * come from the path.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface RESTPutAPIDatabaseDocumentUpdateBody {\n\tdocument: Record<string, unknown>;\n}\n\n/**\n * `DELETE /v1/databases/:id/data/collections/:name/documents` — the collection goes in the path.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface RESTDeleteAPIDatabaseDocumentsBody {\n\tids: string[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface RESTMutateAPIDatabaseDocumentsResult {\n\tresponse: { affected: number };\n}\n\n// ---------------------------------------------------------------------------\n// Redis\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/databases/:id/data/keys?pattern=&cursor=&count=` — uses `SCAN`, never `KEYS`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTGetAPIDatabaseRedisKeysResult {\n\tresponse: APIDatabaseRedisKeysPage;\n}\n\n/**\n * `GET /v1/databases/:id/data/keys/:key`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTGetAPIDatabaseRedisKeyValueResult {\n\tresponse: APIDatabaseRedisKeyValue;\n}\n\n/**\n * `GET /v1/databases/:id/data/info`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/info\n */\nexport interface RESTGetAPIDatabaseRedisInfoResult {\n\tresponse: APIDatabaseRedisInfo;\n}\n\n/**\n * `PUT /v1/databases/:id/data/keys/:key`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTPutAPIDatabaseRedisKeyBody {\n\t/** The key also goes in the path (`:key`); the path wins — this field is redundant by design. */\n\tkey: string;\n\ttype: DatabaseRedisKeyType;\n\tvalue: APIDatabaseRedisKeyValue[\"value\"];\n\t/** `null` = remove the TTL; absent = keep the current one. */\n\tttl_seconds?: number | null;\n}\n\n/**\n * `DELETE /v1/databases/:id/data/keys`\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTDeleteAPIDatabaseRedisKeysBody {\n\tkeys: string[];\n}\n\n/**\n * `PUT /v1/databases/:id/data/keys/:key/expire` — `ttl_seconds: null` = `PERSIST`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTPutAPIDatabaseRedisKeyExpireBody {\n\t/** `null` = `PERSIST`. */\n\tttl_seconds: number | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface RESTMutateAPIDatabaseRedisKeysResult {\n\tresponse: { affected: number };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//# sourceMappingURL=database-data.mjs.map
|
package/rest/v1/database.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { APIPayload } from '../../common/v1.js';
|
|
2
|
-
import { APIDatabase, APIDatabaseStatus, APIDatabaseStatusShort,
|
|
1
|
+
import { APIPayload, SnowFlake } from '../../common/v1.js';
|
|
2
|
+
import { APIDatabaseCertificate, APIDatabaseMetrics, APIDatabase, APIDatabaseStatus, APIDatabaseStatusShort, DatabaseType, APIDatabasePasswordReset, APIDatabaseOperationResponse } from '../../payloads/v1/database.js';
|
|
3
|
+
import '../../payloads/v1/api-error.js';
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
|
|
@@ -12,7 +13,7 @@ type RESTGetAPIDatabaseStatusResponse = APIPayload<APIDatabaseStatus>;
|
|
|
12
13
|
/**
|
|
13
14
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/allstatus
|
|
14
15
|
*/
|
|
15
|
-
type RESTGetAPIDatabaseStatusShortResponse = APIPayload<APIDatabaseStatusShort>;
|
|
16
|
+
type RESTGetAPIDatabaseStatusShortResponse = APIPayload<APIDatabaseStatusShort[]>;
|
|
16
17
|
/**
|
|
17
18
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/metrics
|
|
18
19
|
*/
|
|
@@ -20,42 +21,82 @@ type RESTGetAPIDatabaseMetricsResponse = APIPayload<APIDatabaseMetrics[]>;
|
|
|
20
21
|
/**
|
|
21
22
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/start
|
|
22
23
|
*/
|
|
23
|
-
type
|
|
24
|
+
type RESTPostAPIDatabaseStartResponse = APIPayload<APIDatabaseOperationResponse>;
|
|
24
25
|
/**
|
|
25
|
-
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/
|
|
26
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/stop
|
|
26
27
|
*/
|
|
27
|
-
type
|
|
28
|
+
type RESTPostAPIDatabaseStopResponse = APIPayload<APIDatabaseOperationResponse>;
|
|
28
29
|
/**
|
|
29
|
-
*
|
|
30
|
+
* Body of `POST /databases` — JSON.
|
|
31
|
+
*
|
|
32
|
+
* `snapshot_id` creates the database with the **snapshot's engine** (its `resource_type`) and
|
|
33
|
+
* restores its data instead of starting empty. If `type` is also sent, it **must match** the
|
|
34
|
+
* snapshot's engine; otherwise creation is rejected.
|
|
35
|
+
*
|
|
36
|
+
* Error codes:
|
|
37
|
+
*
|
|
38
|
+
* - `SNAPSHOT_NOT_FOUND` — the snapshot does not exist or does not belong to the user.
|
|
39
|
+
* - `SNAPSHOT_TYPE_MISMATCH` — the snapshot is from an application, or `type` does not match
|
|
40
|
+
* the snapshot's engine.
|
|
41
|
+
* - `SNAPSHOT_TOO_LARGE` — the snapshot exceeds the size limit for creation.
|
|
42
|
+
*
|
|
43
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/create
|
|
30
44
|
*/
|
|
31
|
-
|
|
45
|
+
interface RESTPostAPIDatabaseCreateBody {
|
|
46
|
+
name: string;
|
|
47
|
+
description?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* Database engine. **Optional** with `snapshot_id` — the engine comes from the snapshot; if
|
|
50
|
+
* provided, it must match it (`SNAPSHOT_TYPE_MISMATCH`).
|
|
51
|
+
*/
|
|
52
|
+
type?: DatabaseType;
|
|
53
|
+
/** RAM in MB. */
|
|
54
|
+
ram: number;
|
|
55
|
+
workspace_id?: string;
|
|
56
|
+
/** Creates the database from a database snapshot: snapshot's engine + restored data. */
|
|
57
|
+
snapshot_id?: string;
|
|
58
|
+
}
|
|
32
59
|
/**
|
|
33
60
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/create
|
|
34
61
|
*/
|
|
35
62
|
type RESTPostAPIDatabaseCreateResponse = APIPayload<APIDatabase>;
|
|
36
63
|
/**
|
|
64
|
+
* Returns the id of the deleted database.
|
|
37
65
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/delete
|
|
38
66
|
*/
|
|
39
|
-
type RESTDeleteAPIDatabaseResponse = APIPayload<
|
|
67
|
+
type RESTDeleteAPIDatabaseResponse = APIPayload<SnowFlake>;
|
|
68
|
+
/**
|
|
69
|
+
* Body of `PUT /databases/:id`. Every field is optional. `description: null` (or empty) clears it.
|
|
70
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/update
|
|
71
|
+
*/
|
|
72
|
+
interface RESTPutAPIDatabaseUpdateBody {
|
|
73
|
+
/** 1–50 characters. */
|
|
74
|
+
name?: string;
|
|
75
|
+
/** Up to 128 characters. */
|
|
76
|
+
description?: string | null;
|
|
77
|
+
/** RAM in MB. */
|
|
78
|
+
ram?: number;
|
|
79
|
+
}
|
|
40
80
|
/**
|
|
41
81
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/update
|
|
42
82
|
*/
|
|
43
|
-
type RESTPutAPIDatabaseUpdateResponse = APIPayload<
|
|
83
|
+
type RESTPutAPIDatabaseUpdateResponse = APIPayload<APIDatabaseOperationResponse>;
|
|
44
84
|
/**
|
|
45
85
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/reset
|
|
46
86
|
*/
|
|
47
|
-
type RESTPostAPIDatabaseResetResponse = APIPayload<
|
|
87
|
+
type RESTPostAPIDatabaseResetResponse = APIPayload<APIDatabaseOperationResponse>;
|
|
48
88
|
/**
|
|
49
89
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/get
|
|
50
90
|
*/
|
|
51
|
-
type RESTGetAPIDatabaseCertificateResponse =
|
|
91
|
+
type RESTGetAPIDatabaseCertificateResponse = APIPayload<APIDatabaseCertificate>;
|
|
52
92
|
/**
|
|
93
|
+
* Returns the newly issued certificate.
|
|
53
94
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/reset
|
|
54
95
|
*/
|
|
55
|
-
type RESTPostAPIDatabaseResetCertificateResponse = APIPayload<
|
|
96
|
+
type RESTPostAPIDatabaseResetCertificateResponse = APIPayload<APIDatabaseCertificate>;
|
|
56
97
|
/**
|
|
57
98
|
* @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/resetpassword
|
|
58
99
|
*/
|
|
59
100
|
type RESTPostAPIDatabaseResetPasswordResponse = APIPayload<APIDatabasePasswordReset>;
|
|
60
101
|
|
|
61
|
-
export type { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse,
|
|
102
|
+
export type { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse };
|
package/rest/v1/database.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["database.ts"],"sourcesContent":["import type { APIDatabase, APIDatabaseMetrics, APIDatabasePasswordReset, APIDatabaseStatus, APIDatabaseStatusShort, APIPayload } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport type RESTGetAPIDatabaseResponse = APIPayload<APIDatabase>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/status\n */\nexport type RESTGetAPIDatabaseStatusResponse = APIPayload<APIDatabaseStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/allstatus\n */\nexport type RESTGetAPIDatabaseStatusShortResponse = APIPayload<APIDatabaseStatusShort>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/metrics\n */\nexport type RESTGetAPIDatabaseMetricsResponse = APIPayload<APIDatabaseMetrics[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/start\n */\nexport type
|
|
1
|
+
{"version":3,"sources":["database.ts"],"sourcesContent":["import type { APIDatabase, APIDatabaseCertificate, APIDatabaseMetrics, APIDatabaseOperationResponse, APIDatabasePasswordReset, APIDatabaseStatus, APIDatabaseStatusShort, APIPayload, DatabaseType, SnowFlake } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport type RESTGetAPIDatabaseResponse = APIPayload<APIDatabase>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/status\n */\nexport type RESTGetAPIDatabaseStatusResponse = APIPayload<APIDatabaseStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/allstatus\n */\nexport type RESTGetAPIDatabaseStatusShortResponse = APIPayload<APIDatabaseStatusShort[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/metrics\n */\nexport type RESTGetAPIDatabaseMetricsResponse = APIPayload<APIDatabaseMetrics[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/start\n */\nexport type RESTPostAPIDatabaseStartResponse = APIPayload<APIDatabaseOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/stop\n */\nexport type RESTPostAPIDatabaseStopResponse = APIPayload<APIDatabaseOperationResponse>;\n\n/**\n * Body of `POST /databases` — JSON.\n *\n * `snapshot_id` creates the database with the **snapshot's engine** (its `resource_type`) and\n * restores its data instead of starting empty. If `type` is also sent, it **must match** the\n * snapshot's engine; otherwise creation is rejected.\n *\n * Error codes:\n *\n * - `SNAPSHOT_NOT_FOUND` — the snapshot does not exist or does not belong to the user.\n * - `SNAPSHOT_TYPE_MISMATCH` — the snapshot is from an application, or `type` does not match\n * the snapshot's engine.\n * - `SNAPSHOT_TOO_LARGE` — the snapshot exceeds the size limit for creation.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/create\n */\nexport interface RESTPostAPIDatabaseCreateBody {\n\tname: string;\n\tdescription?: string | null;\n\t/**\n\t * Database engine. **Optional** with `snapshot_id` — the engine comes from the snapshot; if\n\t * provided, it must match it (`SNAPSHOT_TYPE_MISMATCH`).\n\t */\n\ttype?: DatabaseType;\n\t/** RAM in MB. */\n\tram: number;\n\tworkspace_id?: string;\n\t/** Creates the database from a database snapshot: snapshot's engine + restored data. */\n\tsnapshot_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/create\n */\nexport type RESTPostAPIDatabaseCreateResponse = APIPayload<APIDatabase>;\n\n/**\n * Returns the id of the deleted database.\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/delete\n */\nexport type RESTDeleteAPIDatabaseResponse = APIPayload<SnowFlake>;\n\n/**\n * Body of `PUT /databases/:id`. Every field is optional. `description: null` (or empty) clears it.\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/update\n */\nexport interface RESTPutAPIDatabaseUpdateBody {\n\t/** 1–50 characters. */\n\tname?: string;\n\t/** Up to 128 characters. */\n\tdescription?: string | null;\n\t/** RAM in MB. */\n\tram?: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/update\n */\nexport type RESTPutAPIDatabaseUpdateResponse = APIPayload<APIDatabaseOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/reset\n */\nexport type RESTPostAPIDatabaseResetResponse = APIPayload<APIDatabaseOperationResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/get\n */\nexport type RESTGetAPIDatabaseCertificateResponse = APIPayload<APIDatabaseCertificate>;\n\n/**\n * Returns the newly issued certificate.\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/reset\n */\nexport type RESTPostAPIDatabaseResetCertificateResponse = APIPayload<APIDatabaseCertificate>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/resetpassword\n */\nexport type RESTPostAPIDatabaseResetPasswordResponse = APIPayload<APIDatabasePasswordReset>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { APIPayload } from '../../common/v1.js';
|
|
2
|
+
import { APIGitHubFile } from '../../payloads/v1/github.js';
|
|
3
|
+
import '../../payloads/v1/api-error.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/github/file
|
|
7
|
+
*/
|
|
8
|
+
interface RESTPostAPIGitHubFileBody {
|
|
9
|
+
/** Repository URL. A `/tree/<branch>` suffix selects the branch. */
|
|
10
|
+
url: string;
|
|
11
|
+
/** Path relative to the repository root. No `..`, no leading slash, no `.vertracloud/`. */
|
|
12
|
+
path: string;
|
|
13
|
+
/** Branch, tag or commit. Overrides the branch in the URL. */
|
|
14
|
+
ref?: string;
|
|
15
|
+
installation_id?: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @see https://docs.vertracloud.app/api-reference/endpoint/github/file
|
|
19
|
+
*/
|
|
20
|
+
type RESTPostAPIGitHubFileResponse = APIPayload<APIGitHubFile>;
|
|
21
|
+
|
|
22
|
+
export type { RESTPostAPIGitHubFileBody, RESTPostAPIGitHubFileResponse };
|
|
@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
13
13
|
};
|
|
14
14
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
15
|
|
|
16
|
-
// rest/v1/
|
|
17
|
-
var
|
|
18
|
-
module.exports = __toCommonJS(
|
|
19
|
-
//# sourceMappingURL=
|
|
16
|
+
// rest/v1/github.ts
|
|
17
|
+
var github_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(github_exports);
|
|
19
|
+
//# sourceMappingURL=github.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["github.ts"],"sourcesContent":["import type { APIGitHubFile, APIPayload } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/github/file\n */\nexport interface RESTPostAPIGitHubFileBody {\n\t/** Repository URL. A `/tree/<branch>` suffix selects the branch. */\n\turl: string;\n\t/** Path relative to the repository root. No `..`, no leading slash, no `.vertracloud/`. */\n\tpath: string;\n\t/** Branch, tag or commit. Overrides the branch in the URL. */\n\tref?: string;\n\tinstallation_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/github/file\n */\nexport type RESTPostAPIGitHubFileResponse = APIPayload<APIGitHubFile>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//# sourceMappingURL=github.mjs.map
|
package/rest/v1/index.d.ts
CHANGED
|
@@ -1,25 +1,30 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export {
|
|
3
|
-
export {
|
|
4
|
-
export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse,
|
|
1
|
+
export { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse } from './activity.js';
|
|
2
|
+
export { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse } from './api-key.js';
|
|
3
|
+
export { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse } from './application.js';
|
|
4
|
+
export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse } from './database.js';
|
|
5
|
+
export { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody } from './database-data.js';
|
|
6
|
+
export { RESTPostAPIGitHubFileBody, RESTPostAPIGitHubFileResponse } from './github.js';
|
|
5
7
|
export { RESTGetAPINotificationsResponse } from './notification.js';
|
|
6
|
-
export {
|
|
8
|
+
export { RESTGetAPIOAuthClientResponse, RESTPostAPIOAuthConsentBody, RESTPostAPIOAuthConsentResponse, RESTPostAPIOAuthRegisterBody, RESTPostAPIOAuthRegisterResponse, RESTPostAPIOAuthTokenBody, RESTPostAPIOAuthTokenResponse } from './oauth.js';
|
|
9
|
+
export { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse } from './orders.js';
|
|
7
10
|
export { RESTPostAPIRedeemResponse } from './redeem.js';
|
|
8
|
-
export { RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadResponse,
|
|
11
|
+
export { RESTGetAPIGroupedSnapshotsQuery, RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadQuery, RESTGetAPISnapshotDownloadResponse, RESTGetAPISnapshotsQuery, RESTGetAPISnapshotsResponse, RESTPostAPISnapshotCreateQuery, RESTPostAPISnapshotCreateResponse, RESTPostAPISnapshotRestoreBody, RESTPostAPISnapshotRestoreQuery, RESTPostAPISnapshotRestoreResponse } from './snapshot.js';
|
|
9
12
|
export { RESTGetAPIStatusResponse } from './status.js';
|
|
10
|
-
export { RESTGetAPIUserInfoResponse, RESTGetAPIUserSessionsResponse, RESTPostAPIUserDowngradeResponse, RESTPostAPIUserGenerateApiKeyResponse } from './user.js';
|
|
11
|
-
export {
|
|
12
|
-
export { RESTDeleteAPIWorkspaceResponse, RESTGetAPIWorkspaceInfoResponse, RESTGetAPIWorkspaceResponse, RESTGetAPIWorkspacesResponse, RESTPostAPIWorkspaceCreateResponse, RESTPostAPIWorkspaceMemberAddResponse, RESTPutAPIWorkspaceMemberRoleResponse, RESTPutAPIWorkspaceUpdateResponse } from './workspace.js';
|
|
13
|
+
export { RESTDeleteAPIUserFavoriteResponse, RESTDeleteAPIUserResourceFolderResourceResponse, RESTDeleteAPIUserResourceFolderResponse, RESTGetAPIUserApiKeyRequestsQuery, RESTGetAPIUserApiKeyRequestsResponse, RESTGetAPIUserInfoResponse, RESTGetAPIUserSessionsResponse, RESTPatchAPIUserMeBody, RESTPatchAPIUserMeResponse, RESTPatchAPIUserResourceFolderBody, RESTPatchAPIUserResourceFolderResponse, RESTPostAPIUserDowngradeResponse, RESTPostAPIUserGenerateApiKeyResponse, RESTPostAPIUserResourceFolderBody, RESTPostAPIUserResourceFolderResponse, RESTPutAPIUserFavoriteBody, RESTPutAPIUserFavoriteResponse, RESTPutAPIUserResourceFolderResourceBody, RESTPutAPIUserResourceFolderResourceResponse } from './user.js';
|
|
14
|
+
export { RESTDeleteAPIWorkspaceFavoriteResponse, RESTDeleteAPIWorkspaceInviteResponse, RESTDeleteAPIWorkspaceMemberResponse, RESTDeleteAPIWorkspaceResourceFolderResourceResponse, RESTDeleteAPIWorkspaceResourceFolderResponse, RESTDeleteAPIWorkspaceResourceLinkResponse, RESTDeleteAPIWorkspaceResponse, RESTDeleteAPIWorkspaceRoleResponse, RESTGetAPIWorkspaceActionRequestsQuery, RESTGetAPIWorkspaceActionRequestsResponse, RESTGetAPIWorkspaceActivitiesExportQuery, RESTGetAPIWorkspaceInfoResponse, RESTGetAPIWorkspaceInvitePreviewResponse, RESTGetAPIWorkspaceInvitesResponse, RESTGetAPIWorkspaceMembersResponse, RESTGetAPIWorkspaceRolesResponse, RESTGetAPIWorkspacesResponse, RESTPatchAPIWorkspaceResourceFolderBody, RESTPatchAPIWorkspaceResourceFolderResponse, RESTPostAPIWorkspaceActionRequestApproveResponse, RESTPostAPIWorkspaceActionRequestBody, RESTPostAPIWorkspaceActionRequestRejectResponse, RESTPostAPIWorkspaceActionRequestResponse, RESTPostAPIWorkspaceCreateBody, RESTPostAPIWorkspaceCreateResponse, RESTPostAPIWorkspaceInviteAcceptResponse, RESTPostAPIWorkspaceInviteBody, RESTPostAPIWorkspaceInviteDeclineResponse, RESTPostAPIWorkspaceInviteResponse, RESTPostAPIWorkspaceResourceFolderBody, RESTPostAPIWorkspaceResourceFolderResponse, RESTPostAPIWorkspaceResourceLinkResponse, RESTPostAPIWorkspaceRoleBody, RESTPostAPIWorkspaceRoleResponse, RESTPostAPIWorkspaceTransferOwnershipBody, RESTPostAPIWorkspaceTransferOwnershipResponse, RESTPutAPIWorkspaceFavoriteBody, RESTPutAPIWorkspaceFavoriteResponse, RESTPutAPIWorkspaceMemberBody, RESTPutAPIWorkspaceMemberResponse, RESTPutAPIWorkspaceResourceFolderResourceBody, RESTPutAPIWorkspaceResourceFolderResourceResponse, RESTPutAPIWorkspaceRoleBody, RESTPutAPIWorkspaceRoleResponse, RESTPutAPIWorkspaceUpdateBody, RESTPutAPIWorkspaceUpdateResponse } from './workspace.js';
|
|
13
15
|
import '../../common/v1.js';
|
|
16
|
+
import '../../payloads/v1/api-error.js';
|
|
14
17
|
import '../../payloads/v1/activity.js';
|
|
15
18
|
import '../../payloads/v1/notification.js';
|
|
19
|
+
import '../../payloads/v1/api-key.js';
|
|
16
20
|
import '../../payloads/v1/application.js';
|
|
17
|
-
import '../../payloads/v1/credits.js';
|
|
18
21
|
import '../../payloads/v1/database.js';
|
|
22
|
+
import '../../payloads/v1/database-data.js';
|
|
23
|
+
import '../../payloads/v1/github.js';
|
|
24
|
+
import '../../payloads/v1/oauth.js';
|
|
19
25
|
import '../../payloads/v1/orders.js';
|
|
20
26
|
import '../../payloads/v1/redeem.js';
|
|
21
27
|
import '../../payloads/v1/snapshot.js';
|
|
22
28
|
import '../../payloads/v1/status.js';
|
|
23
29
|
import '../../payloads/v1/user.js';
|
|
24
|
-
import '../../payloads/v1/wing.js';
|
|
25
30
|
import '../../payloads/v1/workspace.js';
|
package/rest/v1/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./application\";\nexport * from \"./
|
|
1
|
+
{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./api-key\";\nexport * from \"./application\";\nexport * from \"./database\";\nexport * from \"./database-data\";\nexport * from \"./github\";\nexport * from \"./notification\";\nexport * from \"./oauth\";\nexport * from \"./orders\";\nexport * from \"./redeem\";\nexport * from \"./snapshot\";\nexport * from \"./status\";\nexport * from \"./user\";\nexport * from \"./workspace\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import { APIPayload } from '../../common/v1.js';
|
|
2
2
|
import { APINotification } from '../../payloads/v1/notification.js';
|
|
3
|
+
import '../../payloads/v1/api-error.js';
|
|
3
4
|
|
|
4
|
-
/**
|
|
5
|
-
* @see https://docs.vertracloud.app/api-reference/endpoint/notifications
|
|
6
|
-
*/
|
|
5
|
+
/** Dashboard session only (not reachable with an API key). */
|
|
7
6
|
type RESTGetAPINotificationsResponse = APIPayload<APINotification[]>;
|
|
8
7
|
|
|
9
8
|
export type { RESTGetAPINotificationsResponse };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["notification.ts"],"sourcesContent":["import type { APINotification, APIPayload } from \"../../v1\";\n\n
|
|
1
|
+
{"version":3,"sources":["notification.ts"],"sourcesContent":["import type { APINotification, APIPayload } from \"../../v1\";\n\n/** Dashboard session only (not reachable with an API key). */\nexport type RESTGetAPINotificationsResponse = APIPayload<APINotification[]>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|