@vertracloud/api-types 0.1.1 → 0.2.1

package/payloads/v1/oauth.d.ts

@@ -0,0 +1,27 @@
+import { ISODateString } from '../../common/v1.js';
+import './api-error.js';
+
+/**
+ * OAuth client registered dynamically (RFC 7591) to connect an external agent to the account.
+ * Public client: no secret, PKCE `S256` required.
+ * @see https://docs.vertracloud.app/api-reference/introduction#connecting-through-oauth
+ */
+interface APIOAuthClient {
+    client_id: string;
+    /** Name shown on the consent screen; the API key created on consent is named `oauth:<client_name>` (max. 40 characters). */
+    client_name: string;
+    /** Matched exactly on `authorize`; no wildcards. */
+    redirect_uris: string[];
+    created_at: ISODateString;
+}
+type APIOAuthCodeChallengeMethod = "S256";
+declare const APIOAuthCodeChallengeMethod: {
+    readonly S256: "S256";
+};
+type APIOAuthConsentDecision = "approve" | "deny";
+declare const APIOAuthConsentDecision: {
+    readonly Approve: "approve";
+    readonly Deny: "deny";
+};
+
+export { type APIOAuthClient, APIOAuthCodeChallengeMethod, APIOAuthConsentDecision };

package/payloads/v1/oauth.js

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// payloads/v1/oauth.ts
+var oauth_exports = {};
+__export(oauth_exports, {
+  APIOAuthCodeChallengeMethod: () => APIOAuthCodeChallengeMethod,
+  APIOAuthConsentDecision: () => APIOAuthConsentDecision
+});
+module.exports = __toCommonJS(oauth_exports);
+var APIOAuthCodeChallengeMethod = { S256: "S256" };
+var APIOAuthConsentDecision = { Approve: "approve", Deny: "deny" };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  APIOAuthCodeChallengeMethod,
+  APIOAuthConsentDecision
+});
+//# sourceMappingURL=oauth.js.map

package/payloads/v1/oauth.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["oauth.ts"],"sourcesContent":["import type { ISODateString } from \"../../v1\";\n\n/**\n * OAuth client registered dynamically (RFC 7591) to connect an external agent to the account.\n * Public client: no secret, PKCE `S256` required.\n * @see https://docs.vertracloud.app/api-reference/introduction#connecting-through-oauth\n */\nexport interface APIOAuthClient {\n\tclient_id: string;\n\t/** Name shown on the consent screen; the API key created on consent is named `oauth:<client_name>` (max. 40 characters). */\n\tclient_name: string;\n\t/** Matched exactly on `authorize`; no wildcards. */\n\tredirect_uris: string[];\n\tcreated_at: ISODateString;\n}\n\nexport type APIOAuthCodeChallengeMethod = \"S256\";\nexport const APIOAuthCodeChallengeMethod = { S256: \"S256\" } as const;\n\nexport type APIOAuthConsentDecision = \"approve\" | \"deny\";\nexport const APIOAuthConsentDecision = { Approve: \"approve\", Deny: \"deny\" } as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAiBO,IAAM,8BAA8B,EAAE,MAAM,OAAO;AAGnD,IAAM,0BAA0B,EAAE,SAAS,WAAW,MAAM,OAAO;","names":[]}

package/payloads/v1/oauth.mjs

@@ -0,0 +1,8 @@
+// payloads/v1/oauth.ts
+var APIOAuthCodeChallengeMethod = { S256: "S256" };
+var APIOAuthConsentDecision = { Approve: "approve", Deny: "deny" };
+export {
+  APIOAuthCodeChallengeMethod,
+  APIOAuthConsentDecision
+};
+//# sourceMappingURL=oauth.mjs.map

package/payloads/v1/orders.d.ts

@@ -1,61 +1,84 @@
 import { ISODateString } from '../../common/v1.js';
