@neon/tools 2.8.0 → 2.9.0

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.
@@ -5,99 +5,102 @@ const zProvisioner = z.string();
5
5
  /**
6
6
  * Cursor-based pagination. The `cursor` value reflects the endpoint's sort field (for example, an ID or timestamp), so pass it back unchanged.
7
7
  */
8
- const zPagination = z.strictObject({ cursor: z.string().min(1) });
8
+ const zPagination = z.strictObject({ cursor: z.string().min(1).describe("Cursor marking the last item in this response.") }).describe("Cursor-based pagination.");
9
9
  const zPaginationResponse = z.strictObject({ pagination: zPagination.optional() });
10
10
  /**
11
11
  * Empty response.
12
12
  */
13
- const zEmptyResponse = z.record(z.string(), z.unknown());
13
+ const zEmptyResponse = z.record(z.string(), z.unknown()).describe("Empty response.");
14
+ const zPlanDetails = z.strictObject({
15
+ name: z.string().describe("Plan name, for example `free`, `launch`, or `scale`."),
16
+ version: z.strictObject({
17
+ major: z.int(),
18
+ minor: z.int()
19
+ }).describe("Version of the plan, expressed as `major` and `minor` components.").optional()
20
+ });
14
21
  const zPlanVersion = z.strictObject({
15
22
  major: z.int(),
16
23
  minor: z.int()
17
24
  });
18
- const zPlanDetails = z.strictObject({
19
- name: z.string(),
20
- version: zPlanVersion.optional()
21
- });
22
25
  /**
23
26
  * Add a new JWKS to a specific endpoint of a project
24
27
  */
25
28
  const zAddProjectJwksRequest = z.strictObject({
26
- jwks_url: z.string(),
27
- provider_name: z.string(),
28
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
29
- jwt_audience: z.string().optional(),
30
- role_names: z.array(z.string()).min(0).max(10).optional(),
31
- skip_role_creation: z.boolean().optional()
32
- });
29
+ jwks_url: z.string().describe("URL of the provider's JWKS endpoint used to verify JWTs."),
30
+ provider_name: z.string().describe("The name of the authentication provider (e.g., Clerk, Stytch, Auth0)"),
31
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID.").optional(),
32
+ jwt_audience: z.string().describe("Expected `aud` claim in incoming JWTs.").optional(),
33
+ role_names: z.array(z.string()).min(0).max(10).describe("Deprecated. The roles the JWKS should be mapped to.").optional(),
34
+ skip_role_creation: z.boolean().describe("Deprecated. Only used with Neon RLS.").optional()
35
+ }).describe("Add a new JWKS to a specific endpoint of a project");
33
36
  const zJwks = z.strictObject({
34
- id: z.string(),
35
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
36
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
37
- jwks_url: z.string(),
38
- provider_name: z.string(),
39
- created_at: z.iso.datetime(),
40
- updated_at: z.iso.datetime(),
41
- jwt_audience: z.string().optional(),
42
- role_names: z.array(z.string()).optional()
37
+ id: z.string().describe("The JWKS configuration's ID."),
38
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
39
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID.").optional(),
40
+ jwks_url: z.string().describe("URL of the provider's JWKS endpoint used to verify JWTs."),
41
+ provider_name: z.string().describe("The name of the authentication provider (e.g., Clerk, Stytch, Auth0)"),
42
+ created_at: z.iso.datetime().describe("The date and time when the JWKS was created"),
43
+ updated_at: z.iso.datetime().describe("The date and time when the JWKS was last modified"),
44
+ jwt_audience: z.string().describe("Expected JWT `aud` claim value configured for this JWKS.").optional(),
45
+ role_names: z.array(z.string()).describe("Database role names that are permitted to authenticate using this JWKS configuration.").optional()
43
46
  });
44
47
  /**
45
48
  * The list of configured JWKS definitions for a project
46
49
  */
47
- const zProjectJwksResponse = z.strictObject({ jwks: z.array(zJwks) });
50
+ const zProjectJwksResponse = z.strictObject({ jwks: z.array(zJwks).describe("JWKS configurations associated with the project.") }).describe("The list of configured JWKS definitions for a project");
48
51
  /**
49
52
  * Category of an advisor issue
50
53
  */
51
- const zAdvisorCategory = z.enum(["SECURITY", "PERFORMANCE"]);
54
+ const zAdvisorCategory = z.enum(["SECURITY", "PERFORMANCE"]).describe("Category of an advisor issue");
52
55
  const zAdvisorIssue = z.strictObject({
53
- name: z.string(),
54
- title: z.string(),
55
- level: z.string(),
56
- facing: z.enum(["EXTERNAL", "INTERNAL"]),
57
- categories: z.array(zAdvisorCategory),
58
- description: z.string(),
59
- detail: z.string(),
60
- remediation: z.string(),
61
- metadata: z.record(z.string(), z.unknown()),
62
- cache_key: z.string()
63
- });
64
- const zApiKeyCreateRequest = z.strictObject({ key_name: z.string().max(64) });
65
- const zOrgApiKeyCreateRequest = zApiKeyCreateRequest.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() }));
56
+ name: z.string().describe("Unique identifier for the issue type"),
57
+ title: z.string().describe("Human-readable title"),
58
+ level: z.string().describe("Severity level of the issue"),
59
+ facing: z.enum(["EXTERNAL", "INTERNAL"]).describe("Whether this issue affects external API exposure or is internal only"),
60
+ categories: z.array(zAdvisorCategory).describe("Categories this issue belongs to"),
61
+ description: z.string().describe("Detailed description of what this check detects"),
62
+ detail: z.string().describe("Specific details about this instance of the issue"),
63
+ remediation: z.string().describe("URL to documentation on how to fix this issue"),
64
+ metadata: z.record(z.string(), z.unknown()).describe("Additional context-specific metadata"),
65
+ cache_key: z.string().describe("Unique key for caching this issue result")
66
+ });
67
+ const zApiKeyCreateRequest = z.strictObject({ key_name: z.string().max(64).describe("A user-specified API key name.") });
68
+ const zOrgApiKeyCreateRequest = zApiKeyCreateRequest.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("If set, the API key can access only this project").optional() }));
66
69
  const zApiKeyCreateResponse = z.strictObject({
67
- id: z.int(),
68
- key: z.string(),
69
- name: z.string(),
70
- created_at: z.iso.datetime(),
71
- created_by: z.uuid()
70
+ id: z.int().describe("The API key's unique numeric ID."),
71
+ key: z.string().describe("The generated 64-bit token required to access the Neon API"),
72
+ name: z.string().describe("The user-specified API key name"),
73
+ created_at: z.iso.datetime().describe("A timestamp indicating when the API key was created"),
74
+ created_by: z.uuid().describe("ID of the user who created this API key")
72
75
  });
73
- const zOrgApiKeyCreateResponse = zApiKeyCreateResponse.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() }));
76
+ const zOrgApiKeyCreateResponse = zApiKeyCreateResponse.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("If set, the API key can access only this project").optional() }));
74
77
  const zApiKeyRevokeResponse = z.strictObject({
75
- id: z.int(),
76
- name: z.string(),
77
- created_at: z.iso.datetime(),
78
- created_by: z.uuid(),
78
+ id: z.int().describe("The API key's unique numeric ID."),
79
+ name: z.string().describe("The user-specified API key name"),
80
+ created_at: z.iso.datetime().describe("A timestamp indicating when the API key was created"),
81
+ created_by: z.uuid().describe("ID of the user who created this API key"),
79
82
  last_used_at: z.iso.datetime().nullish(),
80
- last_used_from_addr: z.string(),
81
- revoked: z.boolean()
83
+ last_used_from_addr: z.string().describe("The IP address from which the API key was last used"),
84
+ revoked: z.boolean().describe("A `true` or `false` value indicating whether the API key is revoked")
82
85
  });
83
- const zOrgApiKeyRevokeResponse = zApiKeyRevokeResponse.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() }));
86
+ const zOrgApiKeyRevokeResponse = zApiKeyRevokeResponse.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("If set, the API key can access only this project").optional() }));
84
87
  /**
85
88
  * The user data of the user that created this API key.
86
89
  */
87
90
  const zApiKeyCreatorData = z.strictObject({
88
- id: z.uuid(),
89
- name: z.string(),
90
- image: z.string()
91
- });
91
+ id: z.uuid().describe("ID of the user who created this API key"),
92
+ name: z.string().describe("Display name of the user who created the API key."),
93
+ image: z.string().describe("The URL to the user's avatar image.")
94
+ }).describe("The user data of the user that created this API key.");
92
95
  const zApiKeysListResponseItem = z.strictObject({
93
- id: z.int(),
94
- name: z.string(),
95
- created_at: z.iso.datetime(),
96
+ id: z.int().describe("The API key's unique numeric ID."),
97
+ name: z.string().describe("The user-specified API key name"),
98
+ created_at: z.iso.datetime().describe("A timestamp indicating when the API key was created"),
96
99
  created_by: zApiKeyCreatorData,
97
100
  last_used_at: z.iso.datetime().nullish(),
98
- last_used_from_addr: z.string()
101
+ last_used_from_addr: z.string().describe("The IP address from which the API key was last used")
99
102
  });
100
- const zOrgApiKeysListResponseItem = zApiKeysListResponseItem.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() }));
103
+ const zOrgApiKeysListResponseItem = zApiKeysListResponseItem.merge(z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("If set, the API key can access only this project").optional() }));
101
104
  /**
102
105
  * The action performed by the operation
103
106
  */
@@ -138,7 +141,35 @@ const zOperationAction = z.enum([
138
141
  "mark_migration_prepared",
139
142
  "update_catalog",
140
143
  "epc_sync"
141
- ]);
144
+ ]).describe("The action performed by the operation");
145
+ /**
146
+ * An asynchronous action Neon performs on your resources (for example, starting a compute or creating a branch). Fields such as `action`, `status`, and `total_duration_ms` describe the operation and its progress.
147
+ */
148
+ const zOperation = z.strictObject({
149
+ id: z.uuid().describe("The operation ID"),
150
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this operation ran on."),
151
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this operation ran on.").optional(),
152
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the compute endpoint this operation ran on.").optional(),
153
+ action: zOperationAction,
154
+ status: z.enum([
155
+ "scheduling",
156
+ "running",
157
+ "finished",
158
+ "failed",
159
+ "error",
160
+ "cancelling",
161
+ "cancelled",
162
+ "skipped"
163
+ ]).describe("Current lifecycle state of the operation."),
164
+ error: z.string().describe("Human-readable message describing why the operation failed.").optional(),
165
+ failures_count: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The number of times the operation failed"),
166
+ retry_at: z.iso.datetime().describe("A timestamp indicating when the operation was last retried").optional(),
167
+ created_at: z.iso.datetime().describe("A timestamp indicating when the operation was created"),
168
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the operation status was last updated"),
169
+ total_duration_ms: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The total duration of the operation in milliseconds")
170
+ }).describe("An asynchronous action Neon performs on your resources (for example, starting a compute or creating a branch).");
171
+ const zOperationResponse = z.strictObject({ operation: zOperation });
172
+ const zOperationsResponse = z.strictObject({ operations: z.array(zOperation) });
142
173
  /**
143
174
  * Lifecycle state of the operation. `scheduling`: queued, not yet started. `running`: actively executing. `finished`: completed successfully. `failed`: ended with a failure. `error`: ended with a terminal error. `cancelling`: cancellation requested but not yet complete. `cancelled`: stopped before completion. `skipped`: bypassed without executing.
144
175
  */
@@ -151,45 +182,26 @@ const zOperationStatus = z.enum([
151
182
  "cancelling",
152
183
  "cancelled",
153
184
  "skipped"
154
- ]);
155
- /**
156
- * An asynchronous action Neon performs on your resources (for example, starting a compute or creating a branch). Fields such as `action`, `status`, and `total_duration_ms` describe the operation and its progress.
157
- */
158
- const zOperation = z.strictObject({
159
- id: z.uuid(),
160
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
161
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
162
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
163
- action: zOperationAction,
164
- status: zOperationStatus,
165
- error: z.string().optional(),
166
- failures_count: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
167
- retry_at: z.iso.datetime().optional(),
168
- created_at: z.iso.datetime(),
169
- updated_at: z.iso.datetime(),
170
- total_duration_ms: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })
171
- });
172
- const zOperationResponse = z.strictObject({ operation: zOperation });
173
- const zOperationsResponse = z.strictObject({ operations: z.array(zOperation) });
185
+ ]).describe("Lifecycle state of the operation.");
174
186
  const zProjectTransferRequestResponse = z.strictObject({
175
- id: z.uuid(),
176
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
177
- created_at: z.iso.datetime(),
178
- expires_at: z.iso.datetime()
187
+ id: z.uuid().describe("The unique identifier for the transfer request"),
188
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project that is being transferred"),
189
+ created_at: z.iso.datetime().describe("The timestamp when the transfer request was created"),
190
+ expires_at: z.iso.datetime().describe("The timestamp when the transfer request will expire")
179
191
  });
180
192
  const zAcceptProjectTransferRequestSatisfiesPlanError = z.strictObject({ reasons: z.array(z.strictObject({
181
- message: z.string(),
182
- code: z.string()
183
- })) });
184
- const zProjectsCountResponse = z.strictObject({ count: z.int().gte(0) });
193
+ message: z.string().describe("Description of why the plan is not satisfied"),
194
+ code: z.string().describe("A short code identifying the reason")
195
+ })).describe("List of reasons why the target account's plan cannot satisfy the transfer requirements.") });
196
+ const zProjectsCountResponse = z.strictObject({ count: z.int().gte(0).describe("The total number of projects matching the query criteria.") });
185
197
  const zProjectPermission = z.strictObject({
186
- id: z.string(),
187
- granted_to_email: z.email().min(1).max(256),
188
- granted_at: z.iso.datetime(),
189
- revoked_at: z.iso.datetime().optional()
198
+ id: z.string().describe("The project permission's ID."),
199
+ granted_to_email: z.email().min(1).max(256).describe("Email address of the user who has been granted access to the project."),
200
+ granted_at: z.iso.datetime().describe("Timestamp when the permission was granted."),
201
+ revoked_at: z.iso.datetime().describe("Timestamp when the permission was revoked.").optional()
190
202
  });
191
203
  const zProjectPermissions = z.strictObject({ project_permissions: z.array(zProjectPermission) });
192
- const zGrantPermissionToProjectRequest = z.strictObject({ email: z.email().min(1).max(256) });
204
+ const zGrantPermissionToProjectRequest = z.strictObject({ email: z.email().min(1).max(256).describe("Email address of the user to grant project access to.") });
193
205
  /**
194
206
  * Per-project role. `viewer` maps to `VIEWER`, `editor` maps to `EDITOR`,
195
207
  * and `admin` maps to `ADMIN`.
@@ -199,7 +211,7 @@ const zProjectRole = z.enum([
199
211
  "viewer",
200
212
  "editor",
201
213
  "admin"
202
- ]);
214
+ ]).describe("Per-project role.");
203
215
  /**
204
216
  * The caller's effective permission for a project when
205
217
  * per-project permissions are enabled. `VIEWER` grants read access,
@@ -212,7 +224,7 @@ const zProjectPermissionLevel = z.enum([
212
224
  "VIEWER",
213
225
  "EDITOR",
214
226
  "ADMIN"
215
- ]);
227
+ ]).describe("The caller's effective permission for a project when per-project permissions are enabled.");
216
228
  /**
217
229
  * How a member's project access is granted.
218
230
  *
@@ -222,7 +234,7 @@ const zProjectMemberGrantSource = z.enum([
222
234
  "org_role_default",
223
235
  "org_admin_override",
224
236
  "unassigned"
225
- ]);
237
+ ]).describe("How a member's project access is granted.");
226
238
  /**
227
239
  * Organization-level role used by project member role management.
228
240
  *
@@ -233,12 +245,12 @@ const zProjectMemberOrgRole = z.enum([
233
245
  "editor",
234
246
  "viewer",
235
247
  "collaborator"
236
- ]);
248
+ ]).describe("Organization-level role used by project member role management.");
237
249
  const zProjectMember = z.strictObject({
238
- member_id: z.uuid(),
239
- user_id: z.uuid(),
240
- email: z.email().min(1).max(256).optional(),
241
- name: z.string().optional(),
250
+ member_id: z.uuid().describe("The organization member ID."),
251
+ user_id: z.uuid().describe("The user ID for the organization member."),
252
+ email: z.email().min(1).max(256).describe("Email address of the user who has been granted access to the project.").optional(),
253
+ name: z.string().describe("The user's display name.").optional(),
242
254
  org_role: zProjectMemberOrgRole,
243
255
  project_role: zProjectRole.optional(),
244
256
  org_default_project_permission: zProjectPermissionLevel.optional(),
@@ -251,66 +263,70 @@ const zProjectMemberRoleResponse = z.strictObject({
251
263
  project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
252
264
  member_id: z.uuid(),
253
265
  user_id: z.uuid(),
254
- email: z.email().min(1).max(256).optional(),
255
- name: z.string().optional(),
266
+ email: z.email().min(1).max(256).describe("Email address of the user who has been granted access to the project.").optional(),
267
+ name: z.string().describe("The user's display name.").optional(),
256
268
  org_role: zProjectMemberOrgRole,
257
- project_role: zProjectRole.optional(),
269
+ project_role: z.enum([
270
+ "viewer",
271
+ "editor",
272
+ "admin"
273
+ ]).describe("The resulting effective project role after applying org-admin default access, explicit grants, and creator fallback.").optional(),
258
274
  org_default_project_permission: zProjectPermissionLevel.optional(),
259
275
  explicit_project_permission: zProjectPermissionLevel.optional(),
260
276
  effective_project_permission: zProjectPermissionLevel.optional(),
261
- credential_rotation_recommended: z.boolean().optional(),
262
- org_api_key_rotation_recommended: z.boolean().optional()
277
+ credential_rotation_recommended: z.boolean().describe("Hint that database credentials may need rotation after the role change.").optional(),
278
+ org_api_key_rotation_recommended: z.boolean().describe("Hint that project-scoped org API keys created by the target user may need rotation.").optional()
263
279
  });
264
280
  const zConsumptionHistoryPerTimeframe = z.strictObject({
265
- timeframe_start: z.iso.datetime(),
266
- timeframe_end: z.iso.datetime(),
267
- active_time_seconds: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }),
268
- compute_time_seconds: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }),
269
- written_data_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }),
270
- synthetic_storage_size_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }),
271
- data_storage_bytes_hour: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }),
272
- logical_size_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).optional(),
273
- logical_size_bytes_hour: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).optional()
281
+ timeframe_start: z.iso.datetime().describe("The specified start date-time for the reported consumption."),
282
+ timeframe_end: z.iso.datetime().describe("The specified end date-time for the reported consumption."),
283
+ active_time_seconds: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Seconds."),
284
+ compute_time_seconds: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Seconds."),
285
+ written_data_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Bytes."),
286
+ synthetic_storage_size_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Deprecated: always returns 0."),
287
+ data_storage_bytes_hour: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Deprecated: always returns 0."),
288
+ logical_size_bytes: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Bytes.").optional(),
289
+ logical_size_bytes_hour: z.int().min(0, { error: "Invalid value: Expected uint64 to be >= 0" }).describe("Bytes-Hour.").optional()
274
290
  });
275
291
  const zConsumptionHistoryPerPeriod = z.strictObject({
276
- period_id: z.uuid(),
277
- period_plan: z.string(),
278
- period_start: z.iso.datetime(),
279
- period_end: z.iso.datetime().optional(),
280
- consumption: z.array(zConsumptionHistoryPerTimeframe)
292
+ period_id: z.uuid().describe("The ID assigned to the specified billing period."),
293
+ period_plan: z.string().describe("The billing plan applicable during the billing period."),
294
+ period_start: z.iso.datetime().describe("The start date-time of the billing period."),
295
+ period_end: z.iso.datetime().describe("The end date-time of the billing period, available for the past periods only.").optional(),
296
+ consumption: z.array(zConsumptionHistoryPerTimeframe).describe("Consumption metric records for the billing period.")
281
297
  });
282
298
  const zConsumptionHistoryPerProject = z.strictObject({
283
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
284
- periods: z.array(zConsumptionHistoryPerPeriod)
299
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
300
+ periods: z.array(zConsumptionHistoryPerPeriod).describe("Consumption periods for the project, each covering a discrete billing interval.")
285
301
  });
286
- const zConsumptionHistoryPerProjectResponse = z.strictObject({ projects: z.array(zConsumptionHistoryPerProject) });
302
+ const zConsumptionHistoryPerProjectResponse = z.strictObject({ projects: z.array(zConsumptionHistoryPerProject).describe("Per-project consumption history records included in the response.") });
287
303
  const zConsumptionMetricValue = z.strictObject({
288
- metric_name: z.string(),
289
- value: z.int()
304
+ metric_name: z.string().describe("Name of the consumption metric, such as compute_time or data_storage_bytes_hour."),
305
+ value: z.int().describe("Measured quantity for the metric named by `metric_name`.")
290
306
  });
291
307
  const zConsumptionHistoryPerTimeframeV2 = z.strictObject({
292
- timeframe_start: z.iso.datetime().optional(),
293
- timeframe_end: z.iso.datetime().optional(),
294
- metrics: z.array(zConsumptionMetricValue).optional()
308
+ timeframe_start: z.iso.datetime().describe("The specified start date-time for the reported consumption.").optional(),
309
+ timeframe_end: z.iso.datetime().describe("The specified end date-time for the reported consumption.").optional(),
310
+ metrics: z.array(zConsumptionMetricValue).describe("Consumption metric values recorded for the timeframe.").optional()
295
311
  });
296
312
  const zConsumptionHistoryPerPeriodV2 = z.strictObject({
297
- period_id: z.uuid(),
298
- period_plan: z.string(),
299
- period_start: z.iso.datetime(),
300
- period_end: z.iso.datetime().optional(),
301
- consumption: z.array(zConsumptionHistoryPerTimeframeV2)
313
+ period_id: z.uuid().describe("The ID assigned to the specified billing period."),
314
+ period_plan: z.string().describe("The billing plan applicable during the billing period."),
315
+ period_start: z.iso.datetime().describe("The start date-time of the billing period."),
316
+ period_end: z.iso.datetime().describe("The end date-time of the billing period, available for the past periods only.").optional(),
317
+ consumption: z.array(zConsumptionHistoryPerTimeframeV2).describe("Consumption metric records for the billing period.")
302
318
  });
303
319
  const zConsumptionHistoryPerProjectV2 = z.strictObject({
304
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
305
- periods: z.array(zConsumptionHistoryPerPeriodV2)
320
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
321
+ periods: z.array(zConsumptionHistoryPerPeriodV2).describe("Consumption periods recorded for this project.")
306
322
  });
307
- const zConsumptionHistoryPerProjectV2Response = z.strictObject({ projects: z.array(zConsumptionHistoryPerProjectV2) });
323
+ const zConsumptionHistoryPerProjectV2Response = z.strictObject({ projects: z.array(zConsumptionHistoryPerProjectV2).describe("Per-project consumption history entries for the requested time range.") });
308
324
  const zConsumptionHistoryPerBranchV2 = z.strictObject({
309
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
310
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
311
- periods: z.array(zConsumptionHistoryPerPeriodV2)
325
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project that owns this branch."),
326
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID."),
327
+ periods: z.array(zConsumptionHistoryPerPeriodV2).describe("Consumption history records for the branch, grouped by billing period.")
312
328
  });
313
- const zConsumptionHistoryPerBranchV2Response = z.strictObject({ branches: z.array(zConsumptionHistoryPerBranchV2) });
329
+ const zConsumptionHistoryPerBranchV2Response = z.strictObject({ branches: z.array(zConsumptionHistoryPerBranchV2).describe("Per-branch consumption history records returned for the requested time range.") });
314
330
  const zConsumptionHistoryGranularity = z.enum([
315
331
  "hourly",
316
332
  "daily",
@@ -323,13 +339,13 @@ const zProjectAuditLogLevel = z.enum([
323
339
  "full"
324
340
  ]);
325
341
  const zAvailablePreloadLibrary = z.strictObject({
326
- library_name: z.string(),
327
- description: z.string(),
328
- is_default: z.boolean(),
329
- is_experimental: z.boolean(),
330
- version: z.string()
342
+ library_name: z.string().describe("Name of the Postgres shared preload library as it appears in the `shared_preload_libraries` parameter (for example, `pg_stat_statements`)."),
343
+ description: z.string().describe("Human-readable explanation of the library's purpose and behavior."),
344
+ is_default: z.boolean().describe("Whether this library is loaded by default in the `shared_preload_libraries` configuration for new compute endpoints."),
345
+ is_experimental: z.boolean().describe("Marks the library as experimental."),
346
+ version: z.string().describe("Version of the preload library.")
331
347
  });
332
- const zAvailablePreloadLibraries = z.strictObject({ libraries: z.array(zAvailablePreloadLibrary).optional() });
348
+ const zAvailablePreloadLibraries = z.strictObject({ libraries: z.array(zAvailablePreloadLibrary).describe("Preload libraries available for the project's Postgres version.").optional() });
333
349
  /**
334
350
  * The branch’s state, indicating if it is initializing, ready for use, or archived.
335
351
  * * 'init' - the branch is being created but is not available for querying.
@@ -338,22 +354,22 @@ const zAvailablePreloadLibraries = z.strictObject({ libraries: z.array(zAvailabl
338
354
  * * 'archived' - the branch is stored in cost-effective archival Postgres storage. Expect slow query response times.
339
355
  *
340
356
  */
341
- const zBranchState = z.string();
357
+ const zBranchState = z.string().describe("The branch’s state, indicating if it is initializing, ready for use, or archived.");
342
358
  /**
343
359
  * Could be `restored`, `finalized` or `detaching`.
344
360
  * A `restored` branch becomes permanently `finalized` when you call `finalizeRestoreBranch`
345
361
  * A `restored` or `finalized` branch may begin `detaching` as a one-time performance optimisation, after which it will continue in its original state
346
362
  *
347
363
  */
348
- const zBranchRestoreStatus = z.string();
364
+ const zBranchRestoreStatus = z.string().describe("Could be `restored`, `finalized` or `detaching`.");
349
365
  /**
350
366
  * An action that is currently restricted for the branch and the reason why.
351
367
  *
352
368
  */
353
369
  const zBranchRestrictedAction = z.strictObject({
354
- name: z.string(),
355
- reason: z.string()
356
- });
370
+ name: z.string().describe("The name of a restricted action on a branch."),
371
+ reason: z.string().describe("A human-readable explanation of why the action is restricted.")
372
+ }).describe("An action that is currently restricted for the branch and the reason why.");
357
373
  /**
358
374
  * Recovery information for a deleted branch. Only present when listing deleted branches
359
375
  * with `include_deleted=true`.
@@ -362,103 +378,167 @@ const zBranchRestrictedAction = z.strictObject({
362
378
  *
363
379
  */
364
380
  const zBranchRecoveryInfo = z.strictObject({
365
- deleted_at: z.iso.datetime(),
366
- recoverable_until: z.iso.datetime(),
367
- deletion_method: z.enum(["user", "ttl"])
368
- });
381
+ deleted_at: z.iso.datetime().describe("Timestamp when the branch was deleted"),
382
+ recoverable_until: z.iso.datetime().describe("Timestamp when the recovery window expires and the branch will be permanently deleted"),
383
+ deletion_method: z.enum(["user", "ttl"]).describe("How the branch was deleted: 'user' for manual deletion, 'ttl' for TTL expiration")
384
+ }).describe("Recovery information for a deleted branch.");
369
385
  const zBranch = z.strictObject({
370
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
371
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
372
- parent_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
373
- parent_lsn: z.string().optional(),
374
- parent_timestamp: z.iso.datetime().optional(),
375
- name: z.string(),
386
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID."),
387
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this branch belongs to."),
388
+ parent_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The `branch_id` of the parent branch").optional(),
389
+ parent_lsn: z.string().describe("The Log Sequence Number (LSN) on the parent branch from which this branch was created.").optional(),
390
+ parent_timestamp: z.iso.datetime().describe("The point in time on the parent branch from which this branch was created.").optional(),
391
+ name: z.string().describe("The branch name"),
376
392
  current_state: zBranchState,
377
393
  pending_state: zBranchState.optional(),
378
- state_changed_at: z.iso.datetime(),
379
- logical_size: z.int().optional(),
380
- creation_source: z.string(),
381
- primary: z.boolean().optional(),
382
- default: z.boolean(),
383
- protected: z.boolean(),
384
- cpu_used_sec: z.int(),
385
- compute_time_seconds: z.int(),
386
- active_time_seconds: z.int(),
387
- written_data_bytes: z.int(),
388
- data_transfer_bytes: z.int(),
389
- created_at: z.iso.datetime(),
390
- updated_at: z.iso.datetime(),
391
- ttl_interval_seconds: z.int().optional(),
392
- expires_at: z.iso.datetime().optional(),
393
- last_reset_at: z.iso.datetime().optional(),
394
+ state_changed_at: z.iso.datetime().describe("A UTC timestamp indicating when the `current_state` began"),
395
+ logical_size: z.int().describe("The logical size of the branch, in bytes").optional(),
396
+ creation_source: z.string().describe("The branch creation source"),
397
+ primary: z.boolean().describe("Deprecated. Use the `default` field.").optional(),
398
+ default: z.boolean().describe("Whether the branch is the project's default branch"),
399
+ protected: z.boolean().describe("Whether the branch is protected."),
400
+ cpu_used_sec: z.int().describe("Deprecated. Use `compute_time_seconds` instead."),
401
+ compute_time_seconds: z.int().describe("Total Postgres compute time consumed by this branch during the current billing period, in CU-seconds (weighted by compute size)."),
402
+ active_time_seconds: z.int().describe("Total time this branch's compute has been active during the current billing period, in seconds (not weighted by compute size)."),
403
+ written_data_bytes: z.int().describe("Data written by this branch during the current billing period, in bytes."),
404
+ data_transfer_bytes: z.int().describe("Total data transferred out of the branch, in bytes."),
405
+ created_at: z.iso.datetime().describe("A timestamp indicating when the branch was created"),
406
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the branch was last updated"),
407
+ ttl_interval_seconds: z.int().describe("The time-to-live (TTL) duration originally configured for the branch, in seconds.").optional(),
408
+ expires_at: z.iso.datetime().describe("The timestamp when the branch is scheduled to expire and be automatically deleted.").optional(),
409
+ last_reset_at: z.iso.datetime().describe("A timestamp indicating when the branch was last reset").optional(),
394
410
  created_by: z.strictObject({
395
- name: z.string().optional(),
396
- image: z.string().optional()
397
- }).optional(),
398
- init_source: z.string().optional(),
411
+ name: z.string().describe("Display name of the user who created the branch.").optional(),
412
+ image: z.string().describe("The URL to the user's avatar image.").optional()
413
+ }).describe("The resolved user model that contains details of the user/org/integration/api_key used for branch creation.").optional(),
414
+ init_source: z.string().describe("Source of initialization for the branch.").optional(),
399
415
  restore_status: zBranchRestoreStatus.optional(),
400
- restored_from: z.string().optional(),
401
- restored_as: z.string().optional(),
402
- restricted_actions: z.array(zBranchRestrictedAction).optional(),
416
+ restored_from: z.string().describe("ID of the snapshot that was the restore source for this branch").optional(),
417
+ restored_as: z.string().describe("ID of the target branch which was replaced when this branch was restored").optional(),
418
+ restricted_actions: z.array(zBranchRestrictedAction).describe("A list of actions that are currently restricted for this branch and the reason why.").optional(),
403
419
  recovery: zBranchRecoveryInfo.optional()
404
420
  });
405
421
  const zBranchUpdateRequest = z.strictObject({ branch: z.strictObject({
406
- name: z.string().min(1).max(256).optional(),
407
- protected: z.boolean().optional(),
422
+ name: z.string().min(1).max(256).describe("New display name for the branch.").optional(),
423
+ protected: z.boolean().describe("Whether the branch is protected.").optional(),
408
424
  expires_at: z.iso.datetime().nullish()
409
- }) });
425
+ }).describe("Branch attributes to update.") });
410
426
  const zBranchRestoreRequest = z.strictObject({
411
- source_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
412
- source_lsn: z.string().optional(),
413
- source_timestamp: z.iso.datetime().optional(),
414
- preserve_under_name: z.string().optional()
415
- });
416
- const zBranchResponse = z.strictObject({ branch: zBranch });
417
- const zBranchSchemaCompareResponse = z.strictObject({ diff: z.string().optional() });
418
- const zBranchesResponse = z.strictObject({ branches: z.array(zBranch) });
419
- const zBranchesCountResponse = z.strictObject({ count: z.int() });
427
+ source_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The `branch_id` of the restore source branch."),
428
+ source_lsn: z.string().describe("A Postgres LSN (for example, `0/1A2B3C4`) on the source branch to restore from.").optional(),
429
+ source_timestamp: z.iso.datetime().describe("A point in time on the source branch to restore from, in RFC 3339 format.").optional(),
430
+ preserve_under_name: z.string().describe("Name under which to save the current branch state before restoring.").optional()
431
+ });
432
+ const zBranchResponse = z.strictObject({ branch: z.strictObject({
433
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID."),
434
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this branch belongs to."),
435
+ parent_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The `branch_id` of the parent branch").optional(),
436
+ parent_lsn: z.string().describe("The Log Sequence Number (LSN) on the parent branch from which this branch was created.").optional(),
437
+ parent_timestamp: z.iso.datetime().describe("The point in time on the parent branch from which this branch was created.").optional(),
438
+ name: z.string().describe("The branch name"),
439
+ current_state: zBranchState,
440
+ pending_state: zBranchState.optional(),
441
+ state_changed_at: z.iso.datetime().describe("A UTC timestamp indicating when the `current_state` began"),
442
+ logical_size: z.int().describe("The logical size of the branch, in bytes").optional(),
443
+ creation_source: z.string().describe("The branch creation source"),
444
+ primary: z.boolean().describe("Deprecated. Use the `default` field.").optional(),
445
+ default: z.boolean().describe("Whether the branch is the project's default branch"),
446
+ protected: z.boolean().describe("Whether the branch is protected."),
447
+ cpu_used_sec: z.int().describe("Deprecated. Use `compute_time_seconds` instead."),
448
+ compute_time_seconds: z.int().describe("Total Postgres compute time consumed by this branch during the current billing period, in CU-seconds (weighted by compute size)."),
449
+ active_time_seconds: z.int().describe("Total time this branch's compute has been active during the current billing period, in seconds (not weighted by compute size)."),
450
+ written_data_bytes: z.int().describe("Data written by this branch during the current billing period, in bytes."),
451
+ data_transfer_bytes: z.int().describe("Total data transferred out of the branch, in bytes."),
452
+ created_at: z.iso.datetime().describe("A timestamp indicating when the branch was created"),
453
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the branch was last updated"),
454
+ ttl_interval_seconds: z.int().describe("The time-to-live (TTL) duration originally configured for the branch, in seconds.").optional(),
455
+ expires_at: z.iso.datetime().describe("The timestamp when the branch is scheduled to expire and be automatically deleted.").optional(),
456
+ last_reset_at: z.iso.datetime().describe("A timestamp indicating when the branch was last reset").optional(),
457
+ created_by: z.strictObject({
458
+ name: z.string().describe("Display name of the user who created the branch.").optional(),
459
+ image: z.string().describe("The URL to the user's avatar image.").optional()
460
+ }).describe("The resolved user model that contains details of the user/org/integration/api_key used for branch creation.").optional(),
461
+ init_source: z.string().describe("Source of initialization for the branch.").optional(),
462
+ restore_status: zBranchRestoreStatus.optional(),
463
+ restored_from: z.string().describe("ID of the snapshot that was the restore source for this branch").optional(),
464
+ restored_as: z.string().describe("ID of the target branch which was replaced when this branch was restored").optional(),
465
+ restricted_actions: z.array(zBranchRestrictedAction).describe("A list of actions that are currently restricted for this branch and the reason why.").optional(),
466
+ recovery: zBranchRecoveryInfo.optional()
467
+ }).describe("Branch returned by the request.") });
468
+ const zBranchSchemaResponse = z.strictObject({
469
+ sql: z.string().describe("Branch schema expressed as SQL DDL statements.").optional(),
470
+ json: z.strictObject({ tables: z.array(z.strictObject({
471
+ schema: z.string().describe("Postgres schema (namespace) that contains the table, for example `public`."),
472
+ name: z.string().describe("Name of the table within the schema."),
473
+ columns: z.array(z.strictObject({
474
+ name: z.string().describe("Name of the column."),
475
+ type: z.string().describe("Postgres data type of the column, for example \"integer\" or \"text\"."),
476
+ nullable: z.boolean().describe("Whether the column allows NULL values").optional(),
477
+ generated: z.boolean().describe("Whether the column is a generated (computed) column").optional()
478
+ })).describe("Columns belonging to this table, each describing a column's name and attributes."),
479
+ constraints: z.array(z.strictObject({
480
+ type: z.string().describe("Type of constraint."),
481
+ columns: z.array(z.string()).min(1).describe("Column names participating in this constraint"),
482
+ name: z.string().describe("Optional name of the constraint").optional(),
483
+ referenced_table: z.strictObject({
484
+ schema: z.string().describe("Schema of the referenced table"),
485
+ table: z.string().describe("Name of the referenced table"),
486
+ columns: z.array(z.string()).describe("Names of the referenced columns")
487
+ }).describe("For foreign keys - the referenced table information").optional()
488
+ })).describe("Table constraints defined in the branch schema, such as primary key, foreign key, unique, and check constraints.").optional()
489
+ })).describe("Tables present in the branch schema.") }).describe("Branch schema represented as a structured JSON object, parallel to the SQL DDL in `sql`.").optional()
490
+ });
491
+ const zBranchSchemaCompareResponse = z.strictObject({ diff: z.string().describe("Unified diff of the SQL schema changes between the compared branches.").optional() });
492
+ const zBranchesResponse = z.strictObject({ branches: z.array(zBranch).describe("Branches in the project.") });
493
+ const zBranchesCountResponse = z.strictObject({ count: z.int().describe("Total number of branches in the project.") });
420
494
  const zMaskingRule = z.strictObject({
421
- database_name: z.string(),
422
- schema_name: z.string(),
423
- table_name: z.string(),
424
- column_name: z.string(),
425
- masking_function: z.string().optional(),
426
- masking_value: z.string().optional()
495
+ database_name: z.string().describe("The name of the database containing the table to be masked"),
496
+ schema_name: z.string().describe("The name of the schema containing the table to be masked"),
497
+ table_name: z.string().describe("The name of the table containing the column to be masked"),
498
+ column_name: z.string().describe("The name of the column to be masked"),
499
+ masking_function: z.string().describe("The PostgreSQL Anonymizer masking function to apply.").optional(),
500
+ masking_value: z.string().describe("A literal value to set on the column when masking.").optional()
427
501
  });
