@vertracloud/api-types 0.1.1 → 0.2.1

package/rest/v1/oauth.d.ts

@@ -0,0 +1,60 @@
+import { APIPayload } from '../../common/v1.js';
+import { APIApiKeyScope } from '../../payloads/v1/api-key.js';
+import { APIOAuthClient, APIOAuthCodeChallengeMethod, APIOAuthConsentDecision } from '../../payloads/v1/oauth.js';
+import '../../payloads/v1/api-error.js';
+
+/**
+ * `POST /v1/oauth/register` (RFC 7591). Body and response follow the RFC format, WITHOUT the
+ * `{ response }` envelope.
+ * @see https://docs.vertracloud.app/api-reference/introduction#connecting-through-oauth
+ */
+interface RESTPostAPIOAuthRegisterBody {
+    client_name: string;
+    redirect_uris: string[];
+}
+interface RESTPostAPIOAuthRegisterResponse extends APIOAuthClient {
+    client_id_issued_at: number;
+    token_endpoint_auth_method: "none";
+    grant_types: ["authorization_code"];
+    response_types: ["code"];
+}
+/** `GET /v1/oauth/clients/:client_id` — what the consent screen shows. */
+type RESTGetAPIOAuthClientResponse = APIPayload<APIOAuthClient>;
+/**
+ * `POST /v1/oauth/consent` — dashboard session only. Approving creates an API key with `scopes`
+ * (named `oauth:<client_name>`) and returns the redirect URL with the `code`; denying returns the URL
+ * with `error=access_denied`. The key shows up in the key list and is revoked from there.
+ */
+interface RESTPostAPIOAuthConsentBody {
+    client_id: string;
+    redirect_uri: string;
+    /** At least one scope when `decision` is `approve`. */
+    scopes?: APIApiKeyScope[];
+    state?: string;
+    code_challenge: string;
+    code_challenge_method: APIOAuthCodeChallengeMethod;
+    decision: APIOAuthConsentDecision;
+}
+type RESTPostAPIOAuthConsentResponse = APIPayload<{
+    redirect_to: string;
+}>;
+/**
+ * `POST /v1/oauth/token` (RFC 6749 §4.1.3, `application/x-www-form-urlencoded` or JSON). Only
+ * `authorization_code`; no refresh token. The `access_token` is the API key created on consent
+ * and does not expire — revoke it by deleting the key. Response in RFC format, without envelope.
+ */
+interface RESTPostAPIOAuthTokenBody {
+    grant_type: "authorization_code";
+    code: string;
+    redirect_uri: string;
+    client_id: string;
+    code_verifier: string;
+}
+interface RESTPostAPIOAuthTokenResponse {
+    access_token: string;
+    token_type: "bearer";
+    /** Granted scopes, space-separated. */
+    scope: string;
+}
+
+export type { RESTGetAPIOAuthClientResponse, RESTPostAPIOAuthConsentBody, RESTPostAPIOAuthConsentResponse, RESTPostAPIOAuthRegisterBody, RESTPostAPIOAuthRegisterResponse, RESTPostAPIOAuthTokenBody, RESTPostAPIOAuthTokenResponse };

package/{payloads/v1/wing.js → rest/v1/oauth.js}

@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// payloads/v1/wing.ts
-var wing_exports = {};
-module.exports = __toCommonJS(wing_exports);
-//# sourceMappingURL=wing.js.map
+// rest/v1/oauth.ts
+var oauth_exports = {};
+module.exports = __toCommonJS(oauth_exports);
+//# sourceMappingURL=oauth.js.map