+import './api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
 type OrderStatus = "unpaid" | "paid" | "cancelled" | "expired";
+declare const OrderStatus: {
+    readonly UNPAID: "unpaid";
+    readonly PAID: "paid";
+    readonly CANCELLED: "cancelled";
+    readonly EXPIRED: "expired";
+};
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
-type OrderType = "purchase" | "renew" | "upgrade" | "credits";
+type OrderType = "purchase" | "renew" | "upgrade";
+declare const OrderType: {
+    readonly PURCHASE: "purchase";
+    readonly RENEW: "renew";
+    readonly UPGRADE: "upgrade";
+};
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
 type OrderProvider = "pix" | "redeem_code";
+declare const OrderProvider: {
+    readonly PIX: "pix";
+    readonly REDEEM_CODE: "redeem_code";
+};
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
 interface APIOrderCreateResponse {
     id: string;
     code: string | null;
-    status: string;
-    plan?: string;
-    amount?: number;
-    duration?: number;
+    /** Usually `"unpaid"`; `"paid"` right away when a coupon brings the price to zero. */
+    status: OrderStatus;
+    plan: string;
+    /** Duration in days. */
+    duration: number;
+    discount: APIOrderDiscount;
+    /** Final price, after the discount. */
     price: number;
     expires_at: ISODateString | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
+ */
+interface APIOrderDiscount {
+    /** `null` when no coupon was applied. */
+    percent: number | null;
+    coupon: string | null;
+    /** Price before the discount. */
+    price: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status
  */
 interface APIOrderStatus {
     id: string;
-    status: string;
+    status: OrderStatus;
     price: number;
     related_to: {
-        credits?: {
-            amount: number;
-        };
-        plan?: {
+        plan: {
             name: string;
             months: number;
         };
     };
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders
  */
 interface APIOrderListItem {
     id: string;
-    status: string;
+    status: OrderStatus;
     price: number;
-    provider: string;
-    type: string;
+    provider: OrderProvider;
+    type: OrderType;
     related_to: {
-        credits?: {
-            amount: number;
-        };
-        plan?: {
+        plan: {
             name: string;
             duration: number;
             months: number;
@@ -65,10 +88,12 @@ interface APIOrderListItem {
     paid_at: ISODateString | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/orders
+ * PIX charge of an order (`POST /v1/orders/:orderId/initiate/pix`).
+ * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix
  */
-interface APIPixPaymentResponse {
-    transaction_amount: number | string;
+interface APIOrderPixPayment {
+    /** Amount charged, in BRL. */
+    transaction_amount: number;
     external_reference: string | null;
     txid: string;
     qrcode: {
@@ -77,4 +102,4 @@ interface APIPixPaymentResponse {
     };
 }
 
-export type { APIOrderCreateResponse, APIOrderListItem, APIOrderStatus, APIPixPaymentResponse, OrderProvider, OrderStatus, OrderType };
+export { type APIOrderCreateResponse, type APIOrderDiscount, type APIOrderListItem, type APIOrderPixPayment, type APIOrderStatus, OrderProvider, OrderStatus, OrderType };

package/payloads/v1/orders.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -15,5 +19,31 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 
 // payloads/v1/orders.ts
 var orders_exports = {};
+__export(orders_exports, {
+  OrderProvider: () => OrderProvider,
+  OrderStatus: () => OrderStatus,
+  OrderType: () => OrderType
+});
 module.exports = __toCommonJS(orders_exports);
+var OrderStatus = {
+  UNPAID: "unpaid",
+  PAID: "paid",
+  CANCELLED: "cancelled",
+  EXPIRED: "expired"
+};
+var OrderType = {
+  PURCHASE: "purchase",
+  RENEW: "renew",
+  UPGRADE: "upgrade"
+};
+var OrderProvider = {
+  PIX: "pix",
+  REDEEM_CODE: "redeem_code"
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OrderProvider,
+  OrderStatus,
+  OrderType
+});
 //# sourceMappingURL=orders.js.map

package/payloads/v1/orders.js.map

@@ -1 +1 @@
-{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { ISODateString } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport type OrderStatus = \"unpaid\" | \"paid\" | \"cancelled\" | \"expired\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport type OrderType = \"purchase\" | \"renew\" | \"upgrade\" | \"credits\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport type OrderProvider = \"pix\" | \"redeem_code\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport interface APIOrderCreateResponse {\n\tid: string;\n\tcode: string | null;\n\tstatus: string;\n\tplan?: string;\n\tamount?: number;\n\tduration?: number;\n\tprice: number;\n\texpires_at: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport interface APIOrderStatus {\n\tid: string;\n\tstatus: string;\n\tprice: number;\n\trelated_to: { credits?: { amount: number }; plan?: { name: string; months: number } };\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport interface APIOrderListItem {\n\tid: string;\n\tstatus: string;\n\tprice: number;\n\tprovider: string;\n\ttype: string;\n\trelated_to: { credits?: { amount: number }; plan?: { name: string; duration: number; months: number } };\n\tcreated_at: ISODateString;\n\tpaid_at: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/orders\n */\nexport interface APIPixPaymentResponse {\n\ttransaction_amount: number | string;\n\texternal_reference: string | null;\n\ttxid: string;\n\tqrcode: { copy: string | null; base64: string | null };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { ISODateString } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderStatus = \"unpaid\" | \"paid\" | \"cancelled\" | \"expired\";\nexport const OrderStatus = {\n\tUNPAID: \"unpaid\",\n\tPAID: \"paid\",\n\tCANCELLED: \"cancelled\",\n\tEXPIRED: \"expired\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderType = \"purchase\" | \"renew\" | \"upgrade\";\nexport const OrderType = {\n\tPURCHASE: \"purchase\",\n\tRENEW: \"renew\",\n\tUPGRADE: \"upgrade\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderProvider = \"pix\" | \"redeem_code\";\nexport const OrderProvider = {\n\tPIX: \"pix\",\n\tREDEEM_CODE: \"redeem_code\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderCreateResponse {\n\tid: string;\n\tcode: string | null;\n\t/** Usually `\"unpaid\"`; `\"paid\"` right away when a coupon brings the price to zero. */\n\tstatus: OrderStatus;\n\tplan: string;\n\t/** Duration in days. */\n\tduration: number;\n\tdiscount: APIOrderDiscount;\n\t/** Final price, after the discount. */\n\tprice: number;\n\texpires_at: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderDiscount {\n\t/** `null` when no coupon was applied. */\n\tpercent: number | null;\n\tcoupon: string | null;\n\t/** Price before the discount. */\n\tprice: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport interface APIOrderStatus {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\trelated_to: { plan: { name: string; months: number } };\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface APIOrderListItem {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\tprovider: OrderProvider;\n\ttype: OrderType;\n\trelated_to: { plan: { name: string; duration: number; months: number } };\n\tcreated_at: ISODateString;\n\tpaid_at: ISODateString | null;\n}\n\n/**\n * PIX charge of an order (`POST /v1/orders/:orderId/initiate/pix`).\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport interface APIOrderPixPayment {\n\t/** Amount charged, in BRL. */\n\ttransaction_amount: number;\n\texternal_reference: string | null;\n\ttxid: string;\n\tqrcode: { copy: string | null; base64: string | null };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,cAAc;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,WAAW;AAAA,EACX,SAAS;AACV;AAMO,IAAM,YAAY;AAAA,EACxB,UAAU;AAAA,EACV,OAAO;AAAA,EACP,SAAS;AACV;AAMO,IAAM,gBAAgB;AAAA,EAC5B,KAAK;AAAA,EACL,aAAa;AACd;","names":[]}

package/payloads/v1/orders.mjs

@@ -1 +1,22 @@
+// payloads/v1/orders.ts
+var OrderStatus = {
+  UNPAID: "unpaid",
+  PAID: "paid",
+  CANCELLED: "cancelled",
+  EXPIRED: "expired"
+};
+var OrderType = {
+  PURCHASE: "purchase",
+  RENEW: "renew",
+  UPGRADE: "upgrade"
+};
+var OrderProvider = {
+  PIX: "pix",
+  REDEEM_CODE: "redeem_code"
+};
+export {
+  OrderProvider,
+  OrderStatus,
+  OrderType
+};
 //# sourceMappingURL=orders.mjs.map

package/payloads/v1/redeem.d.ts

@@ -1,5 +1,5 @@
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/redeem
+ * @see https://docs.vertracloud.app/api-reference/endpoint/redeem/redeem
  */
 interface APIRedeemResponse {
     plan: {

package/payloads/v1/redeem.js.map

@@ -1 +1 @@
-{"version":3,"sources":["redeem.ts"],"sourcesContent":["/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/redeem\n */\nexport interface APIRedeemResponse {\n\tplan: {\n\t\tname: string;\n\t\tduration: number;\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["redeem.ts"],"sourcesContent":["/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/redeem/redeem\n */\nexport interface APIRedeemResponse {\n\tplan: {\n\t\tname: string;\n\t\tduration: number;\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/payloads/v1/snapshot.d.ts

@@ -1,7 +1,10 @@
 import { SnowFlake, ISODateString } from '../../common/v1.js';
+import { ApplicationType } from './application.js';
+import { DatabaseType } from './database.js';
+import './api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
  */
 type ResourceType = 1 | 2;
 declare const ResourceType: {
@@ -9,31 +12,58 @@ declare const ResourceType: {
     readonly DATABASE: 2;
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots
+ * `resource_type` of a snapshot: the resource's own type at snapshot time — `ApplicationType` for
+ * an application snapshot, `DatabaseType` (the engine) for a database snapshot.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
+ */
+type SnapshotResourceType = ApplicationType | DatabaseType;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
  */
 interface APIResourceSnapshot {
     id: SnowFlake;
     resource_id: SnowFlake;
     author_id: SnowFlake | null;
-    resource_type: number | null;
+    resource_type: SnapshotResourceType | null;
     size: string;
     date: ISODateString;
+    /**
+     * Name the resource had when this snapshot was taken — frozen: it does not follow renames and
+     * is kept after the project is deleted. `null` for snapshots taken before this field existed.
+     * For the CURRENT resource name, use `APIGroupedResourceSnapshots.resource_name`.
+     */
+    resource_name: string | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
  */
 interface APIGroupedResourceSnapshots {
     resource_id: SnowFlake;
+    /**
+     * CURRENT resource name. If the resource was deleted, falls back to the `resource_name` of the
+     * group's most recent snapshot; `null` only when neither exists.
+     */
     resource_name: string | null;
     type: ResourceType;
-    resource_type: number | null;
+    resource_type: SnapshotResourceType | null;
     snapshots: APIResourceSnapshot[];
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots
+ * Query of the snapshot routes under `/v1/users/...`: which kind of resource the snapshot belongs
+ * to. Required — a missing `scope` returns 400.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots
+ */
+type SnapshotScope = "applications" | "databases";
+declare const SnapshotScope: {
+    readonly APPLICATIONS: "applications";
+    readonly DATABASES: "databases";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore
  */
 interface APISnapshotRestoreResponse {
     message: string;
 }
 
-export { type APIGroupedResourceSnapshots, type APIResourceSnapshot, type APISnapshotRestoreResponse, ResourceType };
+export { type APIGroupedResourceSnapshots, type APIResourceSnapshot, type APISnapshotRestoreResponse, ResourceType, type SnapshotResourceType, SnapshotScope };

package/payloads/v1/snapshot.js

@@ -20,15 +20,21 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // payloads/v1/snapshot.ts
 var snapshot_exports = {};
 __export(snapshot_exports, {
-  ResourceType: () => ResourceType
+  ResourceType: () => ResourceType,
+  SnapshotScope: () => SnapshotScope
 });
 module.exports = __toCommonJS(snapshot_exports);
 var ResourceType = {
   APPLICATION: 1,
   DATABASE: 2
 };
+var SnapshotScope = {
+  APPLICATIONS: "applications",
+  DATABASES: "databases"
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ResourceType
+  ResourceType,
+  SnapshotScope
 });
 //# sourceMappingURL=snapshot.js.map

package/payloads/v1/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"sources":["snapshot.ts"],"sourcesContent":["import type { ISODateString, SnowFlake } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots\n */\nexport type ResourceType = 1 | 2;\nexport const ResourceType = {\n\tAPPLICATION: 1,\n\tDATABASE: 2,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots\n */\nexport interface APIResourceSnapshot {\n\tid: SnowFlake;\n\tresource_id: SnowFlake;\n\tauthor_id: SnowFlake | null;\n\tresource_type: number | null;\n\tsize: string;\n\tdate: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots\n */\nexport interface APIGroupedResourceSnapshots {\n\tresource_id: SnowFlake;\n\tresource_name: string | null;\n\ttype: ResourceType;\n\tresource_type: number | null;\n\tsnapshots: APIResourceSnapshot[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/snapshots\n */\nexport interface APISnapshotRestoreResponse {\n\tmessage: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,eAAe;AAAA,EAC3B,aAAa;AAAA,EACb,UAAU;AACX;","names":[]}
+{"version":3,"sources":["snapshot.ts"],"sourcesContent":["import type { ApplicationType, DatabaseType, ISODateString, SnowFlake } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport type ResourceType = 1 | 2;\nexport const ResourceType = {\n\tAPPLICATION: 1,\n\tDATABASE: 2,\n} as const;\n\n/**\n * `resource_type` of a snapshot: the resource's own type at snapshot time — `ApplicationType` for\n * an application snapshot, `DatabaseType` (the engine) for a database snapshot.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport type SnapshotResourceType = ApplicationType | DatabaseType;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport interface APIResourceSnapshot {\n\tid: SnowFlake;\n\tresource_id: SnowFlake;\n\tauthor_id: SnowFlake | null;\n\tresource_type: SnapshotResourceType | null;\n\tsize: string;\n\tdate: ISODateString;\n\t/**\n\t * Name the resource had when this snapshot was taken — frozen: it does not follow renames and\n\t * is kept after the project is deleted. `null` for snapshots taken before this field existed.\n\t * For the CURRENT resource name, use `APIGroupedResourceSnapshots.resource_name`.\n\t */\n\tresource_name: string | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport interface APIGroupedResourceSnapshots {\n\tresource_id: SnowFlake;\n\t/**\n\t * CURRENT resource name. If the resource was deleted, falls back to the `resource_name` of the\n\t * group's most recent snapshot; `null` only when neither exists.\n\t */\n\tresource_name: string | null;\n\ttype: ResourceType;\n\tresource_type: SnapshotResourceType | null;\n\tsnapshots: APIResourceSnapshot[];\n}\n\n/**\n * Query of the snapshot routes under `/v1/users/...`: which kind of resource the snapshot belongs\n * to. Required — a missing `scope` returns 400.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/snapshots\n */\nexport type SnapshotScope = \"applications\" | \"databases\";\nexport const SnapshotScope = {\n\tAPPLICATIONS: \"applications\",\n\tDATABASES: \"databases\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/snapshots/restore\n */\nexport interface APISnapshotRestoreResponse {\n\tmessage: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,eAAe;AAAA,EAC3B,aAAa;AAAA,EACb,UAAU;AACX;AAiDO,IAAM,gBAAgB;AAAA,EAC5B,cAAc;AAAA,EACd,WAAW;AACZ;","names":[]}

package/payloads/v1/snapshot.mjs

@@ -3,7 +3,12 @@ var ResourceType = {
   APPLICATION: 1,
   DATABASE: 2
 };
+var SnapshotScope = {
+  APPLICATIONS: "applications",
+  DATABASES: "databases"
+};
 export {
-  ResourceType
+  ResourceType,
+  SnapshotScope
 };
 //# sourceMappingURL=snapshot.mjs.map

package/payloads/v1/status.d.ts

@@ -1,5 +1,5 @@
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/status
+ * @see https://docs.vertracloud.app/api-reference/endpoint/services/status
  */
 type StatusType = "healthy" | "degraded" | "unknown";
 declare const StatusType: {
@@ -8,7 +8,7 @@ declare const StatusType: {
     readonly UNKNOWN: "unknown";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/status
+ * @see https://docs.vertracloud.app/api-reference/endpoint/services/status
  */
 interface APIStatus {
     status: StatusType;

package/payloads/v1/status.js.map

@@ -1 +1 @@
-{"version":3,"sources":["status.ts"],"sourcesContent":["/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/status\n */\nexport type StatusType = \"healthy\" | \"degraded\" | \"unknown\";\nexport const StatusType = {\n\tHEALTHY: \"healthy\",\n\tDEGRADED: \"degraded\",\n\tUNKNOWN: \"unknown\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/status\n */\nexport interface APIStatus {\n\tstatus: StatusType;\n\tmessage: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,IAAM,aAAa;AAAA,EACzB,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AACV;","names":[]}
+{"version":3,"sources":["status.ts"],"sourcesContent":["/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/services/status\n */\nexport type StatusType = \"healthy\" | \"degraded\" | \"unknown\";\nexport const StatusType = {\n\tHEALTHY: \"healthy\",\n\tDEGRADED: \"degraded\",\n\tUNKNOWN: \"unknown\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/services/status\n */\nexport interface APIStatus {\n\tstatus: StatusType;\n\tmessage: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,IAAM,aAAa;AAAA,EACzB,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AACV;","names":[]}

package/payloads/v1/user.d.ts

@@ -1,44 +1,58 @@
-import { UserPlan, ISODateString, SnowFlake } from '../../common/v1.js';
+import { UserPlan, ISODateString } from '../../common/v1.js';
 import { APIApplication } from './application.js';
-import { APIUserCredits } from './credits.js';
 import { APIDatabase } from './database.js';
+import { APIWorkspaceResourceOrganization } from './workspace.js';
+import './api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * Dashboard and e-mail language of the account.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/me
+ */
+type UserLanguage = "pt-br" | "en-us" | "es-es";
+declare const UserLanguage: {
+    readonly PT_BR: "pt-br";
+    readonly EN_US: "en-us";
+    readonly ES_ES: "es-es";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/me
  */
 interface APIUser {
     id: string;
     name: string;
     email: string;
     plan_id: UserPlan;
-    language: string;
+    language: UserLanguage;
+    /** Accepts workspace invites by e-mail (`WORKSPACE_INVITES_DISABLED` when off). */
+    workspace_invites_enabled: boolean;
     created_at: ISODateString;
     updated_at: ISODateString;
 }
 interface APIUserConnection {
     provider: string;
     username: string;
-    created_at: ISODateString | string;
+    created_at: ISODateString;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/me
  */
 interface APIUserInfoResponse extends APIUser {
     plan: APIUserPlan;
     applications: APIApplication[];
     databases: APIDatabase[];
     connections: APIUserConnection[];
-    credits: APIUserCredits;
+    /** Saved resource organization (folders, favorites) of this account. */
+    resource_organization: APIWorkspaceResourceOrganization;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/me
  */
 interface APIUserPlanMemory {
     limit: number;
     used: number;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/me
  */
 interface APIUserPlan {
     id: UserPlan;
@@ -48,15 +62,7 @@ interface APIUserPlan {
     memory: APIUserPlanMemory;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
- */
-interface APIUserWorkspaceInviteKey {
-    code: SnowFlake;
-    created_at: ISODateString;
-    expires_at: ISODateString;
-}
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/sessions
  */
 interface APIUserSession {
     id: string;
@@ -71,10 +77,38 @@ interface APIUserSession {
     is_current: boolean;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/users
+ * Legacy response of `POST /me/generate-api-key` (CLI). Prefer `/me/api-keys`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/create
  */
 interface APIUserApiKey {
     api_key: string;
 }
+/**
+ * A request made to the API with one of the user's keys. Dashboard only
+ * (`GET /v1/users/me/api-key/requests` rejects API key authentication). Kept for 30 days.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key-requests
+ */
+interface APIUserApiKeyRequestEvent {
+    id: string;
+    /** Public prefix of the key used; `null` if the key has been deleted. */
+    api_key_prefix: string | null;
+    api_key_id: string | null;
+    method: string;
+    /** Route pattern (`/v1/apps/:id`). */
+    route: string;
+    /** Concrete path, without the query string. */
+    path: string | null;
+    ip: string | null;
+    user_agent: string | null;
+    status: number;
+    duration_ms: number;
+    bytes_in: number | null;
+    bytes_out: number | null;
+    error_code: string | null;
+    /** Request/response body, only for routes that carry no secrets (lifecycle, config, snapshots, network); JSON ≤ 4 KB with secrets redacted. `null` for every other route. */
+    request_body: string | null;
+    response_body: string | null;
+    occurred_at: ISODateString;
+}
 
-export type { APIUser, APIUserApiKey, APIUserConnection, APIUserInfoResponse, APIUserPlan, APIUserPlanMemory, APIUserSession, APIUserWorkspaceInviteKey };
+export { type APIUser, type APIUserApiKey, type APIUserApiKeyRequestEvent, type APIUserConnection, type APIUserInfoResponse, type APIUserPlan, type APIUserPlanMemory, type APIUserSession, UserLanguage };

package/payloads/v1/user.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -15,5 +19,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 
 // payloads/v1/user.ts
 var user_exports = {};
+__export(user_exports, {
+  UserLanguage: () => UserLanguage
+});
 module.exports = __toCommonJS(user_exports);
+var UserLanguage = {
+  PT_BR: "pt-br",
+  EN_US: "en-us",
+  ES_ES: "es-es"
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  UserLanguage
+});
 //# sourceMappingURL=user.js.map

package/payloads/v1/user.js.map

@@ -1 +1 @@
-{"version":3,"sources":["user.ts"],"sourcesContent":["import type { ISODateString, SnowFlake, UserPlan } from \"../../v1\";\nimport type { APIUserCredits } from \"./credits\";\nimport type { APIApplication, APIDatabase } from \"./index\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUser {\n\tid: string;\n\tname: string;\n\temail: string;\n\tplan_id: UserPlan;\n\tlanguage: string;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n}\n\nexport interface APIUserConnection {\n\tprovider: string;\n\tusername: string;\n\tcreated_at: ISODateString | string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserInfoResponse extends APIUser {\n\tplan: APIUserPlan;\n\tapplications: APIApplication[];\n\tdatabases: APIDatabase[];\n\tconnections: APIUserConnection[];\n\tcredits: APIUserCredits;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserPlanMemory {\n\tlimit: number;\n\tused: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserPlan {\n\tid: UserPlan;\n\tname: string;\n\texpires_at: ISODateString | null;\n\tduration: number;\n\tmemory: APIUserPlanMemory;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserWorkspaceInviteKey {\n\tcode: SnowFlake;\n\tcreated_at: ISODateString;\n\texpires_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserSession {\n\tid: string;\n\tuser_id: string;\n\tprovider: string;\n\tip_address: string | null;\n\tlocation: string | null;\n\tdevice: string | null;\n\texpires_at: ISODateString;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tis_current: boolean;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users\n */\nexport interface APIUserApiKey {\n\tapi_key: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["user.ts"],"sourcesContent":["import type { ISODateString, UserPlan } from \"../../v1\";\nimport type { APIApplication, APIDatabase, APIWorkspaceResourceOrganization } from \"./index\";\n\n/**\n * Dashboard and e-mail language of the account.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport type UserLanguage = \"pt-br\" | \"en-us\" | \"es-es\";\nexport const UserLanguage = {\n\tPT_BR: \"pt-br\",\n\tEN_US: \"en-us\",\n\tES_ES: \"es-es\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport interface APIUser {\n\tid: string;\n\tname: string;\n\temail: string;\n\tplan_id: UserPlan;\n\tlanguage: UserLanguage;\n\t/** Accepts workspace invites by e-mail (`WORKSPACE_INVITES_DISABLED` when off). */\n\tworkspace_invites_enabled: boolean;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n}\n\nexport interface APIUserConnection {\n\tprovider: string;\n\tusername: string;\n\tcreated_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport interface APIUserInfoResponse extends APIUser {\n\tplan: APIUserPlan;\n\tapplications: APIApplication[];\n\tdatabases: APIDatabase[];\n\tconnections: APIUserConnection[];\n\t/** Saved resource organization (folders, favorites) of this account. */\n\tresource_organization: APIWorkspaceResourceOrganization;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport interface APIUserPlanMemory {\n\tlimit: number;\n\tused: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/me\n */\nexport interface APIUserPlan {\n\tid: UserPlan;\n\tname: string;\n\texpires_at: ISODateString | null;\n\tduration: number;\n\tmemory: APIUserPlanMemory;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/sessions\n */\nexport interface APIUserSession {\n\tid: string;\n\tuser_id: string;\n\tprovider: string;\n\tip_address: string | null;\n\tlocation: string | null;\n\tdevice: string | null;\n\texpires_at: ISODateString;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tis_current: boolean;\n}\n\n/**\n * Legacy response of `POST /me/generate-api-key` (CLI). Prefer `/me/api-keys`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/create\n */\nexport interface APIUserApiKey {\n\tapi_key: string;\n}\n\n/**\n * A request made to the API with one of the user's keys. Dashboard only\n * (`GET /v1/users/me/api-key/requests` rejects API key authentication). Kept for 30 days.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-key-requests\n */\nexport interface APIUserApiKeyRequestEvent {\n\tid: string;\n\t/** Public prefix of the key used; `null` if the key has been deleted. */\n\tapi_key_prefix: string | null;\n\tapi_key_id: string | null;\n\tmethod: string;\n\t/** Route pattern (`/v1/apps/:id`). */\n\troute: string;\n\t/** Concrete path, without the query string. */\n\tpath: string | null;\n\tip: string | null;\n\tuser_agent: string | null;\n\tstatus: number;\n\tduration_ms: number;\n\tbytes_in: number | null;\n\tbytes_out: number | null;\n\terror_code: string | null;\n\t/** Request/response body, only for routes that carry no secrets (lifecycle, config, snapshots, network); JSON ≤ 4 KB with secrets redacted. `null` for every other route. */\n\trequest_body: string | null;\n\tresponse_body: string | null;\n\toccurred_at: ISODateString;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAQO,IAAM,eAAe;AAAA,EAC3B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;","names":[]}

package/payloads/v1/user.mjs

@@ -1 +1,10 @@
+// payloads/v1/user.ts
+var UserLanguage = {
+  PT_BR: "pt-br",
+  EN_US: "en-us",
+  ES_ES: "es-es"
+};
+export {
+  UserLanguage
+};
 //# sourceMappingURL=user.mjs.map