428
- const zMaskingRulesResponse = z.strictObject({ masking_rules: z.array(zMaskingRule) });
429
- const zMaskingRulesUpdateRequest = z.strictObject({ masking_rules: z.array(zMaskingRule) });
502
+ const zMaskingRulesResponse = z.strictObject({ masking_rules: z.array(zMaskingRule).describe("List of masking rules for the branch") });
503
+ const zMaskingRulesUpdateRequest = z.strictObject({ masking_rules: z.array(zMaskingRule).describe("List of masking rules to apply to the branch.") });
430
504
  /**
431
505
  * Metadata about the most recent anonymization attempt for the branch.
432
506
  */
433
507
  const zAnonymizationRunMetadata = z.strictObject({
434
- started_at: z.iso.datetime().optional(),
435
- completed_at: z.iso.datetime().optional(),
436
- triggered_by: z.uuid().optional(),
437
- triggered_by_username: z.string().optional(),
438
- masked_columns: z.int().optional()
439
- });
508
+ started_at: z.iso.datetime().describe("Timestamp indicating when the latest anonymization attempt started.").optional(),
509
+ completed_at: z.iso.datetime().describe("Timestamp indicating when the latest anonymization attempt completed.").optional(),
510
+ triggered_by: z.uuid().describe("UUID of the user who triggered the latest anonymization attempt.").optional(),
511
+ triggered_by_username: z.string().describe("Username of the user who triggered the latest anonymization attempt.").optional(),
512
+ masked_columns: z.int().describe("Number of columns that had masking rules applied during the attempt.").optional()
513
+ }).describe("Metadata about the most recent anonymization attempt for the branch.");
440
514
  const zAnonymizedBranchStatusResponse = z.strictObject({
441
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
442
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
443
- state: z.string(),
444
- status_message: z.string().optional(),
445
- created_at: z.iso.datetime(),
446
- updated_at: z.iso.datetime(),
447
- failed_at: z.iso.datetime().optional(),
515
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this branch belongs to."),
516
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the anonymized branch."),
517
+ state: z.string().describe("The current state of the anonymized branch."),
518
+ status_message: z.string().describe("A descriptive message about the current status or any errors").optional(),
519
+ created_at: z.iso.datetime().describe("A timestamp indicating when the anonymized branch was created"),
520
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the anonymized branch status was last updated"),
521
+ failed_at: z.iso.datetime().describe("A timestamp indicating when the anonymized branch operation failed (if applicable)").optional(),
448
522
  last_run: zAnonymizationRunMetadata.optional()
449
523
  });
450
524
  const zConnectionParameters = z.strictObject({
451
- database: z.string(),
452
- password: z.string(),
453
- role: z.string(),
454
- host: z.string(),
455
- pooler_host: z.string()
525
+ database: z.string().describe("Name of the Postgres database used in the connection URI."),
526
+ password: z.string().describe("Authentication password for the role, used in the connection URI."),
527
+ role: z.string().describe("Postgres role used to authenticate the database connection."),
528
+ host: z.string().describe("Hostname of the compute endpoint."),
529
+ pooler_host: z.string().describe("PgBouncer (transaction mode) pooled host, the `-pooler` variant of `host`.")
456
530
  });
457
531
  const zConnectionDetails = z.strictObject({
458
- connection_uri: z.string(),
459
- connection_parameters: zConnectionParameters
532
+ connection_uri: z.string().describe("The connection URI is defined as specified here: Connection URIs The connection URI can be used to connect to a Postgres database with psql or defined in a DATABASE_URL environment variable."),
533
+ connection_parameters: z.strictObject({
534
+ database: z.string().describe("Name of the Postgres database used in the connection URI."),
535
+ password: z.string().describe("Authentication password for the role, used in the connection URI."),
536
+ role: z.string().describe("Postgres role used to authenticate the database connection."),
537
+ host: z.string().describe("Hostname of the compute endpoint."),
538
+ pooler_host: z.string().describe("PgBouncer (transaction mode) pooled host, the `-pooler` variant of `host`.")
539
+ }).describe("Individual components of the connection URI (host, port, database, role, and password) as discrete fields, for programmatic use rather than parsing the sibling `connection_uri` string.")
460
540
  });
461
- const zConnectionUriResponse = z.strictObject({ uri: z.string() });
541
+ const zConnectionUriResponse = z.strictObject({ uri: z.string().describe("The connection URI.") });
462
542
  /**
463
543
  * Lifecycle state of the compute endpoint. `init`: being initialized. `active`: running and accepting connections. `idle`: suspended (scaled to zero).
464
544
  */
@@ -466,18 +546,18 @@ const zEndpointState = z.enum([
466
546
  "init",
467
547
  "active",
468
548
  "idle"
469
- ]);
549
+ ]).describe("Lifecycle state of the compute endpoint.");
470
550
  /**
471
551
  * Compute endpoint type. `read_write`: the primary read-write endpoint (one per branch). `read_only`: a read replica endpoint (multiple allowed per branch).
472
552
  */
473
- const zEndpointType = z.enum(["read_only", "read_write"]);
553
+ const zEndpointType = z.enum(["read_only", "read_write"]).describe("Compute endpoint type.");
474
554
  /**
475
555
  * Deprecated. The connection pooler mode. Neon supports PgBouncer in `transaction` mode only. Removal scheduled for June 20, 2026.
476
556
  *
477
557
  *
478
558
  * @deprecated
479
559
  */
480
- const zEndpointPoolerMode = z.enum(["transaction"]);
560
+ const zEndpointPoolerMode = z.enum(["transaction"]).describe("Deprecated. The connection pooler mode.");
481
561
  /**
482
562
  * Duration of inactivity in seconds after which the compute endpoint is
483
563
  * automatically suspended. The value `0` means use the default value.
@@ -487,7 +567,7 @@ const zEndpointPoolerMode = z.enum(["transaction"]);
487
567
  * [Scale to zero configuration](https://neon.com/docs/manage/endpoints#scale-to-zero-configuration).
488
568
  *
489
569
  */
490
- const zSuspendTimeoutSeconds = z.int().gte(-1).lte(604800);
570
+ const zSuspendTimeoutSeconds = z.int().gte(-1).lte(604800).describe("Duration of inactivity in seconds after which the compute endpoint is automatically suspended.");
491
571
  /**
492
572
  * A list of IP addresses that are allowed to connect to the compute endpoint.
493
573
  * If the list is empty or not set, all IP addresses are allowed.
@@ -495,9 +575,9 @@ const zSuspendTimeoutSeconds = z.int().gte(-1).lte(604800);
495
575
  *
496
576
  */
497
577
  const zAllowedIps = z.strictObject({
498
- ips: z.array(z.string()).optional(),
499
- protected_branches_only: z.boolean().optional()
500
- });
578
+ ips: z.array(z.string()).describe("A list of IP addresses that are allowed to connect to the endpoint.").optional(),
579
+ protected_branches_only: z.boolean().describe("If true, the list will be applied only to protected branches.").optional()
580
+ }).describe("A list of IP addresses that are allowed to connect to the compute endpoint.");
501
581
  /**
502
582
  * A maintenance window is a time period during which Neon may perform maintenance on the project's infrastructure.
503
583
  * During this time, the project's compute endpoints may be unavailable and existing connections can be
@@ -505,66 +585,84 @@ const zAllowedIps = z.strictObject({
505
585
  *
506
586
  */
507
587
  const zMaintenanceWindow = z.strictObject({
508
- weekdays: z.array(z.int()),
509
- start_time: z.string(),
510
- end_time: z.string()
511
- });
588
+ weekdays: z.array(z.int()).describe("A list of weekdays when the maintenance window is active."),
589
+ start_time: z.string().describe("Start time of the maintenance window, in the format of \"HH:MM\"."),
590
+ end_time: z.string().describe("End time of the maintenance window, in the format of \"HH:MM\".")
591
+ }).describe("A maintenance window is a time period during which Neon may perform maintenance on the project's infrastructure.");
512
592
  /**
513
593
  * The shared libraries to preload into the project's compute instances.
514
594
  *
515
595
  */
516
596
  const zPreloadLibraries = z.strictObject({
517
- use_defaults: z.boolean().optional(),
518
- enabled_libraries: z.array(z.string()).optional()
519
- });
520
- const zConnectionUrisResponse = z.strictObject({ connection_uris: z.array(zConnectionDetails) });
521
- const zConnectionUrisOptionalResponse = z.strictObject({ connection_uris: z.array(zConnectionDetails).optional() });
597
+ use_defaults: z.boolean().describe("When true, the project's preload libraries include the platform default set in addition to any libraries listed in `enabled_libraries`.").optional(),
598
+ enabled_libraries: z.array(z.string()).describe("Names of shared preload libraries to enable for the project.").optional()
599
+ }).describe("The shared libraries to preload into the project's compute instances.");
600
+ const zConnectionUrisResponse = z.strictObject({ connection_uris: z.array(zConnectionDetails).describe("Connection URIs for the project.") });
601
+ const zConnectionUrisOptionalResponse = z.strictObject({ connection_uris: z.array(zConnectionDetails).describe("Connection URIs for the compute endpoint, including credentials.").optional() });
522
602
  const zVpcEndpoint = z.strictObject({
523
- vpc_endpoint_id: z.string(),
524
- label: z.string()
603
+ vpc_endpoint_id: z.string().describe("Cloud provider identifier for the VPC endpoint."),
604
+ label: z.string().describe("A descriptive label for the VPC endpoint")
525
605
  });
526
- const zVpcEndpointsResponse = z.strictObject({ endpoints: z.array(zVpcEndpoint) });
527
- const zVpcEndpointWithRegion = zVpcEndpoint.merge(z.strictObject({ region_id: z.string() }));
528
- const zVpcEndpointsWithRegionResponse = z.strictObject({ endpoints: z.array(zVpcEndpointWithRegion) });
606
+ const zVpcEndpointsResponse = z.strictObject({ endpoints: z.array(zVpcEndpoint).describe("List of VPC endpoints returned by the request.") });
607
+ const zVpcEndpointWithRegion = zVpcEndpoint.merge(z.strictObject({ region_id: z.string().describe("The region where the VPC endpoint is located") }));
608
+ const zVpcEndpointsWithRegionResponse = z.strictObject({ endpoints: z.array(zVpcEndpointWithRegion).describe("VPC endpoints associated with the region.") });
529
609
  const zVpcEndpointDetails = z.strictObject({
530
- vpc_endpoint_id: z.string(),
531
- label: z.string(),
532
- state: z.string(),
533
- num_restricted_projects: z.int(),
534
- example_restricted_projects: z.array(z.string())
535
- });
536
- const zVpcEndpointAssignment = z.strictObject({ label: z.string() });
537
- const zRealtimeOptions = z.strictObject({ allowed_origins: z.array(z.string().min(1).max(2048).regex(/^(\*|https?:\/\/[^\/?#@,*\s]+)$/)).max(16).optional() });
610
+ vpc_endpoint_id: z.string().describe("Cloud provider identifier for the VPC endpoint."),
611
+ label: z.string().describe("A descriptive label for the VPC endpoint"),
612
+ state: z.string().describe("The current state of the VPC endpoint."),
613
+ num_restricted_projects: z.int().describe("The number of projects that are restricted to use this VPC endpoint."),
614
+ example_restricted_projects: z.array(z.string()).describe("A list of example projects that are restricted to use this VPC endpoint.")
615
+ });
616
+ const zVpcEndpointAssignment = z.strictObject({ label: z.string().describe("Human-readable name for the VPC endpoint assignment, used to identify it within the organization.") });
617
+ const zRealtimeOptions = z.strictObject({ allowed_origins: z.array(z.string().min(1).max(2048).regex(/^(\*|https?:\/\/[^\/?#@,*\s]+)$/)).max(16).describe("The browser origins allowed to connect, each `http` or `https` with a host and optional port and no path.").optional() });
538
618
  const zRealtime = z.strictObject({
539
- enabled: z.boolean(),
540
- pending: z.boolean(),
619
+ enabled: z.boolean().describe("Whether Realtime is enabled for the branch."),
620
+ pending: z.boolean().describe("Whether a provisioning, settings, rotation or deprovisioning change is still being applied."),
541
621
  invocation_url: z.string().optional(),
542
622
  revision: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).optional(),
543
623
  allowed_origins: z.array(z.string()).optional()
544
624
  });
545
625
  const zRealtimeSecret = z.strictObject({
546
- secret: z.string().min(1),
547
- pending: z.boolean()
626
+ secret: z.string().min(1).describe("The key the application backend issues Realtime tokens with, `nrt_live_1` followed by the unpadded base64url 32-byte AES-256-GCM key."),
627
+ pending: z.boolean().describe("Whether a change is still being applied.")
548
628
  });
549
629
  const zRole = z.strictObject({
550
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
551
- name: z.string(),
552
- password: z.string().optional(),
553
- protected: z.boolean().optional(),
554
- authentication_method: z.string().optional(),
555
- created_at: z.iso.datetime(),
556
- updated_at: z.iso.datetime()
630
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this role belongs to."),
631
+ name: z.string().describe("Postgres role name within the branch."),
632
+ password: z.string().describe("The role password").optional(),
633
+ protected: z.boolean().describe("Whether or not the role is system-protected").optional(),
634
+ authentication_method: z.string().describe("Authentication method configured for this role: `password`, `oauth`, `oidc`, or `no_login`.").optional(),
635
+ created_at: z.iso.datetime().describe("A timestamp indicating when the role was created"),
636
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the role was last updated")
557
637
  });
558
638
  const zRoleCreateRequest = z.strictObject({ role: z.strictObject({
559
- name: z.string(),
560
- no_login: z.boolean().optional()
561
- }) });
562
- const zRoleResponse = z.strictObject({ role: zRole });
563
- const zJwksResponse = z.strictObject({ jwks: zJwks });
564
- const zRolesResponse = z.strictObject({ roles: z.array(zRole) });
565
- const zRolePasswordResponse = z.strictObject({ password: z.string() });
639
+ name: z.string().describe("The role name."),
640
+ no_login: z.boolean().describe("Whether to create a role that cannot login.").optional()
641
+ }).describe("Properties of the role to create.") });
642
+ const zRoleResponse = z.strictObject({ role: z.strictObject({
643
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this role belongs to."),
644
+ name: z.string().describe("Postgres role name within the branch."),
645
+ password: z.string().describe("The role password").optional(),
646
+ protected: z.boolean().describe("Whether or not the role is system-protected").optional(),
647
+ authentication_method: z.string().describe("Authentication method configured for this role: `password`, `oauth`, `oidc`, or `no_login`.").optional(),
648
+ created_at: z.iso.datetime().describe("A timestamp indicating when the role was created"),
649
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the role was last updated")
650
+ }).describe("Role details for the requested database role.") });
651
+ const zJwksResponse = z.strictObject({ jwks: z.strictObject({
652
+ id: z.string().describe("The JWKS configuration's ID."),
653
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
654
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID.").optional(),
655
+ jwks_url: z.string().describe("URL of the provider's JWKS endpoint used to verify JWTs."),
656
+ provider_name: z.string().describe("The name of the authentication provider (e.g., Clerk, Stytch, Auth0)"),
657
+ created_at: z.iso.datetime().describe("The date and time when the JWKS was created"),
658
+ updated_at: z.iso.datetime().describe("The date and time when the JWKS was last modified"),
659
+ jwt_audience: z.string().describe("Expected JWT `aud` claim value configured for this JWKS.").optional(),
660
+ role_names: z.array(z.string()).describe("Database role names that are permitted to authenticate using this JWKS configuration.").optional()
661
+ }).describe("JWKS configuration associated with the project.") });
662
+ const zRolesResponse = z.strictObject({ roles: z.array(zRole).describe("Roles belonging to the branch.") });
663
+ const zRolePasswordResponse = z.strictObject({ password: z.string().describe("The role password") });
566
664
  const zPaymentSourceBankCard = z.strictObject({
567
- last4: z.string(),
665
+ last4: z.string().describe("Last 4 digits of the card."),
568
666
  brand: z.enum([
569
667
  "amex",
570
668
  "diners",
@@ -574,15 +672,29 @@ const zPaymentSourceBankCard = z.strictObject({
574
672
  "unionpay",
575
673
  "unknown",
576
674
  "visa"
577
- ]).optional(),
578
- exp_month: z.int().optional(),
579
- exp_year: z.int().optional()
675
+ ]).describe("Card network reported by the payment processor.").optional(),
676
+ exp_month: z.int().describe("Credit card expiration month").optional(),
677
+ exp_year: z.int().describe("Credit card expiration year").optional()
580
678
  });
581
679
  const zPaymentSource = z.strictObject({
582
- type: z.string(),
583
- card: zPaymentSourceBankCard.optional()
584
- });
585
- const zSpendingLimitUpdateRequest = z.strictObject({ spending_limit_cents: z.int().gte(1) });
680
+ type: z.string().describe("Type of payment source."),
681
+ card: z.strictObject({
682
+ last4: z.string().describe("Last 4 digits of the card."),
683
+ brand: z.enum([
684
+ "amex",
685
+ "diners",
686
+ "discover",
687
+ "jcb",
688
+ "mastercard",
689
+ "unionpay",
690
+ "unknown",
691
+ "visa"
692
+ ]).describe("Card network reported by the payment processor.").optional(),
693
+ exp_month: z.int().describe("Credit card expiration month").optional(),
694
+ exp_year: z.int().describe("Credit card expiration year").optional()
695
+ }).describe("Bank card details for this payment source.").optional()
696
+ });
697
+ const zSpendingLimitUpdateRequest = z.strictObject({ spending_limit_cents: z.int().gte(1).describe("Monthly spending cap in cents.") });
586
698
  const zSpendingLimitResponse = z.strictObject({ spending_limit_cents: z.int().nullable() });
587
699
  /**
588
700
  * State of the billing account.
@@ -594,7 +706,7 @@ const zBillingAccountState = z.enum([
594
706
  "suspended",
595
707
  "deactivated",
596
708
  "deleted"
597
- ]);
709
+ ]).describe("State of the billing account.");
598
710
  /**
599
711
  * Type of subscription to Neon Cloud.
600
712
  * Notice that for users without billing account this will be "UNKNOWN"
@@ -614,7 +726,7 @@ const zBillingSubscriptionType = z.enum([
614
726
  "scale_v3",
615
727
  "business",
616
728
  "vercel_pg_legacy"
617
- ]);
729
+ ]).describe("Type of subscription to Neon Cloud.");
618
730
  /**
619
731
  * Indicates whether and how an account makes payments.
620
732
  *
@@ -631,46 +743,82 @@ const zBillingPaymentMethod = z.enum([
631
743
  "trial",
632
744
  "sponsorship",
633
745
  "shared_payment_token"
634
- ]);
746
+ ]).describe("Indicates whether and how an account makes payments.");
635
747
  const zBillingAccount = z.strictObject({
636
- state: zBillingAccountState,
637
- payment_source: zPaymentSource,
748
+ state: z.enum([
749
+ "UNKNOWN",
750
+ "active",
751
+ "suspended",
752
+ "deactivated",
753
+ "deleted"
754
+ ]).describe("State of the billing account."),
755
+ payment_source: z.strictObject({
756
+ type: z.string().describe("Type of payment source."),
757
+ card: z.strictObject({
758
+ last4: z.string().describe("Last 4 digits of the card."),
759
+ brand: z.enum([
760
+ "amex",
761
+ "diners",
762
+ "discover",
763
+ "jcb",
764
+ "mastercard",
765
+ "unionpay",
766
+ "unknown",
767
+ "visa"
768
+ ]).describe("Card network reported by the payment processor.").optional(),
769
+ exp_month: z.int().describe("Credit card expiration month").optional(),
770
+ exp_year: z.int().describe("Credit card expiration year").optional()
771
+ }).describe("Bank card details for this payment source.").optional()
772
+ }).describe("Payment source attached to the billing account, such as a credit card on file."),
638
773
  subscription_type: zBillingSubscriptionType,
639
774
  payment_method: zBillingPaymentMethod,
640
- quota_reset_at_last: z.iso.datetime(),
641
- name: z.string(),
642
- email: z.email().min(1).max(256),
643
- address_city: z.string(),
644
- address_country: z.string(),
645
- address_country_name: z.string().optional(),
646
- address_line1: z.string(),
647
- address_line2: z.string(),
648
- address_postal_code: z.string(),
649
- address_state: z.string(),
650
- orb_portal_url: z.string().optional(),
651
- tax_id: z.string().optional(),
652
- tax_id_type: z.string().optional(),
653
- plan_details: zPlanDetails.optional(),
775
+ quota_reset_at_last: z.iso.datetime().describe("Timestamp of the last quota reset."),
776
+ name: z.string().describe("The full name of the individual or entity that owns the billing account."),
777
+ email: z.email().min(1).max(256).describe("Billing email, to receive emails related to invoices and subscriptions."),
778
+ address_city: z.string().describe("Billing address city."),
779
+ address_country: z.string().describe("Billing address country code defined by ISO 3166-1 alpha-2."),
780
+ address_country_name: z.string().describe("Billing address country name.").optional(),
781
+ address_line1: z.string().describe("Billing address line 1."),
782
+ address_line2: z.string().describe("Billing address line 2."),
783
+ address_postal_code: z.string().describe("Billing address postal code."),
784
+ address_state: z.string().describe("Billing address state or region."),
785
+ orb_portal_url: z.string().describe("Orb user portal url").optional(),
786
+ tax_id: z.string().describe("The tax identification number for the billing account, displayed on invoices.").optional(),
787
+ tax_id_type: z.string().describe("The type of the tax identification number based on the country.").optional(),
788
+ plan_details: z.strictObject({
789
+ name: z.string().describe("Plan name, for example `free`, `launch`, or `scale`."),
790
+ version: z.strictObject({
791
+ major: z.int(),
792
+ minor: z.int()
793
+ }).describe("Version of the plan, expressed as `major` and `minor` components.").optional()
794
+ }).describe("Details of the subscription plan associated with the billing account.").optional(),
654
795
  spending_limit_cents: z.int().nullish()
655
796
  });
656
797
  const zDatabase = z.strictObject({
657
- id: z.int(),
658
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
659
- name: z.string(),
660
- owner_name: z.string(),
661
- created_at: z.iso.datetime(),
662
- updated_at: z.iso.datetime()
798
+ id: z.int().describe("The database ID"),
799
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this database belongs to."),
800
+ name: z.string().describe("The database name"),
801
+ owner_name: z.string().describe("The name of role that owns the database"),
802
+ created_at: z.iso.datetime().describe("A timestamp indicating when the database was created"),
803
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the database was last updated")
663
804
  });
664
805
  const zDatabaseCreateRequest = z.strictObject({ database: z.strictObject({
665
- name: z.string(),
666
- owner_name: z.string()
667
- }) });
806
+ name: z.string().describe("Name of the database to create."),
807
+ owner_name: z.string().describe("The name of the role that owns the database")
808
+ }).describe("Configuration for the new Postgres database.") });
668
809
  const zDatabaseUpdateRequest = z.strictObject({ database: z.strictObject({
669
- name: z.string().optional(),
670
- owner_name: z.string().optional()
671
- }) });
672
- const zDatabaseResponse = z.strictObject({ database: zDatabase });
673
- const zDatabasesResponse = z.strictObject({ databases: z.array(zDatabase) });
810
+ name: z.string().describe("Name of the database to update.").optional(),
811
+ owner_name: z.string().describe("The name of the role that owns the database").optional()
812
+ }).describe("Properties to update on the database.") });
813
+ const zDatabaseResponse = z.strictObject({ database: z.strictObject({
814
+ id: z.int().describe("The database ID"),
815
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this database belongs to."),
816
+ name: z.string().describe("The database name"),
817
+ owner_name: z.string().describe("The name of role that owns the database"),
818
+ created_at: z.iso.datetime().describe("A timestamp indicating when the database was created"),
819
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the database was last updated")
820
+ }).describe("Database object returned by the operation.") });
821
+ const zDatabasesResponse = z.strictObject({ databases: z.array(zDatabase).describe("Databases on the branch.") });
674
822
  /**
675
823
  * Organization member's role. `admin`: full administrative access. `editor` (and its legacy alias `member`): standard access governed by project permissions. `viewer` and `collaborator`: additional scoped project roles. Some values may not be available for all organizations.
676
824
  */
@@ -680,73 +828,83 @@ const zMemberRole = z.enum([
680
828
  "editor",
681
829
  "viewer",
682
830
  "collaborator"
683
- ]);
831
+ ]).describe("Organization member's role.");
684
832
  const zInvitation = z.strictObject({
685
- id: z.uuid(),
686
- email: z.email().min(1).max(256),
687
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
688
- invited_by: z.uuid(),
689
- invited_at: z.iso.datetime(),
833
+ id: z.uuid().describe("The invitation ID."),
834
+ email: z.email().min(1).max(256).describe("Email of the invited user"),
835
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Organization id as it is stored in Neon"),
836
+ invited_by: z.uuid().describe("UUID for the user_id who extended the invitation"),
837
+ invited_at: z.iso.datetime().describe("Timestamp when the invitation was created"),
690
838
  role: zMemberRole
691
839
  });
692
840
  const zMember = z.strictObject({
693
- id: z.uuid(),
694
- user_id: z.uuid(),
695
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
841
+ id: z.uuid().describe("The organization member's ID."),
842
+ user_id: z.uuid().describe("The Neon user ID."),
843
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID."),
696
844
  role: zMemberRole,
697
- joined_at: z.iso.datetime().optional()
845
+ joined_at: z.iso.datetime().describe("Timestamp when the user joined the organization.").optional()
698
846
  });
699
847
  const zMemberUserInfo = z.strictObject({
700
- email: z.email().min(1).max(256),
701
- has_mfa: z.boolean().optional(),
702
- deactivated_at: z.iso.datetime().optional()
848
+ email: z.email().min(1).max(256).describe("Email address of the organization member's user account."),
849
+ has_mfa: z.boolean().describe("Whether the member has MFA (TOTP) enabled").optional(),
850
+ deactivated_at: z.iso.datetime().describe("Timestamp of when the user account was deactivated.").optional()
703
851
  });
704
852
  const zMemberWithUser = z.strictObject({
705
- member: zMember,
706
- user: zMemberUserInfo
853
+ member: z.strictObject({
854
+ id: z.uuid().describe("The organization member's ID."),
855
+ user_id: z.uuid().describe("The Neon user ID."),
856
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID."),
857
+ role: zMemberRole,
858
+ joined_at: z.iso.datetime().describe("Timestamp when the user joined the organization.").optional()
859
+ }).describe("Membership record for the user in the organization."),
860
+ user: z.strictObject({
861
+ email: z.email().min(1).max(256).describe("Email address of the organization member's user account."),
862
+ has_mfa: z.boolean().describe("Whether the member has MFA (TOTP) enabled").optional(),
863
+ deactivated_at: z.iso.datetime().describe("Timestamp of when the user account was deactivated.").optional()
864
+ }).describe("Profile information for the organization member.")
707
865
  });
708
866
  const zOrganization = z.strictObject({
709
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
710
- name: z.string(),
711
- handle: z.string(),
712
- plan: z.string(),
713
- created_at: z.iso.datetime(),
714
- managed_by: z.string(),
715
- updated_at: z.iso.datetime(),
716
- allow_hipaa_projects: z.boolean().optional(),
717
- require_mfa: z.boolean().optional()
718
- });
719
- const zOrganizationsResponse = z.strictObject({ organizations: z.array(zOrganization) });
720
- const zOrganizationInvitationsResponse = z.strictObject({ invitations: z.array(zInvitation) });
867
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID."),
868
+ name: z.string().describe("Human-readable display name of the organization."),
869
+ handle: z.string().describe("URL-safe identifier for the organization, used in API paths."),
870
+ plan: z.string().describe("Billing plan for the organization, for example `free`, `launch`, or `scale`."),
871
+ created_at: z.iso.datetime().describe("A timestamp indicting when the organization was created"),
872
+ managed_by: z.string().describe("Organizations created via the Console or the API are managed by `console`."),
873
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the organization was updated"),
874
+ allow_hipaa_projects: z.boolean().describe("If true, allow account to mark projects as HIPAA").optional(),
875
+ require_mfa: z.boolean().describe("If true, all members must have MFA enabled to access this organization").optional()
876
+ });
877
+ const zOrganizationsResponse = z.strictObject({ organizations: z.array(zOrganization).describe("Organizations returned by the request.") });
878
+ const zOrganizationInvitationsResponse = z.strictObject({ invitations: z.array(zInvitation).describe("List of pending invitations for the organization.") });
721
879
  const zOrganizationInviteCreateRequest = z.strictObject({
722
- email: z.email().min(1).max(256),
880
+ email: z.email().min(1).max(256).describe("Email address of the person to invite to the organization."),
723
881
  role: zMemberRole
724
882
  });
725
- const zOrganizationInvitesCreateRequest = z.strictObject({ invitations: z.array(zOrganizationInviteCreateRequest) });
883
+ const zOrganizationInvitesCreateRequest = z.strictObject({ invitations: z.array(zOrganizationInviteCreateRequest).describe("Invitations to create for the organization.") });
726
884
  const zOrganizationMemberUpdateRequest = z.strictObject({ role: zMemberRole });
727
- const zOrganizationMembersResponse = z.strictObject({ members: z.array(zMemberWithUser) });
885
+ const zOrganizationMembersResponse = z.strictObject({ members: z.array(zMemberWithUser).describe("Members of the organization, each combining membership details (role, status) with the associated user's identity.") });
728
886
  const zRegionResponse = z.strictObject({
729
- region_id: z.string(),
730
- name: z.string(),
731
- default: z.boolean(),
732
- geo_lat: z.string(),
733
- geo_long: z.string()
887
+ region_id: z.string().describe("Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`)."),
888
+ name: z.string().describe("A short description of the region."),
889
+ default: z.boolean().describe("True if this region is selected by default when no region is specified during project creation."),
890
+ geo_lat: z.string().describe("The geographical latitude (approximate) for the region."),
891
+ geo_long: z.string().describe("The geographical longitude (approximate) for the region.")
734
892
  });
735
- const zActiveRegionsResponse = z.strictObject({ regions: z.array(zRegionResponse) });
893
+ const zActiveRegionsResponse = z.strictObject({ regions: z.array(zRegionResponse).describe("The list of active regions") });
736
894
  const zAuthDetailsResponse = z.strictObject({
737
- account_id: z.string(),
895
+ account_id: z.string().describe("The ID of the account associated with this authentication record."),
738
896
  auth_method: z.enum([
739
897
  "keycloak",
740
898
  "session_cookie",
741
899
  "api_key_user",
742
900
  "api_key_org",
743
901
  "oauth"
744
- ]),
902
+ ]).describe("Authentication method used for the request: - `keycloak`: Keycloak identity provider authentication."),
745
903
  auth_data: z.string().optional()
746
904
  });
747
905
  const zTransferProjectsToOrganizationRequest = z.strictObject({
748
- destination_org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
749
- project_ids: z.array(z.string().regex(/^[a-z0-9-]{1,60}$/)).min(1).max(400)
906
+ destination_org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The destination organization identifier"),
907
+ project_ids: z.array(z.string().regex(/^[a-z0-9-]{1,60}$/)).min(1).max(400).describe("The list of projects ids to transfer.")
750
908
  });