package/rest/v1/oauth.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["oauth.ts"],"sourcesContent":["import type { APIApiKeyScope, APIOAuthClient, APIOAuthCodeChallengeMethod, APIOAuthConsentDecision, APIPayload } from \"../../v1\";\n\n/**\n * `POST /v1/oauth/register` (RFC 7591). Body and response follow the RFC format, WITHOUT the\n * `{ response }` envelope.\n * @see https://docs.vertracloud.app/api-reference/introduction#connecting-through-oauth\n */\nexport interface RESTPostAPIOAuthRegisterBody {\n\tclient_name: string;\n\tredirect_uris: string[];\n}\nexport interface RESTPostAPIOAuthRegisterResponse extends APIOAuthClient {\n\tclient_id_issued_at: number;\n\ttoken_endpoint_auth_method: \"none\";\n\tgrant_types: [\"authorization_code\"];\n\tresponse_types: [\"code\"];\n}\n\n/** `GET /v1/oauth/clients/:client_id` — what the consent screen shows. */\nexport type RESTGetAPIOAuthClientResponse = APIPayload<APIOAuthClient>;\n\n/**\n * `POST /v1/oauth/consent` — dashboard session only. Approving creates an API key with `scopes`\n * (named `oauth:<client_name>`) and returns the redirect URL with the `code`; denying returns the URL\n * with `error=access_denied`. The key shows up in the key list and is revoked from there.\n */\nexport interface RESTPostAPIOAuthConsentBody {\n\tclient_id: string;\n\tredirect_uri: string;\n\t/** At least one scope when `decision` is `approve`. */\n\tscopes?: APIApiKeyScope[];\n\tstate?: string;\n\tcode_challenge: string;\n\tcode_challenge_method: APIOAuthCodeChallengeMethod;\n\tdecision: APIOAuthConsentDecision;\n}\nexport type RESTPostAPIOAuthConsentResponse = APIPayload<{ redirect_to: string }>;\n\n/**\n * `POST /v1/oauth/token` (RFC 6749 §4.1.3, `application/x-www-form-urlencoded` or JSON). Only\n * `authorization_code`; no refresh token. The `access_token` is the API key created on consent\n * and does not expire — revoke it by deleting the key. Response in RFC format, without envelope.\n */\nexport interface RESTPostAPIOAuthTokenBody {\n\tgrant_type: \"authorization_code\";\n\tcode: string;\n\tredirect_uri: string;\n\tclient_id: string;\n\tcode_verifier: string;\n}\nexport interface RESTPostAPIOAuthTokenResponse {\n\taccess_token: string;\n\ttoken_type: \"bearer\";\n\t/** Granted scopes, space-separated. */\n\tscope: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/oauth.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=oauth.mjs.map

package/rest/v1/orders.d.ts

@@ -1,21 +1,42 @@
 import { APIPayload } from '../../common/v1.js';
-import { APIOrderCreateResponse, APIOrderStatus, APIOrderListItem, APIPixPaymentResponse } from '../../payloads/v1/orders.js';
+import { OrderProvider, APIOrderListItem, APIOrderStatus, OrderType, APIOrderCreateResponse, APIOrderPixPayment } from '../../payloads/v1/orders.js';
+import '../../payloads/v1/api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders/create
+ * A missing `plan` or `months` returns 400 `MISSING_PLAN_OR_MONTHS`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
+ */
+interface RESTPostAPIOrderCreateBody {
+    plan: string;
+    /** 1, 3, 6 or 12. */
+    months: number;
+    coupon?: string;
+    /** Defaults to `"purchase"`. */
+    type?: OrderType;
+    source?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
 type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders/status
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status
  */
 type RESTGetAPIOrderStatusResponse = APIPayload<APIOrderStatus>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders/list
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders
+ */
+interface RESTGetAPIOrderListQuery {
+    provider?: OrderProvider;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders
  */
 type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders/pix
+ * `POST /v1/orders/:orderId/initiate/pix`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix
  */
-type RESTPostAPIPixPaymentResponse = APIPayload<APIPixPaymentResponse>;
+type RESTPostAPIOrderPixPaymentResponse = APIPayload<APIOrderPixPayment>;
 
-export type { RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateResponse, RESTPostAPIPixPaymentResponse };
+export type { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse };

package/rest/v1/orders.js.map

@@ -1 +1 @@
-{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { APIOrderCreateResponse, APIOrderListItem, APIOrderStatus, APIPayload, APIPixPaymentResponse } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders/create\n */\nexport type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders/status\n */\nexport type RESTGetAPIOrderStatusResponse = APIPayload<APIOrderStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders/list\n */\nexport type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders/pix\n */\nexport type RESTPostAPIPixPaymentResponse = APIPayload<APIPixPaymentResponse>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { APIOrderCreateResponse, APIOrderListItem, APIOrderPixPayment, APIOrderStatus, APIPayload, OrderProvider, OrderType } from \"../../v1\";\n\n/**\n * A missing `plan` or `months` returns 400 `MISSING_PLAN_OR_MONTHS`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface RESTPostAPIOrderCreateBody {\n\tplan: string;\n\t/** 1, 3, 6 or 12. */\n\tmonths: number;\n\tcoupon?: string;\n\t/** Defaults to `\"purchase\"`. */\n\ttype?: OrderType;\n\tsource?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport type RESTGetAPIOrderStatusResponse = APIPayload<APIOrderStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface RESTGetAPIOrderListQuery {\n\tprovider?: OrderProvider;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;\n\n/**\n * `POST /v1/orders/:orderId/initiate/pix`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport type RESTPostAPIOrderPixPaymentResponse = APIPayload<APIOrderPixPayment>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/redeem.d.ts

@@ -1,8 +1,9 @@
 import { APIPayload } from '../../common/v1.js';
 import { APIRedeemResponse } from '../../payloads/v1/redeem.js';
+import '../../payloads/v1/api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/redeem
+ * @see https://docs.vertracloud.app/api-reference/endpoint/redeem/redeem
  */
 type RESTPostAPIRedeemResponse = APIPayload<APIRedeemResponse>;
 

package/rest/v1/redeem.js.map

@@ -1 +1 @@
-{"version":3,"sources":["redeem.ts"],"sourcesContent":["import type { APIPayload, APIRedeemResponse } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/redeem\n */\nexport type RESTPostAPIRedeemResponse = APIPayload<APIRedeemResponse>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["redeem.ts"],"sourcesContent":["import type { APIPayload, APIRedeemResponse } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/redeem/redeem\n */\nexport type RESTPostAPIRedeemResponse = APIPayload<APIRedeemResponse>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/snapshot.d.ts

@@ -1,29 +1,64 @@
 import { APIPayload } from '../../common/v1.js';
-import { APIResourceSnapshot, APIGroupedResourceSnapshots, APISnapshotRestoreResponse } from '../../payloads/v1/snapshot.js';
+import { SnapshotScope, APIGroupedResourceSnapshots, APIResourceSnapshot, APISnapshotRestoreResponse } from '../../payloads/v1/snapshot.js';
+import '../../payloads/v1/api-error.js';
+import '../../payloads/v1/application.js';
+import '../../payloads/v1/database.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/getall
+ * `GET /v1/users/:id/snapshots` — snapshots of one resource. Every snapshot route under
+ * `/v1/users/...` requires `scope`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/getall
+ */
+interface RESTGetAPISnapshotsQuery {
+    scope: SnapshotScope;
+}
+/**
+ * `GET /v1/users/snapshots` — every snapshot of the account, grouped by resource.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
+ */
+type RESTGetAPIGroupedSnapshotsQuery = RESTGetAPISnapshotsQuery;
+/**
+ * `POST /v1/users/:id/snapshots`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/create
+ */
+type RESTPostAPISnapshotCreateQuery = RESTGetAPISnapshotsQuery;
+/**
+ * `POST /v1/users/:id/snapshots/:snapshot_id/restore`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore
+ */
+type RESTPostAPISnapshotRestoreQuery = RESTGetAPISnapshotsQuery;
+/**
+ * `GET /v1/users/:id/snapshots/:snapshot_id/download`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/download
+ */
+type RESTGetAPISnapshotDownloadQuery = RESTGetAPISnapshotsQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/getall
  */
 type RESTGetAPISnapshotsResponse = APIPayload<APIResourceSnapshot[]>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/getall
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
  */
 type RESTGetAPIGroupedSnapshotsResponse = APIPayload<APIGroupedResourceSnapshots[]>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/upload
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/create
  */
-type RESTGetAPISnapshotResponse = APIPayload<APIResourceSnapshot>;
+type RESTPostAPISnapshotCreateResponse = APIPayload<APIResourceSnapshot>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/upload
+ * Optional body of the restore. `resource_id` absent = restore into the resource of the URL's `:id`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore
  */
-type RESTPostAPISnapshotCreateResponse = APIPayload<APIResourceSnapshot>;
+interface RESTPostAPISnapshotRestoreBody {
+    /** Target resource (same kind as the snapshot) when restoring into another resource. */
+    resource_id?: string;
+}
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/revert
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore
  */
 type RESTPostAPISnapshotRestoreResponse = APIPayload<APISnapshotRestoreResponse>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/download
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/download
  */
 type RESTGetAPISnapshotDownloadResponse = ArrayBuffer;
 
-export type { RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadResponse, RESTGetAPISnapshotResponse, RESTGetAPISnapshotsResponse, RESTPostAPISnapshotCreateResponse, RESTPostAPISnapshotRestoreResponse };
+export type { RESTGetAPIGroupedSnapshotsQuery, RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadQuery, RESTGetAPISnapshotDownloadResponse, RESTGetAPISnapshotsQuery, RESTGetAPISnapshotsResponse, RESTPostAPISnapshotCreateQuery, RESTPostAPISnapshotCreateResponse, RESTPostAPISnapshotRestoreBody, RESTPostAPISnapshotRestoreQuery, RESTPostAPISnapshotRestoreResponse };

package/rest/v1/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"sources":["snapshot.ts"],"sourcesContent":["import type { APIGroupedResourceSnapshots, APIPayload, APIResourceSnapshot, APISnapshotRestoreResponse } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/getall\n */\nexport type RESTGetAPISnapshotsResponse = APIPayload<APIResourceSnapshot[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/getall\n */\nexport type RESTGetAPIGroupedSnapshotsResponse = APIPayload<APIGroupedResourceSnapshots[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/upload\n */\nexport type RESTGetAPISnapshotResponse = APIPayload<APIResourceSnapshot>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/upload\n */\nexport type RESTPostAPISnapshotCreateResponse = APIPayload<APIResourceSnapshot>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/revert\n */\nexport type RESTPostAPISnapshotRestoreResponse = APIPayload<APISnapshotRestoreResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/commits/download\n */\nexport type RESTGetAPISnapshotDownloadResponse = ArrayBuffer;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["snapshot.ts"],"sourcesContent":["import type { APIGroupedResourceSnapshots, APIPayload, APIResourceSnapshot, APISnapshotRestoreResponse, SnapshotScope } from \"../../v1\";\n\n/**\n * `GET /v1/users/:id/snapshots` — snapshots of one resource. Every snapshot route under\n * `/v1/users/...` requires `scope`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/getall\n */\nexport interface RESTGetAPISnapshotsQuery {\n\tscope: SnapshotScope;\n}\n\n/**\n * `GET /v1/users/snapshots` — every snapshot of the account, grouped by resource.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport type RESTGetAPIGroupedSnapshotsQuery = RESTGetAPISnapshotsQuery;\n\n/**\n * `POST /v1/users/:id/snapshots`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/create\n */\nexport type RESTPostAPISnapshotCreateQuery = RESTGetAPISnapshotsQuery;\n\n/**\n * `POST /v1/users/:id/snapshots/:snapshot_id/restore`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore\n */\nexport type RESTPostAPISnapshotRestoreQuery = RESTGetAPISnapshotsQuery;\n\n/**\n * `GET /v1/users/:id/snapshots/:snapshot_id/download`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/download\n */\nexport type RESTGetAPISnapshotDownloadQuery = RESTGetAPISnapshotsQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/getall\n */\nexport type RESTGetAPISnapshotsResponse = APIPayload<APIResourceSnapshot[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport type RESTGetAPIGroupedSnapshotsResponse = APIPayload<APIGroupedResourceSnapshots[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/create\n */\nexport type RESTPostAPISnapshotCreateResponse = APIPayload<APIResourceSnapshot>;\n\n/**\n * Optional body of the restore. `resource_id` absent = restore into the resource of the URL's `:id`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore\n */\nexport interface RESTPostAPISnapshotRestoreBody {\n\t/** Target resource (same kind as the snapshot) when restoring into another resource. */\n\tresource_id?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore\n */\nexport type RESTPostAPISnapshotRestoreResponse = APIPayload<APISnapshotRestoreResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/download\n */\nexport type RESTGetAPISnapshotDownloadResponse = ArrayBuffer;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/status.d.ts

@@ -1,5 +1,6 @@
 import { APIPayload } from '../../common/v1.js';
 import { APIStatus } from '../../payloads/v1/status.js';
+import '../../payloads/v1/api-error.js';
 
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/services/status

package/rest/v1/user.d.ts

@@ -1,7 +1,8 @@
-import { APIPayload } from '../../common/v1.js';
-import { APIUserInfoResponse, APIUserApiKey, APIUserSession } from '../../payloads/v1/user.js';
+import { APIPayload, ISODateString, APIPaginatedPayload } from '../../common/v1.js';
+import { APIUserApiKeyRequestEvent, APIUserInfoResponse, APIUserSession, UserLanguage, APIUser, APIUserApiKey } from '../../payloads/v1/user.js';
+import { APIWorkspaceResourceOrganization, WorkspaceFolderColor, APIWorkspaceResourceFolder } from '../../payloads/v1/workspace.js';
+import '../../payloads/v1/api-error.js';
 import '../../payloads/v1/application.js';
-import '../../payloads/v1/credits.js';
 import '../../payloads/v1/database.js';
 
 /**
@@ -9,16 +10,64 @@ import '../../payloads/v1/database.js';
  */
 type RESTGetAPIUserInfoResponse = APIPayload<APIUserInfoResponse>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users/downgrade
+ * `POST /v1/users/me/downgrade` — dashboard session only.
+ * @see https://docs.vertracloud.app/plan-downgrade
  */
-type RESTPostAPIUserDowngradeResponse = APIPayload<APIUserInfoResponse>;
+type RESTPostAPIUserDowngradeResponse = APIPayload<APIUser>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key
+ * `PATCH /v1/users/me`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/update-me
+ */
+interface RESTPatchAPIUserMeBody {
+    name?: string;
+    language?: UserLanguage;
+    workspace_invites_enabled?: boolean;
+}
+type RESTPatchAPIUserMeResponse = APIPayload<APIUser>;
+interface RESTPostAPIUserResourceFolderBody {
+    name: string;
+    color?: WorkspaceFolderColor;
+    position?: number;
+}
+type RESTPostAPIUserResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;
+interface RESTPatchAPIUserResourceFolderBody {
+    name?: string;
+    color?: WorkspaceFolderColor;
+    position?: number;
+}
+type RESTPatchAPIUserResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;
+type RESTDeleteAPIUserResourceFolderResponse = APIPayload<null>;
+interface RESTPutAPIUserResourceFolderResourceBody {
+    position?: number;
+}
+type RESTPutAPIUserResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;
+type RESTDeleteAPIUserResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;
+interface RESTPutAPIUserFavoriteBody {
+    position?: number;
+}
+type RESTPutAPIUserFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;
+type RESTDeleteAPIUserFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;
+/**
+ * Legacy CLI route; prefer the API key management under `/v1/users/me/api-keys`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/create
  */
 type RESTPostAPIUserGenerateApiKeyResponse = APIPayload<APIUserApiKey>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/users/sessions
  */
 type RESTGetAPIUserSessionsResponse = APIPayload<APIUserSession[]>;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key-requests
+ */
+interface RESTGetAPIUserApiKeyRequestsQuery {
+    /** Filters by key (`APIApiKey.id`). */
+    api_key_id?: string;
+    from?: ISODateString;
+    to?: ISODateString;
+    page?: number;
+    per_page?: number;
+    errors_only?: boolean;
+}
+type RESTGetAPIUserApiKeyRequestsResponse = APIPaginatedPayload<APIUserApiKeyRequestEvent>;
 
-export type { RESTGetAPIUserInfoResponse, RESTGetAPIUserSessionsResponse, RESTPostAPIUserDowngradeResponse, RESTPostAPIUserGenerateApiKeyResponse };
+export type { RESTDeleteAPIUserFavoriteResponse, RESTDeleteAPIUserResourceFolderResourceResponse, RESTDeleteAPIUserResourceFolderResponse, RESTGetAPIUserApiKeyRequestsQuery, RESTGetAPIUserApiKeyRequestsResponse, RESTGetAPIUserInfoResponse, RESTGetAPIUserSessionsResponse, RESTPatchAPIUserMeBody, RESTPatchAPIUserMeResponse, RESTPatchAPIUserResourceFolderBody, RESTPatchAPIUserResourceFolderResponse, RESTPostAPIUserDowngradeResponse, RESTPostAPIUserGenerateApiKeyResponse, RESTPostAPIUserResourceFolderBody, RESTPostAPIUserResourceFolderResponse, RESTPutAPIUserFavoriteBody, RESTPutAPIUserFavoriteResponse, RESTPutAPIUserResourceFolderResourceBody, RESTPutAPIUserResourceFolderResourceResponse };

package/rest/v1/user.js.map

@@ -1 +1 @@
-{"version":3,"sources":["user.ts"],"sourcesContent":["import type { APIPayload, APIUserApiKey, APIUserInfoResponse, APIUserSession } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport type RESTGetAPIUserInfoResponse = APIPayload<APIUserInfoResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/downgrade\n */\nexport type RESTPostAPIUserDowngradeResponse = APIPayload<APIUserInfoResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key\n */\nexport type RESTPostAPIUserGenerateApiKeyResponse = APIPayload<APIUserApiKey>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/sessions\n */\nexport type RESTGetAPIUserSessionsResponse = APIPayload<APIUserSession[]>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["user.ts"],"sourcesContent":["import type { APIPaginatedPayload, APIPayload, APIUser, APIUserApiKey, APIUserApiKeyRequestEvent, APIUserInfoResponse, APIUserSession, ISODateString, UserLanguage } from \"../../v1\";\nimport type { APIWorkspaceResourceFolder, APIWorkspaceResourceOrganization, WorkspaceFolderColor } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport type RESTGetAPIUserInfoResponse = APIPayload<APIUserInfoResponse>;\n\n/**\n * `POST /v1/users/me/downgrade` — dashboard session only.\n * @see https://docs.vertracloud.app/plan-downgrade\n */\nexport type RESTPostAPIUserDowngradeResponse = APIPayload<APIUser>;\n\n/**\n * `PATCH /v1/users/me`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/update-me\n */\nexport interface RESTPatchAPIUserMeBody {\n\tname?: string;\n\tlanguage?: UserLanguage;\n\tworkspace_invites_enabled?: boolean;\n}\nexport type RESTPatchAPIUserMeResponse = APIPayload<APIUser>;\n\nexport interface RESTPostAPIUserResourceFolderBody {\n\tname: string;\n\tcolor?: WorkspaceFolderColor;\n\tposition?: number;\n}\nexport type RESTPostAPIUserResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;\nexport interface RESTPatchAPIUserResourceFolderBody {\n\tname?: string;\n\tcolor?: WorkspaceFolderColor;\n\tposition?: number;\n}\nexport type RESTPatchAPIUserResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;\nexport type RESTDeleteAPIUserResourceFolderResponse = APIPayload<null>;\nexport interface RESTPutAPIUserResourceFolderResourceBody {\n\tposition?: number;\n}\nexport type RESTPutAPIUserResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;\nexport type RESTDeleteAPIUserResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;\nexport interface RESTPutAPIUserFavoriteBody {\n\tposition?: number;\n}\nexport type RESTPutAPIUserFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;\nexport type RESTDeleteAPIUserFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;\n\n/**\n * Legacy CLI route; prefer the API key management under `/v1/users/me/api-keys`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/create\n */\nexport type RESTPostAPIUserGenerateApiKeyResponse = APIPayload<APIUserApiKey>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/sessions\n */\nexport type RESTGetAPIUserSessionsResponse = APIPayload<APIUserSession[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key-requests\n */\nexport interface RESTGetAPIUserApiKeyRequestsQuery {\n\t/** Filters by key (`APIApiKey.id`). */\n\tapi_key_id?: string;\n\tfrom?: ISODateString;\n\tto?: ISODateString;\n\tpage?: number;\n\tper_page?: number;\n\terrors_only?: boolean;\n}\n\nexport type RESTGetAPIUserApiKeyRequestsResponse = APIPaginatedPayload<APIUserApiKeyRequestEvent>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/workspace.d.ts

@@ -1,39 +1,207 @@
-import { APIPayload } from '../../common/v1.js';
-import { APIWorkspace, APIWorkspaceInfoResponse, APIWorkspaceMemberAdd, APIWorkspaceMemberRoleUpdate } from '../../payloads/v1/workspace.js';
+import { APIPayload, ISODateString } from '../../common/v1.js';
+import { APIWorkspaceResourceOrganization, WorkspaceActionRequestStatus, APIWorkspaceActionRequest, APIWorkspaceInfoResponse, APIWorkspaceInvitePreview, APIWorkspaceInvite, APIWorkspaceMember, APIWorkspaceRole, APIWorkspace, WorkspaceFolderColor, APIWorkspaceResourceFolder, WorkspaceActionRequestAction, WorkspaceActionRequestParams, APIWorkspaceInviteCreated, WorkspacePermission } from '../../payloads/v1/workspace.js';
+import '../../payloads/v1/api-error.js';
 import '../../payloads/v1/application.js';
 import '../../payloads/v1/database.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/get
- */
-type RESTGetAPIWorkspaceResponse = APIPayload<APIWorkspace>;
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/get
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/get
  */
 type RESTGetAPIWorkspaceInfoResponse = APIPayload<APIWorkspaceInfoResponse>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/getall
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/get-all
  */
 type RESTGetAPIWorkspacesResponse = APIPayload<APIWorkspace[]>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/create
+ * `POST /v1/workspaces` — the caller becomes the owner (requires a plan with workspaces).
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/create
  */
-type RESTPostAPIWorkspaceCreateResponse = APIPayload<APIWorkspace>;
+interface RESTPostAPIWorkspaceCreateBody {
+    name: string;
+    description?: string;
+}
+/** Returns the full workspace view, same as `GET /v1/workspaces/:id`. */
+type RESTPostAPIWorkspaceCreateResponse = APIPayload<APIWorkspaceInfoResponse>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/update
+ * `PUT /v1/workspaces/:id` — owner only. At least one field.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/update
  */
+type RESTPutAPIWorkspaceUpdateBody = Partial<RESTPostAPIWorkspaceCreateBody>;
 type RESTPutAPIWorkspaceUpdateResponse = APIPayload<APIWorkspace>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/delete
+ * `DELETE /v1/workspaces/:id` — soft delete, owner only.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/delete
+ */
+type RESTDeleteAPIWorkspaceResponse = APIPayload<null>;
+/**
+ * `POST /v1/workspaces/:id/transfer-ownership` — owner only.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/transfer-ownership
+ */
+interface RESTPostAPIWorkspaceTransferOwnershipBody {
+    user_id: string;
+}
+type RESTPostAPIWorkspaceTransferOwnershipResponse = APIPayload<APIWorkspace>;
+interface RESTPostAPIWorkspaceResourceFolderBody {
+    name: string;
+    color?: WorkspaceFolderColor;
+    position?: number;
+}
+type RESTPostAPIWorkspaceResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;
+interface RESTPatchAPIWorkspaceResourceFolderBody {
+    name?: string;
+    color?: WorkspaceFolderColor;
+    position?: number;
+}
+type RESTPatchAPIWorkspaceResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;
+type RESTDeleteAPIWorkspaceResourceFolderResponse = APIPayload<null>;
+interface RESTPutAPIWorkspaceResourceFolderResourceBody {
+    position?: number;
+}
+type RESTPutAPIWorkspaceResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;
+type RESTDeleteAPIWorkspaceResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;
+interface RESTPutAPIWorkspaceFavoriteBody {
+    position?: number;
+}
+type RESTPutAPIWorkspaceFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;
+type RESTDeleteAPIWorkspaceFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;
+/**
+ * `GET /v1/workspaces/:id/members` — permission `members:read`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/list
+ */
+type RESTGetAPIWorkspaceMembersResponse = APIPayload<APIWorkspaceMember[]>;
+/**
+ * `PUT /v1/workspaces/:id/members/:user_id` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/update
+ */
+interface RESTPutAPIWorkspaceMemberBody {
+    role_id?: string;
+    expires_at?: ISODateString | null;
+}
+type RESTPutAPIWorkspaceMemberResponse = APIPayload<APIWorkspaceMember>;
+/**
+ * `DELETE /v1/workspaces/:id/members/:user_id` — permission `members:manage`, or the member leaving on their own.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/remove
+ */
+type RESTDeleteAPIWorkspaceMemberResponse = APIPayload<null>;
+/**
+ * `GET /v1/workspaces/:id/roles` — permission `members:read`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/list
+ */
+type RESTGetAPIWorkspaceRolesResponse = APIPayload<APIWorkspaceRole[]>;
+/**
+ * `POST /v1/workspaces/:id/roles` — permission `roles:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/create
+ */
+interface RESTPostAPIWorkspaceRoleBody {
+    name: string;
+    permissions: WorkspacePermission[];
+    position?: number;
+}
+type RESTPostAPIWorkspaceRoleResponse = APIPayload<APIWorkspaceRole>;
+/**
+ * `PUT /v1/workspaces/:id/roles/:role_id` — permission `roles:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/update
+ */
+type RESTPutAPIWorkspaceRoleBody = RESTPostAPIWorkspaceRoleBody;
+type RESTPutAPIWorkspaceRoleResponse = APIPayload<APIWorkspaceRole>;
+/**
+ * `DELETE /v1/workspaces/:id/roles/:role_id` — permission `roles:manage`. A role still used by a
+ * member or pending invite is rejected with `WORKSPACE_ROLE_IN_USE`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/delete
+ */
+type RESTDeleteAPIWorkspaceRoleResponse = APIPayload<null>;
+/**
+ * `GET /v1/workspaces/:id/invites` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/list
+ */
+type RESTGetAPIWorkspaceInvitesResponse = APIPayload<APIWorkspaceInvite[]>;
+/**
+ * `POST /v1/workspaces/:id/invites` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/create
+ */
+type RESTPostAPIWorkspaceInviteBody = {
+    kind: "email";
+    email: string;
+    role_id: string;
+    expires_in_days?: number;
+} | {
+    kind: "link";
+    role_id: string;
+    max_uses?: number;
+    expires_in_days?: number;
+};
+type RESTPostAPIWorkspaceInviteResponse = APIPayload<APIWorkspaceInviteCreated>;
+/**
+ * `DELETE /v1/workspaces/:id/invites/:invite_id` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/revoke
+ */
+type RESTDeleteAPIWorkspaceInviteResponse = APIPayload<null>;
+/**
+ * `GET /v1/workspaces/invites/:token` — any authenticated user.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/preview
+ */
+type RESTGetAPIWorkspaceInvitePreviewResponse = APIPayload<APIWorkspaceInvitePreview>;
+/**
+ * `POST /v1/workspaces/invites/:token/accept` — any authenticated user.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/accept
+ */
+type RESTPostAPIWorkspaceInviteAcceptResponse = APIPayload<Pick<APIWorkspace, "id" | "name">>;
+/**
+ * `POST /v1/workspaces/invites/:token/decline` — any authenticated user.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/decline
+ */
+type RESTPostAPIWorkspaceInviteDeclineResponse = APIPayload<null>;
+/**
+ * `POST /v1/workspaces/:id/apps/:app_id` and `POST /v1/workspaces/:id/databases/:db_id` — owner only.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/links/add-app
+ */
+type RESTPostAPIWorkspaceResourceLinkResponse = APIPayload<null>;
+/**
+ * `DELETE /v1/workspaces/:id/apps/:app_id` and `DELETE /v1/workspaces/:id/databases/:db_id` — owner only.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/links/remove-app
+ */
+type RESTDeleteAPIWorkspaceResourceLinkResponse = APIPayload<null>;
+/**
+ * `GET /v1/workspaces/:id/action-requests` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/list
+ */
+interface RESTGetAPIWorkspaceActionRequestsQuery {
+    status?: WorkspaceActionRequestStatus;
+}
+type RESTGetAPIWorkspaceActionRequestsResponse = APIPayload<APIWorkspaceActionRequest[]>;
+/**
+ * `POST /v1/workspaces/:id/action-requests` — any member (who lacks the action's permission).
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/create
+ */
+type RESTPostAPIWorkspaceActionRequestBody = {
+    [A in WorkspaceActionRequestAction]: {
+        action: A;
+        resource_id: string;
+    } & (WorkspaceActionRequestParams[A] extends Record<string, never> ? {
+        params?: WorkspaceActionRequestParams[A];
+    } : {
+        params: WorkspaceActionRequestParams[A];
+    });
+}[WorkspaceActionRequestAction];
+type RESTPostAPIWorkspaceActionRequestResponse = APIPayload<APIWorkspaceActionRequest>;
+/**
+ * `POST /v1/workspaces/:id/action-requests/:rid/approve` — permission `members:manage` plus
+ * the permission the action requires.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/approve
  */
-type RESTDeleteAPIWorkspaceResponse = APIPayload<void>;
+type RESTPostAPIWorkspaceActionRequestApproveResponse = APIPayload<APIWorkspaceActionRequest>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/members/add
+ * `POST /v1/workspaces/:id/action-requests/:rid/reject` — permission `members:manage`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/reject
  */
-type RESTPostAPIWorkspaceMemberAddResponse = APIPayload<APIWorkspaceMemberAdd>;
+type RESTPostAPIWorkspaceActionRequestRejectResponse = APIPayload<APIWorkspaceActionRequest>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/members/role
+ * `GET /v1/workspaces/:id/activities/export` — permission `activities:read`. CSV, 90-day window.
+ * Dashboard session only.
  */
-type RESTPutAPIWorkspaceMemberRoleResponse = APIPayload<APIWorkspaceMemberRoleUpdate>;
+interface RESTGetAPIWorkspaceActivitiesExportQuery {
+    from?: ISODateString;
+    to?: ISODateString;
+}
 
-export type { RESTDeleteAPIWorkspaceResponse, RESTGetAPIWorkspaceInfoResponse, RESTGetAPIWorkspaceResponse, RESTGetAPIWorkspacesResponse, RESTPostAPIWorkspaceCreateResponse, RESTPostAPIWorkspaceMemberAddResponse, RESTPutAPIWorkspaceMemberRoleResponse, RESTPutAPIWorkspaceUpdateResponse };
+export type { 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 };

package/rest/v1/workspace.js.map

@@ -1 +1 @@
-{"version":3,"sources":["workspace.ts"],"sourcesContent":["import type { APIPayload, APIWorkspace, APIWorkspaceInfoResponse, APIWorkspaceMemberAdd, APIWorkspaceMemberRoleUpdate } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/get\n */\nexport type RESTGetAPIWorkspaceResponse = APIPayload<APIWorkspace>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/get\n */\nexport type RESTGetAPIWorkspaceInfoResponse = APIPayload<APIWorkspaceInfoResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/getall\n */\nexport type RESTGetAPIWorkspacesResponse = APIPayload<APIWorkspace[]>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/create\n */\nexport type RESTPostAPIWorkspaceCreateResponse = APIPayload<APIWorkspace>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/update\n */\nexport type RESTPutAPIWorkspaceUpdateResponse = APIPayload<APIWorkspace>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/delete\n */\nexport type RESTDeleteAPIWorkspaceResponse = APIPayload<void>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/members/add\n */\nexport type RESTPostAPIWorkspaceMemberAddResponse = APIPayload<APIWorkspaceMemberAdd>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/organizations/members/role\n */\nexport type RESTPutAPIWorkspaceMemberRoleResponse = APIPayload<APIWorkspaceMemberRoleUpdate>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["workspace.ts"],"sourcesContent":["import type {\n\tAPIPayload,\n\tAPIWorkspace,\n\tAPIWorkspaceActionRequest,\n\tAPIWorkspaceInfoResponse,\n\tAPIWorkspaceInvite,\n\tAPIWorkspaceInviteCreated,\n\tAPIWorkspaceInvitePreview,\n\tAPIWorkspaceMember,\n\tAPIWorkspaceResourceFolder,\n\tAPIWorkspaceResourceOrganization,\n\tAPIWorkspaceRole,\n\tISODateString,\n\tWorkspaceActionRequestAction,\n\tWorkspaceActionRequestParams,\n\tWorkspaceActionRequestStatus,\n\tWorkspaceFolderColor,\n\tWorkspacePermission,\n} from \"../../v1\";\n\n// ---------------------------------------------------------------------------\n// Workspace\n// ---------------------------------------------------------------------------\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/get\n */\nexport type RESTGetAPIWorkspaceInfoResponse = APIPayload<APIWorkspaceInfoResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/get-all\n */\nexport type RESTGetAPIWorkspacesResponse = APIPayload<APIWorkspace[]>;\n\n/**\n * `POST /v1/workspaces` — the caller becomes the owner (requires a plan with workspaces).\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/create\n */\nexport interface RESTPostAPIWorkspaceCreateBody {\n\tname: string;\n\tdescription?: string;\n}\n/** Returns the full workspace view, same as `GET /v1/workspaces/:id`. */\nexport type RESTPostAPIWorkspaceCreateResponse = APIPayload<APIWorkspaceInfoResponse>;\n\n/**\n * `PUT /v1/workspaces/:id` — owner only. At least one field.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/update\n */\nexport type RESTPutAPIWorkspaceUpdateBody = Partial<RESTPostAPIWorkspaceCreateBody>;\nexport type RESTPutAPIWorkspaceUpdateResponse = APIPayload<APIWorkspace>;\n\n/**\n * `DELETE /v1/workspaces/:id` — soft delete, owner only.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/delete\n */\nexport type RESTDeleteAPIWorkspaceResponse = APIPayload<null>;\n\n/**\n * `POST /v1/workspaces/:id/transfer-ownership` — owner only.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/transfer-ownership\n */\nexport interface RESTPostAPIWorkspaceTransferOwnershipBody {\n\tuser_id: string;\n}\nexport type RESTPostAPIWorkspaceTransferOwnershipResponse = APIPayload<APIWorkspace>;\n\n// ---------------------------------------------------------------------------\n// Saved resource organization\n// ---------------------------------------------------------------------------\n\nexport interface RESTPostAPIWorkspaceResourceFolderBody {\n\tname: string;\n\tcolor?: WorkspaceFolderColor;\n\tposition?: number;\n}\nexport type RESTPostAPIWorkspaceResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;\n\nexport interface RESTPatchAPIWorkspaceResourceFolderBody {\n\tname?: string;\n\tcolor?: WorkspaceFolderColor;\n\tposition?: number;\n}\nexport type RESTPatchAPIWorkspaceResourceFolderResponse = APIPayload<APIWorkspaceResourceFolder>;\nexport type RESTDeleteAPIWorkspaceResourceFolderResponse = APIPayload<null>;\n\nexport interface RESTPutAPIWorkspaceResourceFolderResourceBody {\n\tposition?: number;\n}\nexport type RESTPutAPIWorkspaceResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;\nexport type RESTDeleteAPIWorkspaceResourceFolderResourceResponse = APIPayload<APIWorkspaceResourceOrganization>;\n\nexport interface RESTPutAPIWorkspaceFavoriteBody {\n\tposition?: number;\n}\nexport type RESTPutAPIWorkspaceFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;\nexport type RESTDeleteAPIWorkspaceFavoriteResponse = APIPayload<APIWorkspaceResourceOrganization>;\n\n// ---------------------------------------------------------------------------\n// Members\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/workspaces/:id/members` — permission `members:read`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/list\n */\nexport type RESTGetAPIWorkspaceMembersResponse = APIPayload<APIWorkspaceMember[]>;\n\n/**\n * `PUT /v1/workspaces/:id/members/:user_id` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/update\n */\nexport interface RESTPutAPIWorkspaceMemberBody {\n\trole_id?: string;\n\texpires_at?: ISODateString | null;\n}\nexport type RESTPutAPIWorkspaceMemberResponse = APIPayload<APIWorkspaceMember>;\n\n/**\n * `DELETE /v1/workspaces/:id/members/:user_id` — permission `members:manage`, or the member leaving on their own.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/members/remove\n */\nexport type RESTDeleteAPIWorkspaceMemberResponse = APIPayload<null>;\n\n// ---------------------------------------------------------------------------\n// Roles\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/workspaces/:id/roles` — permission `members:read`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/list\n */\nexport type RESTGetAPIWorkspaceRolesResponse = APIPayload<APIWorkspaceRole[]>;\n\n/**\n * `POST /v1/workspaces/:id/roles` — permission `roles:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/create\n */\nexport interface RESTPostAPIWorkspaceRoleBody {\n\tname: string;\n\tpermissions: WorkspacePermission[];\n\tposition?: number;\n}\nexport type RESTPostAPIWorkspaceRoleResponse = APIPayload<APIWorkspaceRole>;\n\n/**\n * `PUT /v1/workspaces/:id/roles/:role_id` — permission `roles:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/update\n */\nexport type RESTPutAPIWorkspaceRoleBody = RESTPostAPIWorkspaceRoleBody;\nexport type RESTPutAPIWorkspaceRoleResponse = APIPayload<APIWorkspaceRole>;\n\n/**\n * `DELETE /v1/workspaces/:id/roles/:role_id` — permission `roles:manage`. A role still used by a\n * member or pending invite is rejected with `WORKSPACE_ROLE_IN_USE`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/roles/delete\n */\nexport type RESTDeleteAPIWorkspaceRoleResponse = APIPayload<null>;\n\n// ---------------------------------------------------------------------------\n// Invites\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/workspaces/:id/invites` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/list\n */\nexport type RESTGetAPIWorkspaceInvitesResponse = APIPayload<APIWorkspaceInvite[]>;\n\n/**\n * `POST /v1/workspaces/:id/invites` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/create\n */\nexport type RESTPostAPIWorkspaceInviteBody = { kind: \"email\"; email: string; role_id: string; expires_in_days?: number } | { kind: \"link\"; role_id: string; max_uses?: number; expires_in_days?: number };\nexport type RESTPostAPIWorkspaceInviteResponse = APIPayload<APIWorkspaceInviteCreated>;\n\n/**\n * `DELETE /v1/workspaces/:id/invites/:invite_id` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/revoke\n */\nexport type RESTDeleteAPIWorkspaceInviteResponse = APIPayload<null>;\n\n/**\n * `GET /v1/workspaces/invites/:token` — any authenticated user.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/preview\n */\nexport type RESTGetAPIWorkspaceInvitePreviewResponse = APIPayload<APIWorkspaceInvitePreview>;\n\n/**\n * `POST /v1/workspaces/invites/:token/accept` — any authenticated user.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/accept\n */\nexport type RESTPostAPIWorkspaceInviteAcceptResponse = APIPayload<Pick<APIWorkspace, \"id\" | \"name\">>;\n\n/**\n * `POST /v1/workspaces/invites/:token/decline` — any authenticated user.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/invites/decline\n */\nexport type RESTPostAPIWorkspaceInviteDeclineResponse = APIPayload<null>;\n\n// ---------------------------------------------------------------------------\n// Projects (apps/databases) — owner only\n// ---------------------------------------------------------------------------\n\n/**\n * `POST /v1/workspaces/:id/apps/:app_id` and `POST /v1/workspaces/:id/databases/:db_id` — owner only.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/links/add-app\n */\nexport type RESTPostAPIWorkspaceResourceLinkResponse = APIPayload<null>;\n\n/**\n * `DELETE /v1/workspaces/:id/apps/:app_id` and `DELETE /v1/workspaces/:id/databases/:db_id` — owner only.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/links/remove-app\n */\nexport type RESTDeleteAPIWorkspaceResourceLinkResponse = APIPayload<null>;\n\n// ---------------------------------------------------------------------------\n// Action requests\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/workspaces/:id/action-requests` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/list\n */\nexport interface RESTGetAPIWorkspaceActionRequestsQuery {\n\tstatus?: WorkspaceActionRequestStatus;\n}\nexport type RESTGetAPIWorkspaceActionRequestsResponse = APIPayload<APIWorkspaceActionRequest[]>;\n\n/**\n * `POST /v1/workspaces/:id/action-requests` — any member (who lacks the action's permission).\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/create\n */\nexport type RESTPostAPIWorkspaceActionRequestBody = {\n\t[A in WorkspaceActionRequestAction]: { action: A; resource_id: string } & (WorkspaceActionRequestParams[A] extends Record<string, never> ? { params?: WorkspaceActionRequestParams[A] } : { params: WorkspaceActionRequestParams[A] });\n}[WorkspaceActionRequestAction];\nexport type RESTPostAPIWorkspaceActionRequestResponse = APIPayload<APIWorkspaceActionRequest>;\n\n/**\n * `POST /v1/workspaces/:id/action-requests/:rid/approve` — permission `members:manage` plus\n * the permission the action requires.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/approve\n */\nexport type RESTPostAPIWorkspaceActionRequestApproveResponse = APIPayload<APIWorkspaceActionRequest>;\n\n/**\n * `POST /v1/workspaces/:id/action-requests/:rid/reject` — permission `members:manage`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/workspaces/action-requests/reject\n */\nexport type RESTPostAPIWorkspaceActionRequestRejectResponse = APIPayload<APIWorkspaceActionRequest>;\n\n// ---------------------------------------------------------------------------\n// Export\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/workspaces/:id/activities/export` — permission `activities:read`. CSV, 90-day window.\n * Dashboard session only.\n */\nexport interface RESTGetAPIWorkspaceActivitiesExportQuery {\n\tfrom?: ISODateString;\n\tto?: ISODateString;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}