751
909
  /**
752
910
  * Identity provider id from keycloak
@@ -759,29 +917,78 @@ const zIdentityProviderId = z.enum([
759
917
  "microsoftv2",
760
918
  "vercelmp",
761
919
  "keycloak"
762
- ]);
920
+ ]).describe("Identity provider id from keycloak");
763
921
  const zCurrentUserAuthAccount = z.strictObject({
764
- email: z.email().min(1).max(256),
765
- image: z.string(),
766
- login: z.string(),
767
- name: z.string(),
922
+ email: z.email().min(1).max(256).describe("Email address associated with this auth account."),
923
+ image: z.string().describe("URL of the user's profile picture as provided by the identity provider."),
924
+ login: z.string().describe("Deprecated. Use the `email` field."),
925
+ name: z.string().describe("Display name of the account as provided by the identity provider."),
768
926
  provider: zIdentityProviderId
769
927
  });
770
928
  const zCurrentUserInfoResponse = z.strictObject({
771
- active_seconds_limit: z.int(),
772
- billing_account: zBillingAccount.optional(),
773
- auth_accounts: z.array(zCurrentUserAuthAccount),
774
- email: z.email().min(1).max(256),
775
- id: z.string(),
776
- image: z.string(),
777
- login: z.string(),
778
- name: z.string(),
779
- last_name: z.string(),
780
- projects_limit: z.int(),
781
- branches_limit: z.int(),
782
- max_autoscaling_limit: z.number(),
783
- compute_seconds_limit: z.int().optional(),
784
- plan: z.string()
929
+ active_seconds_limit: z.int().describe("Control plane observes active endpoints of a user this amount of wall-clock time."),
930
+ billing_account: z.strictObject({
931
+ state: z.enum([
932
+ "UNKNOWN",
933
+ "active",
934
+ "suspended",
935
+ "deactivated",
936
+ "deleted"
937
+ ]).describe("State of the billing account."),
938
+ payment_source: z.strictObject({
939
+ type: z.string().describe("Type of payment source."),
940
+ card: z.strictObject({
941
+ last4: z.string().describe("Last 4 digits of the card."),
942
+ brand: z.enum([
943
+ "amex",
944
+ "diners",
945
+ "discover",
946
+ "jcb",
947
+ "mastercard",
948
+ "unionpay",
949
+ "unknown",
950
+ "visa"
951
+ ]).describe("Card network reported by the payment processor.").optional(),
952
+ exp_month: z.int().describe("Credit card expiration month").optional(),
953
+ exp_year: z.int().describe("Credit card expiration year").optional()
954
+ }).describe("Bank card details for this payment source.").optional()
955
+ }).describe("Payment source attached to the billing account, such as a credit card on file."),
956
+ subscription_type: zBillingSubscriptionType,
957
+ payment_method: zBillingPaymentMethod,
958
+ quota_reset_at_last: z.iso.datetime().describe("Timestamp of the last quota reset."),
959
+ name: z.string().describe("The full name of the individual or entity that owns the billing account."),
960
+ email: z.email().min(1).max(256).describe("Billing email, to receive emails related to invoices and subscriptions."),
961
+ address_city: z.string().describe("Billing address city."),
962
+ address_country: z.string().describe("Billing address country code defined by ISO 3166-1 alpha-2."),
963
+ address_country_name: z.string().describe("Billing address country name.").optional(),
964
+ address_line1: z.string().describe("Billing address line 1."),
965
+ address_line2: z.string().describe("Billing address line 2."),
966
+ address_postal_code: z.string().describe("Billing address postal code."),
967
+ address_state: z.string().describe("Billing address state or region."),
968
+ orb_portal_url: z.string().describe("Orb user portal url").optional(),
969
+ tax_id: z.string().describe("The tax identification number for the billing account, displayed on invoices.").optional(),
970
+ tax_id_type: z.string().describe("The type of the tax identification number based on the country.").optional(),
971
+ plan_details: z.strictObject({
972
+ name: z.string().describe("Plan name, for example `free`, `launch`, or `scale`."),
973
+ version: z.strictObject({
974
+ major: z.int(),
975
+ minor: z.int()
976
+ }).describe("Version of the plan, expressed as `major` and `minor` components.").optional()
977
+ }).describe("Details of the subscription plan associated with the billing account.").optional(),
978
+ spending_limit_cents: z.int().nullish()
979
+ }).describe("Billing account associated with the current user, including plan and subscription details.").optional(),
980
+ auth_accounts: z.array(zCurrentUserAuthAccount).describe("Authentication provider accounts linked to the current user."),
981
+ email: z.email().min(1).max(256).describe("Email address of the authenticated user."),
982
+ id: z.string().describe("The Neon user ID."),
983
+ image: z.string().describe("URL of the user's profile avatar image."),
984
+ login: z.string().describe("Deprecated. Use the `email` field."),
985
+ name: z.string().describe("First name of the current user."),
986
+ last_name: z.string().describe("Last name of the current user."),
987
+ projects_limit: z.int().describe("Maximum number of projects the account is allowed to create under the current plan."),
988
+ branches_limit: z.int().describe("Maximum number of branches allowed for the account under the current plan."),
989
+ max_autoscaling_limit: z.number().describe("The maximum autoscaling limit in Compute Units."),
990
+ compute_seconds_limit: z.int().describe("Maximum Postgres compute time, in seconds, allowed under the account's current plan.").optional(),
991
+ plan: z.string().describe("Current billing plan for the user's account.")
785
992
  });
786
993
  /**
787
994
  * Per-project consumption quotas. If a quota is exceeded, all active computes
@@ -802,280 +1009,460 @@ const zCurrentUserInfoResponse = z.strictObject({
802
1009
  *
803
1010
  */
804
1011
  const zProjectQuota = z.strictObject({
805
- active_time_seconds: z.int().gte(0).optional(),
806
- compute_time_seconds: z.int().gte(0).optional(),
807
- written_data_bytes: z.int().gte(0).optional(),
808
- data_transfer_bytes: z.int().gte(0).optional(),
809
- logical_size_bytes: z.int().gte(0).optional()
810
- });
1012
+ active_time_seconds: z.int().gte(0).describe("The total amount of wall-clock time allowed to be spent by the project's compute endpoints.").optional(),
1013
+ compute_time_seconds: z.int().gte(0).describe("The total amount of CPU seconds allowed to be spent by the project's compute endpoints.").optional(),
1014
+ written_data_bytes: z.int().gte(0).describe("Total amount of data written to all of a project's branches.").optional(),
1015
+ data_transfer_bytes: z.int().gte(0).describe("Total amount of data transferred from all of a project's branches using the proxy.").optional(),
1016
+ logical_size_bytes: z.int().gte(0).describe("Limit on the logical size of every project's branch.").optional()
1017
+ }).describe("Per-project consumption quotas.");
811
1018
  const zProjectSettingsData = z.strictObject({
812
1019
  quota: zProjectQuota.optional(),
813
1020
  allowed_ips: zAllowedIps.optional(),
814
- enable_logical_replication: z.boolean().optional(),
1021
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
815
1022
  maintenance_window: zMaintenanceWindow.optional(),
816
- block_public_connections: z.boolean().optional(),
817
- block_vpc_connections: z.boolean().optional(),
818
- audit_log_level: zProjectAuditLogLevel.optional(),
819
- hipaa: z.boolean().optional(),
1023
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1024
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1025
+ audit_log_level: z.enum([
1026
+ "base",
1027
+ "extended",
1028
+ "full"
1029
+ ]).describe("Audit logging level, set only on HIPAA-enabled organizations (absent otherwise).").optional(),
1030
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
820
1031
  preload_libraries: zPreloadLibraries.optional()
821
1032
  });
822
1033
  /**
823
1034
  * A raw representation of Postgres settings
824
1035
  */
825
- const zPgSettingsData = z.record(z.string(), z.string());
826
- /**
827
- * Deprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.
828
- *
829
- *
830
- * @deprecated
831
- */
832
- const zPgbouncerSettingsData = z.record(z.string(), z.string());
1036
+ const zPgSettingsData = z.record(z.string(), z.string()).describe("A raw representation of Postgres settings");
833
1037
  /**
834
1038
  * A collection of settings for a compute endpoint
835
1039
  */
836
1040
  const zEndpointSettingsData = z.strictObject({
837
1041
  pg_settings: zPgSettingsData.optional(),
838
- pgbouncer_settings: zPgbouncerSettingsData.optional(),
1042
+ pgbouncer_settings: z.record(z.string(), z.string()).describe("Deprecated. PgBouncer settings for the compute endpoint.").optional(),
839
1043
  preload_libraries: zPreloadLibraries.optional()
840
- });
841
- const zBranchCreateRequestEndpointOptions = z.strictObject({
842
- type: zEndpointType,
843
- settings: zEndpointSettingsData.optional(),
844
- autoscaling_limit_min_cu: zComputeUnit.optional(),
845
- autoscaling_limit_max_cu: zComputeUnit.optional(),
846
- provisioner: zProvisioner.optional(),
847
- suspend_timeout_seconds: zSuspendTimeoutSeconds.optional()
848
- });
849
- const zBranchCreateRequest = z.strictObject({
850
- endpoints: z.array(zBranchCreateRequestEndpointOptions).optional(),
851
- branch: z.strictObject({
852
- parent_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
853
- name: z.string().min(1).max(256).optional(),
854
- parent_lsn: z.string().optional(),
855
- parent_timestamp: z.iso.datetime().optional(),
856
- protected: z.boolean().optional(),
857
- realtime: zRealtimeOptions.optional(),
858
- archived: z.boolean().optional(),
859
- init_source: z.string().optional(),
860
- expires_at: z.iso.datetime().optional()
861
- }).optional()
862
- });
1044
+ }).describe("A collection of settings for a compute endpoint");
863
1045
  const zEndpoint = z.strictObject({
864
- host: z.string(),
865
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
866
- name: z.string().optional(),
867
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
868
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
869
- autoscaling_limit_min_cu: zComputeUnit,
870
- autoscaling_limit_max_cu: zComputeUnit,
871
- region_id: z.string(),
1046
+ host: z.string().describe("The hostname of the compute endpoint."),
1047
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The compute endpoint ID."),
1048
+ name: z.string().describe("Optional name of the compute endpoint").optional(),
1049
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this compute endpoint belongs to."),
1050
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this compute endpoint belongs to."),
1051
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("The minimum number of Compute Units"),
1052
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("The maximum number of Compute Units"),
1053
+ region_id: z.string().describe("Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`)."),
872
1054
  type: zEndpointType,
873
1055
  current_state: zEndpointState,
874
- pending_state: zEndpointState.optional(),
1056
+ pending_state: z.enum([
1057
+ "init",
1058
+ "active",
1059
+ "idle"
1060
+ ]).describe("Target state the compute endpoint is transitioning to.").optional(),
875
1061
  settings: zEndpointSettingsData,
876
- pooler_enabled: z.boolean(),
877
- pooler_mode: zEndpointPoolerMode,
878
- disabled: z.boolean(),
879
- passwordless_access: z.boolean(),
880
- last_active: z.iso.datetime().optional(),
881
- creation_source: z.string(),
882
- created_at: z.iso.datetime(),
883
- updated_at: z.iso.datetime(),
884
- started_at: z.iso.datetime().optional(),
885
- suspended_at: z.iso.datetime().optional(),
886
- proxy_host: z.string(),
887
- suspend_timeout_seconds: zSuspendTimeoutSeconds,
888
- provisioner: zProvisioner,
889
- compute_release_version: z.string().optional()
1062
+ pooler_enabled: z.boolean().describe("Deprecated. To use connection pooling, append `-pooler` to the endpoint ID in the connection string."),
1063
+ pooler_mode: z.enum(["transaction"]).describe("Deprecated. The connection pooler mode."),
1064
+ disabled: z.boolean().describe("Whether to restrict connections to the compute endpoint."),
1065
+ passwordless_access: z.boolean().describe("Whether to permit passwordless access to the compute endpoint"),
1066
+ last_active: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last active").optional(),
1067
+ creation_source: z.string().describe("The compute endpoint creation source"),
1068
+ created_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was created"),
1069
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last updated"),
1070
+ started_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last started").optional(),
1071
+ suspended_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last suspended").optional(),
1072
+ proxy_host: z.string().describe("Deprecated. Use the `host` property instead."),
1073
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends."),
1074
+ provisioner: z.string().describe("Compute provisioner."),
1075
+ compute_release_version: z.string().describe("Attached compute's release version number.").optional()
890
1076
  });
891
1077
  const zEndpointCreateRequest = z.strictObject({ endpoint: z.strictObject({
892
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
893
- region_id: z.string().optional(),
1078
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch the compute endpoint will be associated with"),
1079
+ region_id: z.string().describe("The region where the compute endpoint will be created.").optional(),
894
1080
  type: zEndpointType,
895
1081
  settings: zEndpointSettingsData.optional(),
896
- autoscaling_limit_min_cu: zComputeUnit.optional(),
897
- autoscaling_limit_max_cu: zComputeUnit.optional(),
898
- provisioner: zProvisioner.optional(),
899
- pooler_enabled: z.boolean().optional(),
900
- pooler_mode: zEndpointPoolerMode.optional(),
901
- disabled: z.boolean().optional(),
902
- passwordless_access: z.boolean().optional(),
903
- suspend_timeout_seconds: zSuspendTimeoutSeconds.optional(),
904
- name: z.string().min(1).max(64).optional()
905
- }) });
1082
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("The minimum number of Compute Units.").optional(),
1083
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("The maximum number of Compute Units.").optional(),
1084
+ provisioner: z.string().describe("Compute provisioner.").optional(),
1085
+ pooler_enabled: z.boolean().describe("Deprecated. To enable connection pooling, append `-pooler` to the endpoint ID in the connection string.").optional(),
1086
+ pooler_mode: z.enum(["transaction"]).describe("Deprecated. The connection pooler mode.").optional(),
1087
+ disabled: z.boolean().describe("Whether to restrict connections to the compute endpoint.").optional(),
1088
+ passwordless_access: z.boolean().describe("NOT YET IMPLEMENTED.").optional(),
1089
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends.").optional(),
1090
+ name: z.string().min(1).max(64).describe("Optional name of the compute endpoint").optional()
1091
+ }).describe("Configuration for the compute endpoint to create.") });
906
1092
  const zEndpointUpdateRequest = z.strictObject({ endpoint: z.strictObject({
907
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
908
- autoscaling_limit_min_cu: zComputeUnit.optional(),
909
- autoscaling_limit_max_cu: zComputeUnit.optional(),
910
- provisioner: zProvisioner.optional(),
1093
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Deprecated. The destination branch ID; must not have an existing read-write endpoint.").optional(),
1094
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("The minimum number of Compute Units.").optional(),
1095
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("The maximum number of Compute Units.").optional(),
1096
+ provisioner: z.string().describe("Compute provisioner.").optional(),
911
1097
  settings: zEndpointSettingsData.optional(),
912
- pooler_enabled: z.boolean().optional(),
913
- pooler_mode: zEndpointPoolerMode.optional(),
914
- disabled: z.boolean().optional(),
915
- passwordless_access: z.boolean().optional(),
916
- suspend_timeout_seconds: zSuspendTimeoutSeconds.optional(),
917
- name: z.string().min(1).max(64).optional()
918
- }) });
919
- const zEndpointResponse = z.strictObject({ endpoint: zEndpoint });
920
- const zEndpointsResponse = z.strictObject({ endpoints: z.array(zEndpoint) });
921
- const zEndpointsOptionalResponse = z.strictObject({ endpoints: z.array(zEndpoint).optional() });
1098
+ pooler_enabled: z.boolean().describe("Deprecated. To enable connection pooling, append `-pooler` to the endpoint ID in the connection string.").optional(),
1099
+ pooler_mode: z.enum(["transaction"]).describe("Deprecated. The connection pooler mode.").optional(),
1100
+ disabled: z.boolean().describe("Whether to restrict connections to the compute endpoint.").optional(),
1101
+ passwordless_access: z.boolean().describe("NOT YET IMPLEMENTED.").optional(),
1102
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends.").optional(),
1103
+ name: z.string().min(1).max(64).describe("Optional name of the compute endpoint").optional()
1104
+ }).describe("Parameters for the compute endpoint update.") });
1105
+ const zEndpointResponse = z.strictObject({ endpoint: z.strictObject({
1106
+ host: z.string().describe("The hostname of the compute endpoint."),
1107
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The compute endpoint ID."),
1108
+ name: z.string().describe("Optional name of the compute endpoint").optional(),
1109
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the project this compute endpoint belongs to."),
1110
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The ID of the branch this compute endpoint belongs to."),
1111
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("The minimum number of Compute Units"),
1112
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("The maximum number of Compute Units"),
1113
+ region_id: z.string().describe("Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`)."),
1114
+ type: zEndpointType,
1115
+ current_state: zEndpointState,
1116
+ pending_state: z.enum([
1117
+ "init",
1118
+ "active",
1119
+ "idle"
1120
+ ]).describe("Target state the compute endpoint is transitioning to.").optional(),
1121
+ settings: zEndpointSettingsData,
1122
+ pooler_enabled: z.boolean().describe("Deprecated. To use connection pooling, append `-pooler` to the endpoint ID in the connection string."),
1123
+ pooler_mode: z.enum(["transaction"]).describe("Deprecated. The connection pooler mode."),
1124
+ disabled: z.boolean().describe("Whether to restrict connections to the compute endpoint."),
1125
+ passwordless_access: z.boolean().describe("Whether to permit passwordless access to the compute endpoint"),
1126
+ last_active: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last active").optional(),
1127
+ creation_source: z.string().describe("The compute endpoint creation source"),
1128
+ created_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was created"),
1129
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last updated"),
1130
+ started_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last started").optional(),
1131
+ suspended_at: z.iso.datetime().describe("A timestamp indicating when the compute endpoint was last suspended").optional(),
1132
+ proxy_host: z.string().describe("Deprecated. Use the `host` property instead."),
1133
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends."),
1134
+ provisioner: z.string().describe("Compute provisioner."),
1135
+ compute_release_version: z.string().describe("Attached compute's release version number.").optional()
1136
+ }).describe("Compute endpoint created or retrieved, including its current lifecycle state.") });
1137
+ const zEndpointsResponse = z.strictObject({ endpoints: z.array(zEndpoint).describe("Compute endpoints in the project.") });
1138
+ const zEndpointsOptionalResponse = z.strictObject({ endpoints: z.array(zEndpoint).describe("Compute endpoints associated with the project.").optional() });
922
1139
  /**
923
1140
  * A collection of settings for a Neon endpoint
924
1141
  */
925
1142
  const zDefaultEndpointSettings = z.strictObject({
926
1143
  pg_settings: zPgSettingsData.optional(),
927
- pgbouncer_settings: zPgbouncerSettingsData.optional(),
928
- autoscaling_limit_min_cu: zComputeUnit.optional(),
929
- autoscaling_limit_max_cu: zComputeUnit.optional(),
930
- suspend_timeout_seconds: zSuspendTimeoutSeconds.optional()
931
- });
1144
+ pgbouncer_settings: z.record(z.string(), z.string()).describe("Deprecated. Use the endpoint-level connection pooler configuration instead.").optional(),
1145
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("Minimum number of Compute Units for this endpoint.").optional(),
1146
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("Default maximum number of Compute Units for endpoints created under this account.").optional(),
1147
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends.").optional()
1148
+ }).describe("A collection of settings for a Neon endpoint");
932
1149
  const zProjectUpdateRequest = z.strictObject({ project: z.strictObject({
933
- settings: zProjectSettingsData.optional(),
934
- name: z.string().min(1).max(256).optional(),
1150
+ settings: z.strictObject({
1151
+ quota: zProjectQuota.optional(),
1152
+ allowed_ips: zAllowedIps.optional(),
1153
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
1154
+ maintenance_window: zMaintenanceWindow.optional(),
1155
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1156
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1157
+ audit_log_level: zProjectAuditLogLevel.optional(),
1158
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
1159
+ preload_libraries: zPreloadLibraries.optional()
1160
+ }).describe("Project-level settings, for example `quota`, `allowed_ips`, `enable_logical_replication`, and `maintenance_window`.").optional(),
1161
+ name: z.string().min(1).max(256).describe("The project name").optional(),
935
1162
  default_endpoint_settings: zDefaultEndpointSettings.optional(),
936
- history_retention_seconds: z.int().gte(0).lte(2592e3).optional()
1163
+ history_retention_seconds: z.int().gte(0).lte(2592e3).describe("History window (point-in-time restore range) for all branches, in seconds.").optional()
937
1164
  }) });
938
1165
  /**
1166
+ * Deprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.
1167
+ *
1168
+ *
1169
+ * @deprecated
1170
+ */
1171
+ const zPgbouncerSettingsData = z.record(z.string(), z.string()).describe("Deprecated. A raw representation of PgBouncer settings.");
1172
+ const zBranchCreateRequestEndpointOptions = z.strictObject({
1173
+ type: zEndpointType,
1174
+ settings: z.strictObject({
1175
+ pg_settings: zPgSettingsData.optional(),
1176
+ pgbouncer_settings: zPgbouncerSettingsData.optional(),
1177
+ preload_libraries: zPreloadLibraries.optional()
1178
+ }).describe("Compute endpoint settings: `pg_settings` (Postgres parameter overrides such as `work_mem`, `max_connections`) and `preload_libraries`.").optional(),
1179
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("Minimum number of Compute Units the endpoint can scale down to.").optional(),
1180
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("Maximum number of Compute Units the endpoint can scale up to.").optional(),
1181
+ provisioner: z.string().describe("Compute provisioner.").optional(),
1182
+ suspend_timeout_seconds: z.int().gte(-1).lte(604800).describe("Scale-to-zero idle timeout, in seconds, before the compute suspends.").optional()
1183
+ });
1184
+ const zBranchCreateRequest = z.strictObject({
1185
+ endpoints: z.array(zBranchCreateRequestEndpointOptions).describe("Compute endpoints to create together with the branch.").optional(),
1186
+ branch: z.strictObject({
1187
+ parent_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The `branch_id` of the parent branch.").optional(),
1188
+ name: z.string().min(1).max(256).describe("The branch name").optional(),
1189
+ parent_lsn: z.string().describe("A Log Sequence Number (LSN) on the parent branch.").optional(),
1190
+ parent_timestamp: z.iso.datetime().describe("A timestamp identifying a point in time on the parent branch.").optional(),
1191
+ protected: z.boolean().describe("Whether the branch is protected.").optional(),
1192
+ realtime: z.strictObject({ allowed_origins: z.array(z.string().min(1).max(2048).regex(/^(\*|https?:\/\/[^\/?#@,*\s]+)$/)).max(16).describe("The browser origins allowed to connect, each `http` or `https` with a host and optional port and no path.").optional() }).describe("Enable Realtime for the branch with these options.").optional(),
1193
+ archived: z.boolean().describe("Whether to create the branch in the archived state.").optional(),
1194
+ init_source: z.string().describe("Source of initialization for the branch.").optional(),
1195
+ expires_at: z.iso.datetime().describe("The timestamp when the branch is scheduled to expire and be automatically deleted.").optional()
1196
+ }).describe("Optional configuration for the new branch, for example `name`, `parent_id` (fork from a branch), `parent_lsn` or `parent_timestamp` (point-in-time branching), and `protected`.").optional()
1197
+ });
1198
+ /**
939
1199
  * The major Postgres version number. Supported versions are `14`, `15`, `16`, `17`, and `18`. `19` is rolling out and is accepted only in regions where it is enabled; requesting it elsewhere returns an error.
940
1200
  */
941
- const zPgVersion = z.int().gte(14).lte(19);
1201
+ const zPgVersion = z.int().gte(14).lte(19).describe("The major Postgres version number.");
942
1202
  /**
943
1203
  * Essential data about the project. Full data is available at `GET /projects/{project_id}`.
944
1204
  *
945
1205
  */
946
1206
  const zProjectListItem = z.strictObject({
947
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
948
- platform_id: z.string(),
949
- region_id: z.string(),
950
- name: z.string(),
951
- provisioner: zProvisioner,
1207
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1208
+ platform_id: z.string().describe("The cloud platform identifier."),
1209
+ region_id: z.string().describe("Cloud region where the project's Postgres compute and storage reside (for example, `aws-us-east-2`)."),
1210
+ name: z.string().describe("The project name"),
1211
+ provisioner: z.string().describe("Compute provisioner."),
952
1212
  default_endpoint_settings: zDefaultEndpointSettings.optional(),
953
- settings: zProjectSettingsData.optional(),
1213
+ settings: z.strictObject({
1214
+ quota: zProjectQuota.optional(),
1215
+ allowed_ips: zAllowedIps.optional(),
1216
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
1217
+ maintenance_window: zMaintenanceWindow.optional(),
1218
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1219
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1220
+ audit_log_level: zProjectAuditLogLevel.optional(),
1221
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
1222
+ preload_libraries: zPreloadLibraries.optional()
1223
+ }).describe("Project-level settings, for example `quota`, `allowed_ips`, `enable_logical_replication`, and `maintenance_window`.").optional(),
954
1224
  pg_version: zPgVersion,
955
- proxy_host: z.string(),
956
- branch_logical_size_limit: z.int(),
957
- branch_logical_size_limit_bytes: z.int(),
958
- store_passwords: z.boolean(),
959
- active_time: z.int().gte(0),
960
- cpu_used_sec: z.int(),
961
- maintenance_starts_at: z.iso.datetime().optional(),
962
- creation_source: z.string(),
963
- created_at: z.iso.datetime(),
964
- updated_at: z.iso.datetime(),
965
- synthetic_storage_size: z.int().optional(),
966
- quota_reset_at: z.iso.datetime().optional(),
967
- owner_id: z.string(),
968
- compute_last_active_at: z.iso.datetime().optional(),
969
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
970
- org_name: z.string().optional(),
971
- history_retention_seconds: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).optional(),
972
- hipaa_enabled_at: z.iso.datetime().optional(),
973
- deleted_at: z.iso.datetime().optional(),
974
- recoverable_until: z.iso.datetime().optional(),
1225
+ proxy_host: z.string().describe("The proxy host for the project."),
1226
+ branch_logical_size_limit: z.int().describe("The logical size limit for a branch."),
1227
+ branch_logical_size_limit_bytes: z.int().describe("The logical size limit for a branch."),
1228
+ store_passwords: z.boolean().describe("Whether or not passwords are stored for roles in the Neon project."),
1229
+ active_time: z.int().gte(0).describe("Control plane observed endpoints of this project being active this amount of wall-clock time."),
1230
+ cpu_used_sec: z.int().describe("Deprecated. Use `compute_time_seconds` from `GET /projects/{project_id}` instead."),
1231
+ maintenance_starts_at: z.iso.datetime().describe("A timestamp indicating when project maintenance begins.").optional(),
1232
+ creation_source: z.string().describe("The project creation source"),
1233
+ created_at: z.iso.datetime().describe("A timestamp indicating when the project was created"),
1234
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the project was last updated"),
1235
+ synthetic_storage_size: z.int().describe("Deprecated: always returns 0.").optional(),
1236
+ quota_reset_at: z.iso.datetime().describe("Deprecated. Use `consumption_period_end` from `GET /projects/{project_id}` instead.").optional(),
1237
+ owner_id: z.string().describe("ID of the organization that owns the project."),
1238
+ compute_last_active_at: z.iso.datetime().describe("The most recent time when any endpoint of this project was active.").optional(),
1239
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("ID of the organization that owns the project.").optional(),
1240
+ org_name: z.string().describe("Name of the organization that owns the project.").optional(),
1241
+ history_retention_seconds: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The number of seconds to retain the shared history for all branches in this project.").optional(),
1242
+ hipaa_enabled_at: z.iso.datetime().describe("A timestamp indicating when HIPAA was enabled for this project").optional(),
1243
+ deleted_at: z.iso.datetime().describe("A timestamp indicating when the project was deleted").optional(),
1244
+ recoverable_until: z.iso.datetime().describe("A timestamp indicating the project will be recoverable until this date and time.").optional(),
975
1245
  effective_project_permission: zProjectPermissionLevel.nullish()
976
- });
977
- const zProjectsResponse = z.strictObject({
978
- projects: z.array(zProjectListItem),
979
- unavailable_project_ids: z.array(z.string().regex(/^[a-z0-9-]{1,60}$/)).optional()
980
- });
981
- const zProjectOwnerData = z.strictObject({
982
- email: z.email().min(1).max(256),
983
- name: z.string(),
984
- branches_limit: z.int(),
985
- subscription_type: zBillingSubscriptionType
986
- });
1246
+ }).describe("Essential data about the project.");
987
1247
  const zProject = z.strictObject({
988
- data_storage_bytes_hour: z.int().gte(0),
989
- data_transfer_bytes: z.int().gte(0),
990
- written_data_bytes: z.int().gte(0),
991
- compute_time_seconds: z.int().gte(0),
992
- active_time_seconds: z.int().gte(0),
993
- cpu_used_sec: z.int(),
994
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
995
- platform_id: z.string(),
996
- region_id: z.string(),
997
- name: z.string(),
998
- provisioner: zProvisioner,
1248
+ data_storage_bytes_hour: z.int().gte(0).describe("Deprecated: always returns 0."),
1249
+ data_transfer_bytes: z.int().gte(0).describe("Bytes."),
1250
+ written_data_bytes: z.int().gte(0).describe("Bytes."),
1251
+ compute_time_seconds: z.int().gte(0).describe("Seconds."),
1252
+ active_time_seconds: z.int().gte(0).describe("Seconds."),
1253
+ cpu_used_sec: z.int().describe("Deprecated. Use `compute_time_seconds` instead."),
1254
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1255
+ platform_id: z.string().describe("The cloud platform identifier."),
1256
+ region_id: z.string().describe("Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`)."),
1257
+ name: z.string().describe("The project name"),
1258
+ provisioner: z.string().describe("Compute provisioner."),
999
1259
  default_endpoint_settings: zDefaultEndpointSettings.optional(),
1000
- settings: zProjectSettingsData.optional(),
1260
+ settings: z.strictObject({
1261
+ quota: zProjectQuota.optional(),
1262
+ allowed_ips: zAllowedIps.optional(),
1263
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
1264
+ maintenance_window: zMaintenanceWindow.optional(),
1265
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1266
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1267
+ audit_log_level: zProjectAuditLogLevel.optional(),
1268
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
1269
+ preload_libraries: zPreloadLibraries.optional()
1270
+ }).describe("Project-level settings, for example `quota`, `allowed_ips`, `enable_logical_replication`, and `maintenance_window`.").optional(),
1001
1271
  pg_version: zPgVersion,
1002
- proxy_host: z.string(),
1003
- branch_logical_size_limit: z.int(),
1004
- branch_logical_size_limit_bytes: z.int(),
1005
- store_passwords: z.boolean(),
1006
- maintenance_starts_at: z.iso.datetime().optional(),
1007
- creation_source: z.string(),
1008
- history_retention_seconds: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
1009
- created_at: z.iso.datetime(),
1010
- updated_at: z.iso.datetime(),
1011
- synthetic_storage_size: z.int().optional(),
1012
- consumption_period_start: z.iso.datetime(),
1013
- consumption_period_end: z.iso.datetime(),
1014
- quota_reset_at: z.iso.datetime().optional(),
1015
- owner_id: z.string(),
1016
- owner: zProjectOwnerData.optional(),
1017
- compute_last_active_at: z.iso.datetime().optional(),
1018
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
1019
- maintenance_scheduled_for: z.iso.datetime().optional(),
1020
- hipaa_enabled_at: z.iso.datetime().optional(),
1272
+ proxy_host: z.string().describe("The proxy host for the project."),
1273
+ branch_logical_size_limit: z.int().describe("The logical size limit for a branch."),
1274
+ branch_logical_size_limit_bytes: z.int().describe("The logical size limit for a branch."),
1275
+ store_passwords: z.boolean().describe("Whether or not passwords are stored for roles in the Neon project."),
1276
+ maintenance_starts_at: z.iso.datetime().describe("A timestamp indicating when project maintenance begins.").optional(),
1277
+ creation_source: z.string().describe("The project creation source"),
1278
+ history_retention_seconds: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The number of seconds to retain the shared history for all branches in this project."),
1279
+ created_at: z.iso.datetime().describe("A timestamp indicating when the project was created"),
1280
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the project was last updated"),
1281
+ synthetic_storage_size: z.int().describe("Deprecated: always returns 0.").optional(),
1282
+ consumption_period_start: z.iso.datetime().describe("A date-time indicating when Neon Cloud started measuring consumption for current consumption period."),
1283
+ consumption_period_end: z.iso.datetime().describe("A date-time indicating when Neon Cloud plans to stop measuring consumption for current consumption period."),
1284
+ quota_reset_at: z.iso.datetime().describe("Deprecated. Use the `consumption_period_end` field instead.").optional(),
1285
+ owner_id: z.string().describe("ID of the organization that owns the project."),
1286
+ owner: z.strictObject({
1287
+ email: z.email().min(1).max(256).describe("Email address of the project owner."),
1288
+ name: z.string().describe("Display name of the project owner."),
1289
+ branches_limit: z.int().describe("Maximum number of branches the owner is allowed to create across their projects."),
1290
+ subscription_type: zBillingSubscriptionType
1291
+ }).describe("Ownership details for the project, including the owner's name and email.").optional(),
1292
+ compute_last_active_at: z.iso.datetime().describe("The most recent time when any endpoint of this project was active.").optional(),
1293
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID.").optional(),
1294
+ maintenance_scheduled_for: z.iso.datetime().describe("A timestamp indicating when project update begins.").optional(),
1295
+ hipaa_enabled_at: z.iso.datetime().describe("A timestamp indicating when HIPAA was enabled for this project").optional(),
1021
1296
  effective_project_permission: zProjectPermissionLevel.nullish()
1022
1297
  });
1023
- const zProjectResponse = z.strictObject({ project: zProject });
1298
+ const zProjectCreateRequest = z.strictObject({ project: z.strictObject({
1299
+ settings: z.strictObject({
1300
+ quota: zProjectQuota.optional(),
1301
+ allowed_ips: zAllowedIps.optional(),
1302
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
1303
+ maintenance_window: zMaintenanceWindow.optional(),
1304
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1305
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1306
+ audit_log_level: zProjectAuditLogLevel.optional(),
1307
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
1308
+ preload_libraries: zPreloadLibraries.optional()
1309
+ }).describe("Project-level settings applied at creation.").optional(),
1310
+ name: z.string().min(1).max(256).describe("The project name.").optional(),
1311
+ realtime: z.strictObject({ allowed_origins: z.array(z.string().min(1).max(2048).regex(/^(\*|https?:\/\/[^\/?#@,*\s]+)$/)).max(16).describe("The browser origins allowed to connect, each `http` or `https` with a host and optional port and no path.").optional() }).describe("Enable Realtime for the default branch with these options.").optional(),
1312
+ branch: z.strictObject({
1313
+ name: z.string().min(1).max(256).describe("The default branch name.").optional(),
1314
+ role_name: z.string().describe("The role name.").optional(),
1315
+ database_name: z.string().describe("The database name.").optional(),
1316
+ annotations: z.record(z.string(), z.string()).describe("Arbitrary key-value metadata to attach to the branch.").optional()
1317
+ }).describe("Configuration for the initial branch created with the project.").optional(),
1318
+ autoscaling_limit_min_cu: z.number().gte(.25).describe("Deprecated. Use `default_endpoint_settings.autoscaling_limit_min_cu` instead.").optional(),
1319
+ autoscaling_limit_max_cu: z.number().gte(.25).describe("Deprecated. Use `default_endpoint_settings.autoscaling_limit_max_cu` instead.").optional(),
1320
+ provisioner: z.string().describe("Compute provisioner.").optional(),
1321
+ region_id: z.string().describe("The region identifier.").optional(),
1322
+ default_endpoint_settings: zDefaultEndpointSettings.optional(),
1323
+ pg_version: zPgVersion.optional(),
1324
+ store_passwords: z.boolean().describe("Whether or not passwords are stored for roles in the Neon project.").optional(),
1325
+ history_retention_seconds: z.int().gte(0).lte(2592e3).describe("History window (point-in-time restore range) for all branches, in seconds.").optional(),
1326
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("ID of the organization that will own the project.").optional()
1327
+ }).describe("Configuration for the new project, including name, region, and Postgres compute and storage settings.") });
1328
+ const zProjectResponse = z.strictObject({ project: z.strictObject({
1329
+ data_storage_bytes_hour: z.int().gte(0).describe("Deprecated: always returns 0."),
1330
+ data_transfer_bytes: z.int().gte(0).describe("Bytes."),
1331
+ written_data_bytes: z.int().gte(0).describe("Bytes."),
1332
+ compute_time_seconds: z.int().gte(0).describe("Seconds."),
1333
+ active_time_seconds: z.int().gte(0).describe("Seconds."),
1334
+ cpu_used_sec: z.int().describe("Deprecated. Use `compute_time_seconds` instead."),
1335
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1336
+ platform_id: z.string().describe("The cloud platform identifier."),
1337
+ region_id: z.string().describe("Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`)."),
1338
+ name: z.string().describe("The project name"),
1339
+ provisioner: z.string().describe("Compute provisioner."),
1340
+ default_endpoint_settings: zDefaultEndpointSettings.optional(),
1341
+ settings: z.strictObject({
1342
+ quota: zProjectQuota.optional(),
1343
+ allowed_ips: zAllowedIps.optional(),
1344
+ enable_logical_replication: z.boolean().describe("Sets wal_level=logical for all compute endpoints in this project.").optional(),
1345
+ maintenance_window: zMaintenanceWindow.optional(),
1346
+ block_public_connections: z.boolean().describe("When set, connections from the public internet are disallowed.").optional(),
1347
+ block_vpc_connections: z.boolean().describe("When set, connections using VPC endpoints are disallowed.").optional(),
1348
+ audit_log_level: zProjectAuditLogLevel.optional(),
1349
+ hipaa: z.boolean().describe("Enables HIPAA compliance mode for the project, including audit logging.").optional(),
1350
+ preload_libraries: zPreloadLibraries.optional()
1351
+ }).describe("Project-level settings, for example `quota`, `allowed_ips`, `enable_logical_replication`, and `maintenance_window`.").optional(),
1352
+ pg_version: zPgVersion,
1353
+ proxy_host: z.string().describe("The proxy host for the project."),
1354
+ branch_logical_size_limit: z.int().describe("The logical size limit for a branch."),
1355
+ branch_logical_size_limit_bytes: z.int().describe("The logical size limit for a branch."),
1356
+ store_passwords: z.boolean().describe("Whether or not passwords are stored for roles in the Neon project."),
1357
+ maintenance_starts_at: z.iso.datetime().describe("A timestamp indicating when project maintenance begins.").optional(),
1358
+ creation_source: z.string().describe("The project creation source"),
1359
+ history_retention_seconds: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The number of seconds to retain the shared history for all branches in this project."),
1360
+ created_at: z.iso.datetime().describe("A timestamp indicating when the project was created"),
1361
+ updated_at: z.iso.datetime().describe("A timestamp indicating when the project was last updated"),
1362
+ synthetic_storage_size: z.int().describe("Deprecated: always returns 0.").optional(),
1363
+ consumption_period_start: z.iso.datetime().describe("A date-time indicating when Neon Cloud started measuring consumption for current consumption period."),
1364
+ consumption_period_end: z.iso.datetime().describe("A date-time indicating when Neon Cloud plans to stop measuring consumption for current consumption period."),
1365
+ quota_reset_at: z.iso.datetime().describe("Deprecated. Use the `consumption_period_end` field instead.").optional(),
1366
+ owner_id: z.string().describe("ID of the organization that owns the project."),
1367
+ owner: z.strictObject({
1368
+ email: z.email().min(1).max(256).describe("Email address of the project owner."),
1369
+ name: z.string().describe("Display name of the project owner."),
1370
+ branches_limit: z.int().describe("Maximum number of branches the owner is allowed to create across their projects."),
1371
+ subscription_type: zBillingSubscriptionType
1372
+ }).describe("Ownership details for the project, including the owner's name and email.").optional(),
1373
+ compute_last_active_at: z.iso.datetime().describe("The most recent time when any endpoint of this project was active.").optional(),
1374
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID.").optional(),
1375
+ maintenance_scheduled_for: z.iso.datetime().describe("A timestamp indicating when project update begins.").optional(),
1376
+ hipaa_enabled_at: z.iso.datetime().describe("A timestamp indicating when HIPAA was enabled for this project").optional(),
1377
+ effective_project_permission: zProjectPermissionLevel.nullish()
1378
+ }).describe("Full details of the project, including configuration, consumption metrics, and ownership.") });
1024
1379
  const zProjectRecoverResponse = zProjectResponse.merge(zBranchesResponse);
1380
+ const zProjectsResponse = z.strictObject({
1381
+ projects: z.array(zProjectListItem).describe("List of projects accessible to the caller."),
1382
+ unavailable_project_ids: z.array(z.string().regex(/^[a-z0-9-]{1,60}$/)).describe("A list of project IDs indicating which projects are known to exist, but whose details could not be fetched within the requested (or implicit) time limit").optional()
1383
+ });
1384
+ const zProjectOwnerData = z.strictObject({
1385
+ email: z.email().min(1).max(256).describe("Email address of the project owner."),
1386
+ name: z.string().describe("Display name of the project owner."),
1387
+ branches_limit: z.int().describe("Maximum number of branches the owner is allowed to create across their projects."),
1388
+ subscription_type: zBillingSubscriptionType
1389
+ });
1025
1390
  const zLimitsUnsatisfiedResponse = z.strictObject({ limits: z.array(z.strictObject({
1026
- name: z.string(),
1027
- expected: z.string(),
1028
- actual: z.string()
1029
- })) });
1391
+ name: z.string().describe("Identifier of the unsatisfied limit."),
1392
+ expected: z.string().describe("Required value for the limit named by `name`."),
1393
+ actual: z.string().describe("Current value of the named limit, which does not satisfy the required `expected` value.")
1394
+ })).describe("Plan limits that were not satisfied by the request.") });
1030
1395
  const zProjectsWithIntegrationResponse = z.strictObject({ projects: z.array(z.strictObject({
1031
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1032
- integration: z.string()
1033
- })) });
1396
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1397
+ integration: z.string().describe("Name of the external integration associated with the project.")
1398
+ })).describe("Projects that have the requested integration, each including the project details and associated integration metadata.") });
1034
1399
  /**
1035
1400
  * Configuration settings for the Neon Data API
1036
1401
  */
1037
1402
  const zDataApiSettings = z.strictObject({
1038
- db_aggregates_enabled: z.boolean().optional(),
1039
- db_anon_role: z.string().optional(),
1040
- db_extra_search_path: z.string().optional(),
1041
- db_max_rows: z.int().optional(),
1042
- db_schemas: z.array(z.string()).optional(),
1043
- jwt_role_claim_key: z.string().optional(),
1044
- jwt_cache_max_lifetime: z.int().optional(),
1045
- openapi_mode: z.string().optional(),
1046
- server_cors_allowed_origins: z.string().optional(),
1047
- server_timing_enabled: z.boolean().optional()
1048
- });
1403
+ db_aggregates_enabled: z.boolean().describe("Enable aggregates feature").optional(),
1404
+ db_anon_role: z.string().describe("Database role to use for anonymous requests").optional(),
1405
+ db_extra_search_path: z.string().describe("Extra schemas to add to the search path").optional(),
1406
+ db_max_rows: z.int().describe("Hard limit on the number of rows returned in a single Data API response.").optional(),
1407
+ db_schemas: z.array(z.string()).describe("List of schemas to expose via the API.").optional(),
1408
+ jwt_role_claim_key: z.string().describe("JWT claim key to use for role extraction").optional(),
1409
+ jwt_cache_max_lifetime: z.int().describe("Maximum lifetime of the Data API's JWT cache, in seconds.").optional(),
1410
+ openapi_mode: z.string().describe("OpenAPI specification mode (ignore-privileges, disabled)").optional(),
1411
+ server_cors_allowed_origins: z.string().describe("CORS allowed origins").optional(),
1412
+ server_timing_enabled: z.boolean().describe("When enabled, the Data API adds `Server-Timing` headers to each response showing database execution and internal processing time.").optional()
1413
+ }).describe("Configuration settings for the Neon Data API");
1049
1414
  /**
1050
1415
  * Create Neon Data API
1051
1416
  */
1052
1417
  const zDataApiCreateRequest = z.strictObject({
1053
- auth_provider: z.enum(["neon_auth", "external"]).optional(),
1054
- jwks_url: z.url().optional(),
1055
- provider_name: z.string().optional(),
1056
- jwt_audience: z.string().optional(),
1057
- add_default_grants: z.boolean().optional(),
1058
- skip_auth_schema: z.boolean().optional(),
1059
- settings: zDataApiSettings.optional()
1060
- });
1418
+ auth_provider: z.enum(["neon_auth", "external"]).describe("Authentication provider for the Neon Data API.").optional(),
1419
+ jwks_url: z.url().describe("URL of the JWKS endpoint used to verify JWTs for this Data API.").optional(),
1420
+ provider_name: z.string().describe("Display name for the authentication provider.").optional(),
1421
+ jwt_audience: z.string().describe("Expected `aud` claim in incoming JWTs.").optional(),
1422
+ add_default_grants: z.boolean().describe("Grant all permissions to the tables in the public schema to authenticated users").optional(),
1423
+ skip_auth_schema: z.boolean().describe("Skip creating the auth schema and RLS functions").optional(),
1424
+ settings: z.strictObject({
1425
+ db_aggregates_enabled: z.boolean().describe("Enable aggregates feature").optional(),
1426
+ db_anon_role: z.string().describe("Database role to use for anonymous requests").optional(),
1427
+ db_extra_search_path: z.string().describe("Extra schemas to add to the search path").optional(),
1428
+ db_max_rows: z.int().describe("Hard limit on the number of rows returned in a single Data API response.").optional(),
1429
+ db_schemas: z.array(z.string()).describe("List of schemas to expose via the API.").optional(),
1430
+ jwt_role_claim_key: z.string().describe("JWT claim key to use for role extraction").optional(),
1431
+ jwt_cache_max_lifetime: z.int().describe("Maximum lifetime of the Data API's JWT cache, in seconds.").optional(),
1432
+ openapi_mode: z.string().describe("OpenAPI specification mode (ignore-privileges, disabled)").optional(),
1433
+ server_cors_allowed_origins: z.string().describe("CORS allowed origins").optional(),
1434
+ server_timing_enabled: z.boolean().describe("When enabled, the Data API adds `Server-Timing` headers to each response showing database execution and internal processing time.").optional()
1435
+ }).describe("Auth and schema configuration for the Data API.").optional()
1436
+ }).describe("Create Neon Data API");
1061
1437
  /**
1062
1438
  * Neon Data API created successfully
1063
1439
  */
1064
- const zDataApiCreateResponse = z.strictObject({ url: z.url() });
1440
+ const zDataApiCreateResponse = z.strictObject({ url: z.url().describe("URL of the created Data API endpoint.") }).describe("Neon Data API created successfully");
1065
1441
  /**
1066
1442
  * Neon Data API response
1067
1443
  */
1068
1444
  const zDataApiReponse = z.strictObject({
1069
- url: z.url(),
1070
- status: z.string(),
1445
+ url: z.url().describe("The URL of the Neon Data API"),
1446
+ status: z.string().describe("The status of the Neon Data API deployment"),
1071
1447
  settings: zDataApiSettings.nullish(),
1072
1448
  available_schemas: z.array(z.string()).nullish(),
1073
- observed_at: z.iso.datetime().optional()
1074
- });
1449
+ observed_at: z.iso.datetime().describe("When `settings` and `available_schemas` were read from the database.").optional()
1450
+ }).describe("Neon Data API response");
1075
1451
  /**
1076
1452
  * Update Neon Data API
1077
1453
  */
1078
- const zDataApiUpdateRequest = z.strictObject({ settings: zDataApiSettings.optional() });
1454
+ const zDataApiUpdateRequest = z.strictObject({ settings: z.strictObject({
1455
+ db_aggregates_enabled: z.boolean().describe("Enable aggregates feature").optional(),
1456
+ db_anon_role: z.string().describe("Database role to use for anonymous requests").optional(),
1457
+ db_extra_search_path: z.string().describe("Extra schemas to add to the search path").optional(),
1458
+ db_max_rows: z.int().describe("Hard limit on the number of rows returned in a single Data API response.").optional(),
1459
+ db_schemas: z.array(z.string()).describe("List of schemas to expose via the API.").optional(),
1460
+ jwt_role_claim_key: z.string().describe("JWT claim key to use for role extraction").optional(),
1461
+ jwt_cache_max_lifetime: z.int().describe("Maximum lifetime of the Data API's JWT cache, in seconds.").optional(),
1462
+ openapi_mode: z.string().describe("OpenAPI specification mode (ignore-privileges, disabled)").optional(),
1463
+ server_cors_allowed_origins: z.string().describe("CORS allowed origins").optional(),
1464
+ server_timing_enabled: z.boolean().describe("When enabled, the Data API adds `Server-Timing` headers to each response showing database execution and internal processing time.").optional()
1465
+ }).describe("Configuration settings for the Neon Data API.").optional() }).describe("Update Neon Data API");
1079
1466
  /**
1080
1467
  * Authentication provider integrated with this Neon Auth configuration. `better_auth` integrates with Better Auth (the current, recommended provider). `stack` integrates with Stack Auth (deprecated). `mock` is a simulated provider for local development and testing only.
1081
1468
  */
@@ -1083,165 +1470,173 @@ const zNeonAuthSupportedAuthProvider = z.enum([
1083
1470
  "mock",
1084
1471
  "stack",
1085
1472
  "better_auth"
1086
- ]);
1473
+ ]).describe("Authentication provider integrated with this Neon Auth configuration.");
1087
1474
  const zNeonAuthProviderProjectOwnedBy = z.enum(["user", "neon"]);
1088
1475
  const zNeonAuthProviderProjectTransferStatus = z.enum(["initiated", "finished"]);
1089
1476
  const zNeonAuthRedirectUriWhitelistDomain = z.strictObject({
1090
- domain: z.string(),
1477
+ domain: z.string().describe("Allowed redirect URI domain for the auth provider."),
1091
1478
  auth_provider: zNeonAuthSupportedAuthProvider
1092
1479
  });
1093
- const zNeonAuthRedirectUriWhitelistResponse = z.strictObject({ domains: z.array(zNeonAuthRedirectUriWhitelistDomain) });
1480
+ const zNeonAuthRedirectUriWhitelistResponse = z.strictObject({ domains: z.array(zNeonAuthRedirectUriWhitelistDomain).describe("Domains permitted as redirect URI targets in the whitelist.") });
1094
1481
  const zNeonAuthAddDomainToRedirectUriWhitelistRequest = z.strictObject({
1095
- domain: z.url(),
1482
+ domain: z.url().describe("URI to add to the redirect URI allowlist for the auth provider."),
1096
1483
  auth_provider: zNeonAuthSupportedAuthProvider
1097
1484
  });
1098
- const zNeonAuthDeleteDomainFromRedirectUriWhitelistItem = z.strictObject({ domain: z.url() });
1485
+ const zNeonAuthDeleteDomainFromRedirectUriWhitelistItem = z.strictObject({ domain: z.url().describe("URI to remove from the redirect URI whitelist.") });
1099
1486
  const zNeonAuthDeleteDomainFromRedirectUriWhitelistRequest = z.strictObject({
1100
1487
  auth_provider: zNeonAuthSupportedAuthProvider,
1101
- domains: z.array(zNeonAuthDeleteDomainFromRedirectUriWhitelistItem)
1488
+ domains: z.array(zNeonAuthDeleteDomainFromRedirectUriWhitelistItem).describe("Domain names to remove from the redirect URI whitelist for the specified auth provider.")
1102
1489
  });
1103
1490
  const zNeonAuthCreateIntegrationRequest = z.strictObject({
1104
1491
  auth_provider: zNeonAuthSupportedAuthProvider,
1105
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1106
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1107
- database_name: z.string().optional(),
1108
- role_name: z.string().optional()
1492
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1493
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID."),
1494
+ database_name: z.string().describe("Name of the database to associate with the Neon Auth integration.").optional(),
1495
+ role_name: z.string().describe("Deprecated. The database role for the auth integration.").optional()
1109
1496
  });
1110
1497
  const zEnableNeonAuthIntegrationRequest = z.strictObject({
1111
1498
  auth_provider: zNeonAuthSupportedAuthProvider,
1112
- database_name: z.string().optional()
1499
+ database_name: z.string().describe("Name of the database to enable Neon Auth on.").optional()
1113
1500
  });
1114
1501
  const zNeonAuthCreateIntegrationResponse = z.strictObject({
1115
1502
  auth_provider: zNeonAuthSupportedAuthProvider,
1116
- auth_provider_project_id: z.string(),
1117
- pub_client_key: z.string(),
1118
- secret_server_key: z.string(),
1119
- jwks_url: z.string(),
1120
- schema_name: z.string(),
1121
- table_name: z.string(),
1122
- base_url: z.string().optional()
1503
+ auth_provider_project_id: z.string().describe("Project ID assigned by the auth provider for this integration."),
1504
+ pub_client_key: z.string().describe("Publishable SDK key from the auth provider."),
1505
+ secret_server_key: z.string().describe("Secret server-side SDK key from the auth provider."),
1506
+ jwks_url: z.string().describe("URL of the provider's JWKS endpoint used to verify JWTs."),
1507
+ schema_name: z.string().describe("Postgres schema containing the auth integration tables."),
1508
+ table_name: z.string().describe("Postgres table in the integration schema where synced user records are stored."),
1509
+ base_url: z.string().describe("Base URL of the Neon Auth service for this integration.").optional()
1123
1510
  });
1124
1511
  const zNeonAuthCreateAuthProviderSdkKeysRequest = z.strictObject({
1125
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1512
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1126
1513
  auth_provider: zNeonAuthSupportedAuthProvider
1127
1514
  });
1128
1515
  const zNeonAuthCreateNewUserRequest = z.strictObject({
1129
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1516
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1130
1517
  auth_provider: zNeonAuthSupportedAuthProvider,
1131
- email: z.email().min(1).max(256),
1132
- name: z.string().min(1).max(255).optional()
1518
+ email: z.email().min(1).max(256).describe("Email address of the new user."),
1519
+ name: z.string().min(1).max(255).describe("Display name for the new user.").optional()
1133
1520
  });
1134
1521
  const zCreateBranchNeonAuthNewUserRequest = z.strictObject({
1135
- email: z.email().min(1).max(256),
1136
- name: z.string().min(1).max(255).optional()
1137
- });
1138
- const zNeonAuthCreateNewUserResponse = z.strictObject({ id: z.string() });
1139
- const zUpdateNeonAuthUserRoleRequest = z.strictObject({ roles: z.array(z.string()).min(1) });
1140
- const zUpdateNeonAuthUserRoleResponse = z.strictObject({ id: z.string() });
1141
- const zNeonAuthAllowLocalhostResponse = z.strictObject({ allow_localhost: z.boolean() });
1142
- const zUpdateNeonAuthAllowLocalhostRequest = z.strictObject({ allow_localhost: z.boolean() });
1522
+ email: z.email().min(1).max(256).describe("Email address of the new Neon Auth user to create."),
1523
+ name: z.string().min(1).max(255).describe("Display name for the new user.").optional()
1524
+ });
1525
+ const zNeonAuthCreateNewUserResponse = z.strictObject({ id: z.string().describe("ID of newly created user") });
1526
+ const zUpdateNeonAuthUserRoleRequest = z.strictObject({ roles: z.array(z.string()).min(1).describe("Roles to assign to the user in the Neon Auth (Better Auth) directory.") });
1527
+ const zUpdateNeonAuthUserRoleResponse = z.strictObject({ id: z.string().describe("ID of the updated user") });
1528
+ const zNeonAuthAllowLocalhostResponse = z.strictObject({ allow_localhost: z.boolean().describe("Whether to allow localhost connections") });
1529
+ const zUpdateNeonAuthAllowLocalhostRequest = z.strictObject({ allow_localhost: z.boolean().describe("Whether to allow localhost connections") });
1143
1530
  const zNeonAuthOrganizationConfig = z.strictObject({
1144
- enabled: z.boolean(),
1145
- organization_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
1146
- membership_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
1147
- creator_role: z.enum(["admin", "owner"]),
1148
- send_invitation_email: z.boolean()
1531
+ enabled: z.boolean().describe("Whether the organization plugin is enabled."),
1532
+ organization_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum organizations a user can belong to (created or joined)."),
1533
+ membership_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum number of members per organization."),
1534
+ creator_role: z.enum(["admin", "owner"]).describe("Role of the organization's creator."),
1535
+ send_invitation_email: z.boolean().describe("Whether to send invitation emails when inviting members to an organization.")
1149
1536
  });
1150
1537
  const zNeonAuthOrganizationConfigUpdate = z.strictObject({
1151
- enabled: z.boolean().optional(),
1152
- organization_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).optional(),
1153
- membership_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).optional(),
1154
- creator_role: z.enum(["admin", "owner"]).optional(),
1155
- send_invitation_email: z.boolean().optional()
1538
+ enabled: z.boolean().describe("Controls whether the organization plugin is active for the organization.").optional(),
1539
+ organization_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum organizations a user can belong to (created or joined).").optional(),
1540
+ membership_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum members per organization.").optional(),
1541
+ creator_role: z.enum(["admin", "owner"]).describe("Role of the organization's creator.").optional(),
1542
+ send_invitation_email: z.boolean().describe("When true, invited users receive an email containing an accept link.").optional()
1156
1543
  });
1157
1544
  const zNeonAuthMagicLinkConfig = z.strictObject({
1158
- enabled: z.boolean(),
1159
- expires_in: z.int().gte(5).lte(1440),
1160
- disable_sign_up: z.boolean()
1545
+ enabled: z.boolean().describe("Whether the magic link plugin is enabled."),
1546
+ expires_in: z.int().gte(5).lte(1440).describe("Minutes until the magic link expires."),
1547
+ disable_sign_up: z.boolean().describe("Whether to disable sign-up via magic link.")
1161
1548
  });
1162
1549
  const zNeonAuthMagicLinkConfigUpdate = z.strictObject({
1163
- enabled: z.boolean().optional(),
1164
- expires_in: z.int().gte(5).lte(1440).optional(),
1165
- disable_sign_up: z.boolean().optional()
1550
+ enabled: z.boolean().describe("Whether to enable the magic link plugin.").optional(),
1551
+ expires_in: z.int().gte(5).lte(1440).describe("Minutes until the magic link expires.").optional(),
1552
+ disable_sign_up: z.boolean().describe("When true, sign-up via magic link is disabled.").optional()
1166
1553
  });
1167
1554
  const zNeonAuthPhoneNumberConfig = z.strictObject({
1168
- enabled: z.boolean(),
1169
- otp_expires_in: z.int().gte(60).lte(600).optional()
1555
+ enabled: z.boolean().describe("Whether the phone number plugin is enabled."),
1556
+ otp_expires_in: z.int().gte(60).lte(600).describe("Time in seconds before the OTP expires").optional()
1170
1557
  });
1171
1558
  const zNeonAuthPhoneNumberConfigUpdate = z.strictObject({
1172
- enabled: z.boolean().optional(),
1173
- otp_expires_in: z.int().gte(60).lte(600).optional()
1559
+ enabled: z.boolean().describe("Whether the phone number plugin is enabled.").optional(),
1560
+ otp_expires_in: z.int().gte(60).lte(600).describe("Time in seconds before the OTP expires").optional()
1174
1561
  });
1175
- const zNeonAuthOAuthProviderResource = z.strictObject({ identifier: z.string() });
1562
+ const zNeonAuthOAuthProviderResource = z.strictObject({ identifier: z.string().describe("Absolute URL identifying a protected resource.") });
1176
1563
  const zNeonAuthOAuthProviderMcp = z.strictObject({
1177
- resource: z.string().optional(),
1178
- dynamic_registration: z.boolean().optional(),
1179
- client_id_metadata_documents: z.boolean().optional()
1564
+ resource: z.string().describe("The MCP server URL that MCP clients (Client ID Metadata Document and dynamically registered) are linked to.").optional(),
1565
+ dynamic_registration: z.boolean().describe("Legacy: whether MCP clients may register themselves via dynamic client registration (RFC 7591).").optional(),
1566
+ client_id_metadata_documents: z.boolean().describe("Whether MCP clients may identify themselves with an https Client ID Metadata Document (CIMD) URL.").optional()
1180
1567
  });
1181
1568
  const zNeonAuthOAuthProviderMcpUpdate = z.strictObject({
1182
- resource: z.string(),
1183
- dynamic_registration: z.boolean().optional(),
1184
- client_id_metadata_documents: z.boolean().optional()
1569
+ resource: z.string().describe("The MCP server URL that MCP clients (Client ID Metadata Document and dynamically registered) are linked to."),
1570
+ dynamic_registration: z.boolean().describe("Whether MCP clients may register themselves via dynamic client registration (RFC 7591).").optional(),
1571
+ client_id_metadata_documents: z.boolean().describe("Whether MCP clients may identify themselves with an https Client ID Metadata Document (CIMD) URL.").optional()
1185
1572
  });
1186
1573
  const zNeonAuthOAuthProviderConfig = z.strictObject({
1187
- enabled: z.boolean(),
1188
- login_page: z.string().optional(),
1189
- consent_page: z.string().optional(),
1190
- mcp: zNeonAuthOAuthProviderMcp.optional(),
1191
- resources: z.array(zNeonAuthOAuthProviderResource).optional()
1574
+ enabled: z.boolean().describe("Whether the OAuth provider plugin is enabled."),
1575
+ login_page: z.string().describe("URL of the page that authorization requests redirect to for sign-in.").optional(),
1576
+ consent_page: z.string().describe("URL of the page that authorization requests redirect to for consent.").optional(),
1577
+ mcp: z.strictObject({
1578
+ resource: z.string().describe("The MCP server URL that MCP clients (Client ID Metadata Document and dynamically registered) are linked to.").optional(),
1579
+ dynamic_registration: z.boolean().describe("Legacy: whether MCP clients may register themselves via dynamic client registration (RFC 7591).").optional(),
1580
+ client_id_metadata_documents: z.boolean().describe("Whether MCP clients may identify themselves with an https Client ID Metadata Document (CIMD) URL.").optional()
1581
+ }).describe("MCP resource configuration.").optional(),
1582
+ resources: z.array(zNeonAuthOAuthProviderResource).describe("Protected resources that clients can be linked to.").optional()
1192
1583
  });
1193
1584
  const zNeonAuthOAuthProviderConfigUpdate = z.strictObject({
1194
- enabled: z.boolean().optional(),
1195
- login_page: z.string().optional(),
1196
- consent_page: z.string().optional(),
1197
- mcp: zNeonAuthOAuthProviderMcpUpdate.optional(),
1198
- resources: z.array(zNeonAuthOAuthProviderResource).optional()
1585
+ enabled: z.boolean().describe("Whether the OAuth provider plugin is enabled.").optional(),
1586
+ login_page: z.string().describe("URL of the page that authorization requests redirect to for sign-in.").optional(),
1587
+ consent_page: z.string().describe("URL of the page that authorization requests redirect to for consent.").optional(),
1588
+ mcp: z.strictObject({
1589
+ resource: z.string().describe("The MCP server URL that MCP clients (Client ID Metadata Document and dynamically registered) are linked to."),
1590
+ dynamic_registration: z.boolean().describe("Whether MCP clients may register themselves via dynamic client registration (RFC 7591).").optional(),
1591
+ client_id_metadata_documents: z.boolean().describe("Whether MCP clients may identify themselves with an https Client ID Metadata Document (CIMD) URL.").optional()
1592
+ }).describe("MCP resource configuration.").optional(),
1593
+ resources: z.array(zNeonAuthOAuthProviderResource).describe("Protected resources that clients can be linked to.").optional()
1199
1594
  });
1200
1595
  /**
1201
1596
  * Confidential clients authenticate with a client secret. Public clients have no secret.
1202
1597
  */
1203
- const zNeonAuthOAuthClientType = z.enum(["confidential", "public"]);
1598
+ const zNeonAuthOAuthClientType = z.enum(["confidential", "public"]).describe("Confidential clients authenticate with a client secret.");
1204
1599
  const zNeonAuthOAuthClient = z.strictObject({
1205
- client_id: z.string(),
1206
- name: z.string(),
1600
+ client_id: z.string().describe("The OAuth client ID."),
1601
+ name: z.string().describe("Display name of the client."),
1207
1602
  type: zNeonAuthOAuthClientType,
1208
- redirect_uris: z.array(z.string()),
1209
- resources: z.array(z.string()),
1210
- skip_consent: z.boolean(),
1211
- disabled: z.boolean(),
1212
- created_at: z.iso.datetime().optional()
1213
- });
1214
- const zNeonAuthOAuthClientCreated = zNeonAuthOAuthClient.merge(z.strictObject({ client_secret: z.string().optional() }));
1215
- const zListNeonAuthOAuthClientsResponse = z.strictObject({ clients: z.array(zNeonAuthOAuthClient) });
1603
+ redirect_uris: z.array(z.string()).describe("Redirect URIs the client may use."),
1604
+ resources: z.array(z.string()).describe("Identifiers of the protected resources the client is linked to."),
1605
+ skip_consent: z.boolean().describe("Whether users are not asked for consent when authorizing this client."),
1606
+ disabled: z.boolean().describe("Whether the client is disabled."),
1607
+ created_at: z.iso.datetime().describe("When the client was created.").optional()
1608
+ });
1609
+ const zNeonAuthOAuthClientCreated = zNeonAuthOAuthClient.merge(z.strictObject({ client_secret: z.string().describe("The client secret.").optional() }));
1610
+ const zListNeonAuthOAuthClientsResponse = z.strictObject({ clients: z.array(zNeonAuthOAuthClient).describe("OAuth clients registered for the branch.") });
1216
1611
  const zNeonAuthOAuthClientCreateRequest = z.strictObject({
1217
- name: z.string().min(1).max(100),
1218
- redirect_uris: z.array(z.string()).min(1).max(10),
1612
+ name: z.string().min(1).max(100).describe("Display name of the client."),
1613
+ redirect_uris: z.array(z.string()).min(1).max(10).describe("Redirect URIs the client may use."),
1219
1614
  type: zNeonAuthOAuthClientType,
1220
- resources: z.array(z.string()).min(1).max(11),
1221
- skip_consent: z.boolean().optional()
1615
+ resources: z.array(z.string()).min(1).max(11).describe("Identifiers of the protected resources to link the client to."),
1616
+ skip_consent: z.boolean().describe("Whether to skip the consent prompt for this client.").optional()
1222
1617
  });
1223
1618
  /**
1224
1619
  * At least one field must be provided.
1225
1620
  */
1226
1621
  const zNeonAuthOAuthClientUpdateRequest = z.strictObject({
1227
- name: z.string().min(1).max(100).optional(),
1228
- redirect_uris: z.array(z.string()).max(10).optional(),
1229
- skip_consent: z.boolean().optional(),
1230
- disabled: z.boolean().optional(),
1231
- resources: z.array(z.string()).max(11).optional()
1232
- });
1622
+ name: z.string().min(1).max(100).describe("Display name of the client.").optional(),
1623
+ redirect_uris: z.array(z.string()).max(10).describe("Redirect URIs the client may use.").optional(),
1624
+ skip_consent: z.boolean().describe("Whether to skip the consent prompt for this client.").optional(),
1625
+ disabled: z.boolean().describe("Whether the client is disabled.").optional(),
1626
+ resources: z.array(z.string()).max(11).describe("Identifiers of the protected resources to link the client to.").optional()
1627
+ }).describe("At least one field must be provided.");
1233
1628
  const zNeonAuthOAuthClientSecret = z.strictObject({
1234
- client_id: z.string(),
1235
- client_secret: z.string()
1629
+ client_id: z.string().describe("The OAuth client ID."),
1630
+ client_secret: z.string().describe("The new client secret.")
1236
1631
  });
1237
1632
  const zNeonAuthTransferAuthProviderProjectRequest = z.strictObject({
1238
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1633
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID."),
1239
1634
  auth_provider: zNeonAuthSupportedAuthProvider
1240
1635
  });
1241
- const zNeonAuthTransferAuthProviderProjectResponse = z.strictObject({ url: z.string() });
1636
+ const zNeonAuthTransferAuthProviderProjectResponse = z.strictObject({ url: z.string().describe("URL for completing the process of ownership transfer") });
1242
1637
  const zNeonAuthWebhookConfig = z.strictObject({
1243
- enabled: z.boolean(),
1244
- webhook_url: z.string().optional(),
1638
+ enabled: z.boolean().describe("Whether the webhook is active."),
1639
+ webhook_url: z.string().describe("Destination URL that receives webhook event payloads.").optional(),
1245
1640
  enabled_events: z.array(z.enum([
1246
1641
  "user.before_create",
1247
1642
  "user.created",
@@ -1250,9 +1645,25 @@ const zNeonAuthWebhookConfig = z.strictObject({
1250
1645
  "organization.invitation.created",
1251
1646
  "organization.invitation.accepted",
1252
1647
  "phone_number.verified"
1253
- ])).optional(),
1254
- timeout_seconds: z.int().gte(1).lte(10).optional()
1648
+ ])).describe("Event types that trigger this webhook.").optional(),
1649
+ timeout_seconds: z.int().gte(1).lte(10).describe("Maximum time, in seconds, to wait for a response from the webhook endpoint.").optional()
1255
1650
  });
1651
+ const zNeonAuthOauthProvider = z.strictObject({
1652
+ id: z.enum([
1653
+ "google",
1654
+ "github",
1655
+ "microsoft",
1656
+ "vercel",
1657
+ "apple"
1658
+ ]).describe("The OAuth provider's ID."),
1659
+ type: z.enum(["standard", "shared"]).describe("OAuth provider key type."),
1660
+ client_id: z.string().describe("Public identifier for the OAuth application, issued by the provider when the application is registered.").optional(),
1661
+ client_secret: z.string().describe("Masked OAuth client secret for the provider.").optional(),
1662
+ microsoft_tenant_id: z.string().describe("Tenant ID of the Microsoft OAuth provider.").optional(),
1663
+ apple_team_id: z.string().describe("Apple Developer Team ID.").optional(),
1664
+ apple_key_id: z.string().describe("Key ID of the Sign in with Apple private key.").optional()
1665
+ });
1666
+ const zListNeonAuthOauthProvidersResponse = z.strictObject({ providers: z.array(zNeonAuthOauthProvider).describe("OAuth providers configured for Neon Auth on the project.") });
1256
1667
  const zNeonAuthOauthProviderId = z.enum([
1257
1668
  "google",
1258
1669
  "github",
@@ -1261,71 +1672,67 @@ const zNeonAuthOauthProviderId = z.enum([
1261
1672
  "apple"
1262
1673
  ]);
1263
1674
  const zNeonAuthOauthProviderType = z.enum(["standard", "shared"]);
1264
- const zNeonAuthOauthProvider = z.strictObject({
1265
- id: zNeonAuthOauthProviderId,
1266
- type: zNeonAuthOauthProviderType,
1267
- client_id: z.string().optional(),
1268
- client_secret: z.string().optional(),
1269
- microsoft_tenant_id: z.string().optional(),
1270
- apple_team_id: z.string().optional(),
1271
- apple_key_id: z.string().optional()
1272
- });
1273
- const zListNeonAuthOauthProvidersResponse = z.strictObject({ providers: z.array(zNeonAuthOauthProvider) });
1274
1675
  const zNeonAuthAddOAuthProviderRequest = z.strictObject({
1275
- id: zNeonAuthOauthProviderId,
1276
- client_id: z.string().optional(),
1277
- client_secret: z.string().optional(),
1278
- microsoft_tenant_id: z.string().optional(),
1279
- apple_team_id: z.string().optional(),
1280
- apple_key_id: z.string().optional()
1676
+ id: z.enum([
1677
+ "google",
1678
+ "github",
1679
+ "microsoft",
1680
+ "vercel",
1681
+ "apple"
1682
+ ]).describe("OAuth provider to configure for Neon Auth."),
1683
+ client_id: z.string().describe("The client ID issued by the OAuth provider for your application.").optional(),
1684
+ client_secret: z.string().describe("OAuth client secret for the provider.").optional(),
1685
+ microsoft_tenant_id: z.string().describe("Tenant ID for the Microsoft OAuth provider.").optional(),
1686
+ apple_team_id: z.string().describe("Apple Developer Team ID.").optional(),
1687
+ apple_key_id: z.string().describe("Key ID of the Sign in with Apple private key supplied in `client_secret`.").optional()
1281
1688
  });
1282
1689
  const zNeonAuthUpdateOAuthProviderRequest = z.strictObject({
1283
- client_id: z.string().optional(),
1284
- client_secret: z.string().optional(),
1285
- microsoft_tenant_id: z.string().optional(),
1286
- apple_team_id: z.string().optional(),
1287
- apple_key_id: z.string().optional()
1690
+ client_id: z.string().describe("The OAuth client ID registered with the provider.").optional(),
1691
+ client_secret: z.string().describe("OAuth client secret for the provider.").optional(),
1692
+ microsoft_tenant_id: z.string().describe("The tenant ID scoping the Microsoft OAuth provider.").optional(),
1693
+ apple_team_id: z.string().describe("Apple Developer Team ID.").optional(),
1694
+ apple_key_id: z.string().describe("Key ID of the Sign in with Apple private key supplied in `client_secret`.").optional()
1288
1695
  });
1289
1696
  const zSharedEmailServer = z.strictObject({
1290
- sender_email: z.string().optional(),
1291
- sender_name: z.string().optional()
1697
+ sender_email: z.string().describe("Email address used as the sender for outgoing messages from this shared email server.").optional(),
1698
+ sender_name: z.string().describe("Display name shown as the sender in outgoing emails.").optional()
1292
1699
  });
1293
1700
  const zStandardEmailServer = z.strictObject({
1294
- host: z.string().optional(),
1295
- port: z.int().optional(),
1296
- username: z.string().optional(),
1297
- password: z.string().optional(),
1298
- sender_email: z.string().optional(),
1299
- sender_name: z.string().optional()
1701
+ host: z.string().describe("Hostname of the email server.").optional(),
1702
+ port: z.int().describe("TCP port of the SMTP server.").optional(),
1703
+ username: z.string().describe("Username for authenticating with the SMTP server.").optional(),
1704
+ password: z.string().describe("Password for authenticating with the SMTP server.").optional(),
1705
+ sender_email: z.string().describe("Email address used as the From address on outgoing auth emails.").optional(),
1706
+ sender_name: z.string().describe("Display name shown as the sender in outgoing emails.").optional()
1300
1707
  });
1301
1708
  const zStandardEmailServerResponse = z.strictObject({
1302
- host: z.string(),
1303
- port: z.int(),
1304
- username: z.string(),
1305
- password: z.string(),
1306
- sender_email: z.string(),
1307
- sender_name: z.string()
1709
+ host: z.string().describe("Hostname of the email server."),
1710
+ port: z.int().describe("TCP port of the SMTP server."),
1711
+ username: z.string().describe("Username for authenticating with the SMTP server."),
1712
+ password: z.string().describe("On GET, returned redacted (empty) for ordinary callers, while callers with project-credential read permission receive the stored password — do not assume this field is empty."),
1713
+ sender_email: z.string().describe("Email address used as the From address on outgoing auth emails."),
1714
+ sender_name: z.string().describe("Display name shown as the sender in outgoing emails.")
1308
1715
  });
1309
1716
  const zNeonAuthEmailServerConfig = z.discriminatedUnion("type", [zStandardEmailServer.extend({ type: z.literal("standard") }), zSharedEmailServer.extend({ type: z.literal("shared") })]);
1310
1717
  const zNeonAuthEmailServerConfigResponse = z.discriminatedUnion("type", [zStandardEmailServerResponse.extend({ type: z.literal("standard") }), zSharedEmailServer.extend({ type: z.literal("shared") })]);
1311
1718
  const zSendNeonAuthTestEmailRequest = z.strictObject({
1312
- host: z.string(),
1313
- port: z.int(),
1314
- username: z.string(),
1315
- password: z.string(),
1316
- sender_email: z.string(),
1317
- sender_name: z.string(),
1318
- recipient_email: z.email().min(1).max(256)
1719
+ host: z.string().describe("Hostname of the email server."),
1720
+ port: z.int().describe("TCP port of the SMTP server."),
1721
+ username: z.string().describe("Username for authenticating with the SMTP server."),
1722
+ password: z.string().describe("Password for authenticating with the SMTP server."),
1723
+ sender_email: z.string().describe("Email address used as the From address on outgoing auth emails."),
1724
+ sender_name: z.string().describe("Display name shown as the sender in outgoing emails."),
1725
+ recipient_email: z.email().min(1).max(256).describe("The email address to send the test email to.")
1319
1726
  });
1320
1727
  /**
1321
1728
  * Request to test the branch's saved email provider. Only the recipient is supplied; the stored
1322
1729
  * SMTP settings and password are used server-side.
1323
1730
  *
1324
1731
  */
1325
- const zSendNeonAuthEmailProviderTestRequest = z.strictObject({ recipient_email: z.email().min(1).max(256) });
1732
+ const zSendNeonAuthEmailProviderTestRequest = z.strictObject({ recipient_email: z.email().min(1).max(256).describe("The email address to send the test email to.") }).describe("Request to test the branch's saved email provider.");
1326
1733
  const zSendNeonAuthTestEmailResponse = z.strictObject({
1327
- success: z.boolean(),
1328
- error_message: z.string().optional()
1734
+ success: z.boolean().describe("Whether the test email was sent successfully."),
1735
+ error_message: z.string().describe("The error message from the email server.").optional()
1329
1736
  });
1330
1737
  /**
1331
1738
  * The email verification method to use.
@@ -1333,61 +1740,93 @@ const zSendNeonAuthTestEmailResponse = z.strictObject({
1333
1740
  * - `otp`: Sends a one-time password (OTP) via email
1334
1741
  *
1335
1742
  */
1336
- const zNeonAuthEmailVerificationMethod = z.enum(["link", "otp"]);
1337
- const zNeonAuthEmailAndPasswordConfig = z.strictObject({
1338
- enabled: z.boolean(),
1339
- email_verification_method: zNeonAuthEmailVerificationMethod,
1340
- require_email_verification: z.boolean(),
1341
- auto_sign_in_after_verification: z.boolean(),
1342
- send_verification_email_on_sign_up: z.boolean(),
1343
- send_verification_email_on_sign_in: z.boolean(),
1344
- disable_sign_up: z.boolean(),
1345
- revoke_sessions_on_password_reset: z.boolean()
1346
- });
1743
+ const zNeonAuthEmailVerificationMethod = z.enum(["link", "otp"]).describe("The email verification method to use.");
1347
1744
  /**
1348
1745
  * Aggregated plugin configurations for Neon Auth
1349
1746
  */
1350
1747
  const zNeonAuthPluginConfigs = z.strictObject({
1351
- organization: zNeonAuthOrganizationConfig.optional(),
1352
- magic_link: zNeonAuthMagicLinkConfig.optional(),
1353
- phone_number: zNeonAuthPhoneNumberConfig.optional(),
1354
- oauth_provider: zNeonAuthOAuthProviderConfig.optional(),
1355
- email_provider: zNeonAuthEmailServerConfigResponse.optional(),
1356
- email_and_password: zNeonAuthEmailAndPasswordConfig.optional(),
1357
- oauth_providers: z.array(zNeonAuthOauthProvider).optional(),
1358
- allow_localhost: z.boolean().optional()
1748
+ organization: z.strictObject({
1749
+ enabled: z.boolean().describe("Whether the organization plugin is enabled."),
1750
+ organization_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum organizations a user can belong to (created or joined)."),
1751
+ membership_limit: z.int().gte(1).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("Maximum number of members per organization."),
1752
+ creator_role: z.enum(["admin", "owner"]).describe("Role of the organization's creator."),
1753
+ send_invitation_email: z.boolean().describe("Whether to send invitation emails when inviting members to an organization.")
1754
+ }).describe("Configuration for the Neon Auth organization plugin, which enables user organizations within the authentication system.").optional(),
1755
+ magic_link: z.strictObject({
1756
+ enabled: z.boolean().describe("Whether the magic link plugin is enabled."),
1757
+ expires_in: z.int().gte(5).lte(1440).describe("Minutes until the magic link expires."),
1758
+ disable_sign_up: z.boolean().describe("Whether to disable sign-up via magic link.")
1759
+ }).describe("Configuration for passwordless magic-link email authentication.").optional(),
1760
+ phone_number: z.strictObject({
1761
+ enabled: z.boolean().describe("Whether the phone number plugin is enabled."),
1762
+ otp_expires_in: z.int().gte(60).lte(600).describe("Time in seconds before the OTP expires").optional()
1763
+ }).describe("Configuration for the phone number authentication plugin.").optional(),
1764
+ oauth_provider: z.strictObject({
1765
+ enabled: z.boolean().describe("Whether the OAuth provider plugin is enabled."),
1766
+ login_page: z.string().describe("URL of the page that authorization requests redirect to for sign-in.").optional(),
1767
+ consent_page: z.string().describe("URL of the page that authorization requests redirect to for consent.").optional(),
1768
+ mcp: z.strictObject({
1769
+ resource: z.string().describe("The MCP server URL that MCP clients (Client ID Metadata Document and dynamically registered) are linked to.").optional(),
1770
+ dynamic_registration: z.boolean().describe("Legacy: whether MCP clients may register themselves via dynamic client registration (RFC 7591).").optional(),
1771
+ client_id_metadata_documents: z.boolean().describe("Whether MCP clients may identify themselves with an https Client ID Metadata Document (CIMD) URL.").optional()
1772
+ }).describe("MCP resource configuration.").optional(),
1773
+ resources: z.array(zNeonAuthOAuthProviderResource).describe("Protected resources that clients can be linked to.").optional()
1774
+ }).describe("Configuration for the OAuth provider plugin, which lets Neon Auth act as an OAuth authorization server for your own clients.").optional(),
1775
+ email_provider: z.discriminatedUnion("type", [zStandardEmailServerResponse.extend({ type: z.literal("standard") }), zSharedEmailServer.extend({ type: z.literal("shared") })]).optional(),
1776
+ email_and_password: z.strictObject({
1777
+ enabled: z.boolean().describe("Whether email and password authentication is enabled"),
1778
+ email_verification_method: zNeonAuthEmailVerificationMethod,
1779
+ require_email_verification: z.boolean().describe("Whether email verification is required before users can sign in"),
1780
+ auto_sign_in_after_verification: z.boolean().describe("Whether users are automatically signed in after verifying their email"),
1781
+ send_verification_email_on_sign_up: z.boolean().describe("Whether to send a verification email when users sign up"),
1782
+ send_verification_email_on_sign_in: z.boolean().describe("Whether to send a verification email when users sign in"),
1783
+ disable_sign_up: z.boolean().describe("Whether to disable new user sign ups"),
1784
+ revoke_sessions_on_password_reset: z.boolean().describe("Whether all of a user's sessions are revoked when their password is reset")
1785
+ }).describe("Configuration for email and password authentication.").optional(),
1786
+ oauth_providers: z.array(zNeonAuthOauthProvider).describe("OAuth provider configurations enabled for this auth setup.").optional(),
1787
+ allow_localhost: z.boolean().describe("Permits authentication requests from localhost origins when true.").optional()
1788
+ }).describe("Aggregated plugin configurations for Neon Auth");
1789
+ const zNeonAuthEmailAndPasswordConfig = z.strictObject({
1790
+ enabled: z.boolean().describe("Whether email and password authentication is enabled"),
1791
+ email_verification_method: z.enum(["link", "otp"]).describe("Controls how email addresses are verified during sign-up or sign-in."),
1792
+ require_email_verification: z.boolean().describe("Whether email verification is required before users can sign in"),
1793
+ auto_sign_in_after_verification: z.boolean().describe("Whether users are automatically signed in after verifying their email"),
1794
+ send_verification_email_on_sign_up: z.boolean().describe("Whether to send a verification email when users sign up"),
1795
+ send_verification_email_on_sign_in: z.boolean().describe("Whether to send a verification email when users sign in"),
1796
+ disable_sign_up: z.boolean().describe("Whether to disable new user sign ups"),
1797
+ revoke_sessions_on_password_reset: z.boolean().describe("Whether all of a user's sessions are revoked when their password is reset")
1359
1798
  });
1360
1799
  const zNeonAuthEmailAndPasswordConfigUpdate = z.strictObject({
1361
- enabled: z.boolean().optional(),
1362
- email_verification_method: zNeonAuthEmailVerificationMethod.optional(),
1363
- require_email_verification: z.boolean().optional(),
1364
- auto_sign_in_after_verification: z.boolean().optional(),
1365
- send_verification_email_on_sign_up: z.boolean().optional(),
1366
- send_verification_email_on_sign_in: z.boolean().optional(),
1367
- disable_sign_up: z.boolean().optional(),
1368
- revoke_sessions_on_password_reset: z.boolean().optional()
1800
+ enabled: z.boolean().describe("Controls whether email and password authentication is enabled for this project.").optional(),
1801
+ email_verification_method: z.enum(["link", "otp"]).describe("Email verification method.").optional(),
1802
+ require_email_verification: z.boolean().describe("When true, users must verify their email address before they can sign in.").optional(),
1803
+ auto_sign_in_after_verification: z.boolean().describe("Whether users are automatically signed in after verifying their email").optional(),
1804
+ send_verification_email_on_sign_up: z.boolean().describe("Whether to send a verification email when users sign up.").optional(),
1805
+ send_verification_email_on_sign_in: z.boolean().describe("Whether to send a verification email when a user with an unverified email signs in.").optional(),
1806
+ disable_sign_up: z.boolean().describe("Whether to disable new user sign ups.").optional(),
1807
+ revoke_sessions_on_password_reset: z.boolean().describe("Whether all of a user's sessions are revoked when their password is reset.").optional()
1369
1808
  });
1370
1809
  const zNeonAuthIntegration = z.strictObject({
1371
1810
  auth_provider: zNeonAuthSupportedAuthProvider,
1372
- auth_provider_project_id: z.string(),
1373
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1374
- db_name: z.string(),
1375
- created_at: z.iso.datetime(),
1376
- owned_by: zNeonAuthProviderProjectOwnedBy,
1377
- transfer_status: zNeonAuthProviderProjectTransferStatus.optional(),
1378
- jwks_url: z.string(),
1379
- base_url: z.string().optional(),
1380
- name: z.string().min(1).max(256).optional()
1381
- });
1382
- const zListNeonAuthIntegrationsResponse = z.strictObject({ data: z.array(zNeonAuthIntegration) });
1383
- const zNeonAuthConfigUpdate = z.strictObject({ name: z.string().min(1).max(256) });
1384
- const zNeonAuthConfigResponse = z.strictObject({ name: z.string() });
1385
- const zErrorCode = z.string();
1811
+ auth_provider_project_id: z.string().describe("Project identifier assigned by the auth provider for this integration."),
1812
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID."),
1813
+ db_name: z.string().describe("Name of the database used by the Neon Auth integration."),
1814
+ created_at: z.iso.datetime().describe("Timestamp when the Neon Auth integration was created, in RFC 3339 format (UTC)."),
1815
+ owned_by: z.enum(["user", "neon"]).describe("Owner of the auth provider project."),
1816
+ transfer_status: z.enum(["initiated", "finished"]).describe("Ownership transfer state for the auth provider project.").optional(),
1817
+ jwks_url: z.string().describe("URL of the provider's JWKS endpoint used to verify JWTs."),
1818
+ base_url: z.string().describe("Base URL of the Neon Auth service endpoint for this integration.").optional(),
1819
+ name: z.string().min(1).max(256).describe("Application name shown in auth emails and communications.").optional()
1820
+ });
1821
+ const zListNeonAuthIntegrationsResponse = z.strictObject({ data: z.array(zNeonAuthIntegration).describe("Neon Auth integrations configured for the project.") });
1822
+ const zNeonAuthConfigUpdate = z.strictObject({ name: z.string().min(1).max(256).describe("The application name used in auth emails and communications.") });
1823
+ const zNeonAuthConfigResponse = z.strictObject({ name: z.string().describe("The application name used in auth emails and communications.") });
1386
1824
  const zGeneralError = z.strictObject({
1387
- request_id: z.string().optional(),
1388
- code: zErrorCode,
1389
- message: z.string()
1825
+ request_id: z.string().describe("Unique identifier for the request, useful for debugging.").optional(),
1826
+ code: z.string().describe("Machine-readable code classifying the error type."),
1827
+ message: z.string().describe("Error message")
1390
1828
  });
1829
+ const zErrorCode = z.string();
1391
1830
  const zBranchOperations = zBranchResponse.merge(zOperationsResponse);
1392
1831
  const zBranchRecoverResponse = zBranchResponse.merge(zEndpointsOptionalResponse);
1393
1832
  const zEndpointOperations = zEndpointResponse.merge(zOperationsResponse);
@@ -1397,45 +1836,36 @@ const zJwksCreationOperation = zJwksResponse.merge(zOperationsResponse);
1397
1836
  /**
1398
1837
  * A free-form map of string key-value pairs for attaching metadata to a resource (for example, a git commit reference). Maximum 50 entries.
1399
1838
  */
1400
- const zAnnotationValueData = z.record(z.string(), z.string());
1401
- const zProjectCreateRequest = z.strictObject({ project: z.strictObject({
1402
- settings: zProjectSettingsData.optional(),
1403
- name: z.string().min(1).max(256).optional(),
1404
- realtime: zRealtimeOptions.optional(),
1405
- branch: z.strictObject({
1406
- name: z.string().min(1).max(256).optional(),
1407
- role_name: z.string().optional(),
1408
- database_name: z.string().optional(),
1409
- annotations: zAnnotationValueData.optional()
1410
- }).optional(),
1411
- autoscaling_limit_min_cu: zComputeUnit.optional(),
1412
- autoscaling_limit_max_cu: zComputeUnit.optional(),
1413
- provisioner: zProvisioner.optional(),
1414
- region_id: z.string().optional(),
1415
- default_endpoint_settings: zDefaultEndpointSettings.optional(),
1416
- pg_version: zPgVersion.optional(),
1417
- store_passwords: z.boolean().optional(),
1418
- history_retention_seconds: z.int().gte(0).lte(2592e3).optional(),
1419
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional()
1420
- }) });
1421
- const zAnnotationObjectData = z.strictObject({
1422
- type: z.string(),
1423
- id: z.string()
1424
- });
1839
+ const zAnnotationValueData = z.record(z.string(), z.string()).describe("A free-form map of string key-value pairs for attaching metadata to a resource (for example, a git commit reference).");
1425
1840
  const zAnnotationData = z.strictObject({
1426
- object: zAnnotationObjectData,
1841
+ object: z.strictObject({
1842
+ type: z.string().describe("Kind of resource the annotation is attached to, for example \"branch\" or \"endpoint\"."),
1843
+ id: z.string().describe("The annotated object's ID.")
1844
+ }).describe("Resource that this annotation is attached to."),
1427
1845
  value: zAnnotationValueData,
1428
- created_at: z.iso.datetime().optional(),
1429
- updated_at: z.iso.datetime().optional()
1846
+ created_at: z.iso.datetime().describe("Timestamp when the annotation was created, in RFC 3339 format (UTC).").optional(),
1847
+ updated_at: z.iso.datetime().describe("Timestamp of the most recent update to the annotation, in RFC 3339 format (UTC).").optional()
1848
+ });
1849
+ const zAnnotationObjectData = z.strictObject({
1850
+ type: z.string().describe("Kind of resource the annotation is attached to, for example \"branch\" or \"endpoint\"."),
1851
+ id: z.string().describe("The annotated object's ID.")
1430
1852
  });
1431
1853
  const zAnnotationCreateValueRequest = z.strictObject({ annotation_value: zAnnotationValueData.optional() });
1432
1854
  const zBranchAnonymizedCreateRequest = zAnnotationCreateValueRequest.merge(z.strictObject({
1433
1855
  branch_create: zBranchCreateRequest.optional(),
1434
- masking_rules: z.array(zMaskingRule).optional(),
1435
- start_anonymization: z.boolean().optional()
1856
+ masking_rules: z.array(zMaskingRule).describe("List of masking rules to apply to the branch.").optional(),
1857
+ start_anonymization: z.boolean().describe("If true, automatically start anonymization after the branch is created.").optional()
1436
1858
  }));
1437
- const zAnnotationResponse = z.strictObject({ annotation: zAnnotationData });
1438
- const zAnnotationsMapResponse = z.strictObject({ annotations: z.record(z.string(), zAnnotationData) });
1859
+ const zAnnotationResponse = z.strictObject({ annotation: z.strictObject({
1860
+ object: z.strictObject({
1861
+ type: z.string().describe("Kind of resource the annotation is attached to, for example \"branch\" or \"endpoint\"."),
1862
+ id: z.string().describe("The annotated object's ID.")
1863
+ }).describe("Resource that this annotation is attached to."),
1864
+ value: zAnnotationValueData,
1865
+ created_at: z.iso.datetime().describe("Timestamp when the annotation was created, in RFC 3339 format (UTC).").optional(),
1866
+ updated_at: z.iso.datetime().describe("Timestamp of the most recent update to the annotation, in RFC 3339 format (UTC).").optional()
1867
+ }).describe("Annotation data associated with the annotated object.") });
1868
+ const zAnnotationsMapResponse = z.strictObject({ annotations: z.record(z.string(), zAnnotationData).describe("Map of annotations keyed by resource identifier, where each value contains the annotation data for that resource.") });
1439
1869
  /**
1440
1870
  * Type of application integration
1441
1871
  */
@@ -1444,78 +1874,74 @@ const zApplicationType = z.enum([
1444
1874
  "github",
1445
1875
  "datadog",
1446
1876
  "opentelemetry"
1447
- ]);
1877
+ ]).describe("Type of application integration");
1448
1878
  /**
1449
1879
  * A map where key is a project ID and a value is a list of installed applications.
1450
1880
  *
1451
1881
  */
1452
- const zProjectsApplicationsMapResponse = z.strictObject({ applications: z.record(z.string(), z.array(zApplicationType)) });
1882
+ const zProjectsApplicationsMapResponse = z.strictObject({ applications: z.record(z.string(), z.array(zApplicationType)).describe("Map of project IDs to their installed applications.") }).describe("A map where key is a project ID and a value is a list of installed applications.");
1453
1883
  /**
1454
1884
  * A map where key is a project ID and a value is a list of installed integrations.
1455
1885
  *
1456
1886
  */
1457
- const zProjectsIntegrationsMapResponse = z.strictObject({ integrations: z.record(z.string(), z.array(zApplicationType)) });
1887
+ const zProjectsIntegrationsMapResponse = z.strictObject({ integrations: z.record(z.string(), z.array(zApplicationType)).describe("Map of project IDs to their associated integration details.") }).describe("A map where key is a project ID and a value is a list of installed integrations.");
1458
1888
  /**
1459
1889
  * To paginate the response, issue an initial request with `limit` value. Then, add the value returned in the response `.pagination.next` attribute into the request under the `cursor` query parameter to the subsequent request to retrieve next page in pagination. The contents on cursor `next` are opaque, clients are not expected to make any assumptions on the format of the data inside the cursor.
1460
1890
  */
1461
1891
  const zCursorPagination = z.strictObject({
1462
- next: z.string().optional(),
1463
- sort_by: z.string().optional(),
1464
- sort_order: z.string().optional()
1465
- });
1892
+ next: z.string().describe("Cursor for the next page of results.").optional(),
1893
+ sort_by: z.string().describe("Field by which the results were sorted, echoing the request's sort_by parameter.").optional(),
1894
+ sort_order: z.string().describe("Sort order active for this page.").optional()
1895
+ }).describe("To paginate the response, issue an initial request with `limit` value.");
1466
1896
  const zProjectMembers = z.strictObject({
1467
1897
  project_members: z.array(zProjectMember),
1468
1898
  pagination: zCursorPagination.optional()
1469
1899
  });
1470
1900
  const zCursorPaginationResponse = z.strictObject({ pagination: zCursorPagination.optional() });
1471
1901
  const zSnapshot = z.strictObject({
1472
- id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1473
- name: z.string(),
1474
- lsn: z.string().optional(),
1475
- timestamp: z.string().optional(),
1476
- source_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
1477
- created_at: z.string(),
1478
- expires_at: z.string().optional(),
1479
- manual: z.boolean().optional(),
1480
- full_size: z.int().optional(),
1481
- diff_size: z.int().optional()
1902
+ id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The snapshot ID."),
1903
+ name: z.string().describe("Human-readable label for the snapshot."),
1904
+ lsn: z.string().describe("WAL position (Log Sequence Number) at which the snapshot was captured, in Postgres LSN format (for example, `0/3000000`).").optional(),
1905
+ timestamp: z.string().describe("Point in time captured by the snapshot, in RFC 3339 format (UTC).").optional(),
1906
+ source_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Branch from which this snapshot was created.").optional(),
1907
+ created_at: z.string().describe("Timestamp when the snapshot was created, in RFC 3339 format (UTC)."),
1908
+ expires_at: z.string().describe("RFC 3339 timestamp when the snapshot expires and is eligible for deletion.").optional(),
1909
+ manual: z.boolean().describe("True if the snapshot was created manually rather than by a schedule.").optional(),
1910
+ full_size: z.int().describe("Full logical size of the snapshot in bytes at the time it was taken.").optional(),
1911
+ diff_size: z.int().describe("Incremental Postgres storage size in bytes since the previous scheduled snapshot, when the snapshot is billed on incremental (diff) usage.").optional()
1482
1912
  });
1483
1913
  const zSnapshotUpdateRequest = z.strictObject({ snapshot: z.strictObject({
1484
- name: z.string().optional(),
1914
+ name: z.string().describe("Human-readable label for the snapshot.").optional(),
1485
1915
  expires_at: z.iso.datetime().nullish()
1486
- }) });
1916
+ }).describe("Fields to update on the snapshot.") });
1487
1917
  const zBackupScheduleItem = z.strictObject({
1488
- frequency: z.string(),
1489
- hour: z.int().gte(0).lte(23).optional(),
1490
- day: z.int().gte(1).lte(31).optional(),
1491
- month: z.int().gte(1).lte(12).optional(),
1492
- retention_seconds: z.int().gte(3600).lte(3024e3).optional()
1918
+ frequency: z.string().describe("How often to take snapshots."),
1919
+ hour: z.int().gte(0).lte(23).describe("The hour of the day to take the snapshot (if applicable).").optional(),
1920
+ day: z.int().gte(1).lte(31).describe("The day of the week or month to take the snapshot (if applicable).").optional(),
1921
+ month: z.int().gte(1).lte(12).describe("The month of the year to take the snapshot (if applicable).").optional(),
1922
+ retention_seconds: z.int().gte(3600).lte(3024e3).describe("How long to keep a scheduled snapshot (in seconds) before it's automatically deleted.").optional()
1493
1923
  });
1494
- const zBackupSchedule = z.strictObject({ schedule: z.array(zBackupScheduleItem) });
1924
+ const zBackupSchedule = z.strictObject({ schedule: z.array(zBackupScheduleItem).describe("List of schedule entries defining the backup frequency.") });
1495
1925
  const zBranchSchemaJson = z.strictObject({ tables: z.array(z.strictObject({
1496
- schema: z.string(),
1497
- name: z.string(),
1926
+ schema: z.string().describe("Postgres schema (namespace) that contains the table, for example `public`."),
1927
+ name: z.string().describe("Name of the table within the schema."),
1498
1928
  columns: z.array(z.strictObject({
1499
- name: z.string(),
1500
- type: z.string(),
1501
- nullable: z.boolean().optional(),
1502
- generated: z.boolean().optional()
1503
- })),
1929
+ name: z.string().describe("Name of the column."),
1930
+ type: z.string().describe("Postgres data type of the column, for example \"integer\" or \"text\"."),
1931
+ nullable: z.boolean().describe("Whether the column allows NULL values").optional(),
1932
+ generated: z.boolean().describe("Whether the column is a generated (computed) column").optional()
1933
+ })).describe("Columns belonging to this table, each describing a column's name and attributes."),
1504
1934
  constraints: z.array(z.strictObject({
1505
- type: z.string(),
1506
- columns: z.array(z.string()).min(1),
1507
- name: z.string().optional(),
1935
+ type: z.string().describe("Type of constraint."),
1936
+ columns: z.array(z.string()).min(1).describe("Column names participating in this constraint"),
1937
+ name: z.string().describe("Optional name of the constraint").optional(),
1508
1938
  referenced_table: z.strictObject({
1509
- schema: z.string(),
1510
- table: z.string(),
1511
- columns: z.array(z.string())
1512
- }).optional()
1513
- })).optional()
1514
- })) });
1515
- const zBranchSchemaResponse = z.strictObject({
1516
- sql: z.string().optional(),
1517
- json: zBranchSchemaJson.optional()
1518
- });
1939
+ schema: z.string().describe("Schema of the referenced table"),
1940
+ table: z.string().describe("Name of the referenced table"),
1941
+ columns: z.array(z.string()).describe("Names of the referenced columns")
1942
+ }).describe("For foreign keys - the referenced table information").optional()
1943
+ })).describe("Table constraints defined in the branch schema, such as primary key, foreign key, unique, and check constraints.").optional()
1944
+ })).describe("Tables present in the branch schema.") });
1519
1945
  /**
1520
1946
  * Controls anonymous access to objects in the bucket.
1521
1947
  * - `private`: all reads and writes require authenticated requests (default).
@@ -1523,23 +1949,23 @@ const zBranchSchemaResponse = z.strictObject({
1523
1949
  * writes, and deletes still require authenticated requests.
1524
1950
  *
1525
1951
  */
1526
- const zBucketAccessLevel = z.enum(["private", "public_read"]);
1952
+ const zBucketAccessLevel = z.enum(["private", "public_read"]).describe("Controls anonymous access to objects in the bucket.");
1527
1953
  const zBucket = z.strictObject({
1528
- name: z.string(),
1954
+ name: z.string().describe("The bucket name (unique within a branch)."),
1529
1955
  access_level: zBucketAccessLevel,
1530
- created_at: z.iso.datetime()
1956
+ created_at: z.iso.datetime().describe("When the bucket was created.")
1531
1957
  });
1532
1958
  const zBucketCreateRequest = z.strictObject({
1533
- name: z.string().min(1).max(255),
1534
- access_level: z.enum(["private", "public_read"]).optional()
1959
+ name: z.string().min(1).max(255).describe("The bucket name."),
1960
+ access_level: z.enum(["private", "public_read"]).describe("Access level for the bucket.").optional()
1535
1961
  });
1536
1962
  const zBucketResponse = z.strictObject({ bucket: zBucket });
1537
1963
  const zBucketsListResponse = z.strictObject({ buckets: z.array(zBucket) });
1538
1964
  const zBranchStorage = z.strictObject({
1539
- enabled: z.boolean(),
1540
- s3_endpoint: z.url(),
1541
- region: z.string(),
1542
- force_path_style: z.boolean()
1965
+ enabled: z.boolean().describe("Always `true` in 200 responses."),
1966
+ s3_endpoint: z.url().describe("The S3-compatible endpoint URL for this branch."),
1967
+ region: z.string().describe("The AWS region for this branch's object storage."),
1968
+ force_path_style: z.boolean().describe("Whether the S3 client must use path-style addressing (bucket-in-path rather than virtual-hosted subdomain).")
1543
1969
  });
1544
1970
  const zBranchStorageNotEnabled = z.strictObject({
1545
1971
  code: z.string(),
@@ -1549,7 +1975,7 @@ const zBranchStorageNotEnabled = z.strictObject({
1549
1975
  "region_unavailable",
1550
1976
  "branch_directory_missing",
1551
1977
  "branch_not_found"
1552
- ])
1978
+ ]).describe("Machine-readable reason why object storage is unavailable: - `org_not_entitled`: the org's `PlatformBranchableStorage` feature flag is off.")
1553
1979
  });
1554
1980
  /**
1555
1981
  * The Neon service that emitted the log record.
@@ -1558,7 +1984,7 @@ const zProjectBranchLogSource = z.enum([
1558
1984
  "function",
1559
1985
  "storage",
1560
1986
  "pg_endpoint"
1561
- ]);
1987
+ ]).describe("The Neon service that emitted the log record.");
1562
1988
  /**
1563
1989
  * An OpenTelemetry severity level. A minimum severity includes every
1564
1990
  * higher level in this order: `trace`, `debug`, `info`, `warn`, `error`,
@@ -1572,17 +1998,17 @@ const zProjectBranchLogSeverity = z.enum([
1572
1998
  "warn",
1573
1999
  "error",
1574
2000
  "fatal"
1575
- ]);
2001
+ ]).describe("An OpenTelemetry severity level.");
1576
2002
  /**
1577
2003
  * A length of time as a count and a unit, for example `30m`, `6h`, or
1578
2004
  * `7d`. Valid units are `ms`, `s`, `m`, `h`, and `d`.
1579
2005
  *
1580
2006
  */
1581
- const zProjectBranchLogDuration = z.string().regex(/^[0-9]{1,6}(ms|s|m|h|d)$/);
2007
+ const zProjectBranchLogDuration = z.string().regex(/^[0-9]{1,6}(ms|s|m|h|d)$/).describe("A length of time as a count and a unit, for example `30m`, `6h`, or `7d`.");
1582
2008
  const zProjectBranchLogsNotAvailable = z.strictObject({
1583
2009
  code: z.string(),
1584
2010
  message: z.string(),
1585
- reason: z.enum(["branch_not_found", "telemetry_not_enabled"])
2011
+ reason: z.enum(["branch_not_found", "telemetry_not_enabled"]).describe("Machine-readable reason why logs cannot be read: - `branch_not_found`: the project or branch does not exist, or the caller does not have access to it.")
1586
2012
  });
1587
2013
  const zProjectBranchLogsInvalidQuery = z.strictObject({
1588
2014
  code: z.string(),
@@ -1595,85 +2021,85 @@ const zProjectBranchLogsInvalidQuery = z.strictObject({
1595
2021
  "unknown_field",
1596
2022
  "invalid_logql",
1597
2023
  "conflicting_filters"
1598
- ])
2024
+ ]).describe("Machine-readable reason why the request was rejected: - `time_range_too_large`: the requested window spans more than seven days.")
1599
2025
  });
1600
2026
  const zProjectBranchLogsQueryRequest = z.strictObject({
1601
2027
  since: zProjectBranchLogDuration.optional(),
1602
- start_time: z.iso.datetime().optional(),
1603
- end_time: z.iso.datetime().optional(),
1604
- limit: z.int().gte(1).lte(1e3).optional(),
1605
- cursor: z.string().optional(),
1606
- sort_order: z.enum(["asc", "desc"]).optional(),
2028
+ start_time: z.iso.datetime().describe("Inclusive beginning of the query window.").optional(),
2029
+ end_time: z.iso.datetime().describe("Exclusive end of the query window.").optional(),
2030
+ limit: z.int().gte(1).lte(1e3).describe("Maximum number of log records to return per page.").optional(),
2031
+ cursor: z.string().describe("Opaque pagination cursor returned as `next_cursor` by a previous call.").optional(),
2032
+ sort_order: z.enum(["asc", "desc"]).describe("Order matching records by timestamp.").optional(),
1607
2033
  source: zProjectBranchLogSource.optional(),
1608
- service_name: z.string().min(1).optional(),
1609
- scope_name: z.string().min(1).optional(),
2034
+ service_name: z.string().min(1).describe("Match the OpenTelemetry `service.name` resource attribute exactly.").optional(),
2035
+ scope_name: z.string().min(1).describe("Match the OpenTelemetry instrumentation scope name exactly.").optional(),
1610
2036
  minimum_severity: zProjectBranchLogSeverity.optional(),
1611
- severity_text: z.string().min(1).optional(),
1612
- body_contains: z.string().min(1).optional(),
1613
- trace_id: z.string().regex(/^[0-9a-f]{32}$/).optional(),
1614
- logql: z.string().min(1).optional()
2037
+ severity_text: z.string().min(1).describe("Match the OpenTelemetry severity text exactly.").optional(),
2038
+ body_contains: z.string().min(1).describe("Match records whose rendered `message` contains this case-sensitive substring.").optional(),
2039
+ trace_id: z.string().regex(/^[0-9a-f]{32}$/).describe("Match records associated with this OpenTelemetry trace ID.").optional(),
2040
+ logql: z.string().min(1).describe("Escape hatch for selections the structured filters cannot express: a raw LogQL expression, evaluated against this branch's log stream.").optional()
1615
2041
  });
1616
2042
  const zProjectBranchLogRecord = z.strictObject({
1617
- timestamp: z.iso.datetime(),
1618
- message: z.string(),
2043
+ timestamp: z.iso.datetime().describe("The OpenTelemetry record timestamp in UTC."),
2044
+ message: z.string().describe("The OpenTelemetry log body rendered as text."),
1619
2045
  source: zProjectBranchLogSource.optional(),
1620
- entity_id: z.string().optional(),
1621
- service_name: z.string().optional(),
1622
- scope_name: z.string().optional(),
1623
- severity_number: z.int().gte(0).lte(24).optional(),
1624
- severity_text: z.string().optional(),
1625
- trace_id: z.string().optional(),
1626
- span_id: z.string().optional(),
1627
- attributes: z.record(z.string(), z.unknown())
2046
+ entity_id: z.string().describe("The Neon identifier of the service instance that emitted the record.").optional(),
2047
+ service_name: z.string().describe("The OpenTelemetry `service.name` resource attribute.").optional(),
2048
+ scope_name: z.string().describe("The OpenTelemetry instrumentation scope name.").optional(),
2049
+ severity_number: z.int().gte(0).lte(24).describe("The numeric OpenTelemetry severity.").optional(),
2050
+ severity_text: z.string().describe("The original OpenTelemetry severity text.").optional(),
2051
+ trace_id: z.string().describe("The OpenTelemetry trace ID, when the record belongs to a trace.").optional(),
2052
+ span_id: z.string().describe("The OpenTelemetry span ID, when the record belongs to a span.").optional(),
2053
+ attributes: z.record(z.string(), z.unknown()).describe("Customer-defined OpenTelemetry log and resource attributes.")
1628
2054
  });
1629
2055
  const zProjectBranchLogsQueryResponse = z.strictObject({
1630
2056
  logs: z.array(zProjectBranchLogRecord),
1631
- next_cursor: z.string().optional(),
1632
- is_truncated: z.boolean()
2057
+ next_cursor: z.string().describe("Pagination cursor to pass as `cursor` on the next request.").optional(),
2058
+ is_truncated: z.boolean().describe("True when more records matched than were returned.")
1633
2059
  });
1634
- const zProjectBranchLogFieldsResponse = z.strictObject({ fields: z.array(z.string()) });
2060
+ const zProjectBranchLogFieldsResponse = z.strictObject({ fields: z.array(z.string()).describe("Log field names observed on this branch, each usable as `field_name` on the log field-values endpoint.") });
1635
2061
  const zProjectBranchLogFieldValuesResponse = z.strictObject({
1636
2062
  values: z.array(z.string()),
1637
- is_truncated: z.boolean()
2063
+ is_truncated: z.boolean().describe("True when more distinct values exist than were returned, because either the requested `limit` or the server's own scan cap was reached.")
1638
2064
  });
1639
2065
  const zBranchAiGateway = z.strictObject({
1640
- enabled: z.boolean(),
1641
- base_url: z.url()
2066
+ enabled: z.boolean().describe("Always `true` in 200 responses."),
2067
+ base_url: z.url().describe("The AI-gateway endpoint root for this branch — an OpenAI-compatible base URL.")
1642
2068
  });
1643
2069
  const zBranchAiGatewayNotEnabled = z.strictObject({
1644
2070
  code: z.string(),
1645
2071
  message: z.string(),
1646
- reason: z.enum(["ai_gateway_unavailable", "branch_not_found"])
2072
+ reason: z.enum(["ai_gateway_unavailable", "branch_not_found"]).describe("Machine-readable reason why the AI gateway is unavailable: - `ai_gateway_unavailable`: the project's region/cell has no AI gateway configured.")
1647
2073
  });
1648
2074
  const zBucketObject = z.strictObject({
1649
- key: z.string(),
1650
- size: z.int(),
1651
- last_modified: z.iso.datetime(),
1652
- etag: z.string()
2075
+ key: z.string().describe("The full object key."),
2076
+ size: z.int().describe("The object size in bytes."),
2077
+ last_modified: z.iso.datetime().describe("The time the object was last modified."),
2078
+ etag: z.string().describe("The object's entity tag (content hash).")
1653
2079
  });
1654
2080
  const zBucketObjectsListResponse = z.strictObject({
1655
- folders: z.array(z.string()),
1656
- objects: z.array(zBucketObject),
1657
- prefix: z.string(),
1658
- next_cursor: z.string().optional(),
1659
- is_truncated: z.boolean()
2081
+ folders: z.array(z.string()).describe("Common prefixes (folder names) collapsed under the requested `delimiter`."),
2082
+ objects: z.array(zBucketObject).describe("Objects whose keys did not collapse into a folder."),
2083
+ prefix: z.string().describe("The prefix that was applied to this listing (echoed back)."),
2084
+ next_cursor: z.string().describe("Pagination cursor to pass as `cursor` on the next request.").optional(),
2085
+ is_truncated: z.boolean().describe("True when more results exist beyond this page.")
1660
2086
  });
1661
- const zBucketObjectsDeletePrefixResponse = z.strictObject({ deleted: z.int() });
2087
+ const zBucketObjectsDeletePrefixResponse = z.strictObject({ deleted: z.int().describe("The number of objects soft-deleted under the prefix.") });
1662
2088
  /**
1663
2089
  * Options for the presigned URL. The `operation` selects upload (`PUT`)
1664
2090
  * or download (`GET`); the remaining fields are optional.
1665
2091
  *
1666
2092
  */
1667
2093
  const zPresignRequest = z.strictObject({
1668
- operation: z.enum(["upload", "download"]),
1669
- content_type: z.string().optional(),
1670
- expires_in_seconds: z.int().gte(1).lte(604800).optional()
1671
- });
2094
+ operation: z.enum(["upload", "download"]).describe("The transfer direction."),
2095
+ content_type: z.string().describe("The `Content-Type` to bind into the signed request.").optional(),
2096
+ expires_in_seconds: z.int().gte(1).lte(604800).describe("How long the presigned URL stays valid, in seconds.").optional()
2097
+ }).describe("Options for the presigned URL.");
1672
2098
  const zPresignResponse = z.strictObject({
1673
- url: z.string(),
1674
- method: z.string(),
1675
- headers: z.record(z.string(), z.string()),
1676
- expires_at: z.iso.datetime()
2099
+ url: z.string().describe("The presigned URL."),
2100
+ method: z.string().describe("The HTTP method to use against `url`: `PUT` for an upload, `GET` for a download."),
2101
+ headers: z.record(z.string(), z.string()).describe("Headers the caller MUST send verbatim on the request (e.g. `Content-Type` when it was signed on an upload)."),
2102
+ expires_at: z.iso.datetime().describe("When the presigned URL stops being valid.")
1677
2103
  });
1678
2104
  /**
1679
2105
  * A single capability you may request when issuing a credential. A
@@ -1691,7 +2117,7 @@ const zCredentialScope = z.enum([
1691
2117
  "storage:write",
1692
2118
  "ai_gateway:invoke",
1693
2119
  "functions:invoke"
1694
- ]);
2120
+ ]).describe("A single capability you may request when issuing a credential.");
1695
2121
  /**
1696
2122
  * A single capability a credential actually carries, as reported by
1697
2123
  * responses that describe an existing credential.
@@ -1712,22 +2138,22 @@ const zGrantedCredentialScope = z.enum([
1712
2138
  "ai_gateway:invoke",
1713
2139
  "telemetry:write",
1714
2140
  "functions:invoke"
1715
- ]);
2141
+ ]).describe("A single capability a credential actually carries, as reported by responses that describe an existing credential.");
1716
2142
  const zCreateCredentialRequest = z.strictObject({
1717
- name: z.string().max(256).optional(),
2143
+ name: z.string().max(256).describe("Free-form customer label for the credential.").optional(),
1718
2144
  scopes: z.array(zCredentialScope).min(1).max(16),
1719
- principal_type: z.enum(["user"])
2145
+ principal_type: z.enum(["user"]).describe("Principal type for the credential.")
1720
2146
  });
1721
2147
  const zCreateCredentialResponse = z.strictObject({
1722
- token_id: z.string(),
1723
- token_id_short: z.string(),
1724
- name: z.string().optional(),
1725
- api_token: z.string(),
1726
- s3_secret_access_key: z.string(),
2148
+ token_id: z.string().describe("Opaque credential id (e.g. nak_live_<32hex>)."),
2149
+ token_id_short: z.string().describe("First 12 hex chars of token_id; safe to log."),
2150
+ name: z.string().describe("Customer-supplied label, echoed back from the request.").optional(),
2151
+ api_token: z.string().describe("Bearer token; returned exactly once."),
2152
+ s3_secret_access_key: z.string().describe("nsk_live_<64 hex>; the AWS_SECRET_ACCESS_KEY, returned exactly once."),
1727
2153
  scopes: z.array(zGrantedCredentialScope),
1728
2154
  branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1729
2155
  created_at: z.iso.datetime(),
1730
- expires_at: z.iso.datetime().optional()
2156
+ expires_at: z.iso.datetime().describe("When the credential expires; absent means never expires.").optional()
1731
2157
  });
1732
2158
  /**
1733
2159
  * The live secrets of an existing credential, recovered on demand by the
@@ -1748,10 +2174,10 @@ const zCreateCredentialResponse = z.strictObject({
1748
2174
  *
1749
2175
  */
1750
2176
  const zCredentialSecret = z.strictObject({
1751
- token_id: z.string(),
1752
- api_token: z.string(),
1753
- s3_secret_access_key: z.string()
1754
- });
2177
+ token_id: z.string().describe("Opaque credential id (e.g. nak_live_<32hex>)."),
2178
+ api_token: z.string().describe("Bearer token."),
2179
+ s3_secret_access_key: z.string().describe("nsk_live_<64 hex>; the AWS_SECRET_ACCESS_KEY.")
2180
+ }).describe("The live secrets of an existing credential, recovered on demand by the reveal endpoint.");
1755
2181
  /**
1756
2182
  * The replacement secret material for an existing credential, returned
1757
2183
  * exactly once. `token_id`, `scopes`, `branch_id` and `created_at` are
@@ -1760,21 +2186,21 @@ const zCredentialSecret = z.strictObject({
1760
2186
  *
1761
2187
  */
1762
2188
  const zRotateCredentialResponse = z.strictObject({
1763
- token_id: z.string(),
1764
- token_id_short: z.string(),
1765
- name: z.string().optional(),
1766
- api_token: z.string(),
1767
- s3_secret_access_key: z.string(),
2189
+ token_id: z.string().describe("Opaque credential id (e.g. nak_live_<32hex>), unchanged by the rotation."),
2190
+ token_id_short: z.string().describe("First 12 hex chars of token_id; safe to log."),
2191
+ name: z.string().describe("Customer-supplied label carried on the credential.").optional(),
2192
+ api_token: z.string().describe("The new Bearer token; returned exactly once."),
2193
+ s3_secret_access_key: z.string().describe("The new nsk_live_<64 hex> AWS_SECRET_ACCESS_KEY; returned exactly once."),
1768
2194
  scopes: z.array(zGrantedCredentialScope),
1769
2195
  branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1770
- principal_type: z.enum(["user"]),
1771
- created_at: z.iso.datetime(),
1772
- expires_at: z.iso.datetime().optional()
1773
- });
2196
+ principal_type: z.enum(["user"]).describe("Always `user`: only customer-managed credentials are rotatable through this endpoint."),
2197
+ created_at: z.iso.datetime().describe("When the credential was originally issued."),
2198
+ expires_at: z.iso.datetime().describe("When the credential expires; absent means never expires.").optional()
2199
+ }).describe("The replacement secret material for an existing credential, returned exactly once.");
1774
2200
  const zCredentialMeta = z.strictObject({
1775
- token_id: z.string(),
2201
+ token_id: z.string().describe("Opaque credential id (e.g. nak_live_<32hex>)."),
1776
2202
  token_id_short: z.string(),
1777
- name: z.string().optional(),
2203
+ name: z.string().describe("Customer-supplied label; absent when not provided at issuance.").optional(),
1778
2204
  scopes: z.array(zGrantedCredentialScope),
1779
2205
  branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
1780
2206
  principal_type: z.string(),
@@ -1782,28 +2208,28 @@ const zCredentialMeta = z.strictObject({
1782
2208
  created_at: z.iso.datetime(),
1783
2209
  last_used_at: z.iso.datetime().optional(),
1784
2210
  revoked_at: z.iso.datetime().optional(),
1785
- expires_at: z.iso.datetime().optional()
2211
+ expires_at: z.iso.datetime().describe("When the credential expires; absent means never expires.").optional()
1786
2212
  });
1787
2213
  const zListCredentialsResponse = z.strictObject({ credentials: z.array(zCredentialMeta) });
1788
2214
  const zNeonFunctionDeployment = z.strictObject({
1789
- id: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
2215
+ id: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).describe("The deployment id, which is the platform version number (monotonic per function)."),
1790
2216
  status: z.enum([
1791
2217
  "pending",
1792
2218
  "building",
1793
2219
  "completed",
1794
2220
  "failed"
1795
- ]),
2221
+ ]).describe("Build lifecycle status of the deployment."),
1796
2222
  memory_mib: z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
1797
2223
  runtime: z.string(),
1798
2224
  created_at: z.string(),
1799
- environment: z.array(z.string()).optional(),
1800
- error: z.string().optional()
2225
+ environment: z.array(z.string()).describe("The NAMES of the deployment's environment variables, sorted.").optional(),
2226
+ error: z.string().describe("Human-readable reason the deployment build failed.").optional()
1801
2227
  });
1802
2228
  const zNeonFunction = z.strictObject({
1803
- id: z.string(),
1804
- slug: z.string(),
1805
- name: z.string(),
1806
- invocation_url: z.string(),
2229
+ id: z.string().describe("Opaque, stable function identifier."),
2230
+ slug: z.string().describe("Branch-unique, lowercase DNS-label."),
2231
+ name: z.string().describe("Free-form display name."),
2232
+ invocation_url: z.string().describe("URL at which the function is invoked."),
1807
2233
  current_deployment: zNeonFunctionDeployment.optional(),
1808
2234
  active_deployment: zNeonFunctionDeployment.optional(),
1809
2235
  created_at: z.string()
@@ -1813,11 +2239,11 @@ const zNeonFunctionsListResponse = z.strictObject({ functions: z.array(zNeonFunc
1813
2239
  /**
1814
2240
  * Opaque, server-minted project-wide trigger identifier.
1815
2241
  */
1816
- const zTriggerId = z.string().min(1).max(128).regex(/^[A-Za-z0-9][A-Za-z0-9_.\-]{0,127}$/);
2242
+ const zTriggerId = z.string().min(1).max(128).regex(/^[A-Za-z0-9][A-Za-z0-9_.\-]{0,127}$/).describe("Opaque, server-minted project-wide trigger identifier.");
1817
2243
  /**
1818
2244
  * A numeric five-field cron schedule interpreted in UTC.
1819
2245
  */
1820
- const zFunctionTriggerSchedule = z.strictObject({ cron: z.string().min(1).max(1024) });
2246
+ const zFunctionTriggerSchedule = z.strictObject({ cron: z.string().min(1).max(1024).describe("Numeric five-field cron expression (minute through day-of-week), interpreted in UTC.") }).describe("A numeric five-field cron schedule interpreted in UTC.");
1821
2247
  /**
1822
2248
  * Matches successful uploads to one exact bucket and, when configured, an
1823
2249
  * object-key prefix. The Function receives a JSON request body with
@@ -1826,24 +2252,24 @@ const zFunctionTriggerSchedule = z.strictObject({ cron: z.string().min(1).max(10
1826
2252
  *
1827
2253
  */
1828
2254
  const zFunctionTriggerStorageObjectCreated = z.strictObject({
1829
- bucket_name: z.string().min(3).max(63),
1830
- prefix: z.string().min(1).max(1024).regex(/^[^\x00-\x1f\x7f-\x9f]+$/).optional()
1831
- });
2255
+ bucket_name: z.string().min(3).max(63).describe("The exact object-storage bucket name to watch."),
2256
+ prefix: z.string().min(1).max(1024).regex(/^[^\x00-\x1f\x7f-\x9f]+$/).describe("Optional object-key prefix of at most 1024 UTF-8 bytes.").optional()
2257
+ }).describe("Matches successful uploads to one exact bucket and, when configured, an object-key prefix.");
1832
2258
  const zScheduleTriggerCreateRequest = z.strictObject({
1833
- type: z.enum(["schedule"]),
1834
- function_slug: z.string().regex(/^[a-z0-9]{1,20}$/),
1835
- name: z.string().min(1).max(256),
1836
- function_path: z.string().min(1).max(2048).optional(),
2259
+ type: z.enum(["schedule"]).describe("Trigger type discriminator."),
2260
+ function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The branch-local Function slug to invoke."),
2261
+ name: z.string().min(1).max(256).describe("Human-readable name, unique among triggers visible on the branch."),
2262
+ function_path: z.string().min(1).max(2048).describe("Path passed to the target Function.").optional(),
1837
2263
  schedule: zFunctionTriggerSchedule,
1838
- enabled: z.boolean().optional()
2264
+ enabled: z.boolean().describe("Whether future occurrences should be scheduled.").optional()
1839
2265
  });
1840
2266
  const zStorageObjectCreatedTriggerCreateRequest = z.strictObject({
1841
- type: z.enum(["storage_object_created"]),
1842
- function_slug: z.string().regex(/^[a-z0-9]{1,20}$/),
1843
- name: z.string().min(1).max(256),
1844
- function_path: z.string().min(1).max(2048).optional(),
2267
+ type: z.enum(["storage_object_created"]).describe("Trigger type discriminator."),
2268
+ function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The branch-local Function slug to invoke."),
2269
+ name: z.string().min(1).max(256).describe("Human-readable name, unique among triggers visible on the branch."),
2270
+ function_path: z.string().min(1).max(2048).describe("Path passed to the target Function.").optional(),
1845
2271
  storage_object_created: zFunctionTriggerStorageObjectCreated,
1846
- enabled: z.boolean().optional()
2272
+ enabled: z.boolean().describe("Whether successful matching uploads should invoke the Function.").optional()
1847
2273
  });
1848
2274
  /**
1849
2275
  * Trigger creation payload discriminated by `type`. The supported trigger
@@ -1852,20 +2278,20 @@ const zStorageObjectCreatedTriggerCreateRequest = z.strictObject({
1852
2278
  */
1853
2279
  const zTriggerCreateRequest = z.discriminatedUnion("type", [zScheduleTriggerCreateRequest.extend({ type: z.literal("schedule") }), zStorageObjectCreatedTriggerCreateRequest.extend({ type: z.literal("storage_object_created") })]);
1854
2280
  const zScheduleTriggerUpdateRequest = z.strictObject({
1855
- type: z.enum(["schedule"]),
1856
- function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).optional(),
2281
+ type: z.enum(["schedule"]).describe("Trigger type discriminator; it does not change the trigger type."),
2282
+ function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("Replacement branch-local Function slug.").optional(),
1857
2283
  name: z.string().min(1).max(256).optional(),
1858
2284
  function_path: z.string().min(1).max(2048).optional(),
1859
2285
  schedule: zFunctionTriggerSchedule.optional(),
1860
- enabled: z.boolean().optional()
2286
+ enabled: z.boolean().describe("True enables and false disables future scheduling.").optional()
1861
2287
  });
1862
2288
  const zStorageObjectCreatedTriggerUpdateRequest = z.strictObject({
1863
- type: z.enum(["storage_object_created"]),
1864
- function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).optional(),
2289
+ type: z.enum(["storage_object_created"]).describe("Trigger type discriminator; it does not change the trigger type."),
2290
+ function_slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("Replacement branch-local Function slug.").optional(),
1865
2291
  name: z.string().min(1).max(256).optional(),
1866
2292
  function_path: z.string().min(1).max(2048).optional(),
1867
2293
  storage_object_created: zFunctionTriggerStorageObjectCreated.optional(),
1868
- enabled: z.boolean().optional()
2294
+ enabled: z.boolean().describe("True enables and false disables future matching uploads.").optional()
1869
2295
  });
1870
2296
  /**
1871
2297
  * Partial trigger update discriminated by `type`. The supported trigger
@@ -1877,33 +2303,33 @@ const zTriggerUpdateRequest = z.discriminatedUnion("type", [zScheduleTriggerUpda
1877
2303
  * A branch-effective schedule trigger for a Function.
1878
2304
  */
1879
2305
  const zScheduleTrigger = z.strictObject({
1880
- type: z.enum(["schedule"]),
2306
+ type: z.enum(["schedule"]).describe("Trigger type discriminator."),
1881
2307
  trigger_id: zTriggerId,
1882
- function_slug: z.string(),
1883
- name: z.string(),
1884
- function_path: z.string(),
2308
+ function_slug: z.string().describe("The branch-local Function slug resolved when an occurrence is consumed."),
2309
+ name: z.string().describe("Human-readable trigger name."),
2310
+ function_path: z.string().describe("Path passed to the target Function."),
1885
2311
  schedule: zFunctionTriggerSchedule,
1886
2312
  enabled: z.boolean(),
1887
- version: z.int().gte(1),
2313
+ version: z.int().gte(1).describe("Monotonic configuration version."),
1888
2314
  next_run_at: z.string().nullable(),
1889
- inherited: z.boolean()
1890
- });
2315
+ inherited: z.boolean().describe("True when the effective configuration was authored on an ancestor branch.")
2316
+ }).describe("A branch-effective schedule trigger for a Function.");
1891
2317
  /**
1892
2318
  * A branch-effective trigger that invokes a Function after a successful
1893
2319
  * upload matching its exact bucket and optional object-key prefix.
1894
2320
  *
1895
2321
  */
1896
2322
  const zStorageObjectCreatedTrigger = z.strictObject({
1897
- type: z.enum(["storage_object_created"]),
2323
+ type: z.enum(["storage_object_created"]).describe("Trigger type discriminator."),
1898
2324
  trigger_id: zTriggerId,
1899
- function_slug: z.string(),
1900
- name: z.string(),
1901
- function_path: z.string(),
2325
+ function_slug: z.string().describe("The branch-local Function slug resolved when an invocation is consumed."),
2326
+ name: z.string().describe("Human-readable trigger name."),
2327
+ function_path: z.string().describe("Path passed to the target Function."),
1902
2328
  storage_object_created: zFunctionTriggerStorageObjectCreated,
1903
2329
  enabled: z.boolean(),
1904
- version: z.int().gte(1),
1905
- inherited: z.boolean()
1906
- });
2330
+ version: z.int().gte(1).describe("Monotonic configuration version."),
2331
+ inherited: z.boolean().describe("True when the effective configuration was authored on an ancestor branch.")
2332
+ }).describe("A branch-effective trigger that invokes a Function after a successful upload matching its exact bucket and optional object-key prefix.");
1907
2333
  /**
1908
2334
  * A branch-effective trigger discriminated by `type`. The supported trigger
1909
2335
  * types are `schedule` and `storage_object_created`.
@@ -1913,40 +2339,40 @@ const zTrigger = z.discriminatedUnion("type", [zScheduleTrigger.extend({ type: z
1913
2339
  const zTriggerResponse = z.strictObject({ trigger: zTrigger });
1914
2340
  const zTriggersListResponse = z.strictObject({ triggers: z.array(zTrigger) });
1915
2341
  const zCustomDomain = z.strictObject({
1916
- domain: z.string(),
1917
- entity_type: z.string(),
1918
- entity_id: z.string(),
1919
- cname_target: z.string(),
1920
- status: z.string().optional(),
1921
- dns_status: z.string().optional(),
1922
- binding_status: z.string().optional(),
1923
- status_reason: z.string().optional()
2342
+ domain: z.string().describe("The registered custom domain (normalized, lowercase)."),
2343
+ entity_type: z.string().describe("The kind of branch entity the domain targets."),
2344
+ entity_id: z.string().describe("The target entity's identifier within the branch."),
2345
+ cname_target: z.string().describe("The hostname the customer must point their custom domain at with a CNAME record."),
2346
+ status: z.string().describe("The domain's current validity, computed by a background check: `pending` (still converging — point your CNAME at `cname_target` and wait), `active` (live: DNS resolves to the edge, the CA is authorized, and routing is published), or `error` (a fixable problem — see `status_reason`).").optional(),
2347
+ dns_status: z.string().describe("The DNS + CAA portion of the check: `pending` (no records yet), `ok` (resolves to our edge and the CA is authorized), `misconfigured` (your CNAME does not resolve to our edge), or `caa_blocked` (your CAA records forbid Let's Encrypt).").optional(),
2348
+ binding_status: z.string().describe("Whether Neon's internal routing for the domain is published: `pending`, `present`, or `missing`.").optional(),
2349
+ status_reason: z.string().describe("A short, stable machine-readable reason for a non-active `status` (e.g. `cname-not-pointing-at-edge`, `caa-blocks-lets-encrypt`, `binding-missing`), suitable for keying an actionable hint.").optional()
1924
2350
  });
1925
2351
  const zCustomDomainRegisterRequest = z.strictObject({
1926
- domain: z.string().min(3).max(254),
1927
- entity_type: z.string().min(1).max(32),
1928
- entity_id: z.string().min(1).max(255)
2352
+ domain: z.string().min(3).max(254).describe("The custom domain to register (for example `dashboard.acme.com`)."),
2353
+ entity_type: z.string().min(1).max(32).describe("The kind of branch entity to point the domain at."),
2354
+ entity_id: z.string().min(1).max(255).describe("The target entity's identifier within the branch.")
1929
2355
  });
1930
2356
  const zCustomDomainsListResponse = z.strictObject({ custom_domains: z.array(zCustomDomain) });
1931
2357
  const zNeonFunctionUpdateRequest = z.strictObject({ name: z.string().min(1).max(256).nullable() });
1932
2358
  const zNeonFunctionDeploymentResponse = z.strictObject({ deployment: zNeonFunctionDeployment });
1933
2359
  const zFunctionDeployRequest = z.strictObject({
1934
- zip: z.string().optional(),
2360
+ zip: z.string().describe("Optional ZIP archive of the function source code.").optional(),
1935
2361
  runtime: z.enum(["nodejs24"]).optional(),
1936
- environment: z.string().optional()
2362
+ environment: z.string().describe("Optional JSON object (a string-to-string map) of environment variables for the deployment, e.g. {\"KEY\":\"VALUE\"}.").optional()
1937
2363
  });
1938
2364
  /**
1939
2365
  * A cursor to use in pagination. A cursor defines your place in the data list. Include `response.pagination.next` in subsequent API calls to fetch next page of the list.
1940
2366
  */
1941
- const zCursorParam = z.string();
2367
+ const zCursorParam = z.string().describe("A cursor to use in pagination.");
1942
2368
  /**
1943
2369
  * The maximum number of records to be returned in the response
1944
2370
  */
1945
- const zLimitParam = z.int().gte(1).lte(1e4);
2371
+ const zLimitParam = z.int().gte(1).lte(1e4).describe("The maximum number of records to be returned in the response");
1946
2372
  /**
1947
2373
  * Defines the sorting order of entities.
1948
2374
  */
1949
- const zSortOrderParam = z.enum(["asc", "desc"]);
2375
+ const zSortOrderParam = z.enum(["asc", "desc"]).describe("Defines the sorting order of entities.");
1950
2376
  /**
1951
2377
  * Specify an explicit timeout in milliseconds to limit response delay.
1952
2378
  * After timing out, the incomplete list of project data fetched so far will be returned.
@@ -1954,57 +2380,57 @@ const zSortOrderParam = z.enum(["asc", "desc"]);
1954
2380
  * If not specified, an implicit implementation defined timeout is chosen with the same behaviour as above
1955
2381
  *
1956
2382
  */
1957
- const zTimeoutParam = z.int().gte(100).lte(3e4);
1958
- const zGetProjectAdvisorSecurityIssuesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2383
+ const zTimeoutParam = z.int().gte(100).lte(3e4).describe("Specify an explicit timeout in milliseconds to limit response delay.");
2384
+ const zGetProjectAdvisorSecurityIssuesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Neon project ID") });
1959
2385
  const zGetProjectAdvisorSecurityIssuesQuery = z.strictObject({
1960
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
1961
- database_name: z.string().optional(),
1962
- category: zAdvisorCategory.optional(),
2386
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Branch ID to analyze.").optional(),
2387
+ database_name: z.string().describe("Database name to analyze.").optional(),
2388
+ category: z.enum(["SECURITY", "PERFORMANCE"]).describe("Filter issues by category").optional(),
1963
2389
  min_severity: z.enum([
1964
2390
  "INFO",
1965
2391
  "WARN",
1966
2392
  "ERROR"
1967
- ]).optional()
2393
+ ]).describe("Minimum severity level to include.").optional()
1968
2394
  });
1969
2395
  const zCreateApiKeyBody = zApiKeyCreateRequest;
1970
- const zRevokeApiKeyPath = z.strictObject({ key_id: z.int() });
2396
+ const zRevokeApiKeyPath = z.strictObject({ key_id: z.int().describe("The API key ID") });
1971
2397
  const zGetProjectOperationPath = z.strictObject({
1972
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
1973
- operation_id: z.uuid()
2398
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2399
+ operation_id: z.uuid().describe("The operation ID")
1974
2400
  });
1975
2401
  const zListProjectsQuery = z.strictObject({
1976
- cursor: z.string().optional(),
1977
- limit: z.int().gte(1).lte(400).optional(),
1978
- search: z.string().optional(),
1979
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
1980
- timeout: z.int().gte(100).lte(3e4).optional(),
1981
- recoverable: z.boolean().optional()
2402
+ cursor: z.string().describe("Specify the cursor value from the previous response to retrieve the next batch of projects.").optional(),
2403
+ limit: z.int().gte(1).lte(400).describe("Specify a value from 1 to 400 to limit number of projects in the response.").optional(),
2404
+ search: z.string().describe("Search by project `name` or `id`.").optional(),
2405
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Search for projects by `org_id`.").optional(),
2406
+ timeout: z.int().gte(100).lte(3e4).describe("Specify an explicit timeout in milliseconds to limit response delay.").optional(),
2407
+ recoverable: z.boolean().describe("Show only deleted projects within the recovery window.").optional()
1982
2408
  });
1983
2409
  const zCreateProjectBody = zProjectCreateRequest;
1984
- const zCountProjectsQuery = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() });
2410
+ const zCountProjectsQuery = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Count projects in the organization with this `org_id`.").optional() });
1985
2411
  const zListSharedProjectsQuery = z.strictObject({
1986
- cursor: z.string().optional(),
1987
- limit: z.int().gte(1).lte(400).optional(),
1988
- search: z.string().optional(),
1989
- timeout: z.int().gte(100).lte(3e4).optional()
2412
+ cursor: z.string().describe("Specify the cursor value from the previous response to get the next batch of projects.").optional(),
2413
+ limit: z.int().gte(1).lte(400).describe("Specify a value from 1 to 400 to limit number of projects in the response.").optional(),
2414
+ search: z.string().describe("Search query by name or id.").optional(),
2415
+ timeout: z.int().gte(100).lte(3e4).describe("Specify an explicit timeout in milliseconds to limit response delay.").optional()
1990
2416
  });
1991
- const zDeleteProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
1992
- const zGetProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2417
+ const zDeleteProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2418
+ const zGetProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
1993
2419
  const zUpdateProjectBody = zProjectUpdateRequest;
1994
- const zUpdateProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
1995
- const zRecoverProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
1996
- const zListProjectOperationsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2420
+ const zUpdateProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2421
+ const zRecoverProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2422
+ const zListProjectOperationsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
1997
2423
  const zListProjectOperationsQuery = z.strictObject({
1998
- cursor: z.string().optional(),
1999
- limit: z.int().gte(1).lte(1e3).optional()
2424
+ cursor: z.string().describe("Specify the cursor value from the previous response to get the next batch of operations").optional(),
2425
+ limit: z.int().gte(1).lte(1e3).describe("Specify a value from 1 to 1000 to limit number of operations in the response").optional()
2000
2426
  });
2001
2427
  const zListProjectPermissionsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2002
2428
  const zGrantPermissionToProjectBody = zGrantPermissionToProjectRequest;
2003
2429
  const zGrantPermissionToProjectPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2004
2430
  const zListProjectMembersPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2005
2431
  const zListProjectMembersQuery = z.strictObject({
2006
- cursor: z.string().optional(),
2007
- limit: z.int().gte(1).lte(500).optional()
2432
+ cursor: z.string().describe("A cursor to use in pagination.").optional(),
2433
+ limit: z.int().gte(1).lte(500).describe("The maximum number of members to return in the response").optional()
2008
2434
  });
2009
2435
  const zRemoveProjectMemberRolePath = z.strictObject({
2010
2436
  project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
@@ -2022,772 +2448,816 @@ const zRevokePermissionFromProjectPath = z.strictObject({
2022
2448
  permission_id: z.string()
2023
2449
  });
2024
2450
  const zGetAvailablePreloadLibrariesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2025
- const zCreateProjectTransferRequestBody = z.strictObject({ ttl_seconds: z.int().optional() });
2026
- const zCreateProjectTransferRequestPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2027
- const zAcceptProjectTransferRequestBody = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() });
2451
+ const zCreateProjectTransferRequestBody = z.strictObject({ ttl_seconds: z.int().describe("Number of seconds the transfer request stays valid before it expires.").optional() });
2452
+ const zCreateProjectTransferRequestPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2453
+ const zAcceptProjectTransferRequestBody = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID to transfer the project to.").optional() });
2028
2454
  const zAcceptProjectTransferRequestPath = z.strictObject({
2029
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2030
- request_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2455
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2456
+ request_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project transfer request ID")
2031
2457
  });
2032
- const zGetProjectJwksPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2458
+ const zGetProjectJwksPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2033
2459
  const zAddProjectJwksBody = zAddProjectJwksRequest;
2034
- const zAddProjectJwksPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2460
+ const zAddProjectJwksPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2035
2461
  const zDeleteProjectJwksPath = z.strictObject({
2036
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2037
- jwks_id: z.string()
2462
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2463
+ jwks_id: z.string().describe("The JWKS ID")
2038
2464
  });
2039
2465
  const zDeleteProjectBranchDataApiPath = z.strictObject({
2040
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2041
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2042
- database_name: z.string()
2466
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2467
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2468
+ database_name: z.string().describe("The database name")
2043
2469
  });
2044
2470
  const zGetProjectBranchDataApiPath = z.strictObject({
2045
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2046
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2047
- database_name: z.string()
2471
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2472
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2473
+ database_name: z.string().describe("The database name")
2048
2474
  });
2049
2475
  const zUpdateProjectBranchDataApiBody = zDataApiUpdateRequest;
2050
2476
  const zUpdateProjectBranchDataApiPath = z.strictObject({
2051
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2052
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2053
- database_name: z.string()
2477
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2478
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2479
+ database_name: z.string().describe("The database name")
2054
2480
  });
2055
2481
  const zCreateProjectBranchDataApiBody = zDataApiCreateRequest;
2056
2482
  const zCreateProjectBranchDataApiPath = z.strictObject({
2057
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2058
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2059
- database_name: z.string()
2483
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2484
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2485
+ database_name: z.string().describe("The database name")
2060
2486
  });
2061
2487
  const zCreateNeonAuthIntegrationBody = zNeonAuthCreateIntegrationRequest;
2062
- const zDisableNeonAuthBody = z.strictObject({ delete_data: z.boolean().optional() });
2488
+ const zDisableNeonAuthBody = z.strictObject({ delete_data: z.boolean().describe("If true, deletes the `neon_auth` schema from the database").optional() });
2063
2489
  const zDisableNeonAuthPath = z.strictObject({
2064
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2065
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2490
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2491
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2066
2492
  });
2067
2493
  const zGetNeonAuthPath = z.strictObject({
2068
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2069
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2494
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2495
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2070
2496
  });
2071
2497
  const zCreateNeonAuthBody = zEnableNeonAuthIntegrationRequest;
2072
2498
  const zCreateNeonAuthPath = z.strictObject({
2073
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2074
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2499
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2500
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2075
2501
  });
2076
2502
  const zDeleteNeonAuthDomainFromRedirectUriWhitelistBody = zNeonAuthDeleteDomainFromRedirectUriWhitelistRequest;
2077
- const zDeleteNeonAuthDomainFromRedirectUriWhitelistPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2078
- const zListNeonAuthRedirectUriWhitelistDomainsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2503
+ const zDeleteNeonAuthDomainFromRedirectUriWhitelistPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2504
+ const zListNeonAuthRedirectUriWhitelistDomainsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2079
2505
  const zAddNeonAuthDomainToRedirectUriWhitelistBody = zNeonAuthAddDomainToRedirectUriWhitelistRequest;
2080
- const zAddNeonAuthDomainToRedirectUriWhitelistPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2506
+ const zAddNeonAuthDomainToRedirectUriWhitelistPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2081
2507
  const zDeleteBranchNeonAuthTrustedDomainBody = zNeonAuthDeleteDomainFromRedirectUriWhitelistRequest;
2082
2508
  const zDeleteBranchNeonAuthTrustedDomainPath = z.strictObject({
2083
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2084
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2509
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2510
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2085
2511
  });
2086
2512
  const zListBranchNeonAuthTrustedDomainsPath = z.strictObject({
2087
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2088
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2513
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2514
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2089
2515
  });
2090
2516
  const zAddBranchNeonAuthTrustedDomainBody = zNeonAuthAddDomainToRedirectUriWhitelistRequest;
2091
2517
  const zAddBranchNeonAuthTrustedDomainPath = z.strictObject({
2092
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2093
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2518
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2519
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2094
2520
  });
2095
2521
  const zCreateNeonAuthProviderSdkKeysBody = zNeonAuthCreateAuthProviderSdkKeysRequest;
2096
2522
  const zCreateNeonAuthNewUserBody = zNeonAuthCreateNewUserRequest;
2097
2523
  const zCreateBranchNeonAuthNewUserBody = zCreateBranchNeonAuthNewUserRequest;
2098
2524
  const zCreateBranchNeonAuthNewUserPath = z.strictObject({
2099
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2100
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2525
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2526
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2101
2527
  });
2102
2528
  const zDeleteBranchNeonAuthUserPath = z.strictObject({
2103
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2104
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2105
- auth_user_id: z.string()
2529
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2530
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2531
+ auth_user_id: z.string().describe("The Neon user ID")
2106
2532
  });
2107
2533
  const zUpdateNeonAuthUserRoleBody = zUpdateNeonAuthUserRoleRequest;
2108
2534
  const zUpdateNeonAuthUserRolePath = z.strictObject({
2109
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2110
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2111
- auth_user_id: z.string()
2535
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2536
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2537
+ auth_user_id: z.string().describe("The Neon user ID")
2112
2538
  });
2113
2539
  const zDeleteNeonAuthUserPath = z.strictObject({
2114
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2115
- auth_user_id: z.string()
2540
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2541
+ auth_user_id: z.string().describe("The Neon user ID")
2116
2542
  });
2117
2543
  const zTransferNeonAuthProviderProjectBody = zNeonAuthTransferAuthProviderProjectRequest;
2118
- const zListNeonAuthIntegrationsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2119
- const zListNeonAuthOauthProvidersPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2544
+ const zListNeonAuthIntegrationsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2545
+ const zListNeonAuthOauthProvidersPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2120
2546
  const zAddNeonAuthOauthProviderBody = zNeonAuthAddOAuthProviderRequest;
2121
- const zAddNeonAuthOauthProviderPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2547
+ const zAddNeonAuthOauthProviderPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2122
2548
  const zListBranchNeonAuthOauthProvidersPath = z.strictObject({
2123
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2124
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2549
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2550
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2125
2551
  });
2126
2552
  const zAddBranchNeonAuthOauthProviderBody = zNeonAuthAddOAuthProviderRequest;
2127
2553
  const zAddBranchNeonAuthOauthProviderPath = z.strictObject({
2128
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2129
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2554
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2555
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2130
2556
  });
2131
2557
  const zDeleteNeonAuthOauthProviderPath = z.strictObject({
2132
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2133
- oauth_provider_id: zNeonAuthOauthProviderId
2558
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2559
+ oauth_provider_id: z.enum([
2560
+ "google",
2561
+ "github",
2562
+ "microsoft",
2563
+ "vercel",
2564
+ "apple"
2565
+ ]).describe("The OAuth provider ID")
2134
2566
  });
2135
2567
  const zUpdateNeonAuthOauthProviderBody = zNeonAuthUpdateOAuthProviderRequest;
2136
2568
  const zUpdateNeonAuthOauthProviderPath = z.strictObject({
2137
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2138
- oauth_provider_id: zNeonAuthOauthProviderId
2569
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2570
+ oauth_provider_id: z.enum([
2571
+ "google",
2572
+ "github",
2573
+ "microsoft",
2574
+ "vercel",
2575
+ "apple"
2576
+ ]).describe("The OAuth provider ID")
2139
2577
  });
2140
2578
  const zDeleteBranchNeonAuthOauthProviderPath = z.strictObject({
2141
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2142
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2143
- oauth_provider_id: zNeonAuthOauthProviderId
2579
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2580
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2581
+ oauth_provider_id: z.enum([
2582
+ "google",
2583
+ "github",
2584
+ "microsoft",
2585
+ "vercel",
2586
+ "apple"
2587
+ ]).describe("The OAuth provider ID")
2144
2588
  });
2145
2589
  const zUpdateBranchNeonAuthOauthProviderBody = zNeonAuthUpdateOAuthProviderRequest;
2146
2590
  const zUpdateBranchNeonAuthOauthProviderPath = z.strictObject({
2147
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2148
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2149
- oauth_provider_id: zNeonAuthOauthProviderId
2150
- });
2151
- const zGetNeonAuthEmailServerPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2591
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2592
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2593
+ oauth_provider_id: z.enum([
2594
+ "google",
2595
+ "github",
2596
+ "microsoft",
2597
+ "vercel",
2598
+ "apple"
2599
+ ]).describe("The OAuth provider ID")
2600
+ });
2601
+ const zGetNeonAuthEmailServerPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2152
2602
  const zUpdateNeonAuthEmailServerBody = zNeonAuthEmailServerConfig;
2153
- const zUpdateNeonAuthEmailServerPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2603
+ const zUpdateNeonAuthEmailServerPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2154
2604
  const zSendNeonAuthTestEmailBody = zSendNeonAuthTestEmailRequest;
2155
2605
  const zSendNeonAuthTestEmailPath = z.strictObject({
2156
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2157
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2606
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2607
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2158
2608
  });
2159
2609
  const zSendNeonAuthEmailProviderTestBody = zSendNeonAuthEmailProviderTestRequest;
2160
2610
  const zSendNeonAuthEmailProviderTestPath = z.strictObject({
2161
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2162
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2611
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2612
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2163
2613
  });
2164
2614
  const zGetNeonAuthEmailAndPasswordConfigPath = z.strictObject({
2165
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2166
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2615
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2616
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2167
2617
  });
2168
2618
  const zUpdateNeonAuthEmailAndPasswordConfigBody = zNeonAuthEmailAndPasswordConfigUpdate;
2169
2619
  const zUpdateNeonAuthEmailAndPasswordConfigPath = z.strictObject({
2170
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2171
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2620
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2621
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2172
2622
  });
2173
2623
  const zGetNeonAuthEmailProviderPath = z.strictObject({
2174
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2175
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2624
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2625
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2176
2626
  });
2177
2627
  const zUpdateNeonAuthEmailProviderBody = zNeonAuthEmailServerConfig;
2178
2628
  const zUpdateNeonAuthEmailProviderPath = z.strictObject({
2179
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2180
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2629
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2630
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2181
2631
  });
2182
- const zDeleteNeonAuthIntegrationBody = z.strictObject({ delete_data: z.boolean().optional() });
2632
+ const zDeleteNeonAuthIntegrationBody = z.strictObject({ delete_data: z.boolean().describe("If true, deletes the `neon_auth` schema from the database").optional() });
2183
2633
  const zDeleteNeonAuthIntegrationPath = z.strictObject({
2184
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2185
- auth_provider: zNeonAuthSupportedAuthProvider
2186
- });
2187
- const zGetConnectionUriPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2634
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2635
+ auth_provider: z.enum([
2636
+ "mock",
2637
+ "stack",
2638
+ "better_auth"
2639
+ ]).describe("The authentication provider name")
2640
+ });
2641
+ const zGetConnectionUriPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2188
2642
  const zGetConnectionUriQuery = z.strictObject({
2189
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
2190
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
2191
- database_name: z.string(),
2192
- role_name: z.string(),
2193
- pooled: z.boolean().optional()
2643
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID.").optional(),
2644
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID.").optional(),
2645
+ database_name: z.string().describe("The database name"),
2646
+ role_name: z.string().describe("The role name"),
2647
+ pooled: z.boolean().describe("Adds the `-pooler` option to the connection URI when set to `true`, creating a pooled connection URI.").optional()
2194
2648
  });
2195
2649
  const zGetNeonAuthAllowLocalhostPath = z.strictObject({
2196
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2197
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2650
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2651
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2198
2652
  });
2199
2653
  const zUpdateNeonAuthAllowLocalhostBody = zUpdateNeonAuthAllowLocalhostRequest;
2200
2654
  const zUpdateNeonAuthAllowLocalhostPath = z.strictObject({
2201
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2202
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2655
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2656
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2203
2657
  });
2204
2658
  const zGetNeonAuthPluginConfigsPath = z.strictObject({
2205
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2206
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2659
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2660
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2207
2661
  });
2208
2662
  const zUpdateNeonAuthOrganizationPluginBody = zNeonAuthOrganizationConfigUpdate;
2209
2663
  const zUpdateNeonAuthOrganizationPluginPath = z.strictObject({
2210
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2211
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2664
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2665
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2212
2666
  });
2213
2667
  const zUpdateNeonAuthConfigBody = zNeonAuthConfigUpdate;
2214
2668
  const zUpdateNeonAuthConfigPath = z.strictObject({
2215
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2216
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2669
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2670
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2217
2671
  });
2218
2672
  const zUpdateNeonAuthMagicLinkPluginBody = zNeonAuthMagicLinkConfigUpdate;
2219
2673
  const zUpdateNeonAuthMagicLinkPluginPath = z.strictObject({
2220
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2221
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2674
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2675
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2222
2676
  });
2223
2677
  const zGetNeonAuthPhoneNumberPluginPath = z.strictObject({
2224
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2225
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2678
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2679
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2226
2680
  });
2227
2681
  const zUpdateNeonAuthPhoneNumberPluginBody = zNeonAuthPhoneNumberConfigUpdate;
2228
2682
  const zUpdateNeonAuthPhoneNumberPluginPath = z.strictObject({
2229
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2230
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2683
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2684
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2231
2685
  });
2232
2686
  const zGetNeonAuthOAuthProviderPluginPath = z.strictObject({
2233
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2234
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2687
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2688
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2235
2689
  });
2236
2690
  const zUpdateNeonAuthOAuthProviderPluginBody = zNeonAuthOAuthProviderConfigUpdate;
2237
2691
  const zUpdateNeonAuthOAuthProviderPluginPath = z.strictObject({
2238
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2239
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2692
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2693
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2240
2694
  });
2241
2695
  const zListNeonAuthOAuthClientsPath = z.strictObject({
2242
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2243
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2696
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2697
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2244
2698
  });
2245
2699
  const zCreateNeonAuthOAuthClientBody = zNeonAuthOAuthClientCreateRequest;
2246
2700
  const zCreateNeonAuthOAuthClientPath = z.strictObject({
2247
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2248
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2701
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2702
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2249
2703
  });
2250
2704
  const zDeleteNeonAuthOAuthClientPath = z.strictObject({
2251
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2252
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2253
- client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/)
2705
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2706
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2707
+ client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/).describe("The OAuth client ID")
2254
2708
  });
2255
2709
  const zGetNeonAuthOAuthClientPath = z.strictObject({
2256
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2257
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2258
- client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/)
2710
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2711
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2712
+ client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/).describe("The OAuth client ID")
2259
2713
  });
2260
2714
  const zUpdateNeonAuthOAuthClientBody = zNeonAuthOAuthClientUpdateRequest;
2261
2715
  const zUpdateNeonAuthOAuthClientPath = z.strictObject({
2262
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2263
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2264
- client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/)
2716
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2717
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2718
+ client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/).describe("The OAuth client ID")
2265
2719
  });
2266
2720
  const zRotateNeonAuthOAuthClientSecretPath = z.strictObject({
2267
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2268
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2269
- client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/)
2721
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2722
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
2723
+ client_id: z.string().max(64).regex(/^[A-Za-z0-9]+$/).describe("The OAuth client ID")
2270
2724
  });
2271
2725
  const zGetNeonAuthWebhookConfigPath = z.strictObject({
2272
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2273
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2726
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2727
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2274
2728
  });
2275
2729
  const zUpdateNeonAuthWebhookConfigBody = zNeonAuthWebhookConfig;
2276
2730
  const zUpdateNeonAuthWebhookConfigPath = z.strictObject({
2277
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2278
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2731
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2732
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2279
2733
  });
2280
- const zListProjectBranchesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2734
+ const zListProjectBranchesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2281
2735
  const zListProjectBranchesQuery = z.strictObject({
2282
- search: z.string().optional(),
2736
+ search: z.string().describe("Search by branch `name` or `id`.").optional(),
2283
2737
  sort_by: z.enum([
2284
2738
  "name",
2285
2739
  "created_at",
2286
2740
  "updated_at"
2287
- ]).optional(),
2288
- cursor: z.string().optional(),
2289
- sort_order: z.enum(["asc", "desc"]).optional(),
2290
- limit: z.int().gte(1).lte(1e4).optional(),
2291
- include_deleted: z.boolean().optional()
2741
+ ]).describe("Sort the branches by sort_field.").optional(),
2742
+ cursor: z.string().describe("A cursor to use in pagination.").optional(),
2743
+ sort_order: z.enum(["asc", "desc"]).describe("Defines the sorting order of entities.").optional(),
2744
+ limit: z.int().gte(1).lte(1e4).describe("The maximum number of records to be returned in the response").optional(),
2745
+ include_deleted: z.boolean().describe("If true, return recoverable deleted branches too (soft-deleted within the recovery window).").optional()
2292
2746
  });
2293
2747
  const zCreateProjectBranchBody = zBranchCreateRequest.merge(zAnnotationCreateValueRequest);
2294
- const zCreateProjectBranchPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2748
+ const zCreateProjectBranchPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2295
2749
  const zCreateProjectBranchAnonymizedBody = zBranchAnonymizedCreateRequest;
2296
- const zCreateProjectBranchAnonymizedPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2297
- const zCountProjectBranchesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2298
- const zCountProjectBranchesQuery = z.strictObject({ search: z.string().optional() });
2750
+ const zCreateProjectBranchAnonymizedPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2751
+ const zCountProjectBranchesPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2752
+ const zCountProjectBranchesQuery = z.strictObject({ search: z.string().describe("Count branches matching the `name` in search query").optional() });
2299
2753
  const zDeleteProjectBranchPath = z.strictObject({
2300
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2301
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2754
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2755
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2302
2756
  });
2303
2757
  const zGetProjectBranchPath = z.strictObject({
2304
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2305
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2758
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2759
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2306
2760
  });
2307
2761
  const zUpdateProjectBranchBody = zBranchUpdateRequest;
2308
2762
  const zUpdateProjectBranchPath = z.strictObject({
2309
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2310
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2763
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2764
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2311
2765
  });
2312
2766
  const zRestoreProjectBranchBody = zBranchRestoreRequest;
2313
2767
  const zRestoreProjectBranchPath = z.strictObject({
2314
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2315
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2768
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2769
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2316
2770
  });
2317
2771
  const zGetProjectBranchSchemaPath = z.strictObject({
2318
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2319
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2772
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2773
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2320
2774
  });
2321
2775
  const zGetProjectBranchSchemaQuery = z.strictObject({
2322
- db_name: z.string(),
2323
- lsn: z.string().optional(),
2324
- timestamp: z.iso.datetime().optional(),
2325
- format: z.string().optional()
2776
+ db_name: z.string().describe("Name of the database for which the schema is retrieved"),
2777
+ lsn: z.string().describe("The Log Sequence Number (LSN) for which the schema is retrieved").optional(),
2778
+ timestamp: z.iso.datetime().describe("The point in time for which the schema is retrieved").optional(),
2779
+ format: z.string().describe("The format of the schema to retrieve.").optional()
2326
2780
  });
2327
2781
  const zGetProjectBranchSchemaComparisonPath = z.strictObject({
2328
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2329
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2782
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2783
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2330
2784
  });
2331
2785
  const zGetProjectBranchSchemaComparisonQuery = z.strictObject({
2332
- base_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
2333
- db_name: z.string(),
2334
- lsn: z.string().optional(),
2335
- timestamp: z.iso.datetime().optional(),
2336
- base_lsn: z.string().optional(),
2337
- base_timestamp: z.iso.datetime().optional()
2786
+ base_branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID to compare the schema with").optional(),
2787
+ db_name: z.string().describe("Name of the database for which the schema is retrieved"),
2788
+ lsn: z.string().describe("The Log Sequence Number (LSN) for which the schema is retrieved").optional(),
2789
+ timestamp: z.iso.datetime().describe("The point in time for which the schema is retrieved").optional(),
2790
+ base_lsn: z.string().describe("The Log Sequence Number (LSN) for the base branch schema").optional(),
2791
+ base_timestamp: z.iso.datetime().describe("The point in time for the base branch schema").optional()
2338
2792
  });
2339
2793
  const zGetMaskingRulesPath = z.strictObject({
2340
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2341
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2794
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2795
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2342
2796
  });
2343
2797
  const zUpdateMaskingRulesBody = zMaskingRulesUpdateRequest;
2344
2798
  const zUpdateMaskingRulesPath = z.strictObject({
2345
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2346
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2799
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2800
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2347
2801
  });
2348
2802
  const zGetAnonymizedBranchStatusPath = z.strictObject({
2349
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2350
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2803
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2804
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2351
2805
  });
2352
2806
  const zStartAnonymizationPath = z.strictObject({
2353
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2354
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2807
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2808
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2355
2809
  });
2356
2810
  const zSetDefaultProjectBranchPath = z.strictObject({
2357
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2358
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2811
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2812
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2359
2813
  });
2360
- const zFinalizeRestoreBranchBody = z.strictObject({ name: z.string().optional() });
2814
+ const zFinalizeRestoreBranchBody = z.strictObject({ name: z.string().describe("Name for the replaced branch.").optional() });
2361
2815
  const zFinalizeRestoreBranchPath = z.strictObject({
2362
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2363
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2816
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2817
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2364
2818
  });
2365
2819
  const zListProjectBranchEndpointsPath = z.strictObject({
2366
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2367
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2820
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2821
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2368
2822
  });
2369
2823
  const zListProjectBranchDatabasesPath = z.strictObject({
2370
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2371
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2824
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2825
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2372
2826
  });
2373
2827
  const zCreateProjectBranchDatabaseBody = zDatabaseCreateRequest;
2374
2828
  const zCreateProjectBranchDatabasePath = z.strictObject({
2375
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2376
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2829
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2830
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2377
2831
  });
2378
2832
  const zDeleteProjectBranchDatabasePath = z.strictObject({
2379
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2380
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2381
- database_name: z.string()
2833
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2834
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2835
+ database_name: z.string().describe("The database name")
2382
2836
  });
2383
2837
  const zGetProjectBranchDatabasePath = z.strictObject({
2384
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2385
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2386
- database_name: z.string()
2838
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2839
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2840
+ database_name: z.string().describe("The database name")
2387
2841
  });
2388
2842
  const zUpdateProjectBranchDatabaseBody = zDatabaseUpdateRequest;
2389
2843
  const zUpdateProjectBranchDatabasePath = z.strictObject({
2390
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2391
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2392
- database_name: z.string()
2844
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2845
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2846
+ database_name: z.string().describe("The database name")
2393
2847
  });
2394
2848
  const zListProjectBranchRolesPath = z.strictObject({
2395
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2396
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2849
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2850
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2397
2851
  });
2398
2852
  const zCreateProjectBranchRoleBody = zRoleCreateRequest;
2399
2853
  const zCreateProjectBranchRolePath = z.strictObject({
2400
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2401
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2854
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2855
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2402
2856
  });
2403
2857
  const zDeleteProjectBranchRolePath = z.strictObject({
2404
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2405
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2406
- role_name: z.string()
2858
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2859
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2860
+ role_name: z.string().describe("The role name")
2407
2861
  });
2408
2862
  const zGetProjectBranchRolePath = z.strictObject({
2409
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2410
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2411
- role_name: z.string()
2863
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2864
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2865
+ role_name: z.string().describe("The role name")
2412
2866
  });
2413
2867
  const zGetProjectBranchRolePasswordPath = z.strictObject({
2414
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2415
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2416
- role_name: z.string()
2868
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2869
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2870
+ role_name: z.string().describe("The role name")
2417
2871
  });
2418
2872
  const zDisableProjectBranchRealtimePath = z.strictObject({
2419
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2420
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2873
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The project ID"),
2874
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2421
2875
  });
2422
2876
  const zGetProjectBranchRealtimePath = z.strictObject({
2423
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2424
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2877
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The project ID"),
2878
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2425
2879
  });
2426
2880
  const zEnableProjectBranchRealtimeBody = zRealtimeOptions;
2427
2881
  const zEnableProjectBranchRealtimePath = z.strictObject({
2428
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2429
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2882
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The project ID"),
2883
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2430
2884
  });
2431
2885
  const zGetProjectBranchRealtimeSecretPath = z.strictObject({
2432
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2433
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2886
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The project ID"),
2887
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2434
2888
  });
2435
2889
  const zRotateProjectBranchRealtimeSecretPath = z.strictObject({
2436
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2437
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2890
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The project ID"),
2891
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2438
2892
  });
2439
2893
  const zResetProjectBranchRolePasswordPath = z.strictObject({
2440
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2441
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2442
- role_name: z.string()
2894
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2895
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID"),
2896
+ role_name: z.string().describe("The role name")
2443
2897
  });
2444
- const zListProjectVpcEndpointsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2898
+ const zListProjectVpcEndpointsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2445
2899
  const zDeleteProjectVpcEndpointPath = z.strictObject({
2446
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2447
- vpc_endpoint_id: z.string()
2900
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2901
+ vpc_endpoint_id: z.string().describe("The VPC endpoint ID")
2448
2902
  });
2449
2903
  const zAssignProjectVpcEndpointBody = zVpcEndpointAssignment;
2450
2904
  const zAssignProjectVpcEndpointPath = z.strictObject({
2451
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2452
- vpc_endpoint_id: z.string()
2905
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2906
+ vpc_endpoint_id: z.string().describe("The VPC endpoint ID")
2453
2907
  });
2454
- const zListProjectEndpointsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2908
+ const zListProjectEndpointsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2455
2909
  const zCreateProjectEndpointBody = zEndpointCreateRequest;
2456
- const zCreateProjectEndpointPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2910
+ const zCreateProjectEndpointPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2457
2911
  const zDeleteProjectEndpointPath = z.strictObject({
2458
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2459
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2912
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2913
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2460
2914
  });
2461
2915
  const zGetProjectEndpointPath = z.strictObject({
2462
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2463
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2916
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2917
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2464
2918
  });
2465
2919
  const zUpdateProjectEndpointBody = zEndpointUpdateRequest;
2466
2920
  const zUpdateProjectEndpointPath = z.strictObject({
2467
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2468
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2921
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2922
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2469
2923
  });
2470
2924
  const zStartProjectEndpointPath = z.strictObject({
2471
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2472
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2925
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2926
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2473
2927
  });
2474
2928
  const zSuspendProjectEndpointPath = z.strictObject({
2475
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2476
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2929
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2930
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2477
2931
  });
2478
2932
  const zRestartProjectEndpointPath = z.strictObject({
2479
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2480
- endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
2933
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
2934
+ endpoint_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The endpoint ID")
2481
2935
  });
2482
2936
  const zGetConsumptionHistoryPerProjectQuery = z.strictObject({
2483
- cursor: z.string().optional(),
2484
- limit: z.int().gte(1).lte(100).optional(),
2485
- project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).optional(),
2486
- from: z.iso.datetime(),
2487
- to: z.iso.datetime(),
2488
- granularity: zConsumptionHistoryGranularity,
2489
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional(),
2490
- include_v1_metrics: z.boolean().optional(),
2491
- metrics: zConsumptionHistoryQueryMetrics.optional()
2937
+ cursor: z.string().describe("Specify the cursor value from the previous response to get the next batch of projects.").optional(),
2938
+ limit: z.int().gte(1).lte(100).describe("Specify a value from 1 to 100 to limit number of projects in the response.").optional(),
2939
+ project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).describe("Specify a list of project IDs to filter the response.").optional(),
2940
+ from: z.iso.datetime().describe("Specify the start `date-time` for the consumption period."),
2941
+ to: z.iso.datetime().describe("Specify the end `date-time` for the consumption period."),
2942
+ granularity: z.enum([
2943
+ "hourly",
2944
+ "daily",
2945
+ "monthly"
2946
+ ]).describe("Specify the granularity of consumption metrics."),
2947
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Specify the organization for which the project consumption metrics should be returned.").optional(),
2948
+ include_v1_metrics: z.boolean().describe("The field is deprecated and no longer has any effect: the only metric it used to add (`data_storage_bytes_hour`) is retired and always returns 0.").optional(),
2949
+ metrics: z.array(z.string()).describe("Specify a list of metrics to include in the response.").optional()
2492
2950
  });
2493
2951
  const zGetConsumptionHistoryPerProjectV2Query = z.strictObject({
2494
- cursor: z.string().optional(),
2495
- limit: z.int().gte(1).lte(100).optional(),
2496
- project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).optional(),
2497
- from: z.iso.datetime(),
2498
- to: z.iso.datetime(),
2499
- granularity: zConsumptionHistoryGranularity,
2500
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2501
- metrics: zConsumptionHistoryQueryMetrics
2952
+ cursor: z.string().describe("Cursor from the previous response (`pagination.cursor`).").optional(),
2953
+ limit: z.int().gte(1).lte(100).describe("Maximum number of projects per page.").optional(),
2954
+ project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).describe("Optional project IDs to filter the response (up to 100).").optional(),
2955
+ from: z.iso.datetime().describe("Specify the start `date-time` for the consumption period."),
2956
+ to: z.iso.datetime().describe("Specify the end `date-time` for the consumption period."),
2957
+ granularity: z.enum([
2958
+ "hourly",
2959
+ "daily",
2960
+ "monthly"
2961
+ ]).describe("Specify the granularity of consumption metrics."),
2962
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Organization ID."),
2963
+ metrics: z.array(z.string()).describe("Required. List the metrics to return.")
2502
2964
  });
2503
2965
  const zGetConsumptionHistoryPerBranchV2Query = z.strictObject({
2504
- cursor: z.string().optional(),
2505
- limit: z.int().gte(1).lte(1e3).optional(),
2506
- project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(1).max(100),
2507
- branch_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).optional(),
2508
- from: z.iso.datetime(),
2509
- to: z.iso.datetime(),
2510
- granularity: zConsumptionHistoryGranularity,
2511
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2512
- metrics: zConsumptionHistoryQueryMetrics
2513
- });
2514
- const zGetOrganizationPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2515
- const zListOrgApiKeysPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2966
+ cursor: z.string().describe("Cursor from the previous response (`pagination.cursor`).").optional(),
2967
+ limit: z.int().gte(1).lte(1e3).describe("Maximum number of branches per page.").optional(),
2968
+ project_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(1).max(100).describe("Project IDs to include (required, 1 to 100)."),
2969
+ branch_ids: z.array(z.string().regex(/^([a-z0-9-]{1,60}(,[a-z0-9-]{1,60}){0,99})?$/)).min(0).max(100).describe("Optional branch IDs to filter the response (up to 100).").optional(),
2970
+ from: z.iso.datetime().describe("Specify the start `date-time` for the consumption period."),
2971
+ to: z.iso.datetime().describe("Specify the end `date-time` for the consumption period."),
2972
+ granularity: z.enum([
2973
+ "hourly",
2974
+ "daily",
2975
+ "monthly"
2976
+ ]).describe("Specify the granularity of consumption metrics."),
2977
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Organization ID."),
2978
+ metrics: z.array(z.string()).describe("Required. List the metrics to return.")
2979
+ });
2980
+ const zGetOrganizationPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2981
+ const zListOrgApiKeysPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2516
2982
  const zCreateOrgApiKeyBody = zOrgApiKeyCreateRequest;
2517
- const zCreateOrgApiKeyPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2983
+ const zCreateOrgApiKeyPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2518
2984
  const zRevokeOrgApiKeyPath = z.strictObject({
2519
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2520
- key_id: z.int()
2985
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
2986
+ key_id: z.int().describe("The API key ID")
2521
2987
  });
2522
- const zDeleteOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2523
- const zGetOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2988
+ const zDeleteOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2989
+ const zGetOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2524
2990
  const zSetOrganizationSpendingLimitBody = zSpendingLimitUpdateRequest;
2525
- const zSetOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2526
- const zGetOrganizationMembersPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2991
+ const zSetOrganizationSpendingLimitPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2992
+ const zGetOrganizationMembersPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2527
2993
  const zGetOrganizationMembersQuery = z.strictObject({
2528
2994
  sort_by: z.enum([
2529
2995
  "email",
2530
2996
  "role",
2531
2997
  "joined_at"
2532
- ]).optional(),
2533
- cursor: z.string().optional(),
2534
- sort_order: z.enum(["asc", "desc"]).optional(),
2535
- limit: z.int().gte(1).lte(500).optional()
2998
+ ]).describe("Sort the members by the specified field.").optional(),
2999
+ cursor: z.string().describe("A cursor to use in pagination.").optional(),
3000
+ sort_order: z.enum(["asc", "desc"]).describe("Defines the sorting order of entities.").optional(),
3001
+ limit: z.int().gte(1).lte(500).describe("The maximum number of members to return in the response").optional()
2536
3002
  });
2537
3003
  const zRemoveOrganizationMemberPath = z.strictObject({
2538
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2539
- member_id: z.uuid()
3004
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3005
+ member_id: z.uuid().describe("The Neon organization member ID")
2540
3006
  });
2541
3007
  const zGetOrganizationMemberPath = z.strictObject({
2542
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2543
- member_id: z.uuid()
3008
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3009
+ member_id: z.uuid().describe("The Neon organization member ID")
2544
3010
  });
2545
3011
  const zUpdateOrganizationMemberBody = zOrganizationMemberUpdateRequest;
2546
3012
  const zUpdateOrganizationMemberPath = z.strictObject({
2547
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2548
- member_id: z.uuid()
3013
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3014
+ member_id: z.uuid().describe("The Neon organization member ID")
2549
3015
  });
2550
- const zGetOrganizationInvitationsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
3016
+ const zGetOrganizationInvitationsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2551
3017
  const zCreateOrganizationInvitationsBody = zOrganizationInvitesCreateRequest;
2552
- const zCreateOrganizationInvitationsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
3018
+ const zCreateOrganizationInvitationsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2553
3019
  const zTransferProjectsFromOrgToOrgBody = zTransferProjectsToOrganizationRequest;
2554
- const zTransferProjectsFromOrgToOrgPath = z.strictObject({ source_org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
2555
- const zListOrganizationVpcEndpointsAllRegionsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
3020
+ const zTransferProjectsFromOrgToOrgPath = z.strictObject({ source_org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID (source org, which currently owns the project)") });
3021
+ const zListOrganizationVpcEndpointsAllRegionsPath = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID") });
2556
3022
  const zListOrganizationVpcEndpointsPath = z.strictObject({
2557
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2558
- region_id: z.string()
3023
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3024
+ region_id: z.string().describe("The Neon region ID")
2559
3025
  });
2560
3026
  const zDeleteOrganizationVpcEndpointPath = z.strictObject({
2561
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2562
- region_id: z.string(),
2563
- vpc_endpoint_id: z.string()
3027
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3028
+ region_id: z.string().describe("The Neon region ID."),
3029
+ vpc_endpoint_id: z.string().describe("The VPC endpoint ID")
2564
3030
  });
2565
3031
  const zGetOrganizationVpcEndpointDetailsPath = z.strictObject({
2566
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2567
- region_id: z.string(),
2568
- vpc_endpoint_id: z.string()
3032
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3033
+ region_id: z.string().describe("The Neon region ID."),
3034
+ vpc_endpoint_id: z.string().describe("The VPC endpoint ID")
2569
3035
  });
2570
3036
  const zAssignOrganizationVpcEndpointBody = zVpcEndpointAssignment;
2571
3037
  const zAssignOrganizationVpcEndpointPath = z.strictObject({
2572
- org_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2573
- region_id: z.string(),
2574
- vpc_endpoint_id: z.string()
3038
+ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon organization ID"),
3039
+ region_id: z.string().describe("The Neon region ID."),
3040
+ vpc_endpoint_id: z.string().describe("The VPC endpoint ID")
2575
3041
  });
2576
- const zGetActiveRegionsQuery = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).optional() });
3042
+ const zGetActiveRegionsQuery = z.strictObject({ org_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("Organization ID.").optional() });
2577
3043
  const zTransferProjectsFromUserToOrgBody = zTransferProjectsToOrganizationRequest;
2578
3044
  const zCreateSnapshotPath = z.strictObject({
2579
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2580
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3045
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3046
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2581
3047
  });
2582
3048
  const zCreateSnapshotQuery = z.strictObject({
2583
- lsn: z.string().optional(),
2584
- timestamp: z.string().optional(),
2585
- name: z.string().optional(),
2586
- expires_at: z.string().optional()
3049
+ lsn: z.string().describe("The target Log Sequence Number (LSN) to take the snapshot from.").optional(),
3050
+ timestamp: z.string().describe("The target timestamp for the snapshot.").optional(),
3051
+ name: z.string().describe("A name for the snapshot.").optional(),
3052
+ expires_at: z.string().describe("The time at which the snapshot will be automatically deleted.").optional()
2587
3053
  });
2588
- const zListSnapshotsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/) });
3054
+ const zListSnapshotsPath = z.strictObject({ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID") });
2589
3055
  const zDeleteSnapshotPath = z.strictObject({
2590
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2591
- snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3056
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3057
+ snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The snapshot ID")
2592
3058
  });
2593
3059
  const zUpdateSnapshotBody = zSnapshotUpdateRequest;
2594
3060
  const zUpdateSnapshotPath = z.strictObject({
2595
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2596
- snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3061
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3062
+ snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The snapshot ID")
2597
3063
  });
2598
3064
  const zRestoreSnapshotBody = z.strictObject({
2599
- name: z.string().optional(),
2600
- target_branch_id: z.string().optional(),
2601
- finalize_restore: z.boolean().optional()
3065
+ name: z.string().describe("A name for the newly restored branch.").optional(),
3066
+ target_branch_id: z.string().describe("ID of the branch to restore the snapshot into.").optional(),
3067
+ finalize_restore: z.boolean().describe("Set to `true` to finalize the restore operation immediately.").optional()
2602
3068
  });
2603
3069
  const zRestoreSnapshotPath = z.strictObject({
2604
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2605
- snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3070
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3071
+ snapshot_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The snapshot ID")
2606
3072
  });
2607
- const zRestoreSnapshotQuery = z.strictObject({ name: z.string().optional() });
3073
+ const zRestoreSnapshotQuery = z.strictObject({ name: z.string().describe("Deprecated. Use the `name` field in the request body instead.").optional() });
2608
3074
  const zGetSnapshotSchedulePath = z.strictObject({
2609
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2610
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3075
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3076
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2611
3077
  });
2612
3078
  const zSetSnapshotScheduleBody = zBackupSchedule;
2613
3079
  const zSetSnapshotSchedulePath = z.strictObject({
2614
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2615
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3080
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3081
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The branch ID")
2616
3082
  });
2617
3083
  const zListProjectBranchBucketsPath = z.strictObject({
2618
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2619
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3084
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3085
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2620
3086
  });
2621
3087
  const zCreateProjectBranchBucketBody = zBucketCreateRequest;
2622
3088
  const zCreateProjectBranchBucketPath = z.strictObject({
2623
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2624
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3089
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3090
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2625
3091
  });
2626
3092
  const zDeleteProjectBranchBucketPath = z.strictObject({
2627
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2628
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2629
- bucket_name: z.string().min(1).max(255)
3093
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3094
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3095
+ bucket_name: z.string().min(1).max(255).describe("The bucket name")
2630
3096
  });
2631
3097
  const zGetProjectBranchStoragePath = z.strictObject({
2632
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2633
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3098
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3099
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2634
3100
  });
2635
3101
  const zGetProjectBranchAiGatewayPath = z.strictObject({
2636
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2637
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3102
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3103
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2638
3104
  });
2639
3105
  const zQueryProjectBranchLogsBody = zProjectBranchLogsQueryRequest;
2640
3106
  const zQueryProjectBranchLogsPath = z.strictObject({
2641
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2642
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3107
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3108
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2643
3109
  });
2644
3110
  const zListProjectBranchLogFieldsPath = z.strictObject({
2645
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2646
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3111
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3112
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2647
3113
  });
2648
3114
  const zListProjectBranchLogFieldValuesPath = z.strictObject({
2649
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2650
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2651
- field_name: z.string().min(1)
3115
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3116
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3117
+ field_name: z.string().min(1).describe("The log field whose distinct values should be returned.")
2652
3118
  });
2653
3119
  const zListProjectBranchLogFieldValuesQuery = z.strictObject({
2654
- since: zProjectBranchLogDuration.optional(),
2655
- start_time: z.iso.datetime().optional(),
2656
- end_time: z.iso.datetime().optional(),
2657
- source: zProjectBranchLogSource.optional(),
2658
- limit: z.int().gte(1).lte(1e3).optional()
3120
+ since: z.string().regex(/^[0-9]{1,6}(ms|s|m|h|d)$/).describe("Length of the lookup window, ending at `end_time` or at the current time when `end_time` is omitted.").optional(),
3121
+ start_time: z.iso.datetime().describe("Inclusive beginning of the lookup window.").optional(),
3122
+ end_time: z.iso.datetime().describe("Exclusive end of the lookup window.").optional(),
3123
+ source: z.enum([
3124
+ "function",
3125
+ "storage",
3126
+ "pg_endpoint"
3127
+ ]).describe("Only consider records emitted by this Neon service.").optional(),
3128
+ limit: z.int().gte(1).lte(1e3).describe("Maximum number of distinct values to return.").optional()
2659
3129
  });
2660
3130
  const zListProjectBranchBucketObjectsPath = z.strictObject({
2661
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2662
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2663
- bucket_name: z.string().min(1).max(255)
3131
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3132
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3133
+ bucket_name: z.string().min(1).max(255).describe("The bucket name")
2664
3134
  });
2665
3135
  const zListProjectBranchBucketObjectsQuery = z.strictObject({
2666
- prefix: z.string().optional(),
2667
- delimiter: z.string().optional(),
2668
- cursor: z.string().optional(),
2669
- limit: z.int().gte(1).lte(1e3).optional()
3136
+ prefix: z.string().describe("Only list objects whose key starts with this prefix.").optional(),
3137
+ delimiter: z.string().describe("Collapse keys sharing a common prefix up to the first occurrence of this delimiter (typically `/`) into the `folders` array.").optional(),
3138
+ cursor: z.string().describe("Opaque pagination cursor returned as `next_cursor` by a previous call.").optional(),
3139
+ limit: z.int().gte(1).lte(1e3).describe("Maximum number of items (objects + folders) to return.").optional()
2670
3140
  });
2671
3141
  const zDeleteProjectBranchBucketObjectPath = z.strictObject({
2672
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2673
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2674
- bucket_name: z.string().min(1).max(255),
2675
- object_key: z.string().min(1).max(1024)
3142
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3143
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3144
+ bucket_name: z.string().min(1).max(255).describe("The bucket name"),
3145
+ object_key: z.string().min(1).max(1024).describe("The object key.")
2676
3146
  });
2677
3147
  const zGetProjectBranchBucketObjectPath = z.strictObject({
2678
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2679
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2680
- bucket_name: z.string().min(1).max(255),
2681
- object_key: z.string().min(1).max(1024)
3148
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3149
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3150
+ bucket_name: z.string().min(1).max(255).describe("The bucket name"),
3151
+ object_key: z.string().min(1).max(1024).describe("The object key.")
2682
3152
  });
2683
3153
  const zDeleteProjectBranchBucketObjectsByPrefixPath = z.strictObject({
2684
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2685
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2686
- bucket_name: z.string().min(1).max(255)
3154
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3155
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3156
+ bucket_name: z.string().min(1).max(255).describe("The bucket name")
2687
3157
  });
2688
- const zDeleteProjectBranchBucketObjectsByPrefixQuery = z.strictObject({ prefix: z.string().min(1).max(1024) });
3158
+ const zDeleteProjectBranchBucketObjectsByPrefixQuery = z.strictObject({ prefix: z.string().min(1).max(1024).describe("The key prefix (folder) to delete.") });
2689
3159
  const zPresignProjectBranchBucketObjectBody = zPresignRequest;
2690
3160
  const zPresignProjectBranchBucketObjectPath = z.strictObject({
2691
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2692
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2693
- bucket_name: z.string().min(1).max(255),
2694
- object_key: z.string().min(1).max(1024)
3161
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3162
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3163
+ bucket_name: z.string().min(1).max(255).describe("The bucket name"),
3164
+ object_key: z.string().min(1).max(1024).describe("The object key.")
2695
3165
  });
2696
3166
  const zListCredentialsPath = z.strictObject({
2697
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2698
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3167
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3168
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2699
3169
  });
2700
3170
  const zCreateCredentialBody = zCreateCredentialRequest;
2701
3171
  const zCreateCredentialPath = z.strictObject({
2702
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2703
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3172
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3173
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2704
3174
  });
2705
3175
  const zRevokeCredentialPath = z.strictObject({
2706
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2707
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2708
- token_id: z.string()
3176
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3177
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3178
+ token_id: z.string().describe("The opaque credential id (e.g. nak_live_<32hex>).")
2709
3179
  });
2710
3180
  const zRevealCredentialPath = z.strictObject({
2711
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2712
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2713
- token_id: z.string()
3181
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3182
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3183
+ token_id: z.string().describe("The opaque credential id (e.g. nak_live_<32hex>).")
2714
3184
  });
2715
3185
  const zRotateCredentialPath = z.strictObject({
2716
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2717
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2718
- token_id: z.string()
3186
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3187
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3188
+ token_id: z.string().describe("The opaque credential id (e.g. nak_live_<32hex>).")
2719
3189
  });
2720
3190
  const zListProjectBranchFunctionsPath = z.strictObject({
2721
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2722
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3191
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3192
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2723
3193
  });
2724
3194
  const zListProjectBranchFunctionsQuery = z.strictObject({
2725
- cursor: z.string().optional(),
2726
- limit: z.int().gte(1).lte(1e3).optional()
3195
+ cursor: z.string().describe("A cursor to use in pagination.").optional(),
3196
+ limit: z.int().gte(1).lte(1e3).describe("Specify a value from 1 to 1000 to limit number of functions in the response").optional()
2727
3197
  });
2728
3198
  const zDeleteProjectBranchFunctionPath = z.strictObject({
2729
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2730
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2731
- slug: z.string().regex(/^[a-z0-9]{1,20}$/)
3199
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3200
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3201
+ slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The function slug")
2732
3202
  });
2733
3203
  const zGetProjectBranchFunctionPath = z.strictObject({
2734
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2735
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2736
- slug: z.string().regex(/^[a-z0-9]{1,20}$/)
3204
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3205
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3206
+ slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The function slug")
2737
3207
  });
2738
3208
  const zUpdateProjectBranchFunctionBody = zNeonFunctionUpdateRequest;
2739
3209
  const zUpdateProjectBranchFunctionPath = z.strictObject({
2740
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2741
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2742
- slug: z.string().regex(/^[a-z0-9]{1,20}$/)
3210
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3211
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3212
+ slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The function slug")
2743
3213
  });
2744
3214
  const zCreateProjectBranchFunctionDeploymentBody = zFunctionDeployRequest;
2745
3215
  const zCreateProjectBranchFunctionDeploymentPath = z.strictObject({
2746
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2747
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2748
- slug: z.string().regex(/^[a-z0-9]{1,20}$/)
3216
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3217
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3218
+ slug: z.string().regex(/^[a-z0-9]{1,20}$/).describe("The function slug")
2749
3219
  });
2750
3220
  const zListProjectBranchTriggersPath = z.strictObject({
2751
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2752
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3221
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3222
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2753
3223
  });
2754
3224
  const zCreateProjectBranchTriggerBody = zTriggerCreateRequest;
2755
3225
  const zCreateProjectBranchTriggerPath = z.strictObject({
2756
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2757
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3226
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3227
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2758
3228
  });
2759
3229
  const zDeleteProjectBranchTriggerPath = z.strictObject({
2760
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2761
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2762
- trigger_id: zTriggerId
3230
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3231
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3232
+ trigger_id: z.string().min(1).max(128).regex(/^[A-Za-z0-9][A-Za-z0-9_.\-]{0,127}$/).describe("The opaque, project-wide trigger ID")
2763
3233
  });
2764
3234
  const zGetProjectBranchTriggerPath = z.strictObject({
2765
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2766
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2767
- trigger_id: zTriggerId
3235
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3236
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3237
+ trigger_id: z.string().min(1).max(128).regex(/^[A-Za-z0-9][A-Za-z0-9_.\-]{0,127}$/).describe("The opaque, project-wide trigger ID")
2768
3238
  });
2769
3239
  const zUpdateProjectBranchTriggerBody = zTriggerUpdateRequest;
2770
3240
  const zUpdateProjectBranchTriggerPath = z.strictObject({
2771
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2772
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2773
- trigger_id: zTriggerId
3241
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3242
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3243
+ trigger_id: z.string().min(1).max(128).regex(/^[A-Za-z0-9][A-Za-z0-9_.\-]{0,127}$/).describe("The opaque, project-wide trigger ID")
2774
3244
  });
2775
3245
  const zListProjectBranchCustomDomainsPath = z.strictObject({
2776
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2777
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3246
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3247
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2778
3248
  });
2779
3249
  const zListProjectBranchCustomDomainsQuery = z.strictObject({
2780
- cursor: z.string().optional(),
2781
- limit: z.int().gte(1).lte(1e3).optional()
3250
+ cursor: z.string().describe("A cursor to use in pagination.").optional(),
3251
+ limit: z.int().gte(1).lte(1e3).describe("Specify a value from 1 to 1000 to limit number of domains in the response").optional()
2782
3252
  });
2783
3253
  const zRegisterProjectBranchCustomDomainBody = zCustomDomainRegisterRequest;
2784
3254
  const zRegisterProjectBranchCustomDomainPath = z.strictObject({
2785
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2786
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/)
3255
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3256
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID")
2787
3257
  });
2788
3258
  const zDeleteProjectBranchCustomDomainPath = z.strictObject({
2789
- project_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2790
- branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/),
2791
- domain: z.string().min(3).max(254).regex(/^[A-Za-z0-9.-]+$/)
3259
+ project_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon project ID"),
3260
+ branch_id: z.string().regex(/^[a-z0-9-]{1,60}$/).describe("The Neon branch ID"),
3261
+ domain: z.string().min(3).max(254).regex(/^[A-Za-z0-9.-]+$/).describe("The registered custom domain (case-insensitive).")
2792
3262
  });
2793
3263
  export { zAcceptProjectTransferRequestBody, zAcceptProjectTransferRequestPath, zAcceptProjectTransferRequestSatisfiesPlanError, zActiveRegionsResponse, zAddBranchNeonAuthOauthProviderBody, zAddBranchNeonAuthOauthProviderPath, zAddBranchNeonAuthTrustedDomainBody, zAddBranchNeonAuthTrustedDomainPath, zAddNeonAuthDomainToRedirectUriWhitelistBody, zAddNeonAuthDomainToRedirectUriWhitelistPath, zAddNeonAuthOauthProviderBody, zAddNeonAuthOauthProviderPath, zAddProjectJwksBody, zAddProjectJwksPath, zAddProjectJwksRequest, zAdvisorCategory, zAdvisorIssue, zAllowedIps, zAnnotationCreateValueRequest, zAnnotationData, zAnnotationObjectData, zAnnotationResponse, zAnnotationValueData, zAnnotationsMapResponse, zAnonymizationRunMetadata, zAnonymizedBranchStatusResponse, zApiKeyCreateRequest, zApiKeyCreateResponse, zApiKeyCreatorData, zApiKeyRevokeResponse, zApiKeysListResponseItem, zApplicationType, zAssignOrganizationVpcEndpointBody, zAssignOrganizationVpcEndpointPath, zAssignProjectVpcEndpointBody, zAssignProjectVpcEndpointPath, zAuthDetailsResponse, zAvailablePreloadLibraries, zAvailablePreloadLibrary, zBackupSchedule, zBackupScheduleItem, zBillingAccount, zBillingAccountState, zBillingPaymentMethod, zBillingSubscriptionType, zBranch, zBranchAiGateway, zBranchAiGatewayNotEnabled, zBranchAnonymizedCreateRequest, zBranchCreateRequest, zBranchCreateRequestEndpointOptions, zBranchOperations, zBranchRecoverResponse, zBranchRecoveryInfo, zBranchResponse, zBranchRestoreRequest, zBranchRestoreStatus, zBranchRestrictedAction, zBranchSchemaCompareResponse, zBranchSchemaJson, zBranchSchemaResponse, zBranchState, zBranchStorage, zBranchStorageNotEnabled, zBranchUpdateRequest, zBranchesCountResponse, zBranchesResponse, zBucket, zBucketAccessLevel, zBucketCreateRequest, zBucketObject, zBucketObjectsDeletePrefixResponse, zBucketObjectsListResponse, zBucketResponse, zBucketsListResponse, zComputeUnit, zConnectionDetails, zConnectionParameters, zConnectionUriResponse, zConnectionUrisOptionalResponse, zConnectionUrisResponse, zConsumptionHistoryGranularity, zConsumptionHistoryPerBranchV2, zConsumptionHistoryPerBranchV2Response, zConsumptionHistoryPerPeriod, zConsumptionHistoryPerPeriodV2, zConsumptionHistoryPerProject, zConsumptionHistoryPerProjectResponse, zConsumptionHistoryPerProjectV2, zConsumptionHistoryPerProjectV2Response, zConsumptionHistoryPerTimeframe, zConsumptionHistoryPerTimeframeV2, zConsumptionHistoryQueryMetrics, zConsumptionMetricValue, zCountProjectBranchesPath, zCountProjectBranchesQuery, zCountProjectsQuery, zCreateApiKeyBody, zCreateBranchNeonAuthNewUserBody, zCreateBranchNeonAuthNewUserPath, zCreateBranchNeonAuthNewUserRequest, zCreateCredentialBody, zCreateCredentialPath, zCreateCredentialRequest, zCreateCredentialResponse, zCreateNeonAuthBody, zCreateNeonAuthIntegrationBody, zCreateNeonAuthNewUserBody, zCreateNeonAuthOAuthClientBody, zCreateNeonAuthOAuthClientPath, zCreateNeonAuthPath, zCreateNeonAuthProviderSdkKeysBody, zCreateOrgApiKeyBody, zCreateOrgApiKeyPath, zCreateOrganizationInvitationsBody, zCreateOrganizationInvitationsPath, zCreateProjectBody, zCreateProjectBranchAnonymizedBody, zCreateProjectBranchAnonymizedPath, zCreateProjectBranchBody, zCreateProjectBranchBucketBody, zCreateProjectBranchBucketPath, zCreateProjectBranchDataApiBody, zCreateProjectBranchDataApiPath, zCreateProjectBranchDatabaseBody, zCreateProjectBranchDatabasePath, zCreateProjectBranchFunctionDeploymentBody, zCreateProjectBranchFunctionDeploymentPath, zCreateProjectBranchPath, zCreateProjectBranchRoleBody, zCreateProjectBranchRolePath, zCreateProjectBranchTriggerBody, zCreateProjectBranchTriggerPath, zCreateProjectEndpointBody, zCreateProjectEndpointPath, zCreateProjectTransferRequestBody, zCreateProjectTransferRequestPath, zCreateSnapshotPath, zCreateSnapshotQuery, zCredentialMeta, zCredentialScope, zCredentialSecret, zCurrentUserAuthAccount, zCurrentUserInfoResponse, zCursorPagination, zCursorPaginationResponse, zCursorParam, zCustomDomain, zCustomDomainRegisterRequest, zCustomDomainsListResponse, zDataApiCreateRequest, zDataApiCreateResponse, zDataApiReponse, zDataApiSettings, zDataApiUpdateRequest, zDatabase, zDatabaseCreateRequest, zDatabaseOperations, zDatabaseResponse, zDatabaseUpdateRequest, zDatabasesResponse, zDefaultEndpointSettings, zDeleteBranchNeonAuthOauthProviderPath, zDeleteBranchNeonAuthTrustedDomainBody, zDeleteBranchNeonAuthTrustedDomainPath, zDeleteBranchNeonAuthUserPath, zDeleteNeonAuthDomainFromRedirectUriWhitelistBody, zDeleteNeonAuthDomainFromRedirectUriWhitelistPath, zDeleteNeonAuthIntegrationBody, zDeleteNeonAuthIntegrationPath, zDeleteNeonAuthOAuthClientPath, zDeleteNeonAuthOauthProviderPath, zDeleteNeonAuthUserPath, zDeleteOrganizationSpendingLimitPath, zDeleteOrganizationVpcEndpointPath, zDeleteProjectBranchBucketObjectPath, zDeleteProjectBranchBucketObjectsByPrefixPath, zDeleteProjectBranchBucketObjectsByPrefixQuery, zDeleteProjectBranchBucketPath, zDeleteProjectBranchCustomDomainPath, zDeleteProjectBranchDataApiPath, zDeleteProjectBranchDatabasePath, zDeleteProjectBranchFunctionPath, zDeleteProjectBranchPath, zDeleteProjectBranchRolePath, zDeleteProjectBranchTriggerPath, zDeleteProjectEndpointPath, zDeleteProjectJwksPath, zDeleteProjectPath, zDeleteProjectVpcEndpointPath, zDeleteSnapshotPath, zDisableNeonAuthBody, zDisableNeonAuthPath, zDisableProjectBranchRealtimePath, zEmptyResponse, zEnableNeonAuthIntegrationRequest, zEnableProjectBranchRealtimeBody, zEnableProjectBranchRealtimePath, zEndpoint, zEndpointCreateRequest, zEndpointOperations, zEndpointPoolerMode, zEndpointResponse, zEndpointSettingsData, zEndpointState, zEndpointType, zEndpointUpdateRequest, zEndpointsOptionalResponse, zEndpointsResponse, zErrorCode, zFinalizeRestoreBranchBody, zFinalizeRestoreBranchPath, zFunctionDeployRequest, zFunctionTriggerSchedule, zFunctionTriggerStorageObjectCreated, zGeneralError, zGetActiveRegionsQuery, zGetAnonymizedBranchStatusPath, zGetAvailablePreloadLibrariesPath, zGetConnectionUriPath, zGetConnectionUriQuery, zGetConsumptionHistoryPerBranchV2Query, zGetConsumptionHistoryPerProjectQuery, zGetConsumptionHistoryPerProjectV2Query, zGetMaskingRulesPath, zGetNeonAuthAllowLocalhostPath, zGetNeonAuthEmailAndPasswordConfigPath, zGetNeonAuthEmailProviderPath, zGetNeonAuthEmailServerPath, zGetNeonAuthOAuthClientPath, zGetNeonAuthOAuthProviderPluginPath, zGetNeonAuthPath, zGetNeonAuthPhoneNumberPluginPath, zGetNeonAuthPluginConfigsPath, zGetNeonAuthWebhookConfigPath, zGetOrganizationInvitationsPath, zGetOrganizationMemberPath, zGetOrganizationMembersPath, zGetOrganizationMembersQuery, zGetOrganizationPath, zGetOrganizationSpendingLimitPath, zGetOrganizationVpcEndpointDetailsPath, zGetProjectAdvisorSecurityIssuesPath, zGetProjectAdvisorSecurityIssuesQuery, zGetProjectBranchAiGatewayPath, zGetProjectBranchBucketObjectPath, zGetProjectBranchDataApiPath, zGetProjectBranchDatabasePath, zGetProjectBranchFunctionPath, zGetProjectBranchPath, zGetProjectBranchRealtimePath, zGetProjectBranchRealtimeSecretPath, zGetProjectBranchRolePasswordPath, zGetProjectBranchRolePath, zGetProjectBranchSchemaComparisonPath, zGetProjectBranchSchemaComparisonQuery, zGetProjectBranchSchemaPath, zGetProjectBranchSchemaQuery, zGetProjectBranchStoragePath, zGetProjectBranchTriggerPath, zGetProjectEndpointPath, zGetProjectJwksPath, zGetProjectOperationPath, zGetProjectPath, zGetSnapshotSchedulePath, zGrantPermissionToProjectBody, zGrantPermissionToProjectPath, zGrantPermissionToProjectRequest, zGrantedCredentialScope, zIdentityProviderId, zInvitation, zJwks, zJwksCreationOperation, zJwksResponse, zLimitParam, zLimitsUnsatisfiedResponse, zListBranchNeonAuthOauthProvidersPath, zListBranchNeonAuthTrustedDomainsPath, zListCredentialsPath, zListCredentialsResponse, zListNeonAuthIntegrationsPath, zListNeonAuthIntegrationsResponse, zListNeonAuthOAuthClientsPath, zListNeonAuthOAuthClientsResponse, zListNeonAuthOauthProvidersPath, zListNeonAuthOauthProvidersResponse, zListNeonAuthRedirectUriWhitelistDomainsPath, zListOrgApiKeysPath, zListOrganizationVpcEndpointsAllRegionsPath, zListOrganizationVpcEndpointsPath, zListProjectBranchBucketObjectsPath, zListProjectBranchBucketObjectsQuery, zListProjectBranchBucketsPath, zListProjectBranchCustomDomainsPath, zListProjectBranchCustomDomainsQuery, zListProjectBranchDatabasesPath, zListProjectBranchEndpointsPath, zListProjectBranchFunctionsPath, zListProjectBranchFunctionsQuery, zListProjectBranchLogFieldValuesPath, zListProjectBranchLogFieldValuesQuery, zListProjectBranchLogFieldsPath, zListProjectBranchRolesPath, zListProjectBranchTriggersPath, zListProjectBranchesPath, zListProjectBranchesQuery, zListProjectEndpointsPath, zListProjectMembersPath, zListProjectMembersQuery, zListProjectOperationsPath, zListProjectOperationsQuery, zListProjectPermissionsPath, zListProjectVpcEndpointsPath, zListProjectsQuery, zListSharedProjectsQuery, zListSnapshotsPath, zMaintenanceWindow, zMaskingRule, zMaskingRulesResponse, zMaskingRulesUpdateRequest, zMember, zMemberRole, zMemberUserInfo, zMemberWithUser, zNeonAuthAddDomainToRedirectUriWhitelistRequest, zNeonAuthAddOAuthProviderRequest, zNeonAuthAllowLocalhostResponse, zNeonAuthConfigResponse, zNeonAuthConfigUpdate, zNeonAuthCreateAuthProviderSdkKeysRequest, zNeonAuthCreateIntegrationRequest, zNeonAuthCreateIntegrationResponse, zNeonAuthCreateNewUserRequest, zNeonAuthCreateNewUserResponse, zNeonAuthDeleteDomainFromRedirectUriWhitelistItem, zNeonAuthDeleteDomainFromRedirectUriWhitelistRequest, zNeonAuthEmailAndPasswordConfig, zNeonAuthEmailAndPasswordConfigUpdate, zNeonAuthEmailServerConfig, zNeonAuthEmailServerConfigResponse, zNeonAuthEmailVerificationMethod, zNeonAuthIntegration, zNeonAuthMagicLinkConfig, zNeonAuthMagicLinkConfigUpdate, zNeonAuthOAuthClient, zNeonAuthOAuthClientCreateRequest, zNeonAuthOAuthClientCreated, zNeonAuthOAuthClientSecret, zNeonAuthOAuthClientType, zNeonAuthOAuthClientUpdateRequest, zNeonAuthOAuthProviderConfig, zNeonAuthOAuthProviderConfigUpdate, zNeonAuthOAuthProviderMcp, zNeonAuthOAuthProviderMcpUpdate, zNeonAuthOAuthProviderResource, zNeonAuthOauthProvider, zNeonAuthOauthProviderId, zNeonAuthOauthProviderType, zNeonAuthOrganizationConfig, zNeonAuthOrganizationConfigUpdate, zNeonAuthPhoneNumberConfig, zNeonAuthPhoneNumberConfigUpdate, zNeonAuthPluginConfigs, zNeonAuthProviderProjectOwnedBy, zNeonAuthProviderProjectTransferStatus, zNeonAuthRedirectUriWhitelistDomain, zNeonAuthRedirectUriWhitelistResponse, zNeonAuthSupportedAuthProvider, zNeonAuthTransferAuthProviderProjectRequest, zNeonAuthTransferAuthProviderProjectResponse, zNeonAuthUpdateOAuthProviderRequest, zNeonAuthWebhookConfig, zNeonFunction, zNeonFunctionDeployment, zNeonFunctionDeploymentResponse, zNeonFunctionResponse, zNeonFunctionUpdateRequest, zNeonFunctionsListResponse, zOperation, zOperationAction, zOperationResponse, zOperationStatus, zOperationsResponse, zOrgApiKeyCreateRequest, zOrgApiKeyCreateResponse, zOrgApiKeyRevokeResponse, zOrgApiKeysListResponseItem, zOrganization, zOrganizationInvitationsResponse, zOrganizationInviteCreateRequest, zOrganizationInvitesCreateRequest, zOrganizationMemberUpdateRequest, zOrganizationMembersResponse, zOrganizationsResponse, zPagination, zPaginationResponse, zPaymentSource, zPaymentSourceBankCard, zPgSettingsData, zPgVersion, zPgbouncerSettingsData, zPlanDetails, zPlanVersion, zPreloadLibraries, zPresignProjectBranchBucketObjectBody, zPresignProjectBranchBucketObjectPath, zPresignRequest, zPresignResponse, zProject, zProjectAuditLogLevel, zProjectBranchLogDuration, zProjectBranchLogFieldValuesResponse, zProjectBranchLogFieldsResponse, zProjectBranchLogRecord, zProjectBranchLogSeverity, zProjectBranchLogSource, zProjectBranchLogsInvalidQuery, zProjectBranchLogsNotAvailable, zProjectBranchLogsQueryRequest, zProjectBranchLogsQueryResponse, zProjectCreateRequest, zProjectJwksResponse, zProjectListItem, zProjectMember, zProjectMemberGrantSource, zProjectMemberOrgRole, zProjectMemberRoleResponse, zProjectMembers, zProjectOwnerData, zProjectPermission, zProjectPermissionLevel, zProjectPermissions, zProjectQuota, zProjectRecoverResponse, zProjectResponse, zProjectRole, zProjectSettingsData, zProjectTransferRequestResponse, zProjectUpdateRequest, zProjectsApplicationsMapResponse, zProjectsCountResponse, zProjectsIntegrationsMapResponse, zProjectsResponse, zProjectsWithIntegrationResponse, zProvisioner, zQueryProjectBranchLogsBody, zQueryProjectBranchLogsPath, zRealtime, zRealtimeOptions, zRealtimeSecret, zRecoverProjectPath, zRegionResponse, zRegisterProjectBranchCustomDomainBody, zRegisterProjectBranchCustomDomainPath, zRemoveOrganizationMemberPath, zRemoveProjectMemberRolePath, zRemoveProjectMemberRoleQuery, zResetProjectBranchRolePasswordPath, zRestartProjectEndpointPath, zRestoreProjectBranchBody, zRestoreProjectBranchPath, zRestoreSnapshotBody, zRestoreSnapshotPath, zRestoreSnapshotQuery, zRevealCredentialPath, zRevokeApiKeyPath, zRevokeCredentialPath, zRevokeOrgApiKeyPath, zRevokePermissionFromProjectPath, zRole, zRoleCreateRequest, zRoleOperations, zRolePasswordResponse, zRoleResponse, zRolesResponse, zRotateCredentialPath, zRotateCredentialResponse, zRotateNeonAuthOAuthClientSecretPath, zRotateProjectBranchRealtimeSecretPath, zScheduleTrigger, zScheduleTriggerCreateRequest, zScheduleTriggerUpdateRequest, zSendNeonAuthEmailProviderTestBody, zSendNeonAuthEmailProviderTestPath, zSendNeonAuthEmailProviderTestRequest, zSendNeonAuthTestEmailBody, zSendNeonAuthTestEmailPath, zSendNeonAuthTestEmailRequest, zSendNeonAuthTestEmailResponse, zSetDefaultProjectBranchPath, zSetOrganizationSpendingLimitBody, zSetOrganizationSpendingLimitPath, zSetProjectMemberRoleBody, zSetProjectMemberRolePath, zSetProjectMemberRoleQuery, zSetProjectMemberRoleRequest, zSetSnapshotScheduleBody, zSetSnapshotSchedulePath, zSharedEmailServer, zSnapshot, zSnapshotUpdateRequest, zSortOrderParam, zSpendingLimitResponse, zSpendingLimitUpdateRequest, zStandardEmailServer, zStandardEmailServerResponse, zStartAnonymizationPath, zStartProjectEndpointPath, zStorageObjectCreatedTrigger, zStorageObjectCreatedTriggerCreateRequest, zStorageObjectCreatedTriggerUpdateRequest, zSuspendProjectEndpointPath, zSuspendTimeoutSeconds, zTimeoutParam, zTransferNeonAuthProviderProjectBody, zTransferProjectsFromOrgToOrgBody, zTransferProjectsFromOrgToOrgPath, zTransferProjectsFromUserToOrgBody, zTransferProjectsToOrganizationRequest, zTrigger, zTriggerCreateRequest, zTriggerId, zTriggerResponse, zTriggerUpdateRequest, zTriggersListResponse, zUpdateBranchNeonAuthOauthProviderBody, zUpdateBranchNeonAuthOauthProviderPath, zUpdateMaskingRulesBody, zUpdateMaskingRulesPath, zUpdateNeonAuthAllowLocalhostBody, zUpdateNeonAuthAllowLocalhostPath, zUpdateNeonAuthAllowLocalhostRequest, zUpdateNeonAuthConfigBody, zUpdateNeonAuthConfigPath, zUpdateNeonAuthEmailAndPasswordConfigBody, zUpdateNeonAuthEmailAndPasswordConfigPath, zUpdateNeonAuthEmailProviderBody, zUpdateNeonAuthEmailProviderPath, zUpdateNeonAuthEmailServerBody, zUpdateNeonAuthEmailServerPath, zUpdateNeonAuthMagicLinkPluginBody, zUpdateNeonAuthMagicLinkPluginPath, zUpdateNeonAuthOAuthClientBody, zUpdateNeonAuthOAuthClientPath, zUpdateNeonAuthOAuthProviderPluginBody, zUpdateNeonAuthOAuthProviderPluginPath, zUpdateNeonAuthOauthProviderBody, zUpdateNeonAuthOauthProviderPath, zUpdateNeonAuthOrganizationPluginBody, zUpdateNeonAuthOrganizationPluginPath, zUpdateNeonAuthPhoneNumberPluginBody, zUpdateNeonAuthPhoneNumberPluginPath, zUpdateNeonAuthUserRoleBody, zUpdateNeonAuthUserRolePath, zUpdateNeonAuthUserRoleRequest, zUpdateNeonAuthUserRoleResponse, zUpdateNeonAuthWebhookConfigBody, zUpdateNeonAuthWebhookConfigPath, zUpdateOrganizationMemberBody, zUpdateOrganizationMemberPath, zUpdateProjectBody, zUpdateProjectBranchBody, zUpdateProjectBranchDataApiBody, zUpdateProjectBranchDataApiPath, zUpdateProjectBranchDatabaseBody, zUpdateProjectBranchDatabasePath, zUpdateProjectBranchFunctionBody, zUpdateProjectBranchFunctionPath, zUpdateProjectBranchPath, zUpdateProjectBranchTriggerBody, zUpdateProjectBranchTriggerPath, zUpdateProjectEndpointBody, zUpdateProjectEndpointPath, zUpdateProjectPath, zUpdateSnapshotBody, zUpdateSnapshotPath, zVpcEndpoint, zVpcEndpointAssignment, zVpcEndpointDetails, zVpcEndpointWithRegion, zVpcEndpointsResponse, zVpcEndpointsWithRegionResponse };