@neon/sdk 1.5.0 → 2.0.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.
- package/README.md +194 -28
- package/dist/client/client/client.gen.js +1 -3
- package/dist/client/client/client.gen.js.map +1 -1
- package/dist/client/client/utils.gen.js +1 -3
- package/dist/client/client/utils.gen.js.map +1 -1
- package/dist/client/index.d.ts +3 -3
- package/dist/client/index.js +2 -2
- package/dist/client/raw.gen.d.ts +146 -16
- package/dist/client/raw.gen.d.ts.map +1 -1
- package/dist/client/raw.gen.js +8 -3
- package/dist/client/raw.gen.js.map +1 -1
- package/dist/client/sdk.gen.d.ts +137 -78
- package/dist/client/sdk.gen.d.ts.map +1 -1
- package/dist/client/sdk.gen.js +258 -96
- package/dist/client/sdk.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1397 -315
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/index.d.ts +5 -4
- package/dist/neon/client.d.ts +2 -0
- package/dist/neon/client.d.ts.map +1 -1
- package/dist/neon/client.js +2 -0
- package/dist/neon/client.js.map +1 -1
- package/dist/neon/context.js +2 -1
- package/dist/neon/context.js.map +1 -1
- package/dist/neon/coverage.d.ts.map +1 -1
- package/dist/neon/coverage.js +12 -2
- package/dist/neon/coverage.js.map +1 -1
- package/dist/neon/paginate.d.ts.map +1 -1
- package/dist/neon/paginate.js +5 -2
- package/dist/neon/paginate.js.map +1 -1
- package/dist/neon/resources/branches.d.ts +0 -7
- package/dist/neon/resources/branches.d.ts.map +1 -1
- package/dist/neon/resources/branches.js +6 -15
- package/dist/neon/resources/branches.js.map +1 -1
- package/dist/neon/resources/logs.d.ts +76 -0
- package/dist/neon/resources/logs.d.ts.map +1 -0
- package/dist/neon/resources/logs.js +90 -0
- package/dist/neon/resources/logs.js.map +1 -0
- package/dist/neon/resources/postgres.js +2 -1
- package/dist/neon/resources/postgres.js.map +1 -1
- package/dist/neon/resources/projects.d.ts +61 -4
- package/dist/neon/resources/projects.d.ts.map +1 -1
- package/dist/neon/resources/projects.js +71 -5
- package/dist/neon/resources/projects.js.map +1 -1
- package/dist/raw.d.ts +3 -3
- package/dist/raw.js +8 -3
- package/package.json +1 -1
|
@@ -3,29 +3,17 @@ type ClientOptions = {
|
|
|
3
3
|
baseUrl: 'https://console.neon.tech/api/v2' | (string & {});
|
|
4
4
|
};
|
|
5
5
|
type ComputeUnit = number;
|
|
6
|
-
/**
|
|
7
|
-
* The Neon compute provisioner.
|
|
8
|
-
* Specify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling.
|
|
9
|
-
*
|
|
10
|
-
* Provisioner can be one of the following values:
|
|
11
|
-
* * k8s-pod
|
|
12
|
-
* * k8s-neonvm
|
|
13
|
-
* * serverless-platform
|
|
14
|
-
*
|
|
15
|
-
* Clients must expect, that any string value that is not documented in the description above should be treated as a error. UNKNOWN value if safe to treat as an error too.
|
|
16
|
-
*
|
|
17
|
-
*/
|
|
18
6
|
type Provisioner = string;
|
|
19
7
|
type PaginationResponse = {
|
|
20
8
|
pagination?: Pagination;
|
|
21
9
|
};
|
|
22
10
|
/**
|
|
23
|
-
* Cursor
|
|
24
|
-
* For more information about cursor based pagination, see
|
|
25
|
-
* https://learn.microsoft.com/en-us/ef/core/querying/pagination#keyset-pagination
|
|
26
|
-
*
|
|
11
|
+
* Cursor-based pagination. The `cursor` value reflects the endpoint's sort field (for example, an ID or timestamp), so pass it back unchanged.
|
|
27
12
|
*/
|
|
28
13
|
type Pagination = {
|
|
14
|
+
/**
|
|
15
|
+
* Cursor marking the last item in this response. Pass it unchanged as the `cursor` query parameter to fetch the next page.
|
|
16
|
+
*/
|
|
29
17
|
cursor: string;
|
|
30
18
|
};
|
|
31
19
|
/**
|
|
@@ -35,6 +23,9 @@ type EmptyResponse = {
|
|
|
35
23
|
[key: string]: unknown;
|
|
36
24
|
};
|
|
37
25
|
type PlanDetails = {
|
|
26
|
+
/**
|
|
27
|
+
* Plan name, for example `free`, `launch`, or `scale`.
|
|
28
|
+
*/
|
|
38
29
|
name: string;
|
|
39
30
|
version?: PlanVersion;
|
|
40
31
|
};
|
|
@@ -47,7 +38,7 @@ type PlanVersion = {
|
|
|
47
38
|
*/
|
|
48
39
|
type AddProjectJwksRequest = {
|
|
49
40
|
/**
|
|
50
|
-
*
|
|
41
|
+
* URL of the provider's JWKS endpoint used to verify JWTs.
|
|
51
42
|
*/
|
|
52
43
|
jwks_url: string;
|
|
53
44
|
/**
|
|
@@ -55,39 +46,39 @@ type AddProjectJwksRequest = {
|
|
|
55
46
|
*/
|
|
56
47
|
provider_name: string;
|
|
57
48
|
/**
|
|
58
|
-
*
|
|
49
|
+
* The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
|
|
59
50
|
*/
|
|
60
51
|
branch_id?: string;
|
|
61
52
|
/**
|
|
62
|
-
*
|
|
53
|
+
* Expected `aud` claim in incoming JWTs. When set, tokens with a different audience are rejected; tokens with no audience are still accepted. Omit to skip audience validation.
|
|
63
54
|
*/
|
|
64
55
|
jwt_audience?: string;
|
|
65
56
|
/**
|
|
66
|
-
*
|
|
57
|
+
* Deprecated. The roles the JWKS should be mapped to. By default, the JWKS is mapped to the `authenticator`, `authenticated`, and `anonymous` roles.
|
|
67
58
|
*
|
|
68
59
|
* @deprecated
|
|
69
60
|
*/
|
|
70
61
|
role_names?: Array<string>;
|
|
71
62
|
/**
|
|
72
|
-
*
|
|
63
|
+
* Deprecated. Only used with Neon RLS. If true, role creation is skipped.
|
|
73
64
|
*/
|
|
74
65
|
skip_role_creation?: boolean;
|
|
75
66
|
};
|
|
76
67
|
type Jwks = {
|
|
77
68
|
/**
|
|
78
|
-
* JWKS ID
|
|
69
|
+
* The JWKS configuration's ID.
|
|
79
70
|
*/
|
|
80
71
|
id: string;
|
|
81
72
|
/**
|
|
82
|
-
*
|
|
73
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
83
74
|
*/
|
|
84
75
|
project_id: string;
|
|
85
76
|
/**
|
|
86
|
-
*
|
|
77
|
+
* The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
|
|
87
78
|
*/
|
|
88
79
|
branch_id?: string;
|
|
89
80
|
/**
|
|
90
|
-
*
|
|
81
|
+
* URL of the provider's JWKS endpoint used to verify JWTs.
|
|
91
82
|
*/
|
|
92
83
|
jwks_url: string;
|
|
93
84
|
/**
|
|
@@ -103,15 +94,21 @@ type Jwks = {
|
|
|
103
94
|
*/
|
|
104
95
|
updated_at: string;
|
|
105
96
|
/**
|
|
106
|
-
*
|
|
97
|
+
* Expected JWT `aud` claim value configured for this JWKS.
|
|
107
98
|
*/
|
|
108
99
|
jwt_audience?: string;
|
|
100
|
+
/**
|
|
101
|
+
* Database role names that are permitted to authenticate using this JWKS configuration.
|
|
102
|
+
*/
|
|
109
103
|
role_names?: Array<string>;
|
|
110
104
|
};
|
|
111
105
|
/**
|
|
112
106
|
* The list of configured JWKS definitions for a project
|
|
113
107
|
*/
|
|
114
108
|
type ProjectJwksResponse = {
|
|
109
|
+
/**
|
|
110
|
+
* JWKS configurations associated with the project.
|
|
111
|
+
*/
|
|
115
112
|
jwks: Array<Jwks>;
|
|
116
113
|
};
|
|
117
114
|
/**
|
|
@@ -176,7 +173,7 @@ type OrgApiKeyCreateRequest = ApiKeyCreateRequest & {
|
|
|
176
173
|
};
|
|
177
174
|
type ApiKeyCreateResponse = {
|
|
178
175
|
/**
|
|
179
|
-
* The API key ID
|
|
176
|
+
* The API key's unique numeric ID. Distinct from the API key token (`key`).
|
|
180
177
|
*/
|
|
181
178
|
id: number;
|
|
182
179
|
/**
|
|
@@ -204,7 +201,7 @@ type OrgApiKeyCreateResponse = ApiKeyCreateResponse & {
|
|
|
204
201
|
};
|
|
205
202
|
type ApiKeyRevokeResponse = {
|
|
206
203
|
/**
|
|
207
|
-
* The API key ID
|
|
204
|
+
* The API key's unique numeric ID. Distinct from the API key token (`key`).
|
|
208
205
|
*/
|
|
209
206
|
id: number;
|
|
210
207
|
/**
|
|
@@ -240,7 +237,7 @@ type OrgApiKeyRevokeResponse = ApiKeyRevokeResponse & {
|
|
|
240
237
|
};
|
|
241
238
|
type ApiKeysListResponseItem = {
|
|
242
239
|
/**
|
|
243
|
-
* The API key ID
|
|
240
|
+
* The API key's unique numeric ID. Distinct from the API key token (`key`).
|
|
244
241
|
*/
|
|
245
242
|
id: number;
|
|
246
243
|
/**
|
|
@@ -276,7 +273,7 @@ type ApiKeyCreatorData = {
|
|
|
276
273
|
*/
|
|
277
274
|
id: string;
|
|
278
275
|
/**
|
|
279
|
-
*
|
|
276
|
+
* Display name of the user who created the API key.
|
|
280
277
|
*/
|
|
281
278
|
name: string;
|
|
282
279
|
/**
|
|
@@ -284,27 +281,30 @@ type ApiKeyCreatorData = {
|
|
|
284
281
|
*/
|
|
285
282
|
image: string;
|
|
286
283
|
};
|
|
284
|
+
/**
|
|
285
|
+
* 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.
|
|
286
|
+
*/
|
|
287
287
|
type Operation = {
|
|
288
288
|
/**
|
|
289
289
|
* The operation ID
|
|
290
290
|
*/
|
|
291
291
|
id: string;
|
|
292
292
|
/**
|
|
293
|
-
* The
|
|
293
|
+
* The ID of the project this operation ran on.
|
|
294
294
|
*/
|
|
295
295
|
project_id: string;
|
|
296
296
|
/**
|
|
297
|
-
* The branch
|
|
297
|
+
* The ID of the branch this operation ran on.
|
|
298
298
|
*/
|
|
299
299
|
branch_id?: string;
|
|
300
300
|
/**
|
|
301
|
-
* The endpoint
|
|
301
|
+
* The ID of the compute endpoint this operation ran on.
|
|
302
302
|
*/
|
|
303
303
|
endpoint_id?: string;
|
|
304
304
|
action: OperationAction;
|
|
305
305
|
status: OperationStatus;
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
307
|
+
* Human-readable message describing why the operation failed.
|
|
308
308
|
*/
|
|
309
309
|
error?: string;
|
|
310
310
|
/**
|
|
@@ -339,16 +339,16 @@ type OperationsResponse = {
|
|
|
339
339
|
*/
|
|
340
340
|
type OperationAction = 'create_compute' | 'create_timeline' | 'start_compute' | 'suspend_compute' | 'apply_config' | 'check_availability' | 'delete_timeline' | 'create_branch' | 'import_data' | 'tenant_ignore' | 'tenant_attach' | 'tenant_detach' | 'tenant_detach_safekeepers' | 'tenant_attach_safekeepers' | 'tenant_reattach' | 'replace_safekeeper' | 'disable_maintenance' | 'apply_storage_config' | 'prepare_secondary_pageserver' | 'switch_pageserver' | 'detach_parent_branch' | 'timeline_archive' | 'timeline_unarchive' | 'start_reserved_compute' | 'sync_dbs_and_roles_from_compute' | 'apply_schema_from_branch' | 'timeline_mark_invisible' | 'timeline_update_protected_config' | 'prewarm_replica' | 'promote_replica' | 'set_storage_non_dirty' | 'swap_binding_id' | 'finalize_migration' | 'mark_migration_prepared' | 'update_catalog' | 'epc_sync';
|
|
341
341
|
/**
|
|
342
|
-
*
|
|
342
|
+
* 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.
|
|
343
343
|
*/
|
|
344
344
|
type OperationStatus = 'scheduling' | 'running' | 'finished' | 'failed' | 'error' | 'cancelling' | 'cancelled' | 'skipped';
|
|
345
345
|
/**
|
|
346
|
-
* Essential data about the project. Full data is available at
|
|
346
|
+
* Essential data about the project. Full data is available at `GET /projects/{project_id}`.
|
|
347
347
|
*
|
|
348
348
|
*/
|
|
349
349
|
type ProjectListItem = {
|
|
350
350
|
/**
|
|
351
|
-
* The project ID
|
|
351
|
+
* The Neon project ID. Use as the `project_id` path parameter in other endpoints.
|
|
352
352
|
*/
|
|
353
353
|
id: string;
|
|
354
354
|
/**
|
|
@@ -357,7 +357,7 @@ type ProjectListItem = {
|
|
|
357
357
|
*/
|
|
358
358
|
platform_id: string;
|
|
359
359
|
/**
|
|
360
|
-
*
|
|
360
|
+
* Cloud region where the project's Postgres compute and storage reside (for example, `aws-us-east-2`). Valid values are returned by `GET /regions`.
|
|
361
361
|
*
|
|
362
362
|
*/
|
|
363
363
|
region_id: string;
|
|
@@ -396,7 +396,7 @@ type ProjectListItem = {
|
|
|
396
396
|
*/
|
|
397
397
|
active_time: number;
|
|
398
398
|
/**
|
|
399
|
-
*
|
|
399
|
+
* Deprecated. Use `compute_time_seconds` from `GET /projects/{project_id}` instead.
|
|
400
400
|
*
|
|
401
401
|
*
|
|
402
402
|
* @deprecated
|
|
@@ -423,18 +423,20 @@ type ProjectListItem = {
|
|
|
423
423
|
*/
|
|
424
424
|
updated_at: string;
|
|
425
425
|
/**
|
|
426
|
-
* The current space occupied by the project in storage, in bytes. Synthetic storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.
|
|
426
|
+
* The current space occupied by the project in Postgres storage, in bytes. Synthetic Postgres storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.
|
|
427
427
|
*
|
|
428
428
|
*/
|
|
429
429
|
synthetic_storage_size?: number;
|
|
430
430
|
/**
|
|
431
|
-
*
|
|
432
|
-
* A timestamp indicating when the project quota resets
|
|
431
|
+
* Deprecated. Use `consumption_period_end` from `GET /projects/{project_id}` instead. A timestamp indicating when the project quota resets.
|
|
433
432
|
*
|
|
434
433
|
*
|
|
435
434
|
* @deprecated
|
|
436
435
|
*/
|
|
437
436
|
quota_reset_at?: string;
|
|
437
|
+
/**
|
|
438
|
+
* ID of the organization that owns the project.
|
|
439
|
+
*/
|
|
438
440
|
owner_id: string;
|
|
439
441
|
/**
|
|
440
442
|
* The most recent time when any endpoint of this project was active.
|
|
@@ -444,14 +446,12 @@ type ProjectListItem = {
|
|
|
444
446
|
*/
|
|
445
447
|
compute_last_active_at?: string;
|
|
446
448
|
/**
|
|
447
|
-
*
|
|
448
|
-
* Permissions for the project will be given to organization members as defined by the organization admins.
|
|
449
|
-
* The permissions of the project do not depend on the user that created the project if a project belongs to an organization.
|
|
449
|
+
* ID of the organization that owns the project. Project permissions are granted to organization members as configured by the organization's admins, independent of which member created the project.
|
|
450
450
|
*
|
|
451
451
|
*/
|
|
452
452
|
org_id?: string;
|
|
453
453
|
/**
|
|
454
|
-
*
|
|
454
|
+
* Name of the organization that owns the project.
|
|
455
455
|
*
|
|
456
456
|
*/
|
|
457
457
|
org_name?: string;
|
|
@@ -476,7 +476,7 @@ type ProjectListItem = {
|
|
|
476
476
|
};
|
|
477
477
|
type Project = {
|
|
478
478
|
/**
|
|
479
|
-
* Bytes-Hour. Project consumed that much storage hourly during the billing period. The value has some lag.
|
|
479
|
+
* Bytes-Hour. Project consumed that much Postgres storage hourly during the billing period. The value has some lag.
|
|
480
480
|
* The value is reset at the beginning of each billing period.
|
|
481
481
|
*
|
|
482
482
|
*/
|
|
@@ -488,7 +488,7 @@ type Project = {
|
|
|
488
488
|
*/
|
|
489
489
|
data_transfer_bytes: number;
|
|
490
490
|
/**
|
|
491
|
-
* Bytes. Amount of WAL that travelled through storage for given project across all branches.
|
|
491
|
+
* Bytes. Amount of WAL that travelled through Postgres storage for given project across all branches.
|
|
492
492
|
* The value has some lag. The value is reset at the beginning of each billing period.
|
|
493
493
|
*
|
|
494
494
|
*/
|
|
@@ -510,14 +510,14 @@ type Project = {
|
|
|
510
510
|
*/
|
|
511
511
|
active_time_seconds: number;
|
|
512
512
|
/**
|
|
513
|
-
*
|
|
513
|
+
* Deprecated. Use `compute_time_seconds` instead.
|
|
514
514
|
*
|
|
515
515
|
*
|
|
516
516
|
* @deprecated
|
|
517
517
|
*/
|
|
518
518
|
cpu_used_sec: number;
|
|
519
519
|
/**
|
|
520
|
-
* The project ID
|
|
520
|
+
* The Neon project ID. Use as the `project_id` path parameter in other endpoints.
|
|
521
521
|
*/
|
|
522
522
|
id: string;
|
|
523
523
|
/**
|
|
@@ -526,7 +526,7 @@ type Project = {
|
|
|
526
526
|
*/
|
|
527
527
|
platform_id: string;
|
|
528
528
|
/**
|
|
529
|
-
*
|
|
529
|
+
* Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.
|
|
530
530
|
*
|
|
531
531
|
*/
|
|
532
532
|
region_id: string;
|
|
@@ -585,7 +585,7 @@ type Project = {
|
|
|
585
585
|
*/
|
|
586
586
|
updated_at: string;
|
|
587
587
|
/**
|
|
588
|
-
* The current space occupied by the project in storage, in bytes. Synthetic storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.
|
|
588
|
+
* The current space occupied by the project in Postgres storage, in bytes. Synthetic Postgres storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.
|
|
589
589
|
*
|
|
590
590
|
*/
|
|
591
591
|
synthetic_storage_size?: number;
|
|
@@ -600,13 +600,15 @@ type Project = {
|
|
|
600
600
|
*/
|
|
601
601
|
consumption_period_end: string;
|
|
602
602
|
/**
|
|
603
|
-
*
|
|
604
|
-
* A timestamp indicating when the project quota resets.
|
|
603
|
+
* Deprecated. Use the `consumption_period_end` field instead. A timestamp indicating when the project quota resets.
|
|
605
604
|
*
|
|
606
605
|
*
|
|
607
606
|
* @deprecated
|
|
608
607
|
*/
|
|
609
608
|
quota_reset_at?: string;
|
|
609
|
+
/**
|
|
610
|
+
* ID of the organization that owns the project.
|
|
611
|
+
*/
|
|
610
612
|
owner_id: string;
|
|
611
613
|
owner?: ProjectOwnerData;
|
|
612
614
|
/**
|
|
@@ -616,6 +618,9 @@ type Project = {
|
|
|
616
618
|
*
|
|
617
619
|
*/
|
|
618
620
|
compute_last_active_at?: string;
|
|
621
|
+
/**
|
|
622
|
+
* The Neon organization ID. Returned as `id` from `GET /users/me/organizations`.
|
|
623
|
+
*/
|
|
619
624
|
org_id?: string;
|
|
620
625
|
/**
|
|
621
626
|
* A timestamp indicating when project update begins. If set, computes might experience a brief restart around this time.
|
|
@@ -629,12 +634,18 @@ type Project = {
|
|
|
629
634
|
effective_project_permission?: ProjectPermissionLevel | null;
|
|
630
635
|
};
|
|
631
636
|
type ProjectCreateRequest = {
|
|
637
|
+
/**
|
|
638
|
+
* Configuration for the new project, including name, region, and Postgres compute and storage settings.
|
|
639
|
+
*/
|
|
632
640
|
project: {
|
|
633
641
|
settings?: ProjectSettingsData;
|
|
634
642
|
/**
|
|
635
643
|
* The project name. If not specified, the name will be identical to the generated project ID
|
|
636
644
|
*/
|
|
637
645
|
name?: string;
|
|
646
|
+
/**
|
|
647
|
+
* Configuration for the initial branch created with the project.
|
|
648
|
+
*/
|
|
638
649
|
branch?: {
|
|
639
650
|
/**
|
|
640
651
|
* The default branch name. If not specified, the default branch name, `main`, will be used.
|
|
@@ -669,14 +680,12 @@ type ProjectCreateRequest = {
|
|
|
669
680
|
*/
|
|
670
681
|
store_passwords?: boolean;
|
|
671
682
|
/**
|
|
672
|
-
*
|
|
673
|
-
* The default is 1 day (86400 seconds).
|
|
683
|
+
* History window (point-in-time restore range) for all branches, in seconds. `0` disables it. Default 1 day (Free: 6 hours). Maximum depends on plan: Free 6 hours (21600), Launch 7 days (604800), Scale 30 days (2592000).
|
|
674
684
|
*
|
|
675
685
|
*/
|
|
676
686
|
history_retention_seconds?: number;
|
|
677
687
|
/**
|
|
678
|
-
*
|
|
679
|
-
* If not present, project is owned by a user and not by org.
|
|
688
|
+
* ID of the organization that will own the project. If omitted when using an organization API key, it is inferred from the key.
|
|
680
689
|
*
|
|
681
690
|
*/
|
|
682
691
|
org_id?: string;
|
|
@@ -691,8 +700,7 @@ type ProjectUpdateRequest = {
|
|
|
691
700
|
name?: string;
|
|
692
701
|
default_endpoint_settings?: DefaultEndpointSettings;
|
|
693
702
|
/**
|
|
694
|
-
*
|
|
695
|
-
* The default is 1 day (604800 seconds).
|
|
703
|
+
* History window (point-in-time restore range) for all branches, in seconds. `0` disables it. Default 1 day (Free: 6 hours). Maximum depends on plan: Free 6 hours (21600), Launch 7 days (604800), Scale 30 days (2592000).
|
|
696
704
|
*
|
|
697
705
|
*/
|
|
698
706
|
history_retention_seconds?: number;
|
|
@@ -717,6 +725,9 @@ type ProjectTransferRequestResponse = {
|
|
|
717
725
|
expires_at: string;
|
|
718
726
|
};
|
|
719
727
|
type AcceptProjectTransferRequestSatisfiesPlanError = {
|
|
728
|
+
/**
|
|
729
|
+
* List of reasons why the target account's plan cannot satisfy the transfer requirements. Each item contains a `code` identifying the constraint and a `message` with a human-readable explanation.
|
|
730
|
+
*/
|
|
720
731
|
reasons: Array<{
|
|
721
732
|
/**
|
|
722
733
|
* Description of why the plan is not satisfied
|
|
@@ -753,6 +764,9 @@ type ProjectSettingsData = {
|
|
|
753
764
|
*/
|
|
754
765
|
block_vpc_connections?: boolean;
|
|
755
766
|
audit_log_level?: ProjectAuditLogLevel;
|
|
767
|
+
/**
|
|
768
|
+
* Enables HIPAA compliance mode for the project, including audit logging.
|
|
769
|
+
*/
|
|
756
770
|
hipaa?: boolean;
|
|
757
771
|
preload_libraries?: PreloadLibraries;
|
|
758
772
|
};
|
|
@@ -761,6 +775,9 @@ type ProjectResponse = {
|
|
|
761
775
|
};
|
|
762
776
|
type ProjectRecoverResponse = ProjectResponse & BranchesResponse;
|
|
763
777
|
type ProjectsResponse = {
|
|
778
|
+
/**
|
|
779
|
+
* List of projects accessible to the caller. Projects that exist but could not be retrieved are identified in `unavailable_project_ids`.
|
|
780
|
+
*/
|
|
764
781
|
projects: Array<ProjectListItem>;
|
|
765
782
|
/**
|
|
766
783
|
* A list of project IDs indicating which projects are known to exist, but whose details could not
|
|
@@ -770,17 +787,38 @@ type ProjectsResponse = {
|
|
|
770
787
|
unavailable_project_ids?: Array<string>;
|
|
771
788
|
};
|
|
772
789
|
type ProjectPermission = {
|
|
790
|
+
/**
|
|
791
|
+
* The project permission's ID.
|
|
792
|
+
*/
|
|
773
793
|
id: string;
|
|
794
|
+
/**
|
|
795
|
+
* Email address of the user who has been granted access to the project.
|
|
796
|
+
*/
|
|
774
797
|
granted_to_email: string;
|
|
798
|
+
/**
|
|
799
|
+
* Timestamp when the permission was granted.
|
|
800
|
+
*/
|
|
775
801
|
granted_at: string;
|
|
802
|
+
/**
|
|
803
|
+
* Timestamp when the permission was revoked. Null if the permission is still active.
|
|
804
|
+
*/
|
|
776
805
|
revoked_at?: string;
|
|
777
806
|
};
|
|
778
807
|
type ProjectPermissions = {
|
|
779
808
|
project_permissions: Array<ProjectPermission>;
|
|
780
809
|
};
|
|
781
810
|
type GrantPermissionToProjectRequest = {
|
|
811
|
+
/**
|
|
812
|
+
* Email address of the user to grant project access to.
|
|
813
|
+
*/
|
|
782
814
|
email: string;
|
|
783
815
|
};
|
|
816
|
+
/**
|
|
817
|
+
* Per-project role. `viewer` maps to `VIEWER`, `editor` maps to `EDITOR`,
|
|
818
|
+
* and `admin` maps to `ADMIN`.
|
|
819
|
+
*
|
|
820
|
+
*/
|
|
821
|
+
type ProjectRole = 'viewer' | 'editor' | 'admin';
|
|
784
822
|
/**
|
|
785
823
|
* The caller's effective permission for a project when
|
|
786
824
|
* per-project permissions are enabled. `VIEWER` grants read access,
|
|
@@ -790,38 +828,125 @@ type GrantPermissionToProjectRequest = {
|
|
|
790
828
|
*
|
|
791
829
|
*/
|
|
792
830
|
type ProjectPermissionLevel = 'VIEWER' | 'EDITOR' | 'ADMIN';
|
|
831
|
+
/**
|
|
832
|
+
* How a member's project access is granted.
|
|
833
|
+
*
|
|
834
|
+
*/
|
|
835
|
+
type ProjectMemberGrantSource = 'explicit' | 'org_role_default' | 'org_admin_override' | 'unassigned';
|
|
836
|
+
/**
|
|
837
|
+
* Organization-level role used by project member role management.
|
|
838
|
+
*
|
|
839
|
+
*/
|
|
840
|
+
type ProjectMemberOrgRole = 'admin' | 'member' | 'editor' | 'viewer' | 'collaborator';
|
|
841
|
+
type ProjectMember = {
|
|
842
|
+
/**
|
|
843
|
+
* The organization member ID.
|
|
844
|
+
*/
|
|
845
|
+
member_id: string;
|
|
846
|
+
/**
|
|
847
|
+
* The user ID for the organization member.
|
|
848
|
+
*/
|
|
849
|
+
user_id: string;
|
|
850
|
+
/**
|
|
851
|
+
* Email address of the user who has been granted access to the project.
|
|
852
|
+
*/
|
|
853
|
+
email?: string;
|
|
854
|
+
/**
|
|
855
|
+
* The user's display name.
|
|
856
|
+
*/
|
|
857
|
+
name?: string;
|
|
858
|
+
org_role: ProjectMemberOrgRole;
|
|
859
|
+
project_role?: ProjectRole;
|
|
860
|
+
org_default_project_permission?: ProjectPermissionLevel;
|
|
861
|
+
explicit_project_permission?: ProjectPermissionLevel;
|
|
862
|
+
effective_project_permission?: ProjectPermissionLevel;
|
|
863
|
+
grant_source?: ProjectMemberGrantSource;
|
|
864
|
+
};
|
|
865
|
+
type ProjectMembers = {
|
|
866
|
+
project_members: Array<ProjectMember>;
|
|
867
|
+
pagination?: CursorPagination;
|
|
868
|
+
};
|
|
869
|
+
type SetProjectMemberRoleRequest = {
|
|
870
|
+
role: ProjectRole;
|
|
871
|
+
};
|
|
872
|
+
type ProjectMemberRoleResponse = {
|
|
873
|
+
project_id: string;
|
|
874
|
+
member_id: string;
|
|
875
|
+
user_id: string;
|
|
876
|
+
/**
|
|
877
|
+
* Email address of the user who has been granted access to the project.
|
|
878
|
+
*/
|
|
879
|
+
email?: string;
|
|
880
|
+
/**
|
|
881
|
+
* The user's display name.
|
|
882
|
+
*/
|
|
883
|
+
name?: string;
|
|
884
|
+
org_role: ProjectMemberOrgRole;
|
|
885
|
+
project_role?: ProjectRole;
|
|
886
|
+
org_default_project_permission?: ProjectPermissionLevel;
|
|
887
|
+
explicit_project_permission?: ProjectPermissionLevel;
|
|
888
|
+
effective_project_permission?: ProjectPermissionLevel;
|
|
889
|
+
/**
|
|
890
|
+
* Hint that database credentials may need rotation after the role change.
|
|
891
|
+
*
|
|
892
|
+
*/
|
|
893
|
+
credential_rotation_recommended?: boolean;
|
|
894
|
+
/**
|
|
895
|
+
* Hint that project-scoped org API keys created by the target user may need rotation.
|
|
896
|
+
*
|
|
897
|
+
*/
|
|
898
|
+
org_api_key_rotation_recommended?: boolean;
|
|
899
|
+
};
|
|
793
900
|
type ConsumptionHistoryPerProjectResponse = {
|
|
901
|
+
/**
|
|
902
|
+
* Per-project consumption history records included in the response.
|
|
903
|
+
*/
|
|
794
904
|
projects: Array<ConsumptionHistoryPerProject>;
|
|
795
905
|
};
|
|
796
906
|
type ConsumptionHistoryPerProjectV2Response = {
|
|
907
|
+
/**
|
|
908
|
+
* Per-project consumption history entries for the requested time range.
|
|
909
|
+
*/
|
|
797
910
|
projects: Array<ConsumptionHistoryPerProjectV2>;
|
|
798
911
|
};
|
|
799
912
|
type ConsumptionHistoryPerProject = {
|
|
800
913
|
/**
|
|
801
|
-
* The project ID
|
|
914
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
802
915
|
*/
|
|
803
916
|
project_id: string;
|
|
917
|
+
/**
|
|
918
|
+
* Consumption periods for the project, each covering a discrete billing interval.
|
|
919
|
+
*/
|
|
804
920
|
periods: Array<ConsumptionHistoryPerPeriod>;
|
|
805
921
|
};
|
|
806
922
|
type ConsumptionHistoryPerProjectV2 = {
|
|
807
923
|
/**
|
|
808
|
-
* The project ID
|
|
924
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
809
925
|
*/
|
|
810
926
|
project_id: string;
|
|
927
|
+
/**
|
|
928
|
+
* Consumption periods recorded for this project.
|
|
929
|
+
*/
|
|
811
930
|
periods: Array<ConsumptionHistoryPerPeriodV2>;
|
|
812
931
|
};
|
|
813
932
|
type ConsumptionHistoryPerBranchV2Response = {
|
|
933
|
+
/**
|
|
934
|
+
* Per-branch consumption history records returned for the requested time range.
|
|
935
|
+
*/
|
|
814
936
|
branches: Array<ConsumptionHistoryPerBranchV2>;
|
|
815
937
|
};
|
|
816
938
|
type ConsumptionHistoryPerBranchV2 = {
|
|
817
939
|
/**
|
|
818
|
-
* The project that owns
|
|
940
|
+
* The ID of the project that owns this branch.
|
|
819
941
|
*/
|
|
820
942
|
project_id: string;
|
|
821
943
|
/**
|
|
822
|
-
* The branch ID
|
|
944
|
+
* The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
|
|
823
945
|
*/
|
|
824
946
|
branch_id: string;
|
|
947
|
+
/**
|
|
948
|
+
* Consumption history records for the branch, grouped by billing period.
|
|
949
|
+
*/
|
|
825
950
|
periods: Array<ConsumptionHistoryPerPeriodV2>;
|
|
826
951
|
};
|
|
827
952
|
type ConsumptionHistoryPerPeriod = {
|
|
@@ -843,6 +968,9 @@ type ConsumptionHistoryPerPeriod = {
|
|
|
843
968
|
*
|
|
844
969
|
*/
|
|
845
970
|
period_end?: string;
|
|
971
|
+
/**
|
|
972
|
+
* Consumption metric records for the billing period.
|
|
973
|
+
*/
|
|
846
974
|
consumption: Array<ConsumptionHistoryPerTimeframe>;
|
|
847
975
|
};
|
|
848
976
|
type ConsumptionHistoryPerPeriodV2 = {
|
|
@@ -864,6 +992,9 @@ type ConsumptionHistoryPerPeriodV2 = {
|
|
|
864
992
|
*
|
|
865
993
|
*/
|
|
866
994
|
period_end?: string;
|
|
995
|
+
/**
|
|
996
|
+
* Consumption metric records for the billing period.
|
|
997
|
+
*/
|
|
867
998
|
consumption: Array<ConsumptionHistoryPerTimeframeV2>;
|
|
868
999
|
};
|
|
869
1000
|
type ConsumptionHistoryPerTimeframe = {
|
|
@@ -893,12 +1024,12 @@ type ConsumptionHistoryPerTimeframe = {
|
|
|
893
1024
|
*/
|
|
894
1025
|
written_data_bytes: number;
|
|
895
1026
|
/**
|
|
896
|
-
* Bytes. The space occupied in storage. Synthetic storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches.
|
|
1027
|
+
* Bytes. The space occupied in Postgres storage. Synthetic Postgres storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches.
|
|
897
1028
|
*
|
|
898
1029
|
*/
|
|
899
1030
|
synthetic_storage_size_bytes: number;
|
|
900
1031
|
/**
|
|
901
|
-
* Bytes-Hour. The amount of storage consumed hourly.
|
|
1032
|
+
* Bytes-Hour. The amount of Postgres storage consumed hourly.
|
|
902
1033
|
*
|
|
903
1034
|
*/
|
|
904
1035
|
data_storage_bytes_hour?: number;
|
|
@@ -924,23 +1055,50 @@ type ConsumptionHistoryPerTimeframeV2 = {
|
|
|
924
1055
|
*
|
|
925
1056
|
*/
|
|
926
1057
|
timeframe_end?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Consumption metric values recorded for the timeframe.
|
|
1060
|
+
*/
|
|
927
1061
|
metrics?: Array<ConsumptionMetricValue>;
|
|
928
1062
|
};
|
|
929
1063
|
type ConsumptionMetricValue = {
|
|
1064
|
+
/**
|
|
1065
|
+
* Name of the consumption metric, such as compute_time or data_storage_bytes_hour.
|
|
1066
|
+
*/
|
|
930
1067
|
metric_name: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* Measured quantity for the metric named by `metric_name`.
|
|
1070
|
+
*/
|
|
931
1071
|
value: number;
|
|
932
1072
|
};
|
|
933
1073
|
type ConsumptionHistoryGranularity = 'hourly' | 'daily' | 'monthly';
|
|
934
1074
|
type ConsumptionHistoryQueryMetrics = Array<string>;
|
|
935
1075
|
type ProjectAuditLogLevel = 'base' | 'extended' | 'full';
|
|
936
1076
|
type AvailablePreloadLibrary = {
|
|
1077
|
+
/**
|
|
1078
|
+
* Name of the Postgres shared preload library as it appears in the `shared_preload_libraries` parameter (for example, `pg_stat_statements`).
|
|
1079
|
+
*/
|
|
937
1080
|
library_name: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* Human-readable explanation of the library's purpose and behavior.
|
|
1083
|
+
*/
|
|
938
1084
|
description: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* Whether this library is loaded by default in the `shared_preload_libraries` configuration for new compute endpoints.
|
|
1087
|
+
*/
|
|
939
1088
|
is_default: boolean;
|
|
1089
|
+
/**
|
|
1090
|
+
* Marks the library as experimental. Experimental libraries may be unstable, subject to breaking changes, or not recommended for production use.
|
|
1091
|
+
*/
|
|
940
1092
|
is_experimental: boolean;
|
|
1093
|
+
/**
|
|
1094
|
+
* Version of the preload library.
|
|
1095
|
+
*/
|
|
941
1096
|
version: string;
|
|
942
1097
|
};
|
|
943
1098
|
type AvailablePreloadLibraries = {
|
|
1099
|
+
/**
|
|
1100
|
+
* Preload libraries available for the project's Postgres version. Each entry includes `library_name`, `description`, `is_default`, `is_experimental`, and `version`.
|
|
1101
|
+
*/
|
|
944
1102
|
libraries?: Array<AvailablePreloadLibrary>;
|
|
945
1103
|
};
|
|
946
1104
|
type Branch = {
|
|
@@ -950,8 +1108,7 @@ type Branch = {
|
|
|
950
1108
|
*/
|
|
951
1109
|
id: string;
|
|
952
1110
|
/**
|
|
953
|
-
* The ID of the project
|
|
954
|
-
*
|
|
1111
|
+
* The ID of the project this branch belongs to.
|
|
955
1112
|
*/
|
|
956
1113
|
project_id: string;
|
|
957
1114
|
/**
|
|
@@ -997,8 +1154,7 @@ type Branch = {
|
|
|
997
1154
|
*/
|
|
998
1155
|
creation_source: string;
|
|
999
1156
|
/**
|
|
1000
|
-
*
|
|
1001
|
-
* Whether the branch is the project's primary branch
|
|
1157
|
+
* Deprecated. Use the `default` field. Whether the branch is the project's primary branch.
|
|
1002
1158
|
*
|
|
1003
1159
|
*
|
|
1004
1160
|
* @deprecated
|
|
@@ -1010,24 +1166,32 @@ type Branch = {
|
|
|
1010
1166
|
*/
|
|
1011
1167
|
default: boolean;
|
|
1012
1168
|
/**
|
|
1013
|
-
* Whether the branch is protected
|
|
1169
|
+
* Whether the branch is protected. Protected branches (and their computes) cannot be deleted, archived, or reset, and block deletion of the project.
|
|
1014
1170
|
*
|
|
1015
1171
|
*/
|
|
1016
1172
|
protected: boolean;
|
|
1017
1173
|
/**
|
|
1018
|
-
* CPU seconds used by all of the branch's compute endpoints, including deleted ones.
|
|
1019
|
-
* This value is reset at the beginning of each billing period.
|
|
1020
|
-
* Examples:
|
|
1021
|
-
* 1. A branch that uses 1 CPU for 1 second is equal to `cpu_used_sec=1`.
|
|
1022
|
-
* 2. A branch that uses 2 CPUs simultaneously for 1 second is equal to `cpu_used_sec=2`.
|
|
1174
|
+
* Deprecated. Use `compute_time_seconds` instead. CPU seconds used by all of the branch's compute endpoints, including deleted ones. This value is reset at the beginning of each billing period.
|
|
1023
1175
|
*
|
|
1024
1176
|
*
|
|
1025
1177
|
* @deprecated
|
|
1026
1178
|
*/
|
|
1027
1179
|
cpu_used_sec: number;
|
|
1180
|
+
/**
|
|
1181
|
+
* Total Postgres compute time consumed by this branch during the current billing period, in CU-seconds (weighted by compute size). Divide by 3600 for CU-hours.
|
|
1182
|
+
*/
|
|
1028
1183
|
compute_time_seconds: number;
|
|
1184
|
+
/**
|
|
1185
|
+
* Total time this branch's compute has been active during the current billing period, in seconds (not weighted by compute size). Distinct from `compute_time_seconds`, which is CU-weighted.
|
|
1186
|
+
*/
|
|
1029
1187
|
active_time_seconds: number;
|
|
1188
|
+
/**
|
|
1189
|
+
* Data written by this branch during the current billing period, in bytes.
|
|
1190
|
+
*/
|
|
1030
1191
|
written_data_bytes: number;
|
|
1192
|
+
/**
|
|
1193
|
+
* Total data transferred out of the branch, in bytes. Used as a consumption metric.
|
|
1194
|
+
*/
|
|
1031
1195
|
data_transfer_bytes: number;
|
|
1032
1196
|
/**
|
|
1033
1197
|
* A timestamp indicating when the branch was created
|
|
@@ -1064,7 +1228,7 @@ type Branch = {
|
|
|
1064
1228
|
*/
|
|
1065
1229
|
created_by?: {
|
|
1066
1230
|
/**
|
|
1067
|
-
*
|
|
1231
|
+
* Display name of the user who created the branch.
|
|
1068
1232
|
*/
|
|
1069
1233
|
name?: string;
|
|
1070
1234
|
/**
|
|
@@ -1073,9 +1237,7 @@ type Branch = {
|
|
|
1073
1237
|
image?: string;
|
|
1074
1238
|
};
|
|
1075
1239
|
/**
|
|
1076
|
-
*
|
|
1077
|
-
* * `schema-only` - creates a new root branch containing only the schema. Use `parent_id` to specify the source branch. Optionally, you can provide `parent_lsn` or `parent_timestamp` to branch from a specific point in time or LSN. These fields define which branch to copy the schema from and at what point—they do not establish a parent-child relationship between the `parent_id` branch and the new schema-only branch.
|
|
1078
|
-
* * `parent-data` - creates the branch with both schema and data from the parent.
|
|
1240
|
+
* Source of initialization for the branch. `parent-data` (default) copies schema and data from the parent. `parent-schema` copies schema only from the parent. `schema-only` creates a root branch with schema only. `import` initializes from an external import.
|
|
1079
1241
|
*
|
|
1080
1242
|
*/
|
|
1081
1243
|
init_source?: string;
|
|
@@ -1102,7 +1264,7 @@ type Branch = {
|
|
|
1102
1264
|
* * 'init' - the branch is being created but is not available for querying.
|
|
1103
1265
|
* * 'resetting' - the branch is being reset to a specific point in time or LSN and is not yet available for querying.
|
|
1104
1266
|
* * 'ready' - the branch is fully operational and ready for querying. Expect normal query response times.
|
|
1105
|
-
* * 'archived' - the branch is stored in cost-effective archival storage. Expect slow query response times.
|
|
1267
|
+
* * 'archived' - the branch is stored in cost-effective archival Postgres storage. Expect slow query response times.
|
|
1106
1268
|
*
|
|
1107
1269
|
*/
|
|
1108
1270
|
type BranchState = string;
|
|
@@ -1119,7 +1281,7 @@ type BranchRestoreStatus = string;
|
|
|
1119
1281
|
*/
|
|
1120
1282
|
type BranchRestrictedAction = {
|
|
1121
1283
|
/**
|
|
1122
|
-
* The name of a restricted action
|
|
1284
|
+
* The name of a restricted action on a branch. `restore`: the branch cannot be used as a restore target. `delete-rw-endpoint`: the read-write endpoint for the branch cannot be deleted.
|
|
1123
1285
|
*
|
|
1124
1286
|
*/
|
|
1125
1287
|
name: string;
|
|
@@ -1176,7 +1338,13 @@ type BranchAnonymizedCreateRequest = AnnotationCreateValueRequest & {
|
|
|
1176
1338
|
start_anonymization?: boolean;
|
|
1177
1339
|
};
|
|
1178
1340
|
type BranchCreateRequest = {
|
|
1341
|
+
/**
|
|
1342
|
+
* Compute endpoints to create together with the branch. If omitted, the branch is created without any compute endpoint. Endpoints can be added to the branch separately after creation.
|
|
1343
|
+
*/
|
|
1179
1344
|
endpoints?: Array<BranchCreateRequestEndpointOptions>;
|
|
1345
|
+
/**
|
|
1346
|
+
* 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`.
|
|
1347
|
+
*/
|
|
1180
1348
|
branch?: {
|
|
1181
1349
|
/**
|
|
1182
1350
|
* The `branch_id` of the parent branch. If omitted or empty, the branch will be created from the project's default branch.
|
|
@@ -1194,26 +1362,22 @@ type BranchCreateRequest = {
|
|
|
1194
1362
|
*/
|
|
1195
1363
|
parent_lsn?: string;
|
|
1196
1364
|
/**
|
|
1197
|
-
* A timestamp identifying a point in time on the parent branch. The branch will be created with data starting from this point in time.
|
|
1198
|
-
* The timestamp must be provided in ISO 8601 format; for example: `2024-02-26T12:00:00Z`.
|
|
1365
|
+
* A timestamp identifying a point in time on the parent branch. The branch will be created with data starting from this point in time. RFC 3339 format.
|
|
1199
1366
|
*
|
|
1200
1367
|
*/
|
|
1201
1368
|
parent_timestamp?: string;
|
|
1202
1369
|
/**
|
|
1203
|
-
* Whether the branch is protected
|
|
1370
|
+
* Whether the branch is protected. Protected branches (and their computes) cannot be deleted, archived, or reset, and block deletion of the project. Can be gated by `protected_branches_only` in the IP allowlist. Paid plans only.
|
|
1204
1371
|
*
|
|
1205
1372
|
*/
|
|
1206
1373
|
protected?: boolean;
|
|
1207
1374
|
/**
|
|
1208
|
-
* Whether to create the branch as archived
|
|
1375
|
+
* Whether to create the branch in the archived state. When omitted, the branch is created as a normal (non-archived) branch.
|
|
1209
1376
|
*
|
|
1210
1377
|
*/
|
|
1211
1378
|
archived?: boolean;
|
|
1212
1379
|
/**
|
|
1213
|
-
*
|
|
1214
|
-
* * `schema-only` - creates a new root branch containing only the schema. Use `parent_id` to specify the source branch. Optionally, you can provide `parent_lsn` or `parent_timestamp` to branch from a specific point in time or LSN. These fields define which branch to copy the schema from and at what point—they do not establish a parent-child relationship between the `parent_id` branch and the new schema-only branch.
|
|
1215
|
-
* * `parent-data` - creates the branch with both schema and data from the parent.
|
|
1216
|
-
*
|
|
1380
|
+
* Source of initialization for the branch. `parent-data` copies schema and data from the parent branch. `parent-schema` copies schema only from the parent branch. `schema-only` creates a new root branch containing schema only, using `parent_id` as the source; optionally, `parent_lsn` or `parent_timestamp` can narrow the source point. `import` initializes the branch from an external import.
|
|
1217
1381
|
*/
|
|
1218
1382
|
init_source?: string;
|
|
1219
1383
|
/**
|
|
@@ -1226,8 +1390,18 @@ type BranchCreateRequest = {
|
|
|
1226
1390
|
};
|
|
1227
1391
|
};
|
|
1228
1392
|
type BranchUpdateRequest = {
|
|
1393
|
+
/**
|
|
1394
|
+
* Branch attributes to update. Supply only the fields you want to change, for example `name` or `protected`.
|
|
1395
|
+
*/
|
|
1229
1396
|
branch: {
|
|
1397
|
+
/**
|
|
1398
|
+
* New display name for the branch.
|
|
1399
|
+
*/
|
|
1230
1400
|
name?: string;
|
|
1401
|
+
/**
|
|
1402
|
+
* Whether the branch is protected. Protected branches (and their computes) cannot be deleted, archived, or reset, and block deletion of the project. Can be gated by `protected_branches_only` in the IP allowlist. Paid plans only.
|
|
1403
|
+
*
|
|
1404
|
+
*/
|
|
1231
1405
|
protected?: boolean;
|
|
1232
1406
|
/**
|
|
1233
1407
|
* The timestamp when the branch is scheduled to expire and be automatically deleted. Must be set by the client following the [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6) format with precision up to seconds (such as 2025-06-09T18:02:16Z). Deletion is performed by a background job and may not occur exactly at the specified time. If this field is set to null, the expiration timestamp is removed.
|
|
@@ -1247,19 +1421,18 @@ type BranchRestoreRequest = {
|
|
|
1247
1421
|
*/
|
|
1248
1422
|
source_branch_id: string;
|
|
1249
1423
|
/**
|
|
1250
|
-
* A
|
|
1424
|
+
* A Postgres LSN (for example, `0/1A2B3C4`) on the source branch to restore from.
|
|
1425
|
+
* Mutually exclusive with `source_timestamp`. Omit both to restore to head.
|
|
1251
1426
|
*
|
|
1252
1427
|
*/
|
|
1253
1428
|
source_lsn?: string;
|
|
1254
1429
|
/**
|
|
1255
|
-
* A
|
|
1256
|
-
* The timestamp must be provided in ISO 8601 format; for example: `2024-02-26T12:00:00Z`.
|
|
1430
|
+
* A point in time on the source branch to restore from, in RFC 3339 format. When omitted alongside `source_lsn`, the branch is restored to the latest available state of the source branch.
|
|
1257
1431
|
*
|
|
1258
1432
|
*/
|
|
1259
1433
|
source_timestamp?: string;
|
|
1260
1434
|
/**
|
|
1261
|
-
*
|
|
1262
|
-
* If the branch has children or the `source_branch_id` is equal to the branch id, this field is required. All existing child branches will be moved to the newly created branch under the name `preserve_under_name`.
|
|
1435
|
+
* Name under which to save the current branch state before restoring. Required when the branch has children or when `source_branch_id` equals the branch being restored; in those cases all existing child branches are moved to the newly created branch. If omitted and not required, the previous state is not preserved.
|
|
1263
1436
|
*
|
|
1264
1437
|
*/
|
|
1265
1438
|
preserve_under_name?: string;
|
|
@@ -1268,16 +1441,28 @@ type BranchResponse = {
|
|
|
1268
1441
|
branch: Branch;
|
|
1269
1442
|
};
|
|
1270
1443
|
type BranchSchemaResponse = {
|
|
1444
|
+
/**
|
|
1445
|
+
* Branch schema expressed as SQL DDL statements.
|
|
1446
|
+
*/
|
|
1271
1447
|
sql?: string;
|
|
1272
1448
|
json?: BranchSchemaJson;
|
|
1273
1449
|
};
|
|
1274
1450
|
type BranchSchemaCompareResponse = {
|
|
1451
|
+
/**
|
|
1452
|
+
* Unified diff of the SQL schema changes between the compared branches.
|
|
1453
|
+
*/
|
|
1275
1454
|
diff?: string;
|
|
1276
1455
|
};
|
|
1277
1456
|
type BranchesResponse = {
|
|
1457
|
+
/**
|
|
1458
|
+
* Branches in the project. Each includes `id`, `name`, `current_state`, and `created_at`.
|
|
1459
|
+
*/
|
|
1278
1460
|
branches: Array<Branch>;
|
|
1279
1461
|
};
|
|
1280
1462
|
type BranchesCountResponse = {
|
|
1463
|
+
/**
|
|
1464
|
+
* Total number of branches in the project.
|
|
1465
|
+
*/
|
|
1281
1466
|
count: number;
|
|
1282
1467
|
};
|
|
1283
1468
|
type MaskingRule = {
|
|
@@ -1331,17 +1516,15 @@ type MaskingRulesUpdateRequest = {
|
|
|
1331
1516
|
};
|
|
1332
1517
|
type AnonymizedBranchStatusResponse = {
|
|
1333
1518
|
/**
|
|
1334
|
-
* The ID of the project
|
|
1335
|
-
*
|
|
1519
|
+
* The ID of the project this branch belongs to.
|
|
1336
1520
|
*/
|
|
1337
1521
|
project_id: string;
|
|
1338
1522
|
/**
|
|
1339
|
-
* The ID of the anonymized branch
|
|
1340
|
-
*
|
|
1523
|
+
* The ID of the anonymized branch.
|
|
1341
1524
|
*/
|
|
1342
1525
|
branch_id: string;
|
|
1343
1526
|
/**
|
|
1344
|
-
* The current state of the anonymized branch.
|
|
1527
|
+
* The current state of the anonymized branch. `created`: branch record exists but setup has not started. `initialized`: setup is complete and the branch is ready for anonymization. `initialization_error`: an error occurred during setup. `anonymizing`: the anonymization process is currently running. `anonymized`: anonymization completed successfully. `error`: an error occurred during anonymization.
|
|
1345
1528
|
*
|
|
1346
1529
|
*/
|
|
1347
1530
|
state: string;
|
|
@@ -1400,27 +1583,27 @@ type AnonymizationRunMetadata = {
|
|
|
1400
1583
|
};
|
|
1401
1584
|
type ConnectionParameters = {
|
|
1402
1585
|
/**
|
|
1403
|
-
*
|
|
1586
|
+
* Name of the Postgres database used in the connection URI.
|
|
1404
1587
|
*
|
|
1405
1588
|
*/
|
|
1406
1589
|
database: string;
|
|
1407
1590
|
/**
|
|
1408
|
-
*
|
|
1591
|
+
* Authentication password for the role, used in the connection URI.
|
|
1409
1592
|
*
|
|
1410
1593
|
*/
|
|
1411
1594
|
password: string;
|
|
1412
1595
|
/**
|
|
1413
|
-
*
|
|
1596
|
+
* Postgres role used to authenticate the database connection.
|
|
1414
1597
|
*
|
|
1415
1598
|
*/
|
|
1416
1599
|
role: string;
|
|
1417
1600
|
/**
|
|
1418
|
-
* Hostname
|
|
1601
|
+
* Hostname of the compute endpoint. Use `pooler_host` for the pooled connection hostname.
|
|
1419
1602
|
*
|
|
1420
1603
|
*/
|
|
1421
1604
|
host: string;
|
|
1422
1605
|
/**
|
|
1423
|
-
*
|
|
1606
|
+
* PgBouncer (transaction mode) pooled host, the `-pooler` variant of `host`. Connect through it to work around the Postgres `max_connections` limit for serverless or connection-per-request workloads.
|
|
1424
1607
|
*
|
|
1425
1608
|
*/
|
|
1426
1609
|
pooler_host: string;
|
|
@@ -1459,19 +1642,17 @@ type Endpoint = {
|
|
|
1459
1642
|
*/
|
|
1460
1643
|
name?: string;
|
|
1461
1644
|
/**
|
|
1462
|
-
* The ID of the project
|
|
1463
|
-
*
|
|
1645
|
+
* The ID of the project this compute endpoint belongs to.
|
|
1464
1646
|
*/
|
|
1465
1647
|
project_id: string;
|
|
1466
1648
|
/**
|
|
1467
|
-
* The ID of the branch
|
|
1468
|
-
*
|
|
1649
|
+
* The ID of the branch this compute endpoint belongs to.
|
|
1469
1650
|
*/
|
|
1470
1651
|
branch_id: string;
|
|
1471
1652
|
autoscaling_limit_min_cu: ComputeUnit;
|
|
1472
1653
|
autoscaling_limit_max_cu: ComputeUnit;
|
|
1473
1654
|
/**
|
|
1474
|
-
*
|
|
1655
|
+
* Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.
|
|
1475
1656
|
*
|
|
1476
1657
|
*/
|
|
1477
1658
|
region_id: string;
|
|
@@ -1480,9 +1661,7 @@ type Endpoint = {
|
|
|
1480
1661
|
pending_state?: EndpointState;
|
|
1481
1662
|
settings: EndpointSettingsData;
|
|
1482
1663
|
/**
|
|
1483
|
-
*
|
|
1484
|
-
* The recommended way to enable connection pooling is to append `-pooler` to the endpoint ID in the connection string.
|
|
1485
|
-
* See [How to use connection pooling](https://neon.com/docs/connect/connection-pooling#how-to-use-connection-pooling)
|
|
1664
|
+
* Deprecated. To use connection pooling, append `-pooler` to the endpoint ID in the connection string.
|
|
1486
1665
|
*
|
|
1487
1666
|
*
|
|
1488
1667
|
* @deprecated
|
|
@@ -1533,7 +1712,7 @@ type Endpoint = {
|
|
|
1533
1712
|
*/
|
|
1534
1713
|
suspended_at?: string;
|
|
1535
1714
|
/**
|
|
1536
|
-
*
|
|
1715
|
+
* Deprecated. Use the `host` property instead.
|
|
1537
1716
|
*
|
|
1538
1717
|
*/
|
|
1539
1718
|
proxy_host: string;
|
|
@@ -1546,17 +1725,15 @@ type Endpoint = {
|
|
|
1546
1725
|
compute_release_version?: string;
|
|
1547
1726
|
};
|
|
1548
1727
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1728
|
+
* Lifecycle state of the compute endpoint. `init`: being initialized. `active`: running and accepting connections. `idle`: suspended (scaled to zero).
|
|
1551
1729
|
*/
|
|
1552
1730
|
type EndpointState = 'init' | 'active' | 'idle';
|
|
1553
1731
|
/**
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1732
|
+
* Compute endpoint type. `read_write`: the primary read-write endpoint (one per branch). `read_only`: a read replica endpoint (multiple allowed per branch).
|
|
1556
1733
|
*/
|
|
1557
1734
|
type EndpointType = 'read_only' | 'read_write';
|
|
1558
1735
|
/**
|
|
1559
|
-
*
|
|
1736
|
+
* Deprecated. The connection pooler mode. Neon supports PgBouncer in `transaction` mode only. Removal scheduled for June 20, 2026.
|
|
1560
1737
|
*
|
|
1561
1738
|
*
|
|
1562
1739
|
* @deprecated
|
|
@@ -1617,10 +1794,19 @@ type MaintenanceWindow = {
|
|
|
1617
1794
|
*
|
|
1618
1795
|
*/
|
|
1619
1796
|
type PreloadLibraries = {
|
|
1797
|
+
/**
|
|
1798
|
+
* When true, the project's preload libraries include the platform default set in addition to any libraries listed in `enabled_libraries`.
|
|
1799
|
+
*/
|
|
1620
1800
|
use_defaults?: boolean;
|
|
1801
|
+
/**
|
|
1802
|
+
* Names of shared preload libraries to enable for the project.
|
|
1803
|
+
*/
|
|
1621
1804
|
enabled_libraries?: Array<string>;
|
|
1622
1805
|
};
|
|
1623
1806
|
type EndpointCreateRequest = {
|
|
1807
|
+
/**
|
|
1808
|
+
* Configuration for the compute endpoint to create.
|
|
1809
|
+
*/
|
|
1624
1810
|
endpoint: {
|
|
1625
1811
|
/**
|
|
1626
1812
|
* The ID of the branch the compute endpoint will be associated with
|
|
@@ -1638,8 +1824,7 @@ type EndpointCreateRequest = {
|
|
|
1638
1824
|
autoscaling_limit_max_cu?: ComputeUnit;
|
|
1639
1825
|
provisioner?: Provisioner;
|
|
1640
1826
|
/**
|
|
1641
|
-
*
|
|
1642
|
-
* The recommended way to enable connection pooling is to append `-pooler` to the endpoint ID in the connection string.
|
|
1827
|
+
* Deprecated. To enable connection pooling, append `-pooler` to the endpoint ID in the connection string.
|
|
1643
1828
|
* See [How to use connection pooling](https://neon.com/docs/connect/connection-pooling#how-to-use-connection-pooling)
|
|
1644
1829
|
*
|
|
1645
1830
|
*
|
|
@@ -1670,10 +1855,12 @@ type EndpointCreateRequest = {
|
|
|
1670
1855
|
};
|
|
1671
1856
|
};
|
|
1672
1857
|
type EndpointUpdateRequest = {
|
|
1858
|
+
/**
|
|
1859
|
+
* Parameters for the compute endpoint update.
|
|
1860
|
+
*/
|
|
1673
1861
|
endpoint: {
|
|
1674
1862
|
/**
|
|
1675
|
-
*
|
|
1676
|
-
* The destination branch ID. The destination branch must not have an existing read-write endpoint.
|
|
1863
|
+
* Deprecated. The destination branch ID; must not have an existing read-write endpoint.
|
|
1677
1864
|
*
|
|
1678
1865
|
*
|
|
1679
1866
|
* @deprecated
|
|
@@ -1684,8 +1871,7 @@ type EndpointUpdateRequest = {
|
|
|
1684
1871
|
provisioner?: Provisioner;
|
|
1685
1872
|
settings?: EndpointSettingsData;
|
|
1686
1873
|
/**
|
|
1687
|
-
*
|
|
1688
|
-
* The recommended way to enable connection pooling is to append `-pooler` to the endpoint ID in the connection string.
|
|
1874
|
+
* Deprecated. To enable connection pooling, append `-pooler` to the endpoint ID in the connection string.
|
|
1689
1875
|
* See [How to use connection pooling](https://neon.com/docs/connect/connection-pooling#how-to-use-connection-pooling)
|
|
1690
1876
|
*
|
|
1691
1877
|
*
|
|
@@ -1719,20 +1905,32 @@ type EndpointResponse = {
|
|
|
1719
1905
|
endpoint: Endpoint;
|
|
1720
1906
|
};
|
|
1721
1907
|
type ConnectionUrisResponse = {
|
|
1908
|
+
/**
|
|
1909
|
+
* Connection URIs for the project. Each entry contains credentials and should be treated as sensitive.
|
|
1910
|
+
*/
|
|
1722
1911
|
connection_uris: Array<ConnectionDetails>;
|
|
1723
1912
|
};
|
|
1724
1913
|
type ConnectionUrisOptionalResponse = {
|
|
1914
|
+
/**
|
|
1915
|
+
* Connection URIs for the compute endpoint, including credentials.
|
|
1916
|
+
*/
|
|
1725
1917
|
connection_uris?: Array<ConnectionDetails>;
|
|
1726
1918
|
};
|
|
1727
1919
|
type VpcEndpointsResponse = {
|
|
1920
|
+
/**
|
|
1921
|
+
* List of VPC endpoints returned by the request.
|
|
1922
|
+
*/
|
|
1728
1923
|
endpoints: Array<VpcEndpoint>;
|
|
1729
1924
|
};
|
|
1730
1925
|
type VpcEndpointsWithRegionResponse = {
|
|
1926
|
+
/**
|
|
1927
|
+
* VPC endpoints associated with the region.
|
|
1928
|
+
*/
|
|
1731
1929
|
endpoints: Array<VpcEndpointWithRegion>;
|
|
1732
1930
|
};
|
|
1733
1931
|
type VpcEndpoint = {
|
|
1734
1932
|
/**
|
|
1735
|
-
*
|
|
1933
|
+
* Cloud provider identifier for the VPC endpoint.
|
|
1736
1934
|
*/
|
|
1737
1935
|
vpc_endpoint_id: string;
|
|
1738
1936
|
/**
|
|
@@ -1748,7 +1946,7 @@ type VpcEndpointWithRegion = VpcEndpoint & {
|
|
|
1748
1946
|
};
|
|
1749
1947
|
type VpcEndpointDetails = {
|
|
1750
1948
|
/**
|
|
1751
|
-
*
|
|
1949
|
+
* Cloud provider identifier for the VPC endpoint.
|
|
1752
1950
|
*/
|
|
1753
1951
|
vpc_endpoint_id: string;
|
|
1754
1952
|
/**
|
|
@@ -1756,9 +1954,7 @@ type VpcEndpointDetails = {
|
|
|
1756
1954
|
*/
|
|
1757
1955
|
label: string;
|
|
1758
1956
|
/**
|
|
1759
|
-
* The current state of the VPC endpoint.
|
|
1760
|
-
* `new` (just configured, pending acceptance) or `accepted`
|
|
1761
|
-
* (VPC connection was accepted by Neon).
|
|
1957
|
+
* The current state of the VPC endpoint. `new` means the endpoint has just been configured and is pending acceptance by Neon. `accepted` means the VPC connection has been accepted by Neon.
|
|
1762
1958
|
*
|
|
1763
1959
|
*/
|
|
1764
1960
|
state: string;
|
|
@@ -1775,22 +1971,30 @@ type VpcEndpointDetails = {
|
|
|
1775
1971
|
example_restricted_projects: Array<string>;
|
|
1776
1972
|
};
|
|
1777
1973
|
type VpcEndpointAssignment = {
|
|
1974
|
+
/**
|
|
1975
|
+
* Human-readable name for the VPC endpoint assignment, used to identify it within the organization.
|
|
1976
|
+
*/
|
|
1778
1977
|
label: string;
|
|
1779
1978
|
};
|
|
1780
1979
|
type EndpointsResponse = {
|
|
1980
|
+
/**
|
|
1981
|
+
* Compute endpoints in the project. Each includes `id`, `branch_id`, `host`, and `type`.
|
|
1982
|
+
*/
|
|
1781
1983
|
endpoints: Array<Endpoint>;
|
|
1782
1984
|
};
|
|
1783
1985
|
type EndpointsOptionalResponse = {
|
|
1986
|
+
/**
|
|
1987
|
+
* Compute endpoints associated with the project.
|
|
1988
|
+
*/
|
|
1784
1989
|
endpoints?: Array<Endpoint>;
|
|
1785
1990
|
};
|
|
1786
1991
|
type Role = {
|
|
1787
1992
|
/**
|
|
1788
|
-
* The ID of the branch
|
|
1789
|
-
*
|
|
1993
|
+
* The ID of the branch this role belongs to.
|
|
1790
1994
|
*/
|
|
1791
1995
|
branch_id: string;
|
|
1792
1996
|
/**
|
|
1793
|
-
*
|
|
1997
|
+
* Postgres role name within the branch.
|
|
1794
1998
|
*
|
|
1795
1999
|
*/
|
|
1796
2000
|
name: string;
|
|
@@ -1805,7 +2009,7 @@ type Role = {
|
|
|
1805
2009
|
*/
|
|
1806
2010
|
protected?: boolean;
|
|
1807
2011
|
/**
|
|
1808
|
-
* Authentication method configured for this role
|
|
2012
|
+
* Authentication method configured for this role: `password`, `oauth`, or `no_login`.
|
|
1809
2013
|
*
|
|
1810
2014
|
*/
|
|
1811
2015
|
authentication_method?: string;
|
|
@@ -1821,6 +2025,9 @@ type Role = {
|
|
|
1821
2025
|
updated_at: string;
|
|
1822
2026
|
};
|
|
1823
2027
|
type RoleCreateRequest = {
|
|
2028
|
+
/**
|
|
2029
|
+
* Properties of the role to create.
|
|
2030
|
+
*/
|
|
1824
2031
|
role: {
|
|
1825
2032
|
/**
|
|
1826
2033
|
* The role name. Cannot exceed 63 bytes in length.
|
|
@@ -1841,6 +2048,10 @@ type JwksResponse = {
|
|
|
1841
2048
|
jwks: Jwks;
|
|
1842
2049
|
};
|
|
1843
2050
|
type RolesResponse = {
|
|
2051
|
+
/**
|
|
2052
|
+
* Roles belonging to the branch. Each role includes fields such as `branch_id`, `name`, `protected`, `created_at`, and `updated_at`.
|
|
2053
|
+
*
|
|
2054
|
+
*/
|
|
1844
2055
|
roles: Array<Role>;
|
|
1845
2056
|
};
|
|
1846
2057
|
type RolePasswordResponse = {
|
|
@@ -1857,7 +2068,7 @@ type PaymentSourceBankCard = {
|
|
|
1857
2068
|
*/
|
|
1858
2069
|
last4: string;
|
|
1859
2070
|
/**
|
|
1860
|
-
*
|
|
2071
|
+
* Card network reported by the payment processor. Set to `unknown` when the network cannot be determined.
|
|
1861
2072
|
*
|
|
1862
2073
|
*/
|
|
1863
2074
|
brand?: 'amex' | 'diners' | 'discover' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa';
|
|
@@ -1886,7 +2097,7 @@ type BillingAccount = {
|
|
|
1886
2097
|
subscription_type: BillingSubscriptionType;
|
|
1887
2098
|
payment_method: BillingPaymentMethod;
|
|
1888
2099
|
/**
|
|
1889
|
-
*
|
|
2100
|
+
* Timestamp of the last quota reset. Set to the account creation time when the account is first created.
|
|
1890
2101
|
*
|
|
1891
2102
|
*/
|
|
1892
2103
|
quota_reset_at_last: string;
|
|
@@ -2002,8 +2213,7 @@ type Database = {
|
|
|
2002
2213
|
*/
|
|
2003
2214
|
id: number;
|
|
2004
2215
|
/**
|
|
2005
|
-
* The ID of the branch
|
|
2006
|
-
*
|
|
2216
|
+
* The ID of the branch this database belongs to.
|
|
2007
2217
|
*/
|
|
2008
2218
|
branch_id: string;
|
|
2009
2219
|
/**
|
|
@@ -2028,9 +2238,12 @@ type Database = {
|
|
|
2028
2238
|
updated_at: string;
|
|
2029
2239
|
};
|
|
2030
2240
|
type DatabaseCreateRequest = {
|
|
2241
|
+
/**
|
|
2242
|
+
* Configuration for the new Postgres database.
|
|
2243
|
+
*/
|
|
2031
2244
|
database: {
|
|
2032
2245
|
/**
|
|
2033
|
-
*
|
|
2246
|
+
* Name of the database to create.
|
|
2034
2247
|
*
|
|
2035
2248
|
*/
|
|
2036
2249
|
name: string;
|
|
@@ -2042,9 +2255,12 @@ type DatabaseCreateRequest = {
|
|
|
2042
2255
|
};
|
|
2043
2256
|
};
|
|
2044
2257
|
type DatabaseUpdateRequest = {
|
|
2258
|
+
/**
|
|
2259
|
+
* Properties to update on the database.
|
|
2260
|
+
*/
|
|
2045
2261
|
database: {
|
|
2046
2262
|
/**
|
|
2047
|
-
*
|
|
2263
|
+
* Name of the database to update.
|
|
2048
2264
|
*
|
|
2049
2265
|
*/
|
|
2050
2266
|
name?: string;
|
|
@@ -2059,9 +2275,15 @@ type DatabaseResponse = {
|
|
|
2059
2275
|
database: Database;
|
|
2060
2276
|
};
|
|
2061
2277
|
type DatabasesResponse = {
|
|
2278
|
+
/**
|
|
2279
|
+
* Databases on the branch. Each includes `id`, `name`, `owner_name`, and `created_at`.
|
|
2280
|
+
*/
|
|
2062
2281
|
databases: Array<Database>;
|
|
2063
2282
|
};
|
|
2064
2283
|
type Invitation = {
|
|
2284
|
+
/**
|
|
2285
|
+
* The invitation ID.
|
|
2286
|
+
*/
|
|
2065
2287
|
id: string;
|
|
2066
2288
|
/**
|
|
2067
2289
|
* Email of the invited user
|
|
@@ -2082,19 +2304,32 @@ type Invitation = {
|
|
|
2082
2304
|
role: MemberRole;
|
|
2083
2305
|
};
|
|
2084
2306
|
/**
|
|
2085
|
-
*
|
|
2086
|
-
* available for all organizations.
|
|
2087
|
-
*
|
|
2307
|
+
* 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.
|
|
2088
2308
|
*/
|
|
2089
2309
|
type MemberRole = 'admin' | 'member' | 'editor' | 'viewer' | 'collaborator';
|
|
2090
2310
|
type Member = {
|
|
2311
|
+
/**
|
|
2312
|
+
* The organization member's ID.
|
|
2313
|
+
*/
|
|
2091
2314
|
id: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* The Neon user ID.
|
|
2317
|
+
*/
|
|
2092
2318
|
user_id: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* The Neon organization ID. Returned as `id` from `GET /users/me/organizations`.
|
|
2321
|
+
*/
|
|
2093
2322
|
org_id: string;
|
|
2094
2323
|
role: MemberRole;
|
|
2324
|
+
/**
|
|
2325
|
+
* Timestamp when the user joined the organization.
|
|
2326
|
+
*/
|
|
2095
2327
|
joined_at?: string;
|
|
2096
2328
|
};
|
|
2097
2329
|
type MemberUserInfo = {
|
|
2330
|
+
/**
|
|
2331
|
+
* Email address of the organization member's user account.
|
|
2332
|
+
*/
|
|
2098
2333
|
email: string;
|
|
2099
2334
|
/**
|
|
2100
2335
|
* Whether the member has MFA (TOTP) enabled
|
|
@@ -2113,9 +2348,21 @@ type MemberWithUser = {
|
|
|
2113
2348
|
user: MemberUserInfo;
|
|
2114
2349
|
};
|
|
2115
2350
|
type Organization = {
|
|
2351
|
+
/**
|
|
2352
|
+
* The Neon organization ID. Use as the `org_id` path parameter in other endpoints.
|
|
2353
|
+
*/
|
|
2116
2354
|
id: string;
|
|
2355
|
+
/**
|
|
2356
|
+
* Human-readable display name of the organization.
|
|
2357
|
+
*/
|
|
2117
2358
|
name: string;
|
|
2359
|
+
/**
|
|
2360
|
+
* URL-safe identifier for the organization, used in API paths. Distinct from the display name.
|
|
2361
|
+
*/
|
|
2118
2362
|
handle: string;
|
|
2363
|
+
/**
|
|
2364
|
+
* Billing plan for the organization, for example `free`, `launch`, or `scale`.
|
|
2365
|
+
*/
|
|
2119
2366
|
plan: string;
|
|
2120
2367
|
/**
|
|
2121
2368
|
* A timestamp indicting when the organization was created
|
|
@@ -2143,22 +2390,37 @@ type Organization = {
|
|
|
2143
2390
|
require_mfa?: boolean;
|
|
2144
2391
|
};
|
|
2145
2392
|
type OrganizationsResponse = {
|
|
2393
|
+
/**
|
|
2394
|
+
* Organizations returned by the request. Each includes `id`, `name`, `handle`, and `plan`.
|
|
2395
|
+
*/
|
|
2146
2396
|
organizations: Array<Organization>;
|
|
2147
2397
|
};
|
|
2148
2398
|
type OrganizationInvitationsResponse = {
|
|
2399
|
+
/**
|
|
2400
|
+
* List of pending invitations for the organization.
|
|
2401
|
+
*/
|
|
2149
2402
|
invitations: Array<Invitation>;
|
|
2150
2403
|
};
|
|
2151
2404
|
type OrganizationInviteCreateRequest = {
|
|
2405
|
+
/**
|
|
2406
|
+
* Email address of the person to invite to the organization.
|
|
2407
|
+
*/
|
|
2152
2408
|
email: string;
|
|
2153
2409
|
role: MemberRole;
|
|
2154
2410
|
};
|
|
2155
2411
|
type OrganizationInvitesCreateRequest = {
|
|
2412
|
+
/**
|
|
2413
|
+
* Invitations to create for the organization.
|
|
2414
|
+
*/
|
|
2156
2415
|
invitations: Array<OrganizationInviteCreateRequest>;
|
|
2157
2416
|
};
|
|
2158
2417
|
type OrganizationMemberUpdateRequest = {
|
|
2159
2418
|
role: MemberRole;
|
|
2160
2419
|
};
|
|
2161
2420
|
type OrganizationMembersResponse = {
|
|
2421
|
+
/**
|
|
2422
|
+
* Members of the organization, each combining membership details (role, status) with the associated user's identity.
|
|
2423
|
+
*/
|
|
2162
2424
|
members: Array<MemberWithUser>;
|
|
2163
2425
|
};
|
|
2164
2426
|
type ActiveRegionsResponse = {
|
|
@@ -2169,7 +2431,7 @@ type ActiveRegionsResponse = {
|
|
|
2169
2431
|
};
|
|
2170
2432
|
type RegionResponse = {
|
|
2171
2433
|
/**
|
|
2172
|
-
*
|
|
2434
|
+
* Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.
|
|
2173
2435
|
*/
|
|
2174
2436
|
region_id: string;
|
|
2175
2437
|
/**
|
|
@@ -2177,7 +2439,7 @@ type RegionResponse = {
|
|
|
2177
2439
|
*/
|
|
2178
2440
|
name: string;
|
|
2179
2441
|
/**
|
|
2180
|
-
*
|
|
2442
|
+
* True if this region is selected by default when no region is specified during project creation.
|
|
2181
2443
|
*/
|
|
2182
2444
|
default: boolean;
|
|
2183
2445
|
/**
|
|
@@ -2190,15 +2452,24 @@ type RegionResponse = {
|
|
|
2190
2452
|
geo_long: string;
|
|
2191
2453
|
};
|
|
2192
2454
|
type CurrentUserAuthAccount = {
|
|
2455
|
+
/**
|
|
2456
|
+
* Email address associated with this auth account.
|
|
2457
|
+
*/
|
|
2193
2458
|
email: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* URL of the user's profile picture as provided by the identity provider.
|
|
2461
|
+
*/
|
|
2194
2462
|
image: string;
|
|
2195
2463
|
/**
|
|
2196
|
-
*
|
|
2464
|
+
* Deprecated. Use the `email` field.
|
|
2197
2465
|
*
|
|
2198
2466
|
*
|
|
2199
2467
|
* @deprecated
|
|
2200
2468
|
*/
|
|
2201
2469
|
login: string;
|
|
2470
|
+
/**
|
|
2471
|
+
* Display name of the account as provided by the identity provider.
|
|
2472
|
+
*/
|
|
2202
2473
|
name: string;
|
|
2203
2474
|
provider: IdentityProviderId;
|
|
2204
2475
|
};
|
|
@@ -2209,20 +2480,44 @@ type CurrentUserInfoResponse = {
|
|
|
2209
2480
|
*/
|
|
2210
2481
|
active_seconds_limit: number;
|
|
2211
2482
|
billing_account?: BillingAccount;
|
|
2483
|
+
/**
|
|
2484
|
+
* Authentication provider accounts linked to the current user.
|
|
2485
|
+
*/
|
|
2212
2486
|
auth_accounts: Array<CurrentUserAuthAccount>;
|
|
2487
|
+
/**
|
|
2488
|
+
* Email address of the authenticated user.
|
|
2489
|
+
*/
|
|
2213
2490
|
email: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* The Neon user ID.
|
|
2493
|
+
*/
|
|
2214
2494
|
id: string;
|
|
2495
|
+
/**
|
|
2496
|
+
* URL of the user's profile avatar image.
|
|
2497
|
+
*/
|
|
2215
2498
|
image: string;
|
|
2216
2499
|
/**
|
|
2217
|
-
*
|
|
2500
|
+
* Deprecated. Use the `email` field.
|
|
2218
2501
|
*
|
|
2219
2502
|
*
|
|
2220
2503
|
* @deprecated
|
|
2221
2504
|
*/
|
|
2222
2505
|
login: string;
|
|
2506
|
+
/**
|
|
2507
|
+
* First name of the current user.
|
|
2508
|
+
*/
|
|
2223
2509
|
name: string;
|
|
2510
|
+
/**
|
|
2511
|
+
* Last name of the current user.
|
|
2512
|
+
*/
|
|
2224
2513
|
last_name: string;
|
|
2514
|
+
/**
|
|
2515
|
+
* Maximum number of projects the account is allowed to create under the current plan.
|
|
2516
|
+
*/
|
|
2225
2517
|
projects_limit: number;
|
|
2518
|
+
/**
|
|
2519
|
+
* Maximum number of branches allowed for the account under the current plan.
|
|
2520
|
+
*/
|
|
2226
2521
|
branches_limit: number;
|
|
2227
2522
|
/**
|
|
2228
2523
|
* The maximum autoscaling limit in Compute Units.
|
|
@@ -2230,11 +2525,29 @@ type CurrentUserInfoResponse = {
|
|
|
2230
2525
|
*
|
|
2231
2526
|
*/
|
|
2232
2527
|
max_autoscaling_limit: number;
|
|
2528
|
+
/**
|
|
2529
|
+
* Maximum Postgres compute time, in seconds, allowed under the account's current plan.
|
|
2530
|
+
*/
|
|
2233
2531
|
compute_seconds_limit?: number;
|
|
2532
|
+
/**
|
|
2533
|
+
* Current billing plan for the user's account.
|
|
2534
|
+
*/
|
|
2234
2535
|
plan: string;
|
|
2235
2536
|
};
|
|
2236
2537
|
type AuthDetailsResponse = {
|
|
2538
|
+
/**
|
|
2539
|
+
* The ID of the account associated with this authentication record.
|
|
2540
|
+
*/
|
|
2237
2541
|
account_id: string;
|
|
2542
|
+
/**
|
|
2543
|
+
* Authentication method used for the request:
|
|
2544
|
+
* - `keycloak`: Keycloak identity provider authentication.
|
|
2545
|
+
* - `session_cookie`: Browser session cookie authentication.
|
|
2546
|
+
* - `api_key_user`: API key scoped to a user account.
|
|
2547
|
+
* - `api_key_org`: API key scoped to an organization.
|
|
2548
|
+
* - `oauth`: OAuth-based authentication.
|
|
2549
|
+
*
|
|
2550
|
+
*/
|
|
2238
2551
|
auth_method: 'keycloak' | 'session_cookie' | 'api_key_user' | 'api_key_org' | 'oauth';
|
|
2239
2552
|
auth_data?: string;
|
|
2240
2553
|
};
|
|
@@ -2328,7 +2641,7 @@ type PgSettingsData = {
|
|
|
2328
2641
|
[key: string]: string;
|
|
2329
2642
|
};
|
|
2330
2643
|
/**
|
|
2331
|
-
*
|
|
2644
|
+
* Deprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.
|
|
2332
2645
|
*
|
|
2333
2646
|
*
|
|
2334
2647
|
* @deprecated
|
|
@@ -2337,16 +2650,28 @@ type PgbouncerSettingsData = {
|
|
|
2337
2650
|
[key: string]: string;
|
|
2338
2651
|
};
|
|
2339
2652
|
/**
|
|
2340
|
-
* The major Postgres version number.
|
|
2653
|
+
* 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.
|
|
2341
2654
|
*/
|
|
2342
2655
|
type PgVersion = number;
|
|
2343
2656
|
type ProjectOwnerData = {
|
|
2657
|
+
/**
|
|
2658
|
+
* Email address of the project owner.
|
|
2659
|
+
*/
|
|
2344
2660
|
email: string;
|
|
2661
|
+
/**
|
|
2662
|
+
* Display name of the project owner.
|
|
2663
|
+
*/
|
|
2345
2664
|
name: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* Maximum number of branches the owner is allowed to create across their projects.
|
|
2667
|
+
*/
|
|
2346
2668
|
branches_limit: number;
|
|
2347
2669
|
subscription_type: BillingSubscriptionType;
|
|
2348
2670
|
};
|
|
2349
2671
|
type LimitsUnsatisfiedResponse = {
|
|
2672
|
+
/**
|
|
2673
|
+
* Plan limits that were not satisfied by the request.
|
|
2674
|
+
*/
|
|
2350
2675
|
limits: Array<{
|
|
2351
2676
|
/**
|
|
2352
2677
|
* Identifier of the unsatisfied limit. Possible values are:
|
|
@@ -2356,13 +2681,28 @@ type LimitsUnsatisfiedResponse = {
|
|
|
2356
2681
|
*
|
|
2357
2682
|
*/
|
|
2358
2683
|
name: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* Required value for the limit named by `name`. Compare with `actual` to determine the shortfall.
|
|
2686
|
+
*/
|
|
2359
2687
|
expected: string;
|
|
2360
|
-
|
|
2688
|
+
/**
|
|
2689
|
+
* Current value of the named limit, which does not satisfy the required `expected` value.
|
|
2690
|
+
*/
|
|
2691
|
+
actual: string;
|
|
2361
2692
|
}>;
|
|
2362
2693
|
};
|
|
2363
2694
|
type ProjectsWithIntegrationResponse = {
|
|
2695
|
+
/**
|
|
2696
|
+
* Projects that have the requested integration, each including the project details and associated integration metadata.
|
|
2697
|
+
*/
|
|
2364
2698
|
projects: Array<{
|
|
2699
|
+
/**
|
|
2700
|
+
* The Neon project ID. Use as the `project_id` path parameter in other endpoints.
|
|
2701
|
+
*/
|
|
2365
2702
|
id: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* Name of the external integration associated with the project.
|
|
2705
|
+
*/
|
|
2366
2706
|
integration: string;
|
|
2367
2707
|
}>;
|
|
2368
2708
|
};
|
|
@@ -2383,7 +2723,7 @@ type DataApiSettings = {
|
|
|
2383
2723
|
*/
|
|
2384
2724
|
db_extra_search_path?: string;
|
|
2385
2725
|
/**
|
|
2386
|
-
*
|
|
2726
|
+
* Hard limit on the number of rows returned in a single Data API response. No limit when unset.
|
|
2387
2727
|
*/
|
|
2388
2728
|
db_max_rows?: number;
|
|
2389
2729
|
/**
|
|
@@ -2395,7 +2735,7 @@ type DataApiSettings = {
|
|
|
2395
2735
|
*/
|
|
2396
2736
|
jwt_role_claim_key?: string;
|
|
2397
2737
|
/**
|
|
2398
|
-
* Maximum lifetime
|
|
2738
|
+
* Maximum lifetime of the Data API's JWT cache, in seconds.
|
|
2399
2739
|
*/
|
|
2400
2740
|
jwt_cache_max_lifetime?: number;
|
|
2401
2741
|
/**
|
|
@@ -2407,7 +2747,7 @@ type DataApiSettings = {
|
|
|
2407
2747
|
*/
|
|
2408
2748
|
server_cors_allowed_origins?: string;
|
|
2409
2749
|
/**
|
|
2410
|
-
*
|
|
2750
|
+
* When enabled, the Data API adds `Server-Timing` headers to each response showing database execution and internal processing time. Default: disabled.
|
|
2411
2751
|
*/
|
|
2412
2752
|
server_timing_enabled?: boolean;
|
|
2413
2753
|
};
|
|
@@ -2416,21 +2756,19 @@ type DataApiSettings = {
|
|
|
2416
2756
|
*/
|
|
2417
2757
|
type DataApiCreateRequest = {
|
|
2418
2758
|
/**
|
|
2419
|
-
*
|
|
2759
|
+
* Authentication provider for the Neon Data API. `neon_auth`: use Neon's built-in managed authentication (no JWKS configuration required). `external`: use an external JWT provider, which requires `jwks_url`. When omitted, no auth provider is configured (existing setup is kept).
|
|
2420
2760
|
*/
|
|
2421
2761
|
auth_provider?: 'neon_auth' | 'external';
|
|
2422
2762
|
/**
|
|
2423
|
-
*
|
|
2763
|
+
* URL of the JWKS endpoint used to verify JWTs for this Data API. Required when configuring JWT-based authentication; omit when using a non-JWT auth provider.
|
|
2424
2764
|
*/
|
|
2425
2765
|
jwks_url?: string;
|
|
2426
2766
|
/**
|
|
2427
|
-
*
|
|
2767
|
+
* Display name for the authentication provider. Accepted values include "Clerk", "Stytch", and "Auth0", but any non-empty string is valid. Optional field.
|
|
2428
2768
|
*/
|
|
2429
2769
|
provider_name?: string;
|
|
2430
2770
|
/**
|
|
2431
|
-
*
|
|
2432
|
-
* different audience claim. Tokens without audience claim will still
|
|
2433
|
-
* be accepted.
|
|
2771
|
+
* Expected `aud` claim in incoming JWTs. When set, tokens with a different audience are rejected; tokens with no audience are still accepted. Omit to skip audience validation.
|
|
2434
2772
|
*
|
|
2435
2773
|
*/
|
|
2436
2774
|
jwt_audience?: string;
|
|
@@ -2448,6 +2786,9 @@ type DataApiCreateRequest = {
|
|
|
2448
2786
|
* Neon Data API created successfully
|
|
2449
2787
|
*/
|
|
2450
2788
|
type DataApiCreateResponse = {
|
|
2789
|
+
/**
|
|
2790
|
+
* URL of the created Data API endpoint.
|
|
2791
|
+
*/
|
|
2451
2792
|
url: string;
|
|
2452
2793
|
};
|
|
2453
2794
|
/**
|
|
@@ -2477,63 +2818,134 @@ type DataApiReponse = {
|
|
|
2477
2818
|
type DataApiUpdateRequest = {
|
|
2478
2819
|
settings?: DataApiSettings;
|
|
2479
2820
|
};
|
|
2821
|
+
/**
|
|
2822
|
+
* 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.
|
|
2823
|
+
*/
|
|
2480
2824
|
type NeonAuthSupportedAuthProvider = 'mock' | 'stack' | 'better_auth';
|
|
2481
2825
|
type NeonAuthProviderProjectOwnedBy = 'user' | 'neon';
|
|
2482
2826
|
type NeonAuthProviderProjectTransferStatus = 'initiated' | 'finished';
|
|
2483
2827
|
type NeonAuthRedirectUriWhitelistDomain = {
|
|
2828
|
+
/**
|
|
2829
|
+
* Allowed redirect URI domain for the auth provider.
|
|
2830
|
+
*/
|
|
2484
2831
|
domain: string;
|
|
2485
2832
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2486
2833
|
};
|
|
2487
2834
|
type NeonAuthRedirectUriWhitelistResponse = {
|
|
2835
|
+
/**
|
|
2836
|
+
* Domains permitted as redirect URI targets in the whitelist.
|
|
2837
|
+
*/
|
|
2488
2838
|
domains: Array<NeonAuthRedirectUriWhitelistDomain>;
|
|
2489
2839
|
};
|
|
2490
2840
|
type NeonAuthAddDomainToRedirectUriWhitelistRequest = {
|
|
2841
|
+
/**
|
|
2842
|
+
* URI to add to the redirect URI allowlist for the auth provider.
|
|
2843
|
+
*/
|
|
2491
2844
|
domain: string;
|
|
2492
2845
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2493
2846
|
};
|
|
2494
2847
|
type NeonAuthDeleteDomainFromRedirectUriWhitelistRequest = {
|
|
2495
2848
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2849
|
+
/**
|
|
2850
|
+
* Domain names to remove from the redirect URI whitelist for the specified auth provider.
|
|
2851
|
+
*/
|
|
2496
2852
|
domains: Array<NeonAuthDeleteDomainFromRedirectUriWhitelistItem>;
|
|
2497
2853
|
};
|
|
2498
2854
|
type NeonAuthDeleteDomainFromRedirectUriWhitelistItem = {
|
|
2855
|
+
/**
|
|
2856
|
+
* URI to remove from the redirect URI whitelist.
|
|
2857
|
+
*/
|
|
2499
2858
|
domain: string;
|
|
2500
2859
|
};
|
|
2501
2860
|
type NeonAuthCreateIntegrationRequest = {
|
|
2502
2861
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2862
|
+
/**
|
|
2863
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
2864
|
+
*/
|
|
2503
2865
|
project_id: string;
|
|
2866
|
+
/**
|
|
2867
|
+
* The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
|
|
2868
|
+
*/
|
|
2504
2869
|
branch_id: string;
|
|
2870
|
+
/**
|
|
2871
|
+
* Name of the database to associate with the Neon Auth integration. When omitted, the integration uses the project's default database.
|
|
2872
|
+
*/
|
|
2505
2873
|
database_name?: string;
|
|
2506
2874
|
/**
|
|
2875
|
+
* Deprecated. The database role for the auth integration. Omit this field; it is ignored.
|
|
2876
|
+
*
|
|
2507
2877
|
* @deprecated
|
|
2508
2878
|
*/
|
|
2509
2879
|
role_name?: string;
|
|
2510
2880
|
};
|
|
2511
2881
|
type EnableNeonAuthIntegrationRequest = {
|
|
2512
2882
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2883
|
+
/**
|
|
2884
|
+
* Name of the database to enable Neon Auth on. When omitted, the integration uses the project's default database.
|
|
2885
|
+
*/
|
|
2513
2886
|
database_name?: string;
|
|
2514
2887
|
};
|
|
2515
2888
|
type NeonAuthCreateIntegrationResponse = {
|
|
2516
2889
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2890
|
+
/**
|
|
2891
|
+
* Project ID assigned by the auth provider for this integration.
|
|
2892
|
+
*/
|
|
2517
2893
|
auth_provider_project_id: string;
|
|
2894
|
+
/**
|
|
2895
|
+
* Publishable SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth.
|
|
2896
|
+
*/
|
|
2518
2897
|
pub_client_key: string;
|
|
2898
|
+
/**
|
|
2899
|
+
* Secret server-side SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth. Treat as a credential.
|
|
2900
|
+
*/
|
|
2519
2901
|
secret_server_key: string;
|
|
2902
|
+
/**
|
|
2903
|
+
* URL of the provider's JWKS endpoint used to verify JWTs.
|
|
2904
|
+
*/
|
|
2520
2905
|
jwks_url: string;
|
|
2906
|
+
/**
|
|
2907
|
+
* Postgres schema containing the auth integration tables. Defaults to `neon_auth`.
|
|
2908
|
+
*/
|
|
2521
2909
|
schema_name: string;
|
|
2910
|
+
/**
|
|
2911
|
+
* Postgres table in the integration schema where synced user records are stored.
|
|
2912
|
+
*/
|
|
2522
2913
|
table_name: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* Base URL of the Neon Auth service for this integration. Set as the NEON_AUTH_BASE_URL environment variable in your application.
|
|
2916
|
+
*/
|
|
2523
2917
|
base_url?: string;
|
|
2524
2918
|
};
|
|
2525
2919
|
type NeonAuthCreateAuthProviderSdkKeysRequest = {
|
|
2920
|
+
/**
|
|
2921
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
2922
|
+
*/
|
|
2526
2923
|
project_id: string;
|
|
2527
2924
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2528
2925
|
};
|
|
2529
2926
|
type NeonAuthCreateNewUserRequest = {
|
|
2927
|
+
/**
|
|
2928
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
2929
|
+
*/
|
|
2530
2930
|
project_id: string;
|
|
2531
2931
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2932
|
+
/**
|
|
2933
|
+
* Email address of the new user.
|
|
2934
|
+
*/
|
|
2532
2935
|
email: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Display name for the new user. When omitted, the created user has no display name.
|
|
2938
|
+
*/
|
|
2533
2939
|
name?: string;
|
|
2534
2940
|
};
|
|
2535
2941
|
type CreateBranchNeonAuthNewUserRequest = {
|
|
2942
|
+
/**
|
|
2943
|
+
* Email address of the new Neon Auth user to create.
|
|
2944
|
+
*/
|
|
2536
2945
|
email: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* Display name for the new user. Optional. Pair with the required email field when creating a new user.
|
|
2948
|
+
*/
|
|
2537
2949
|
name?: string;
|
|
2538
2950
|
};
|
|
2539
2951
|
type NeonAuthCreateNewUserResponse = {
|
|
@@ -2544,7 +2956,7 @@ type NeonAuthCreateNewUserResponse = {
|
|
|
2544
2956
|
};
|
|
2545
2957
|
type UpdateNeonAuthUserRoleRequest = {
|
|
2546
2958
|
/**
|
|
2547
|
-
*
|
|
2959
|
+
* Roles to assign to the user in the Neon Auth (Better Auth) directory. `user` and `admin` are the built-in roles; custom role strings are also supported.
|
|
2548
2960
|
*/
|
|
2549
2961
|
roles: Array<string>;
|
|
2550
2962
|
};
|
|
@@ -2568,79 +2980,79 @@ type UpdateNeonAuthAllowLocalhostRequest = {
|
|
|
2568
2980
|
};
|
|
2569
2981
|
type NeonAuthOrganizationConfig = {
|
|
2570
2982
|
/**
|
|
2571
|
-
* Whether the organization plugin is enabled
|
|
2983
|
+
* Whether the organization plugin is enabled.
|
|
2572
2984
|
*/
|
|
2573
2985
|
enabled: boolean;
|
|
2574
2986
|
/**
|
|
2575
|
-
* Maximum
|
|
2987
|
+
* Maximum organizations a user can belong to (created or joined). At the limit, the user cannot create or join more.
|
|
2576
2988
|
*/
|
|
2577
2989
|
organization_limit: number;
|
|
2578
2990
|
/**
|
|
2579
|
-
* Maximum number of members per organization
|
|
2991
|
+
* Maximum number of members per organization.
|
|
2580
2992
|
*/
|
|
2581
2993
|
membership_limit: number;
|
|
2582
2994
|
/**
|
|
2583
|
-
*
|
|
2995
|
+
* Role of the organization's creator. `owner`: full control, including deleting the org and transferring ownership. `admin`: manage members and settings only.
|
|
2584
2996
|
*/
|
|
2585
2997
|
creator_role: 'admin' | 'owner';
|
|
2586
2998
|
/**
|
|
2587
|
-
* Whether to send invitation emails when inviting members to an organization
|
|
2999
|
+
* Whether to send invitation emails when inviting members to an organization.
|
|
2588
3000
|
*/
|
|
2589
3001
|
send_invitation_email: boolean;
|
|
2590
3002
|
};
|
|
2591
3003
|
type NeonAuthOrganizationConfigUpdate = {
|
|
2592
3004
|
/**
|
|
2593
|
-
*
|
|
3005
|
+
* Controls whether the organization plugin is active for the organization.
|
|
2594
3006
|
*/
|
|
2595
3007
|
enabled?: boolean;
|
|
2596
3008
|
/**
|
|
2597
|
-
* Maximum
|
|
3009
|
+
* Maximum organizations a user can belong to (created or joined). At the limit, the user cannot create or join more.
|
|
2598
3010
|
*/
|
|
2599
3011
|
organization_limit?: number;
|
|
2600
3012
|
/**
|
|
2601
|
-
* Maximum
|
|
3013
|
+
* Maximum members per organization.
|
|
2602
3014
|
*/
|
|
2603
3015
|
membership_limit?: number;
|
|
2604
3016
|
/**
|
|
2605
|
-
*
|
|
3017
|
+
* Role of the organization's creator. `owner`: full control, including deleting the org and transferring ownership. `admin`: manage members and settings only.
|
|
2606
3018
|
*/
|
|
2607
3019
|
creator_role?: 'admin' | 'owner';
|
|
2608
3020
|
/**
|
|
2609
|
-
*
|
|
3021
|
+
* When true, invited users receive an email containing an accept link. Requires that the invited user has a verified email address.
|
|
2610
3022
|
*/
|
|
2611
3023
|
send_invitation_email?: boolean;
|
|
2612
3024
|
};
|
|
2613
3025
|
type NeonAuthMagicLinkConfig = {
|
|
2614
3026
|
/**
|
|
2615
|
-
* Whether the magic link plugin is enabled
|
|
3027
|
+
* Whether the magic link plugin is enabled.
|
|
2616
3028
|
*/
|
|
2617
3029
|
enabled: boolean;
|
|
2618
3030
|
/**
|
|
2619
|
-
*
|
|
3031
|
+
* Minutes until the magic link expires.
|
|
2620
3032
|
*/
|
|
2621
3033
|
expires_in: number;
|
|
2622
3034
|
/**
|
|
2623
|
-
* Whether to disable sign-up via magic link
|
|
3035
|
+
* Whether to disable sign-up via magic link.
|
|
2624
3036
|
*/
|
|
2625
3037
|
disable_sign_up: boolean;
|
|
2626
3038
|
};
|
|
2627
3039
|
type NeonAuthMagicLinkConfigUpdate = {
|
|
2628
3040
|
/**
|
|
2629
|
-
* Whether the magic link plugin
|
|
3041
|
+
* Whether to enable the magic link plugin.
|
|
2630
3042
|
*/
|
|
2631
3043
|
enabled?: boolean;
|
|
2632
3044
|
/**
|
|
2633
|
-
*
|
|
3045
|
+
* Minutes until the magic link expires.
|
|
2634
3046
|
*/
|
|
2635
3047
|
expires_in?: number;
|
|
2636
3048
|
/**
|
|
2637
|
-
*
|
|
3049
|
+
* When true, sign-up via magic link is disabled.
|
|
2638
3050
|
*/
|
|
2639
3051
|
disable_sign_up?: boolean;
|
|
2640
3052
|
};
|
|
2641
3053
|
type NeonAuthPhoneNumberConfig = {
|
|
2642
3054
|
/**
|
|
2643
|
-
* Whether the phone number plugin is enabled
|
|
3055
|
+
* Whether the phone number plugin is enabled.
|
|
2644
3056
|
*/
|
|
2645
3057
|
enabled: boolean;
|
|
2646
3058
|
/**
|
|
@@ -2650,7 +3062,7 @@ type NeonAuthPhoneNumberConfig = {
|
|
|
2650
3062
|
};
|
|
2651
3063
|
type NeonAuthPhoneNumberConfigUpdate = {
|
|
2652
3064
|
/**
|
|
2653
|
-
* Whether the phone number plugin is enabled
|
|
3065
|
+
* Whether the phone number plugin is enabled.
|
|
2654
3066
|
*/
|
|
2655
3067
|
enabled?: boolean;
|
|
2656
3068
|
/**
|
|
@@ -2659,6 +3071,9 @@ type NeonAuthPhoneNumberConfigUpdate = {
|
|
|
2659
3071
|
otp_expires_in?: number;
|
|
2660
3072
|
};
|
|
2661
3073
|
type NeonAuthTransferAuthProviderProjectRequest = {
|
|
3074
|
+
/**
|
|
3075
|
+
* The Neon project ID. Returned as `id` from `GET /projects`.
|
|
3076
|
+
*/
|
|
2662
3077
|
project_id: string;
|
|
2663
3078
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
2664
3079
|
};
|
|
@@ -2669,9 +3084,15 @@ type NeonAuthTransferAuthProviderProjectResponse = {
|
|
|
2669
3084
|
url: string;
|
|
2670
3085
|
};
|
|
2671
3086
|
type ListNeonAuthIntegrationsResponse = {
|
|
3087
|
+
/**
|
|
3088
|
+
* Neon Auth integrations configured for the project.
|
|
3089
|
+
*/
|
|
2672
3090
|
data: Array<NeonAuthIntegration>;
|
|
2673
3091
|
};
|
|
2674
3092
|
type ListNeonAuthOauthProvidersResponse = {
|
|
3093
|
+
/**
|
|
3094
|
+
* OAuth providers configured for Neon Auth on the project.
|
|
3095
|
+
*/
|
|
2675
3096
|
providers: Array<NeonAuthOauthProvider>;
|
|
2676
3097
|
};
|
|
2677
3098
|
/**
|
|
@@ -2683,44 +3104,110 @@ type NeonAuthPluginConfigs = {
|
|
|
2683
3104
|
phone_number?: NeonAuthPhoneNumberConfig;
|
|
2684
3105
|
email_provider?: NeonAuthEmailServerConfig;
|
|
2685
3106
|
email_and_password?: NeonAuthEmailAndPasswordConfig;
|
|
3107
|
+
/**
|
|
3108
|
+
* OAuth provider configurations enabled for this auth setup.
|
|
3109
|
+
*/
|
|
2686
3110
|
oauth_providers?: Array<NeonAuthOauthProvider>;
|
|
3111
|
+
/**
|
|
3112
|
+
* Permits authentication requests from localhost origins when true. Intended for local development; disable in production environments.
|
|
3113
|
+
*/
|
|
2687
3114
|
allow_localhost?: boolean;
|
|
2688
3115
|
};
|
|
2689
3116
|
type NeonAuthWebhookConfig = {
|
|
3117
|
+
/**
|
|
3118
|
+
* Whether the webhook is active.
|
|
3119
|
+
*/
|
|
2690
3120
|
enabled: boolean;
|
|
3121
|
+
/**
|
|
3122
|
+
* Destination URL that receives webhook event payloads.
|
|
3123
|
+
*/
|
|
2691
3124
|
webhook_url?: string;
|
|
3125
|
+
/**
|
|
3126
|
+
* Event types that trigger this webhook. Covers user lifecycle, email/OTP delivery, organization invitations, and phone verification events; see the enum for exact values.
|
|
3127
|
+
*/
|
|
2692
3128
|
enabled_events?: Array<'user.before_create' | 'user.created' | 'send.otp' | 'send.magic_link' | 'organization.invitation.created' | 'organization.invitation.accepted' | 'phone_number.verified'>;
|
|
3129
|
+
/**
|
|
3130
|
+
* Maximum time, in seconds, to wait for a response from the webhook endpoint.
|
|
3131
|
+
*/
|
|
2693
3132
|
timeout_seconds?: number;
|
|
2694
3133
|
};
|
|
2695
3134
|
type NeonAuthOauthProvider = {
|
|
2696
3135
|
id: NeonAuthOauthProviderId;
|
|
2697
3136
|
type: NeonAuthOauthProviderType;
|
|
3137
|
+
/**
|
|
3138
|
+
* Public identifier for the OAuth application, issued by the provider when the application is registered.
|
|
3139
|
+
*/
|
|
2698
3140
|
client_id?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* OAuth client secret for the provider.
|
|
3143
|
+
*/
|
|
2699
3144
|
client_secret?: string;
|
|
2700
3145
|
};
|
|
2701
3146
|
type NeonAuthOauthProviderId = 'google' | 'github' | 'microsoft' | 'vercel';
|
|
2702
3147
|
type NeonAuthOauthProviderType = 'standard' | 'shared';
|
|
2703
3148
|
type NeonAuthAddOAuthProviderRequest = {
|
|
2704
3149
|
id: NeonAuthOauthProviderId;
|
|
3150
|
+
/**
|
|
3151
|
+
* The client ID issued by the OAuth provider for your application. Used to identify the application during the OAuth flow.
|
|
3152
|
+
*/
|
|
2705
3153
|
client_id?: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* OAuth client secret for the provider.
|
|
3156
|
+
*/
|
|
2706
3157
|
client_secret?: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* Tenant ID for the Microsoft OAuth provider. Only relevant when the OAuth provider is Microsoft; omit or leave blank for other providers.
|
|
3160
|
+
*/
|
|
2707
3161
|
microsoft_tenant_id?: string;
|
|
2708
3162
|
};
|
|
2709
3163
|
type NeonAuthUpdateOAuthProviderRequest = {
|
|
3164
|
+
/**
|
|
3165
|
+
* The OAuth client ID registered with the provider. Omit to keep the currently configured value.
|
|
3166
|
+
*/
|
|
2710
3167
|
client_id?: string;
|
|
3168
|
+
/**
|
|
3169
|
+
* OAuth client secret for the provider. Omit to leave the existing secret unchanged.
|
|
3170
|
+
*/
|
|
2711
3171
|
client_secret?: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* The tenant ID scoping the Microsoft OAuth provider. Supply this field when the provider type is microsoft; it has no effect for other provider types.
|
|
3174
|
+
*/
|
|
2712
3175
|
microsoft_tenant_id?: string;
|
|
2713
3176
|
};
|
|
2714
3177
|
type SharedEmailServer = {
|
|
3178
|
+
/**
|
|
3179
|
+
* Email address used as the sender for outgoing messages from this shared email server.
|
|
3180
|
+
*/
|
|
2715
3181
|
sender_email?: string;
|
|
3182
|
+
/**
|
|
3183
|
+
* Display name shown as the sender in outgoing emails.
|
|
3184
|
+
*/
|
|
2716
3185
|
sender_name?: string;
|
|
2717
3186
|
};
|
|
2718
3187
|
type StandardEmailServer = {
|
|
3188
|
+
/**
|
|
3189
|
+
* Hostname of the email server.
|
|
3190
|
+
*/
|
|
2719
3191
|
host: string;
|
|
3192
|
+
/**
|
|
3193
|
+
* TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).
|
|
3194
|
+
*/
|
|
2720
3195
|
port: number;
|
|
3196
|
+
/**
|
|
3197
|
+
* Username for authenticating with the SMTP server.
|
|
3198
|
+
*/
|
|
2721
3199
|
username: string;
|
|
3200
|
+
/**
|
|
3201
|
+
* Password for authenticating with the SMTP server.
|
|
3202
|
+
*/
|
|
2722
3203
|
password: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* Email address used as the From address on outgoing auth emails.
|
|
3206
|
+
*/
|
|
2723
3207
|
sender_email: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* Display name shown as the sender in outgoing emails.
|
|
3210
|
+
*/
|
|
2724
3211
|
sender_name: string;
|
|
2725
3212
|
};
|
|
2726
3213
|
type NeonAuthEmailServerConfig = ({
|
|
@@ -2780,12 +3267,12 @@ type NeonAuthEmailAndPasswordConfig = {
|
|
|
2780
3267
|
};
|
|
2781
3268
|
type NeonAuthEmailAndPasswordConfigUpdate = {
|
|
2782
3269
|
/**
|
|
2783
|
-
*
|
|
3270
|
+
* Controls whether email and password authentication is enabled for this project. When omitted from an update request, the current value is unchanged.
|
|
2784
3271
|
*/
|
|
2785
3272
|
enabled?: boolean;
|
|
2786
3273
|
email_verification_method?: NeonAuthEmailVerificationMethod;
|
|
2787
3274
|
/**
|
|
2788
|
-
*
|
|
3275
|
+
* When true, users must verify their email address before they can sign in. Omitting this field from an update request leaves the current value unchanged.
|
|
2789
3276
|
*/
|
|
2790
3277
|
require_email_verification?: boolean;
|
|
2791
3278
|
/**
|
|
@@ -2793,30 +3280,48 @@ type NeonAuthEmailAndPasswordConfigUpdate = {
|
|
|
2793
3280
|
*/
|
|
2794
3281
|
auto_sign_in_after_verification?: boolean;
|
|
2795
3282
|
/**
|
|
2796
|
-
* Whether to send a verification email when users sign up
|
|
3283
|
+
* Whether to send a verification email when users sign up.
|
|
2797
3284
|
*/
|
|
2798
3285
|
send_verification_email_on_sign_up?: boolean;
|
|
2799
3286
|
/**
|
|
2800
|
-
* Whether to send a verification email when
|
|
3287
|
+
* Whether to send a verification email when a user with an unverified email signs in.
|
|
2801
3288
|
*/
|
|
2802
3289
|
send_verification_email_on_sign_in?: boolean;
|
|
2803
3290
|
/**
|
|
2804
|
-
* Whether to disable new user sign ups
|
|
3291
|
+
* Whether to disable new user sign ups. When omitted, the current setting is not changed.
|
|
2805
3292
|
*/
|
|
2806
3293
|
disable_sign_up?: boolean;
|
|
2807
3294
|
};
|
|
2808
3295
|
type NeonAuthIntegration = {
|
|
2809
3296
|
auth_provider: NeonAuthSupportedAuthProvider;
|
|
3297
|
+
/**
|
|
3298
|
+
* Project identifier assigned by the auth provider for this integration.
|
|
3299
|
+
*/
|
|
2810
3300
|
auth_provider_project_id: string;
|
|
3301
|
+
/**
|
|
3302
|
+
* The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
|
|
3303
|
+
*/
|
|
2811
3304
|
branch_id: string;
|
|
3305
|
+
/**
|
|
3306
|
+
* Name of the database used by the Neon Auth integration.
|
|
3307
|
+
*/
|
|
2812
3308
|
db_name: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* Timestamp when the Neon Auth integration was created, in RFC 3339 format (UTC).
|
|
3311
|
+
*/
|
|
2813
3312
|
created_at: string;
|
|
2814
3313
|
owned_by: NeonAuthProviderProjectOwnedBy;
|
|
2815
3314
|
transfer_status?: NeonAuthProviderProjectTransferStatus;
|
|
3315
|
+
/**
|
|
3316
|
+
* URL of the provider's JWKS endpoint used to verify JWTs.
|
|
3317
|
+
*/
|
|
2816
3318
|
jwks_url: string;
|
|
3319
|
+
/**
|
|
3320
|
+
* Base URL of the Neon Auth service endpoint for this integration. Injected into the project environment as `NEON_AUTH_BASE_URL`.
|
|
3321
|
+
*/
|
|
2817
3322
|
base_url?: string;
|
|
2818
3323
|
/**
|
|
2819
|
-
*
|
|
3324
|
+
* Application name shown in auth emails and communications. Defaults to the project name.
|
|
2820
3325
|
*/
|
|
2821
3326
|
name?: string;
|
|
2822
3327
|
};
|
|
@@ -2855,17 +3360,29 @@ type JwksCreationOperation = JwksResponse & OperationsResponse;
|
|
|
2855
3360
|
type AnnotationData = {
|
|
2856
3361
|
object: AnnotationObjectData;
|
|
2857
3362
|
value: AnnotationValueData;
|
|
3363
|
+
/**
|
|
3364
|
+
* Timestamp when the annotation was created, in RFC 3339 format (UTC).
|
|
3365
|
+
*/
|
|
2858
3366
|
created_at?: string;
|
|
3367
|
+
/**
|
|
3368
|
+
* Timestamp of the most recent update to the annotation, in RFC 3339 format (UTC).
|
|
3369
|
+
*/
|
|
2859
3370
|
updated_at?: string;
|
|
2860
3371
|
};
|
|
2861
3372
|
/**
|
|
2862
|
-
*
|
|
3373
|
+
* A free-form map of string key-value pairs for attaching metadata to a resource (for example, a git commit reference). Maximum 50 entries.
|
|
2863
3374
|
*/
|
|
2864
3375
|
type AnnotationValueData = {
|
|
2865
3376
|
[key: string]: string;
|
|
2866
3377
|
};
|
|
2867
3378
|
type AnnotationObjectData = {
|
|
3379
|
+
/**
|
|
3380
|
+
* Kind of resource the annotation is attached to, for example "branch" or "endpoint".
|
|
3381
|
+
*/
|
|
2868
3382
|
type: string;
|
|
3383
|
+
/**
|
|
3384
|
+
* The annotated object's ID.
|
|
3385
|
+
*/
|
|
2869
3386
|
id: string;
|
|
2870
3387
|
};
|
|
2871
3388
|
type AnnotationCreateValueRequest = {
|
|
@@ -2875,6 +3392,9 @@ type AnnotationResponse = {
|
|
|
2875
3392
|
annotation: AnnotationData;
|
|
2876
3393
|
};
|
|
2877
3394
|
type AnnotationsMapResponse = {
|
|
3395
|
+
/**
|
|
3396
|
+
* Map of annotations keyed by resource identifier, where each value contains the annotation data for that resource.
|
|
3397
|
+
*/
|
|
2878
3398
|
annotations: {
|
|
2879
3399
|
[key: string]: AnnotationData;
|
|
2880
3400
|
};
|
|
@@ -2888,6 +3408,9 @@ type ApplicationType = 'vercel' | 'github' | 'datadog' | 'opentelemetry';
|
|
|
2888
3408
|
*
|
|
2889
3409
|
*/
|
|
2890
3410
|
type ProjectsApplicationsMapResponse = {
|
|
3411
|
+
/**
|
|
3412
|
+
* Map of project IDs to their installed applications. Each key is a project ID; each value is an array of application types (for example, `vercel`, `github`).
|
|
3413
|
+
*/
|
|
2891
3414
|
applications: {
|
|
2892
3415
|
[key: string]: Array<ApplicationType>;
|
|
2893
3416
|
};
|
|
@@ -2897,6 +3420,9 @@ type ProjectsApplicationsMapResponse = {
|
|
|
2897
3420
|
*
|
|
2898
3421
|
*/
|
|
2899
3422
|
type ProjectsIntegrationsMapResponse = {
|
|
3423
|
+
/**
|
|
3424
|
+
* Map of project IDs to their associated integration details.
|
|
3425
|
+
*/
|
|
2900
3426
|
integrations: {
|
|
2901
3427
|
[key: string]: Array<ApplicationType>;
|
|
2902
3428
|
};
|
|
@@ -2908,18 +3434,51 @@ type CursorPaginationResponse = {
|
|
|
2908
3434
|
* 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.
|
|
2909
3435
|
*/
|
|
2910
3436
|
type CursorPagination = {
|
|
3437
|
+
/**
|
|
3438
|
+
* Cursor for the next page of results. Pass it as the `cursor` query parameter on the next request. Absent on the last page.
|
|
3439
|
+
*/
|
|
2911
3440
|
next?: string;
|
|
3441
|
+
/**
|
|
3442
|
+
* Field by which the results were sorted, echoing the request's sort_by parameter.
|
|
3443
|
+
*/
|
|
2912
3444
|
sort_by?: string;
|
|
3445
|
+
/**
|
|
3446
|
+
* Sort order active for this page. Pass back as `sort_order` in the next request to maintain consistent ordering. Valid values are `asc` and `desc`.
|
|
3447
|
+
*/
|
|
2913
3448
|
sort_order?: string;
|
|
2914
3449
|
};
|
|
2915
3450
|
type Snapshot = {
|
|
3451
|
+
/**
|
|
3452
|
+
* The snapshot ID.
|
|
3453
|
+
*/
|
|
2916
3454
|
id: string;
|
|
3455
|
+
/**
|
|
3456
|
+
* Human-readable label for the snapshot.
|
|
3457
|
+
*/
|
|
2917
3458
|
name: string;
|
|
3459
|
+
/**
|
|
3460
|
+
* WAL position (Log Sequence Number) at which the snapshot was captured, in Postgres LSN format (for example, `0/3000000`).
|
|
3461
|
+
*/
|
|
2918
3462
|
lsn?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* Point in time captured by the snapshot, in RFC 3339 format (UTC).
|
|
3465
|
+
*/
|
|
2919
3466
|
timestamp?: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Branch from which this snapshot was created.
|
|
3469
|
+
*/
|
|
2920
3470
|
source_branch_id?: string;
|
|
3471
|
+
/**
|
|
3472
|
+
* Timestamp when the snapshot was created, in RFC 3339 format (UTC).
|
|
3473
|
+
*/
|
|
2921
3474
|
created_at: string;
|
|
3475
|
+
/**
|
|
3476
|
+
* RFC 3339 timestamp when the snapshot expires and is eligible for deletion. Null if the snapshot does not have an expiry.
|
|
3477
|
+
*/
|
|
2922
3478
|
expires_at?: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* True if the snapshot was created manually rather than by a schedule.
|
|
3481
|
+
*/
|
|
2923
3482
|
manual?: boolean;
|
|
2924
3483
|
/**
|
|
2925
3484
|
* Full logical size of the snapshot in bytes at the time it was taken.
|
|
@@ -2931,7 +3490,7 @@ type Snapshot = {
|
|
|
2931
3490
|
*/
|
|
2932
3491
|
full_size?: number;
|
|
2933
3492
|
/**
|
|
2934
|
-
* Incremental storage size in bytes since the previous scheduled snapshot, when the snapshot is billed on incremental (diff) usage.
|
|
3493
|
+
* Incremental Postgres storage size in bytes since the previous scheduled snapshot, when the snapshot is billed on incremental (diff) usage.
|
|
2935
3494
|
*
|
|
2936
3495
|
* When absent, either the incremental size has not been calculated yet and the snapshot is not being charged, or the snapshot is charged at full logical size (in that case `full_size` is set).
|
|
2937
3496
|
*
|
|
@@ -2939,7 +3498,13 @@ type Snapshot = {
|
|
|
2939
3498
|
diff_size?: number;
|
|
2940
3499
|
};
|
|
2941
3500
|
type SnapshotUpdateRequest = {
|
|
3501
|
+
/**
|
|
3502
|
+
* Fields to update on the snapshot. Updatable fields include `name` and `expires_at`.
|
|
3503
|
+
*/
|
|
2942
3504
|
snapshot: {
|
|
3505
|
+
/**
|
|
3506
|
+
* Human-readable label for the snapshot.
|
|
3507
|
+
*/
|
|
2943
3508
|
name?: string;
|
|
2944
3509
|
/**
|
|
2945
3510
|
* The date and time when the snapshot will expire.
|
|
@@ -2954,10 +3519,7 @@ type SnapshotUpdateRequest = {
|
|
|
2954
3519
|
};
|
|
2955
3520
|
type BackupScheduleItem = {
|
|
2956
3521
|
/**
|
|
2957
|
-
* How often to take snapshots.
|
|
2958
|
-
* - `daily`
|
|
2959
|
-
* - `weekly`
|
|
2960
|
-
* - `monthly`
|
|
3522
|
+
* How often to take snapshots. Known values: `daily`, `weekly`, `monthly`.
|
|
2961
3523
|
*
|
|
2962
3524
|
*/
|
|
2963
3525
|
frequency: string;
|
|
@@ -2977,21 +3539,43 @@ type BackupScheduleItem = {
|
|
|
2977
3539
|
*/
|
|
2978
3540
|
month?: number;
|
|
2979
3541
|
/**
|
|
2980
|
-
* How long to keep a snapshot (in seconds) before it's automatically deleted.
|
|
2981
|
-
*
|
|
3542
|
+
* How long to keep a scheduled snapshot (in seconds) before it's automatically deleted.
|
|
3543
|
+
* The default is 3024000 seconds (35 days), which is also the maximum.
|
|
3544
|
+
* Manually created snapshots have no maximum retention: set their `expires_at` instead.
|
|
2982
3545
|
*
|
|
2983
3546
|
*/
|
|
2984
3547
|
retention_seconds?: number;
|
|
2985
3548
|
};
|
|
2986
3549
|
type BackupSchedule = {
|
|
3550
|
+
/**
|
|
3551
|
+
* List of schedule entries defining the backup frequency. At least one entry is required.
|
|
3552
|
+
*/
|
|
2987
3553
|
schedule: Array<BackupScheduleItem>;
|
|
2988
3554
|
};
|
|
2989
3555
|
type BranchSchemaJson = {
|
|
3556
|
+
/**
|
|
3557
|
+
* Tables present in the branch schema.
|
|
3558
|
+
*/
|
|
2990
3559
|
tables: Array<{
|
|
3560
|
+
/**
|
|
3561
|
+
* Postgres schema (namespace) that contains the table, for example `public`.
|
|
3562
|
+
*/
|
|
2991
3563
|
schema: string;
|
|
3564
|
+
/**
|
|
3565
|
+
* Name of the table within the schema.
|
|
3566
|
+
*/
|
|
2992
3567
|
name: string;
|
|
3568
|
+
/**
|
|
3569
|
+
* Columns belonging to this table, each describing a column's name and attributes.
|
|
3570
|
+
*/
|
|
2993
3571
|
columns: Array<{
|
|
3572
|
+
/**
|
|
3573
|
+
* Name of the column.
|
|
3574
|
+
*/
|
|
2994
3575
|
name: string;
|
|
3576
|
+
/**
|
|
3577
|
+
* Postgres data type of the column, for example "integer" or "text".
|
|
3578
|
+
*/
|
|
2995
3579
|
type: string;
|
|
2996
3580
|
/**
|
|
2997
3581
|
* Whether the column allows NULL values
|
|
@@ -3002,6 +3586,9 @@ type BranchSchemaJson = {
|
|
|
3002
3586
|
*/
|
|
3003
3587
|
generated?: boolean;
|
|
3004
3588
|
}>;
|
|
3589
|
+
/**
|
|
3590
|
+
* Table constraints defined in the branch schema, such as primary key, foreign key, unique, and check constraints.
|
|
3591
|
+
*/
|
|
3005
3592
|
constraints?: Array<{
|
|
3006
3593
|
/**
|
|
3007
3594
|
* Type of constraint. Possible values: `primary_key`, `unique`, `foreign_key`
|
|
@@ -3080,7 +3667,7 @@ type BranchStorage = {
|
|
|
3080
3667
|
/**
|
|
3081
3668
|
* Always `true` in 200 responses. Present for forward compatibility: a
|
|
3082
3669
|
* future version may add intermediate states; callers should treat `true`
|
|
3083
|
-
* as "storage is usable for this branch right now."
|
|
3670
|
+
* as "object storage is usable for this branch right now."
|
|
3084
3671
|
*
|
|
3085
3672
|
*/
|
|
3086
3673
|
enabled: boolean;
|
|
@@ -3089,7 +3676,7 @@ type BranchStorage = {
|
|
|
3089
3676
|
*/
|
|
3090
3677
|
s3_endpoint: string;
|
|
3091
3678
|
/**
|
|
3092
|
-
* The AWS region for this branch's storage. The platform normalizes
|
|
3679
|
+
* The AWS region for this branch's object storage. The platform normalizes
|
|
3093
3680
|
* the us-east-1 convention server-side: a non-empty region string is
|
|
3094
3681
|
* always returned in 200 responses (e.g. `"us-east-1"` for the S3
|
|
3095
3682
|
* default region).
|
|
@@ -3112,16 +3699,240 @@ type BranchStorageNotEnabled = {
|
|
|
3112
3699
|
code: string;
|
|
3113
3700
|
message: string;
|
|
3114
3701
|
/**
|
|
3115
|
-
* Machine-readable reason why storage is unavailable:
|
|
3702
|
+
* Machine-readable reason why object storage is unavailable:
|
|
3116
3703
|
* - `org_not_entitled`: the org's `PlatformBranchableStorage` feature flag is off.
|
|
3117
|
-
* - `region_unavailable`: the project's region has no storage admin service wired.
|
|
3118
|
-
* - `branch_directory_missing`: the branch is not registered in the storage service.
|
|
3704
|
+
* - `region_unavailable`: the project's region has no object storage admin service wired.
|
|
3705
|
+
* - `branch_directory_missing`: the branch is not registered in the object storage service.
|
|
3119
3706
|
* - `branch_not_found`: the project or branch does not exist, or the caller does not
|
|
3120
3707
|
* have access to it.
|
|
3121
3708
|
*
|
|
3122
3709
|
*/
|
|
3123
3710
|
reason: 'org_not_entitled' | 'region_unavailable' | 'branch_directory_missing' | 'branch_not_found';
|
|
3124
3711
|
};
|
|
3712
|
+
/**
|
|
3713
|
+
* The Neon service that emitted the log record.
|
|
3714
|
+
*/
|
|
3715
|
+
type ProjectBranchLogSource = 'function' | 'storage' | 'pg_endpoint';
|
|
3716
|
+
/**
|
|
3717
|
+
* An OpenTelemetry severity level. A minimum severity includes every
|
|
3718
|
+
* higher level in this order: `trace`, `debug`, `info`, `warn`, `error`,
|
|
3719
|
+
* `fatal`.
|
|
3720
|
+
*
|
|
3721
|
+
*/
|
|
3722
|
+
type ProjectBranchLogSeverity = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
|
|
3723
|
+
/**
|
|
3724
|
+
* A length of time as a count and a unit, for example `30m`, `6h`, or
|
|
3725
|
+
* `7d`. Valid units are `ms`, `s`, `m`, `h`, and `d`.
|
|
3726
|
+
*
|
|
3727
|
+
*/
|
|
3728
|
+
type ProjectBranchLogDuration = string;
|
|
3729
|
+
type ProjectBranchLogsNotAvailable = {
|
|
3730
|
+
code: string;
|
|
3731
|
+
message: string;
|
|
3732
|
+
/**
|
|
3733
|
+
* Machine-readable reason why logs cannot be read:
|
|
3734
|
+
* - `branch_not_found`: the project or branch does not exist, or the caller does not
|
|
3735
|
+
* have access to it.
|
|
3736
|
+
* - `telemetry_not_enabled`: the branch exists but is not collecting telemetry, so it
|
|
3737
|
+
* has no logs to serve.
|
|
3738
|
+
*
|
|
3739
|
+
*/
|
|
3740
|
+
reason: 'branch_not_found' | 'telemetry_not_enabled';
|
|
3741
|
+
};
|
|
3742
|
+
type ProjectBranchLogsInvalidQuery = {
|
|
3743
|
+
code: string;
|
|
3744
|
+
message: string;
|
|
3745
|
+
/**
|
|
3746
|
+
* Machine-readable reason why the request was rejected:
|
|
3747
|
+
* - `time_range_too_large`: the requested window spans more than seven days.
|
|
3748
|
+
* - `invalid_time_range`: `end_time` is not after `start_time`.
|
|
3749
|
+
* - `conflicting_time_range`: both `since` and `start_time` were supplied.
|
|
3750
|
+
* - `invalid_cursor`: the supplied `cursor` is malformed, expired, or was issued for a
|
|
3751
|
+
* different query.
|
|
3752
|
+
* - `unknown_field`: the requested `field_name` is not one of the fields the log fields
|
|
3753
|
+
* endpoint reports for this branch.
|
|
3754
|
+
* - `invalid_logql`: the supplied `logql` expression does not parse, or uses a
|
|
3755
|
+
* construct this endpoint does not accept.
|
|
3756
|
+
* - `conflicting_filters`: `logql` was supplied alongside one or more structured
|
|
3757
|
+
* filters. Use one or the other.
|
|
3758
|
+
*
|
|
3759
|
+
*/
|
|
3760
|
+
reason: 'time_range_too_large' | 'invalid_time_range' | 'conflicting_time_range' | 'invalid_cursor' | 'unknown_field' | 'invalid_logql' | 'conflicting_filters';
|
|
3761
|
+
};
|
|
3762
|
+
type ProjectBranchLogsQueryRequest = {
|
|
3763
|
+
/**
|
|
3764
|
+
* Length of the query window, ending at `end_time` or at the current
|
|
3765
|
+
* time when `end_time` is omitted. Mutually exclusive with
|
|
3766
|
+
* `start_time`. Prefer this over computing absolute bounds when the
|
|
3767
|
+
* caller only means "the last hour".
|
|
3768
|
+
*
|
|
3769
|
+
*/
|
|
3770
|
+
since?: ProjectBranchLogDuration;
|
|
3771
|
+
/**
|
|
3772
|
+
* Inclusive beginning of the query window. Mutually exclusive with
|
|
3773
|
+
* `since`. Defaults to one hour before `end_time`, or one hour before
|
|
3774
|
+
* the current time when both bounds are omitted.
|
|
3775
|
+
*
|
|
3776
|
+
*/
|
|
3777
|
+
start_time?: string;
|
|
3778
|
+
/**
|
|
3779
|
+
* Exclusive end of the query window. Defaults to the current time.
|
|
3780
|
+
*/
|
|
3781
|
+
end_time?: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* Maximum number of log records to return per page.
|
|
3784
|
+
*/
|
|
3785
|
+
limit?: number;
|
|
3786
|
+
/**
|
|
3787
|
+
* Opaque pagination cursor returned as `next_cursor` by a previous
|
|
3788
|
+
* call. Resume the query after the last record of the previous page,
|
|
3789
|
+
* repeating the time range and every filter unchanged.
|
|
3790
|
+
*
|
|
3791
|
+
*/
|
|
3792
|
+
cursor?: string;
|
|
3793
|
+
/**
|
|
3794
|
+
* Order matching records by timestamp. `desc`, the default, returns
|
|
3795
|
+
* the newest records first.
|
|
3796
|
+
*
|
|
3797
|
+
*/
|
|
3798
|
+
sort_order?: 'asc' | 'desc';
|
|
3799
|
+
source?: ProjectBranchLogSource;
|
|
3800
|
+
/**
|
|
3801
|
+
* Match the OpenTelemetry `service.name` resource attribute exactly.
|
|
3802
|
+
*/
|
|
3803
|
+
service_name?: string;
|
|
3804
|
+
/**
|
|
3805
|
+
* Match the OpenTelemetry instrumentation scope name exactly.
|
|
3806
|
+
*/
|
|
3807
|
+
scope_name?: string;
|
|
3808
|
+
minimum_severity?: ProjectBranchLogSeverity;
|
|
3809
|
+
/**
|
|
3810
|
+
* Match the OpenTelemetry severity text exactly.
|
|
3811
|
+
*/
|
|
3812
|
+
severity_text?: string;
|
|
3813
|
+
/**
|
|
3814
|
+
* Match records whose rendered `message` contains this case-sensitive
|
|
3815
|
+
* substring.
|
|
3816
|
+
*
|
|
3817
|
+
* Records with a structured body are matched against their JSON
|
|
3818
|
+
* rendering, so the substring meets JSON syntax rather than prose: a
|
|
3819
|
+
* bare key name such as `operation` matches every record carrying that
|
|
3820
|
+
* key, and `http_status: 200` matches none, because the rendering
|
|
3821
|
+
* contains `"http_status":200` with no space.
|
|
3822
|
+
*
|
|
3823
|
+
*/
|
|
3824
|
+
body_contains?: string;
|
|
3825
|
+
/**
|
|
3826
|
+
* Match records associated with this OpenTelemetry trace ID. W3C Trace
|
|
3827
|
+
* Context defines a trace ID as 32 lowercase hex digits, and that is
|
|
3828
|
+
* what is stored, so an uppercase value is rejected rather than
|
|
3829
|
+
* silently matching nothing.
|
|
3830
|
+
*
|
|
3831
|
+
*/
|
|
3832
|
+
trace_id?: string;
|
|
3833
|
+
/**
|
|
3834
|
+
* Escape hatch for selections the structured filters cannot express: a
|
|
3835
|
+
* raw LogQL expression, evaluated against this branch's log stream.
|
|
3836
|
+
*
|
|
3837
|
+
* Only stream selectors and line filters are accepted — no
|
|
3838
|
+
* aggregations and no parser stages. Supplying this alongside any
|
|
3839
|
+
* structured filter is rejected with `conflicting_filters` rather than
|
|
3840
|
+
* silently ignoring one of them. `limit`, `sort_order`, and the time
|
|
3841
|
+
* window still apply.
|
|
3842
|
+
*
|
|
3843
|
+
* This field passes the underlying query language through to the
|
|
3844
|
+
* caller, so unlike the rest of this contract it may change as that
|
|
3845
|
+
* backend changes. Prefer the structured filters where they suffice.
|
|
3846
|
+
*
|
|
3847
|
+
*/
|
|
3848
|
+
logql?: string;
|
|
3849
|
+
};
|
|
3850
|
+
type ProjectBranchLogRecord = {
|
|
3851
|
+
/**
|
|
3852
|
+
* The OpenTelemetry record timestamp in UTC.
|
|
3853
|
+
*/
|
|
3854
|
+
timestamp: string;
|
|
3855
|
+
/**
|
|
3856
|
+
* The OpenTelemetry log body rendered as text. A body that is already a
|
|
3857
|
+
* string is returned verbatim. Any other OpenTelemetry `AnyValue` body
|
|
3858
|
+
* — notably the structured key/value body that `storage` records always
|
|
3859
|
+
* carry — is rendered as compact JSON with its keys sorted
|
|
3860
|
+
* alphabetically, for example
|
|
3861
|
+
* `{"bytes":1024,"operation":"GET","object_key":"a/b.png"}`.
|
|
3862
|
+
*
|
|
3863
|
+
*/
|
|
3864
|
+
message: string;
|
|
3865
|
+
source?: ProjectBranchLogSource;
|
|
3866
|
+
/**
|
|
3867
|
+
* The Neon identifier of the service instance that emitted the record.
|
|
3868
|
+
*/
|
|
3869
|
+
entity_id?: string;
|
|
3870
|
+
/**
|
|
3871
|
+
* The OpenTelemetry `service.name` resource attribute.
|
|
3872
|
+
*/
|
|
3873
|
+
service_name?: string;
|
|
3874
|
+
/**
|
|
3875
|
+
* The OpenTelemetry instrumentation scope name.
|
|
3876
|
+
*/
|
|
3877
|
+
scope_name?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* The numeric OpenTelemetry severity.
|
|
3880
|
+
*/
|
|
3881
|
+
severity_number?: number;
|
|
3882
|
+
/**
|
|
3883
|
+
* The original OpenTelemetry severity text.
|
|
3884
|
+
*/
|
|
3885
|
+
severity_text?: string;
|
|
3886
|
+
/**
|
|
3887
|
+
* The OpenTelemetry trace ID, when the record belongs to a trace.
|
|
3888
|
+
*/
|
|
3889
|
+
trace_id?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* The OpenTelemetry span ID, when the record belongs to a span.
|
|
3892
|
+
*/
|
|
3893
|
+
span_id?: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* Customer-defined OpenTelemetry log and resource attributes.
|
|
3896
|
+
*/
|
|
3897
|
+
attributes: {
|
|
3898
|
+
[key: string]: unknown;
|
|
3899
|
+
};
|
|
3900
|
+
};
|
|
3901
|
+
type ProjectBranchLogsQueryResponse = {
|
|
3902
|
+
logs: Array<ProjectBranchLogRecord>;
|
|
3903
|
+
/**
|
|
3904
|
+
* Pagination cursor to pass as `cursor` on the next request. Empty
|
|
3905
|
+
* when the response is not truncated.
|
|
3906
|
+
*
|
|
3907
|
+
*/
|
|
3908
|
+
next_cursor?: string;
|
|
3909
|
+
/**
|
|
3910
|
+
* True when more records matched than were returned.
|
|
3911
|
+
*/
|
|
3912
|
+
is_truncated: boolean;
|
|
3913
|
+
};
|
|
3914
|
+
type ProjectBranchLogFieldsResponse = {
|
|
3915
|
+
/**
|
|
3916
|
+
* Log field names observed on this branch, each usable as `field_name`
|
|
3917
|
+
* on the log field-values endpoint. Computed per branch rather than
|
|
3918
|
+
* fixed by this specification, so clients should not assume a
|
|
3919
|
+
* particular set.
|
|
3920
|
+
*
|
|
3921
|
+
*/
|
|
3922
|
+
fields: Array<string>;
|
|
3923
|
+
};
|
|
3924
|
+
type ProjectBranchLogFieldValuesResponse = {
|
|
3925
|
+
values: Array<string>;
|
|
3926
|
+
/**
|
|
3927
|
+
* True when more distinct values exist than were returned, because
|
|
3928
|
+
* either the requested `limit` or the server's own scan cap was
|
|
3929
|
+
* reached. A caller that filters on a partial list is choosing from an
|
|
3930
|
+
* arbitrary subset, so narrow `since` or `source` and ask again when
|
|
3931
|
+
* this is `true`.
|
|
3932
|
+
*
|
|
3933
|
+
*/
|
|
3934
|
+
is_truncated: boolean;
|
|
3935
|
+
};
|
|
3125
3936
|
type BranchAiGateway = {
|
|
3126
3937
|
/**
|
|
3127
3938
|
* Always `true` in 200 responses. Present for forward compatibility,
|
|
@@ -3900,15 +4711,139 @@ type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
|
|
|
3900
4711
|
type UpdateProjectData = {
|
|
3901
4712
|
body: ProjectUpdateRequest;
|
|
3902
4713
|
path: {
|
|
3903
|
-
/**
|
|
3904
|
-
* The Neon project ID
|
|
3905
|
-
*/
|
|
4714
|
+
/**
|
|
4715
|
+
* The Neon project ID
|
|
4716
|
+
*/
|
|
4717
|
+
project_id: string;
|
|
4718
|
+
};
|
|
4719
|
+
query?: never;
|
|
4720
|
+
url: '/projects/{project_id}';
|
|
4721
|
+
};
|
|
4722
|
+
type UpdateProjectErrors = {
|
|
4723
|
+
/**
|
|
4724
|
+
* General Error.
|
|
4725
|
+
*
|
|
4726
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
4727
|
+
* and whether a response was received.
|
|
4728
|
+
*
|
|
4729
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
4730
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
4731
|
+
*
|
|
4732
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
4733
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
4734
|
+
*
|
|
4735
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
4736
|
+
*
|
|
4737
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
4738
|
+
*
|
|
4739
|
+
*/
|
|
4740
|
+
'4XX': GeneralError;
|
|
4741
|
+
};
|
|
4742
|
+
type UpdateProjectError = UpdateProjectErrors[keyof UpdateProjectErrors];
|
|
4743
|
+
type UpdateProjectResponses = {
|
|
4744
|
+
/**
|
|
4745
|
+
* Updated the specified project
|
|
4746
|
+
*/
|
|
4747
|
+
200: ProjectResponse & OperationsResponse;
|
|
4748
|
+
};
|
|
4749
|
+
type UpdateProjectResponse = UpdateProjectResponses[keyof UpdateProjectResponses];
|
|
4750
|
+
type RecoverProjectData = {
|
|
4751
|
+
body?: never;
|
|
4752
|
+
path: {
|
|
4753
|
+
/**
|
|
4754
|
+
* The Neon project ID
|
|
4755
|
+
*/
|
|
4756
|
+
project_id: string;
|
|
4757
|
+
};
|
|
4758
|
+
query?: never;
|
|
4759
|
+
url: '/projects/{project_id}/recover';
|
|
4760
|
+
};
|
|
4761
|
+
type RecoverProjectErrors = {
|
|
4762
|
+
/**
|
|
4763
|
+
* General Error.
|
|
4764
|
+
*
|
|
4765
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
4766
|
+
* and whether a response was received.
|
|
4767
|
+
*
|
|
4768
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
4769
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
4770
|
+
*
|
|
4771
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
4772
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
4773
|
+
*
|
|
4774
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
4775
|
+
*
|
|
4776
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
4777
|
+
*
|
|
4778
|
+
*/
|
|
4779
|
+
'4XX': GeneralError;
|
|
4780
|
+
};
|
|
4781
|
+
type RecoverProjectError = RecoverProjectErrors[keyof RecoverProjectErrors];
|
|
4782
|
+
type RecoverProjectResponses = {
|
|
4783
|
+
/**
|
|
4784
|
+
* Returned the recovered project
|
|
4785
|
+
*/
|
|
4786
|
+
200: ProjectRecoverResponse;
|
|
4787
|
+
};
|
|
4788
|
+
type RecoverProjectResponse = RecoverProjectResponses[keyof RecoverProjectResponses];
|
|
4789
|
+
type ListProjectOperationsData = {
|
|
4790
|
+
body?: never;
|
|
4791
|
+
path: {
|
|
4792
|
+
/**
|
|
4793
|
+
* The Neon project ID
|
|
4794
|
+
*/
|
|
4795
|
+
project_id: string;
|
|
4796
|
+
};
|
|
4797
|
+
query?: {
|
|
4798
|
+
/**
|
|
4799
|
+
* Specify the cursor value from the previous response to get the next batch of operations
|
|
4800
|
+
*/
|
|
4801
|
+
cursor?: string;
|
|
4802
|
+
/**
|
|
4803
|
+
* Specify a value from 1 to 1000 to limit number of operations in the response
|
|
4804
|
+
*/
|
|
4805
|
+
limit?: number;
|
|
4806
|
+
};
|
|
4807
|
+
url: '/projects/{project_id}/operations';
|
|
4808
|
+
};
|
|
4809
|
+
type ListProjectOperationsErrors = {
|
|
4810
|
+
/**
|
|
4811
|
+
* General Error.
|
|
4812
|
+
*
|
|
4813
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
4814
|
+
* and whether a response was received.
|
|
4815
|
+
*
|
|
4816
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
4817
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
4818
|
+
*
|
|
4819
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
4820
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
4821
|
+
*
|
|
4822
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
4823
|
+
*
|
|
4824
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
4825
|
+
*
|
|
4826
|
+
*/
|
|
4827
|
+
'4XX': GeneralError;
|
|
4828
|
+
};
|
|
4829
|
+
type ListProjectOperationsError = ListProjectOperationsErrors[keyof ListProjectOperationsErrors];
|
|
4830
|
+
type ListProjectOperationsResponses = {
|
|
4831
|
+
/**
|
|
4832
|
+
* Returned a list of operations
|
|
4833
|
+
*
|
|
4834
|
+
*/
|
|
4835
|
+
200: OperationsResponse & PaginationResponse;
|
|
4836
|
+
};
|
|
4837
|
+
type ListProjectOperationsResponse = ListProjectOperationsResponses[keyof ListProjectOperationsResponses];
|
|
4838
|
+
type ListProjectPermissionsData = {
|
|
4839
|
+
body?: never;
|
|
4840
|
+
path: {
|
|
3906
4841
|
project_id: string;
|
|
3907
4842
|
};
|
|
3908
4843
|
query?: never;
|
|
3909
|
-
url: '/projects/{project_id}';
|
|
4844
|
+
url: '/projects/{project_id}/permissions';
|
|
3910
4845
|
};
|
|
3911
|
-
type
|
|
4846
|
+
type ListProjectPermissionsErrors = {
|
|
3912
4847
|
/**
|
|
3913
4848
|
* General Error.
|
|
3914
4849
|
*
|
|
@@ -3928,26 +4863,23 @@ type UpdateProjectErrors = {
|
|
|
3928
4863
|
*/
|
|
3929
4864
|
'4XX': GeneralError;
|
|
3930
4865
|
};
|
|
3931
|
-
type
|
|
3932
|
-
type
|
|
4866
|
+
type ListProjectPermissionsError = ListProjectPermissionsErrors[keyof ListProjectPermissionsErrors];
|
|
4867
|
+
type ListProjectPermissionsResponses = {
|
|
3933
4868
|
/**
|
|
3934
|
-
*
|
|
4869
|
+
* Returned project access details
|
|
3935
4870
|
*/
|
|
3936
|
-
200:
|
|
4871
|
+
200: ProjectPermissions;
|
|
3937
4872
|
};
|
|
3938
|
-
type
|
|
3939
|
-
type
|
|
3940
|
-
body
|
|
4873
|
+
type ListProjectPermissionsResponse = ListProjectPermissionsResponses[keyof ListProjectPermissionsResponses];
|
|
4874
|
+
type GrantPermissionToProjectData = {
|
|
4875
|
+
body: GrantPermissionToProjectRequest;
|
|
3941
4876
|
path: {
|
|
3942
|
-
/**
|
|
3943
|
-
* The Neon project ID
|
|
3944
|
-
*/
|
|
3945
4877
|
project_id: string;
|
|
3946
4878
|
};
|
|
3947
4879
|
query?: never;
|
|
3948
|
-
url: '/projects/{project_id}/
|
|
4880
|
+
url: '/projects/{project_id}/permissions';
|
|
3949
4881
|
};
|
|
3950
|
-
type
|
|
4882
|
+
type GrantPermissionToProjectErrors = {
|
|
3951
4883
|
/**
|
|
3952
4884
|
* General Error.
|
|
3953
4885
|
*
|
|
@@ -3967,35 +4899,32 @@ type RecoverProjectErrors = {
|
|
|
3967
4899
|
*/
|
|
3968
4900
|
'4XX': GeneralError;
|
|
3969
4901
|
};
|
|
3970
|
-
type
|
|
3971
|
-
type
|
|
4902
|
+
type GrantPermissionToProjectError = GrantPermissionToProjectErrors[keyof GrantPermissionToProjectErrors];
|
|
4903
|
+
type GrantPermissionToProjectResponses = {
|
|
3972
4904
|
/**
|
|
3973
|
-
*
|
|
4905
|
+
* Granted project access
|
|
3974
4906
|
*/
|
|
3975
|
-
200:
|
|
4907
|
+
200: ProjectPermission;
|
|
3976
4908
|
};
|
|
3977
|
-
type
|
|
3978
|
-
type
|
|
4909
|
+
type GrantPermissionToProjectResponse = GrantPermissionToProjectResponses[keyof GrantPermissionToProjectResponses];
|
|
4910
|
+
type ListProjectMembersData = {
|
|
3979
4911
|
body?: never;
|
|
3980
4912
|
path: {
|
|
3981
|
-
/**
|
|
3982
|
-
* The Neon project ID
|
|
3983
|
-
*/
|
|
3984
4913
|
project_id: string;
|
|
3985
4914
|
};
|
|
3986
4915
|
query?: {
|
|
3987
4916
|
/**
|
|
3988
|
-
*
|
|
4917
|
+
* 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.
|
|
3989
4918
|
*/
|
|
3990
4919
|
cursor?: string;
|
|
3991
4920
|
/**
|
|
3992
|
-
*
|
|
4921
|
+
* The maximum number of members to return in the response
|
|
3993
4922
|
*/
|
|
3994
4923
|
limit?: number;
|
|
3995
4924
|
};
|
|
3996
|
-
url: '/projects/{project_id}/
|
|
4925
|
+
url: '/projects/{project_id}/members';
|
|
3997
4926
|
};
|
|
3998
|
-
type
|
|
4927
|
+
type ListProjectMembersErrors = {
|
|
3999
4928
|
/**
|
|
4000
4929
|
* General Error.
|
|
4001
4930
|
*
|
|
@@ -4015,24 +4944,26 @@ type ListProjectOperationsErrors = {
|
|
|
4015
4944
|
*/
|
|
4016
4945
|
'4XX': GeneralError;
|
|
4017
4946
|
};
|
|
4018
|
-
type
|
|
4019
|
-
type
|
|
4947
|
+
type ListProjectMembersError = ListProjectMembersErrors[keyof ListProjectMembersErrors];
|
|
4948
|
+
type ListProjectMembersResponses = {
|
|
4020
4949
|
/**
|
|
4021
|
-
* Returned
|
|
4022
|
-
*
|
|
4950
|
+
* Returned the org members and their project roles
|
|
4023
4951
|
*/
|
|
4024
|
-
200:
|
|
4952
|
+
200: ProjectMembers;
|
|
4025
4953
|
};
|
|
4026
|
-
type
|
|
4027
|
-
type
|
|
4954
|
+
type ListProjectMembersResponse = ListProjectMembersResponses[keyof ListProjectMembersResponses];
|
|
4955
|
+
type RemoveProjectMemberRoleData = {
|
|
4028
4956
|
body?: never;
|
|
4029
4957
|
path: {
|
|
4030
4958
|
project_id: string;
|
|
4959
|
+
member_id: string;
|
|
4031
4960
|
};
|
|
4032
|
-
query?:
|
|
4033
|
-
|
|
4961
|
+
query?: {
|
|
4962
|
+
confirm_self_lockout?: boolean;
|
|
4963
|
+
};
|
|
4964
|
+
url: '/projects/{project_id}/members/{member_id}/role';
|
|
4034
4965
|
};
|
|
4035
|
-
type
|
|
4966
|
+
type RemoveProjectMemberRoleErrors = {
|
|
4036
4967
|
/**
|
|
4037
4968
|
* General Error.
|
|
4038
4969
|
*
|
|
@@ -4052,23 +4983,26 @@ type ListProjectPermissionsErrors = {
|
|
|
4052
4983
|
*/
|
|
4053
4984
|
'4XX': GeneralError;
|
|
4054
4985
|
};
|
|
4055
|
-
type
|
|
4056
|
-
type
|
|
4986
|
+
type RemoveProjectMemberRoleError = RemoveProjectMemberRoleErrors[keyof RemoveProjectMemberRoleErrors];
|
|
4987
|
+
type RemoveProjectMemberRoleResponses = {
|
|
4057
4988
|
/**
|
|
4058
|
-
*
|
|
4989
|
+
* Role removed, or no-op if no explicit row existed
|
|
4059
4990
|
*/
|
|
4060
|
-
200:
|
|
4991
|
+
200: ProjectMemberRoleResponse;
|
|
4061
4992
|
};
|
|
4062
|
-
type
|
|
4063
|
-
type
|
|
4064
|
-
body:
|
|
4993
|
+
type RemoveProjectMemberRoleResponse = RemoveProjectMemberRoleResponses[keyof RemoveProjectMemberRoleResponses];
|
|
4994
|
+
type SetProjectMemberRoleData = {
|
|
4995
|
+
body: SetProjectMemberRoleRequest;
|
|
4065
4996
|
path: {
|
|
4066
4997
|
project_id: string;
|
|
4998
|
+
member_id: string;
|
|
4067
4999
|
};
|
|
4068
|
-
query?:
|
|
4069
|
-
|
|
5000
|
+
query?: {
|
|
5001
|
+
confirm_self_demotion?: boolean;
|
|
5002
|
+
};
|
|
5003
|
+
url: '/projects/{project_id}/members/{member_id}/role';
|
|
4070
5004
|
};
|
|
4071
|
-
type
|
|
5005
|
+
type SetProjectMemberRoleErrors = {
|
|
4072
5006
|
/**
|
|
4073
5007
|
* General Error.
|
|
4074
5008
|
*
|
|
@@ -4088,14 +5022,14 @@ type GrantPermissionToProjectErrors = {
|
|
|
4088
5022
|
*/
|
|
4089
5023
|
'4XX': GeneralError;
|
|
4090
5024
|
};
|
|
4091
|
-
type
|
|
4092
|
-
type
|
|
5025
|
+
type SetProjectMemberRoleError = SetProjectMemberRoleErrors[keyof SetProjectMemberRoleErrors];
|
|
5026
|
+
type SetProjectMemberRoleResponses = {
|
|
4093
5027
|
/**
|
|
4094
|
-
*
|
|
5028
|
+
* Role set or updated
|
|
4095
5029
|
*/
|
|
4096
|
-
200:
|
|
5030
|
+
200: ProjectMemberRoleResponse;
|
|
4097
5031
|
};
|
|
4098
|
-
type
|
|
5032
|
+
type SetProjectMemberRoleResponse = SetProjectMemberRoleResponses[keyof SetProjectMemberRoleResponses];
|
|
4099
5033
|
type RevokePermissionFromProjectData = {
|
|
4100
5034
|
body?: never;
|
|
4101
5035
|
path: {
|
|
@@ -4172,8 +5106,7 @@ type GetAvailablePreloadLibrariesResponse = GetAvailablePreloadLibrariesResponse
|
|
|
4172
5106
|
type CreateProjectTransferRequestData = {
|
|
4173
5107
|
body?: {
|
|
4174
5108
|
/**
|
|
4175
|
-
*
|
|
4176
|
-
* the request will expire after 24 hours (86,400 seconds).
|
|
5109
|
+
* Number of seconds the transfer request stays valid before it expires. Defaults to 86400 (24 hours).
|
|
4177
5110
|
*
|
|
4178
5111
|
*/
|
|
4179
5112
|
ttl_seconds?: number;
|
|
@@ -7207,53 +8140,10 @@ type SetDefaultProjectBranchResponses = {
|
|
|
7207
8140
|
200: BranchOperations;
|
|
7208
8141
|
};
|
|
7209
8142
|
type SetDefaultProjectBranchResponse = SetDefaultProjectBranchResponses[keyof SetDefaultProjectBranchResponses];
|
|
7210
|
-
type RecoverProjectBranchData = {
|
|
7211
|
-
body?: never;
|
|
7212
|
-
path: {
|
|
7213
|
-
/**
|
|
7214
|
-
* The Neon project ID
|
|
7215
|
-
*/
|
|
7216
|
-
project_id: string;
|
|
7217
|
-
/**
|
|
7218
|
-
* The branch ID
|
|
7219
|
-
*/
|
|
7220
|
-
branch_id: string;
|
|
7221
|
-
};
|
|
7222
|
-
query?: never;
|
|
7223
|
-
url: '/projects/{project_id}/branches/{branch_id}/recover';
|
|
7224
|
-
};
|
|
7225
|
-
type RecoverProjectBranchErrors = {
|
|
7226
|
-
/**
|
|
7227
|
-
* General Error.
|
|
7228
|
-
*
|
|
7229
|
-
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
7230
|
-
* and whether a response was received.
|
|
7231
|
-
*
|
|
7232
|
-
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
7233
|
-
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
7234
|
-
*
|
|
7235
|
-
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
7236
|
-
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
7237
|
-
*
|
|
7238
|
-
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
7239
|
-
*
|
|
7240
|
-
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
7241
|
-
*
|
|
7242
|
-
*/
|
|
7243
|
-
'4XX': GeneralError;
|
|
7244
|
-
};
|
|
7245
|
-
type RecoverProjectBranchError = RecoverProjectBranchErrors[keyof RecoverProjectBranchErrors];
|
|
7246
|
-
type RecoverProjectBranchResponses = {
|
|
7247
|
-
/**
|
|
7248
|
-
* Recovered the specified branch
|
|
7249
|
-
*/
|
|
7250
|
-
200: BranchRecoverResponse;
|
|
7251
|
-
};
|
|
7252
|
-
type RecoverProjectBranchResponse = RecoverProjectBranchResponses[keyof RecoverProjectBranchResponses];
|
|
7253
8143
|
type FinalizeRestoreBranchData = {
|
|
7254
8144
|
body?: {
|
|
7255
8145
|
/**
|
|
7256
|
-
*
|
|
8146
|
+
* Name for the replaced branch. If omitted, a unique name is generated.
|
|
7257
8147
|
*/
|
|
7258
8148
|
name?: string;
|
|
7259
8149
|
};
|
|
@@ -9282,11 +10172,11 @@ type TransferProjectsFromOrgToOrgData = {
|
|
|
9282
10172
|
};
|
|
9283
10173
|
type TransferProjectsFromOrgToOrgErrors = {
|
|
9284
10174
|
/**
|
|
9285
|
-
* Transfer failed
|
|
10175
|
+
* Transfer failed. The target organization has too many projects or an incompatible plan. Reduce projects or upgrade the target organization.
|
|
9286
10176
|
*/
|
|
9287
10177
|
406: LimitsUnsatisfiedResponse;
|
|
9288
10178
|
/**
|
|
9289
|
-
*
|
|
10179
|
+
* Transfer failed. Projects with active integrations (for example, GitHub or Vercel) cannot be transferred.
|
|
9290
10180
|
*/
|
|
9291
10181
|
422: ProjectsWithIntegrationResponse;
|
|
9292
10182
|
/**
|
|
@@ -9662,11 +10552,11 @@ type TransferProjectsFromUserToOrgData = {
|
|
|
9662
10552
|
};
|
|
9663
10553
|
type TransferProjectsFromUserToOrgErrors = {
|
|
9664
10554
|
/**
|
|
9665
|
-
* Transfer failed
|
|
10555
|
+
* Transfer failed. The target organization has too many projects or an incompatible plan. Reduce projects or upgrade the target organization.
|
|
9666
10556
|
*/
|
|
9667
10557
|
406: LimitsUnsatisfiedResponse;
|
|
9668
10558
|
/**
|
|
9669
|
-
*
|
|
10559
|
+
* Transfer failed. Projects with active integrations (for example, GitHub or Vercel) cannot be transferred.
|
|
9670
10560
|
*/
|
|
9671
10561
|
422: ProjectsWithIntegrationResponse;
|
|
9672
10562
|
/**
|
|
@@ -9751,8 +10641,7 @@ type CreateSnapshotData = {
|
|
|
9751
10641
|
*/
|
|
9752
10642
|
lsn?: string;
|
|
9753
10643
|
/**
|
|
9754
|
-
* The target timestamp for the snapshot. Must fall within the restore window.
|
|
9755
|
-
* Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z). Cannot be used with `lsn`.
|
|
10644
|
+
* The target timestamp for the snapshot. Must fall within the restore window. RFC 3339 format. Cannot be used with `lsn`.
|
|
9756
10645
|
*
|
|
9757
10646
|
*/
|
|
9758
10647
|
timestamp?: string;
|
|
@@ -9761,8 +10650,7 @@ type CreateSnapshotData = {
|
|
|
9761
10650
|
*/
|
|
9762
10651
|
name?: string;
|
|
9763
10652
|
/**
|
|
9764
|
-
* The time at which the snapshot will be automatically deleted.
|
|
9765
|
-
* Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z).
|
|
10653
|
+
* The time at which the snapshot will be automatically deleted. RFC 3339 format.
|
|
9766
10654
|
*
|
|
9767
10655
|
*/
|
|
9768
10656
|
expires_at?: string;
|
|
@@ -9932,15 +10820,12 @@ type UpdateSnapshotResponse = UpdateSnapshotResponses[keyof UpdateSnapshotRespon
|
|
|
9932
10820
|
type RestoreSnapshotData = {
|
|
9933
10821
|
body?: {
|
|
9934
10822
|
/**
|
|
9935
|
-
* A name for the newly restored branch.
|
|
9936
|
-
* If omitted, a default name will be generated.
|
|
10823
|
+
* A name for the newly restored branch. If not provided, the server generates a unique name for the branch automatically.
|
|
9937
10824
|
*
|
|
9938
10825
|
*/
|
|
9939
10826
|
name?: string;
|
|
9940
10827
|
/**
|
|
9941
|
-
*
|
|
9942
|
-
* If not specified, the branch from which the snapshot was originally
|
|
9943
|
-
* created (`snapshot.source_branch_id`) will be used.
|
|
10828
|
+
* ID of the branch to restore the snapshot into. Defaults to the snapshot's source branch (`snapshot.source_branch_id`); fails if that cannot be determined.
|
|
9944
10829
|
*
|
|
9945
10830
|
*/
|
|
9946
10831
|
target_branch_id?: string;
|
|
@@ -9965,7 +10850,7 @@ type RestoreSnapshotData = {
|
|
|
9965
10850
|
};
|
|
9966
10851
|
query?: {
|
|
9967
10852
|
/**
|
|
9968
|
-
*
|
|
10853
|
+
* Deprecated. Use the `name` field in the request body instead. Removal scheduled for November 29, 2025.
|
|
9969
10854
|
* A name for the newly restored branch. If omitted, a default name will be generated.
|
|
9970
10855
|
*
|
|
9971
10856
|
*
|
|
@@ -10247,7 +11132,7 @@ type GetProjectBranchStorageData = {
|
|
|
10247
11132
|
};
|
|
10248
11133
|
type GetProjectBranchStorageErrors = {
|
|
10249
11134
|
/**
|
|
10250
|
-
*
|
|
11135
|
+
* Object storage is not enabled for this branch, or the project/branch was not
|
|
10251
11136
|
* found. The body is always `BranchStorageNotEnabled` — see `reason` for
|
|
10252
11137
|
* the exact cause.
|
|
10253
11138
|
*
|
|
@@ -10275,7 +11160,7 @@ type GetProjectBranchStorageErrors = {
|
|
|
10275
11160
|
type GetProjectBranchStorageError = GetProjectBranchStorageErrors[keyof GetProjectBranchStorageErrors];
|
|
10276
11161
|
type GetProjectBranchStorageResponses = {
|
|
10277
11162
|
/**
|
|
10278
|
-
*
|
|
11163
|
+
* Object storage is enabled for this branch
|
|
10279
11164
|
*/
|
|
10280
11165
|
200: BranchStorage;
|
|
10281
11166
|
};
|
|
@@ -10330,6 +11215,203 @@ type GetProjectBranchAiGatewayResponses = {
|
|
|
10330
11215
|
200: BranchAiGateway;
|
|
10331
11216
|
};
|
|
10332
11217
|
type GetProjectBranchAiGatewayResponse = GetProjectBranchAiGatewayResponses[keyof GetProjectBranchAiGatewayResponses];
|
|
11218
|
+
type QueryProjectBranchLogsData = {
|
|
11219
|
+
body: ProjectBranchLogsQueryRequest;
|
|
11220
|
+
path: {
|
|
11221
|
+
/**
|
|
11222
|
+
* The Neon project ID
|
|
11223
|
+
*/
|
|
11224
|
+
project_id: string;
|
|
11225
|
+
/**
|
|
11226
|
+
* The Neon branch ID
|
|
11227
|
+
*/
|
|
11228
|
+
branch_id: string;
|
|
11229
|
+
};
|
|
11230
|
+
query?: never;
|
|
11231
|
+
url: '/projects/{project_id}/branches/{branch_id}/logs/query';
|
|
11232
|
+
};
|
|
11233
|
+
type QueryProjectBranchLogsErrors = {
|
|
11234
|
+
/**
|
|
11235
|
+
* The query could not be served as written. The body is always
|
|
11236
|
+
* `ProjectBranchLogsInvalidQuery` — see `reason` for the exact cause.
|
|
11237
|
+
*
|
|
11238
|
+
*/
|
|
11239
|
+
400: ProjectBranchLogsInvalidQuery;
|
|
11240
|
+
/**
|
|
11241
|
+
* Logs are not available for this branch, or the project/branch was
|
|
11242
|
+
* not found. The body is always `ProjectBranchLogsNotAvailable` — see
|
|
11243
|
+
* `reason` for the exact cause.
|
|
11244
|
+
*
|
|
11245
|
+
*/
|
|
11246
|
+
404: ProjectBranchLogsNotAvailable;
|
|
11247
|
+
/**
|
|
11248
|
+
* General Error.
|
|
11249
|
+
*
|
|
11250
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
11251
|
+
* and whether a response was received.
|
|
11252
|
+
*
|
|
11253
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
11254
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
11255
|
+
*
|
|
11256
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
11257
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
11258
|
+
*
|
|
11259
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
11260
|
+
*
|
|
11261
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
11262
|
+
*
|
|
11263
|
+
*/
|
|
11264
|
+
'4XX': GeneralError;
|
|
11265
|
+
};
|
|
11266
|
+
type QueryProjectBranchLogsError = QueryProjectBranchLogsErrors[keyof QueryProjectBranchLogsErrors];
|
|
11267
|
+
type QueryProjectBranchLogsResponses = {
|
|
11268
|
+
/**
|
|
11269
|
+
* Logs matching the supplied filters
|
|
11270
|
+
*/
|
|
11271
|
+
200: ProjectBranchLogsQueryResponse;
|
|
11272
|
+
};
|
|
11273
|
+
type QueryProjectBranchLogsResponse = QueryProjectBranchLogsResponses[keyof QueryProjectBranchLogsResponses];
|
|
11274
|
+
type ListProjectBranchLogFieldsData = {
|
|
11275
|
+
body?: never;
|
|
11276
|
+
path: {
|
|
11277
|
+
/**
|
|
11278
|
+
* The Neon project ID
|
|
11279
|
+
*/
|
|
11280
|
+
project_id: string;
|
|
11281
|
+
/**
|
|
11282
|
+
* The Neon branch ID
|
|
11283
|
+
*/
|
|
11284
|
+
branch_id: string;
|
|
11285
|
+
};
|
|
11286
|
+
query?: never;
|
|
11287
|
+
url: '/projects/{project_id}/branches/{branch_id}/logs/fields';
|
|
11288
|
+
};
|
|
11289
|
+
type ListProjectBranchLogFieldsErrors = {
|
|
11290
|
+
/**
|
|
11291
|
+
* Logs are not available for this branch, or the project/branch was
|
|
11292
|
+
* not found. The body is always `ProjectBranchLogsNotAvailable` — see
|
|
11293
|
+
* `reason` for the exact cause.
|
|
11294
|
+
*
|
|
11295
|
+
*/
|
|
11296
|
+
404: ProjectBranchLogsNotAvailable;
|
|
11297
|
+
/**
|
|
11298
|
+
* General Error.
|
|
11299
|
+
*
|
|
11300
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
11301
|
+
* and whether a response was received.
|
|
11302
|
+
*
|
|
11303
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
11304
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
11305
|
+
*
|
|
11306
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
11307
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
11308
|
+
*
|
|
11309
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
11310
|
+
*
|
|
11311
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
11312
|
+
*
|
|
11313
|
+
*/
|
|
11314
|
+
'4XX': GeneralError;
|
|
11315
|
+
};
|
|
11316
|
+
type ListProjectBranchLogFieldsError = ListProjectBranchLogFieldsErrors[keyof ListProjectBranchLogFieldsErrors];
|
|
11317
|
+
type ListProjectBranchLogFieldsResponses = {
|
|
11318
|
+
/**
|
|
11319
|
+
* Log fields available for value discovery on this branch
|
|
11320
|
+
*/
|
|
11321
|
+
200: ProjectBranchLogFieldsResponse;
|
|
11322
|
+
};
|
|
11323
|
+
type ListProjectBranchLogFieldsResponse = ListProjectBranchLogFieldsResponses[keyof ListProjectBranchLogFieldsResponses];
|
|
11324
|
+
type ListProjectBranchLogFieldValuesData = {
|
|
11325
|
+
body?: never;
|
|
11326
|
+
path: {
|
|
11327
|
+
/**
|
|
11328
|
+
* The Neon project ID
|
|
11329
|
+
*/
|
|
11330
|
+
project_id: string;
|
|
11331
|
+
/**
|
|
11332
|
+
* The Neon branch ID
|
|
11333
|
+
*/
|
|
11334
|
+
branch_id: string;
|
|
11335
|
+
/**
|
|
11336
|
+
* The log field whose distinct values should be returned. Must be one of
|
|
11337
|
+
* the names returned by the log fields endpoint for this branch.
|
|
11338
|
+
*
|
|
11339
|
+
*/
|
|
11340
|
+
field_name: string;
|
|
11341
|
+
};
|
|
11342
|
+
query?: {
|
|
11343
|
+
/**
|
|
11344
|
+
* Length of the lookup window, ending at `end_time` or at the current
|
|
11345
|
+
* time when `end_time` is omitted. Mutually exclusive with
|
|
11346
|
+
* `start_time`. Defaults to six hours.
|
|
11347
|
+
*
|
|
11348
|
+
*/
|
|
11349
|
+
since?: ProjectBranchLogDuration;
|
|
11350
|
+
/**
|
|
11351
|
+
* Inclusive beginning of the lookup window. Mutually exclusive with
|
|
11352
|
+
* `since`.
|
|
11353
|
+
*
|
|
11354
|
+
*/
|
|
11355
|
+
start_time?: string;
|
|
11356
|
+
/**
|
|
11357
|
+
* Exclusive end of the lookup window. Defaults to the current time.
|
|
11358
|
+
*/
|
|
11359
|
+
end_time?: string;
|
|
11360
|
+
/**
|
|
11361
|
+
* Only consider records emitted by this Neon service.
|
|
11362
|
+
*/
|
|
11363
|
+
source?: ProjectBranchLogSource;
|
|
11364
|
+
/**
|
|
11365
|
+
* Maximum number of distinct values to return. The response sets
|
|
11366
|
+
* `is_truncated` when this bound, or the server's own scan cap, cut the
|
|
11367
|
+
* list short.
|
|
11368
|
+
*
|
|
11369
|
+
*/
|
|
11370
|
+
limit?: number;
|
|
11371
|
+
};
|
|
11372
|
+
url: '/projects/{project_id}/branches/{branch_id}/logs/fields/{field_name}/values';
|
|
11373
|
+
};
|
|
11374
|
+
type ListProjectBranchLogFieldValuesErrors = {
|
|
11375
|
+
/**
|
|
11376
|
+
* The lookup could not be served as written. The body is always
|
|
11377
|
+
* `ProjectBranchLogsInvalidQuery` — see `reason` for the exact cause.
|
|
11378
|
+
*
|
|
11379
|
+
*/
|
|
11380
|
+
400: ProjectBranchLogsInvalidQuery;
|
|
11381
|
+
/**
|
|
11382
|
+
* Logs are not available for this branch, or the project/branch was
|
|
11383
|
+
* not found. The body is always `ProjectBranchLogsNotAvailable` — see
|
|
11384
|
+
* `reason` for the exact cause.
|
|
11385
|
+
*
|
|
11386
|
+
*/
|
|
11387
|
+
404: ProjectBranchLogsNotAvailable;
|
|
11388
|
+
/**
|
|
11389
|
+
* General Error.
|
|
11390
|
+
*
|
|
11391
|
+
* The request may or may not be safe to retry, depending on the HTTP method, response status code,
|
|
11392
|
+
* and whether a response was received.
|
|
11393
|
+
*
|
|
11394
|
+
* - If no response is returned from the API, a network error or timeout likely occurred.
|
|
11395
|
+
* - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
|
|
11396
|
+
*
|
|
11397
|
+
* The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
|
|
11398
|
+
* The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.
|
|
11399
|
+
*
|
|
11400
|
+
* Any request that returns a `503 Service Unavailable` response is always safe to retry.
|
|
11401
|
+
*
|
|
11402
|
+
* Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
|
|
11403
|
+
*
|
|
11404
|
+
*/
|
|
11405
|
+
'4XX': GeneralError;
|
|
11406
|
+
};
|
|
11407
|
+
type ListProjectBranchLogFieldValuesError = ListProjectBranchLogFieldValuesErrors[keyof ListProjectBranchLogFieldValuesErrors];
|
|
11408
|
+
type ListProjectBranchLogFieldValuesResponses = {
|
|
11409
|
+
/**
|
|
11410
|
+
* Distinct values for the requested log field
|
|
11411
|
+
*/
|
|
11412
|
+
200: ProjectBranchLogFieldValuesResponse;
|
|
11413
|
+
};
|
|
11414
|
+
type ListProjectBranchLogFieldValuesResponse = ListProjectBranchLogFieldValuesResponses[keyof ListProjectBranchLogFieldValuesResponses];
|
|
10333
11415
|
type ListProjectBranchBucketObjectsData = {
|
|
10334
11416
|
body?: never;
|
|
10335
11417
|
path: {
|
|
@@ -11014,5 +12096,5 @@ type CreateProjectBranchFunctionDeploymentResponses = {
|
|
|
11014
12096
|
};
|
|
11015
12097
|
type CreateProjectBranchFunctionDeploymentResponse = CreateProjectBranchFunctionDeploymentResponses[keyof CreateProjectBranchFunctionDeploymentResponses];
|
|
11016
12098
|
//#endregion
|
|
11017
|
-
export { AcceptProjectTransferRequestData, AcceptProjectTransferRequestError, AcceptProjectTransferRequestErrors, AcceptProjectTransferRequestResponse, AcceptProjectTransferRequestResponses, AcceptProjectTransferRequestSatisfiesPlanError, ActiveRegionsResponse, AddBranchNeonAuthOauthProviderData, AddBranchNeonAuthOauthProviderError, AddBranchNeonAuthOauthProviderErrors, AddBranchNeonAuthOauthProviderResponse, AddBranchNeonAuthOauthProviderResponses, AddBranchNeonAuthTrustedDomainData, AddBranchNeonAuthTrustedDomainError, AddBranchNeonAuthTrustedDomainErrors, AddBranchNeonAuthTrustedDomainResponses, AddNeonAuthDomainToRedirectUriWhitelistData, AddNeonAuthDomainToRedirectUriWhitelistError, AddNeonAuthDomainToRedirectUriWhitelistErrors, AddNeonAuthDomainToRedirectUriWhitelistResponses, AddNeonAuthOauthProviderData, AddNeonAuthOauthProviderError, AddNeonAuthOauthProviderErrors, AddNeonAuthOauthProviderResponse, AddNeonAuthOauthProviderResponses, AddProjectJwksData, AddProjectJwksError, AddProjectJwksErrors, AddProjectJwksRequest, AddProjectJwksResponse, AddProjectJwksResponses, AdvisorCategory, AdvisorIssue, AllowedIps, AnnotationCreateValueRequest, AnnotationData, AnnotationObjectData, AnnotationResponse, AnnotationValueData, AnnotationsMapResponse, AnonymizationRunMetadata, AnonymizedBranchStatusResponse, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyCreatorData, ApiKeyRevokeResponse, ApiKeysListResponseItem, ApplicationType, AssignOrganizationVpcEndpointData, AssignOrganizationVpcEndpointError, AssignOrganizationVpcEndpointErrors, AssignOrganizationVpcEndpointResponses, AssignProjectVpcEndpointData, AssignProjectVpcEndpointError, AssignProjectVpcEndpointErrors, AssignProjectVpcEndpointResponses, AuthDetailsResponse, AvailablePreloadLibraries, AvailablePreloadLibrary, BackupSchedule, BackupScheduleItem, BillingAccount, BillingAccountState, BillingPaymentMethod, BillingSubscriptionType, Branch, BranchAiGateway, BranchAiGatewayNotEnabled, BranchAnonymizedCreateRequest, BranchCreateRequest, BranchCreateRequestEndpointOptions, BranchOperations, BranchRecoverResponse, BranchRecoveryInfo, BranchResponse, BranchRestoreRequest, BranchRestoreStatus, BranchRestrictedAction, BranchSchemaCompareResponse, BranchSchemaJson, BranchSchemaResponse, BranchState, BranchStorage, BranchStorageNotEnabled, BranchUpdateRequest, BranchesCountResponse, BranchesResponse, Bucket, BucketAccessLevel, BucketCreateRequest, BucketObject, BucketObjectsDeletePrefixResponse, BucketObjectsListResponse, BucketResponse, BucketsListResponse, ClientOptions, ComputeUnit, ConnectionDetails, ConnectionParameters, ConnectionUriResponse, ConnectionUrisOptionalResponse, ConnectionUrisResponse, ConsumptionHistoryGranularity, ConsumptionHistoryPerBranchV2, ConsumptionHistoryPerBranchV2Response, ConsumptionHistoryPerPeriod, ConsumptionHistoryPerPeriodV2, ConsumptionHistoryPerProject, ConsumptionHistoryPerProjectResponse, ConsumptionHistoryPerProjectV2, ConsumptionHistoryPerProjectV2Response, ConsumptionHistoryPerTimeframe, ConsumptionHistoryPerTimeframeV2, ConsumptionHistoryQueryMetrics, ConsumptionMetricValue, CountProjectBranchesData, CountProjectBranchesError, CountProjectBranchesErrors, CountProjectBranchesResponse, CountProjectBranchesResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateBranchNeonAuthNewUserData, CreateBranchNeonAuthNewUserError, CreateBranchNeonAuthNewUserErrors, CreateBranchNeonAuthNewUserRequest, CreateBranchNeonAuthNewUserResponse, CreateBranchNeonAuthNewUserResponses, CreateCredentialData, CreateCredentialError, CreateCredentialErrors, CreateCredentialRequest, CreateCredentialResponse, CreateCredentialResponse2, CreateCredentialResponses, CreateNeonAuthData, CreateNeonAuthError, CreateNeonAuthErrors, CreateNeonAuthIntegrationData, CreateNeonAuthIntegrationError, CreateNeonAuthIntegrationErrors, CreateNeonAuthIntegrationResponse, CreateNeonAuthIntegrationResponses, CreateNeonAuthNewUserData, CreateNeonAuthNewUserError, CreateNeonAuthNewUserErrors, CreateNeonAuthNewUserResponse, CreateNeonAuthNewUserResponses, CreateNeonAuthProviderSdkKeysData, CreateNeonAuthProviderSdkKeysError, CreateNeonAuthProviderSdkKeysErrors, CreateNeonAuthProviderSdkKeysResponse, CreateNeonAuthProviderSdkKeysResponses, CreateNeonAuthResponse, CreateNeonAuthResponses, CreateOrgApiKeyData, CreateOrgApiKeyError, CreateOrgApiKeyErrors, CreateOrgApiKeyResponse, CreateOrgApiKeyResponses, CreateOrganizationInvitationsData, CreateOrganizationInvitationsError, CreateOrganizationInvitationsErrors, CreateOrganizationInvitationsResponse, CreateOrganizationInvitationsResponses, CreateProjectBranchAnonymizedData, CreateProjectBranchAnonymizedError, CreateProjectBranchAnonymizedErrors, CreateProjectBranchAnonymizedResponse, CreateProjectBranchAnonymizedResponses, CreateProjectBranchBucketData, CreateProjectBranchBucketError, CreateProjectBranchBucketErrors, CreateProjectBranchBucketResponse, CreateProjectBranchBucketResponses, CreateProjectBranchData, CreateProjectBranchDataApiData, CreateProjectBranchDataApiError, CreateProjectBranchDataApiErrors, CreateProjectBranchDataApiResponse, CreateProjectBranchDataApiResponses, CreateProjectBranchDatabaseData, CreateProjectBranchDatabaseError, CreateProjectBranchDatabaseErrors, CreateProjectBranchDatabaseResponse, CreateProjectBranchDatabaseResponses, CreateProjectBranchError, CreateProjectBranchErrors, CreateProjectBranchFunctionDeploymentData, CreateProjectBranchFunctionDeploymentError, CreateProjectBranchFunctionDeploymentErrors, CreateProjectBranchFunctionDeploymentResponse, CreateProjectBranchFunctionDeploymentResponses, CreateProjectBranchResponse, CreateProjectBranchResponses, CreateProjectBranchRoleData, CreateProjectBranchRoleError, CreateProjectBranchRoleErrors, CreateProjectBranchRoleResponse, CreateProjectBranchRoleResponses, CreateProjectData, CreateProjectEndpointData, CreateProjectEndpointError, CreateProjectEndpointErrors, CreateProjectEndpointResponse, CreateProjectEndpointResponses, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateProjectTransferRequestData, CreateProjectTransferRequestError, CreateProjectTransferRequestErrors, CreateProjectTransferRequestResponse, CreateProjectTransferRequestResponses, CreateSnapshotData, CreateSnapshotError, CreateSnapshotErrors, CreateSnapshotResponse, CreateSnapshotResponses, CredentialMeta, CredentialScope, CurrentUserAuthAccount, CurrentUserInfoResponse, CursorPagination, CursorPaginationResponse, CursorParam, DataApiCreateRequest, DataApiCreateResponse, DataApiReponse, DataApiSettings, DataApiUpdateRequest, Database, DatabaseCreateRequest, DatabaseOperations, DatabaseResponse, DatabaseUpdateRequest, DatabasesResponse, DefaultEndpointSettings, DeleteBranchNeonAuthOauthProviderData, DeleteBranchNeonAuthOauthProviderError, DeleteBranchNeonAuthOauthProviderErrors, DeleteBranchNeonAuthOauthProviderResponses, DeleteBranchNeonAuthTrustedDomainData, DeleteBranchNeonAuthTrustedDomainError, DeleteBranchNeonAuthTrustedDomainErrors, DeleteBranchNeonAuthTrustedDomainResponses, DeleteBranchNeonAuthUserData, DeleteBranchNeonAuthUserError, DeleteBranchNeonAuthUserErrors, DeleteBranchNeonAuthUserResponse, DeleteBranchNeonAuthUserResponses, DeleteNeonAuthDomainFromRedirectUriWhitelistData, DeleteNeonAuthDomainFromRedirectUriWhitelistError, DeleteNeonAuthDomainFromRedirectUriWhitelistErrors, DeleteNeonAuthDomainFromRedirectUriWhitelistResponses, DeleteNeonAuthIntegrationData, DeleteNeonAuthIntegrationError, DeleteNeonAuthIntegrationErrors, DeleteNeonAuthIntegrationResponses, DeleteNeonAuthOauthProviderData, DeleteNeonAuthOauthProviderError, DeleteNeonAuthOauthProviderErrors, DeleteNeonAuthOauthProviderResponses, DeleteNeonAuthUserData, DeleteNeonAuthUserError, DeleteNeonAuthUserErrors, DeleteNeonAuthUserResponse, DeleteNeonAuthUserResponses, DeleteOrganizationSpendingLimitData, DeleteOrganizationSpendingLimitError, DeleteOrganizationSpendingLimitErrors, DeleteOrganizationSpendingLimitResponse, DeleteOrganizationSpendingLimitResponses, DeleteOrganizationVpcEndpointData, DeleteOrganizationVpcEndpointError, DeleteOrganizationVpcEndpointErrors, DeleteOrganizationVpcEndpointResponses, DeleteProjectBranchBucketData, DeleteProjectBranchBucketError, DeleteProjectBranchBucketErrors, DeleteProjectBranchBucketObjectData, DeleteProjectBranchBucketObjectError, DeleteProjectBranchBucketObjectErrors, DeleteProjectBranchBucketObjectResponse, DeleteProjectBranchBucketObjectResponses, DeleteProjectBranchBucketObjectsByPrefixData, DeleteProjectBranchBucketObjectsByPrefixError, DeleteProjectBranchBucketObjectsByPrefixErrors, DeleteProjectBranchBucketObjectsByPrefixResponse, DeleteProjectBranchBucketObjectsByPrefixResponses, DeleteProjectBranchBucketResponse, DeleteProjectBranchBucketResponses, DeleteProjectBranchData, DeleteProjectBranchDataApiData, DeleteProjectBranchDataApiError, DeleteProjectBranchDataApiErrors, DeleteProjectBranchDataApiResponse, DeleteProjectBranchDataApiResponses, DeleteProjectBranchDatabaseData, DeleteProjectBranchDatabaseError, DeleteProjectBranchDatabaseErrors, DeleteProjectBranchDatabaseResponse, DeleteProjectBranchDatabaseResponses, DeleteProjectBranchError, DeleteProjectBranchErrors, DeleteProjectBranchFunctionData, DeleteProjectBranchFunctionError, DeleteProjectBranchFunctionErrors, DeleteProjectBranchFunctionResponse, DeleteProjectBranchFunctionResponses, DeleteProjectBranchResponse, DeleteProjectBranchResponses, DeleteProjectBranchRoleData, DeleteProjectBranchRoleError, DeleteProjectBranchRoleErrors, DeleteProjectBranchRoleResponse, DeleteProjectBranchRoleResponses, DeleteProjectData, DeleteProjectEndpointData, DeleteProjectEndpointError, DeleteProjectEndpointErrors, DeleteProjectEndpointResponse, DeleteProjectEndpointResponses, DeleteProjectError, DeleteProjectErrors, DeleteProjectJwksData, DeleteProjectJwksError, DeleteProjectJwksErrors, DeleteProjectJwksResponse, DeleteProjectJwksResponses, DeleteProjectResponse, DeleteProjectResponses, DeleteProjectVpcEndpointData, DeleteProjectVpcEndpointError, DeleteProjectVpcEndpointErrors, DeleteProjectVpcEndpointResponses, DeleteSnapshotData, DeleteSnapshotError, DeleteSnapshotErrors, DeleteSnapshotResponse, DeleteSnapshotResponses, DisableNeonAuthData, DisableNeonAuthError, DisableNeonAuthErrors, DisableNeonAuthResponses, EmptyResponse, EnableNeonAuthIntegrationRequest, Endpoint, EndpointCreateRequest, EndpointOperations, EndpointPoolerMode, EndpointResponse, EndpointSettingsData, EndpointState, EndpointType, EndpointUpdateRequest, EndpointsOptionalResponse, EndpointsResponse, ErrorCode, FinalizeRestoreBranchData, FinalizeRestoreBranchError, FinalizeRestoreBranchErrors, FinalizeRestoreBranchResponse, FinalizeRestoreBranchResponses, FunctionDeployRequest, GeneralError, GetActiveRegionsData, GetActiveRegionsError, GetActiveRegionsErrors, GetActiveRegionsResponse, GetActiveRegionsResponses, GetAnonymizedBranchStatusData, GetAnonymizedBranchStatusError, GetAnonymizedBranchStatusErrors, GetAnonymizedBranchStatusResponse, GetAnonymizedBranchStatusResponses, GetAuthDetailsData, GetAuthDetailsError, GetAuthDetailsErrors, GetAuthDetailsResponse, GetAuthDetailsResponses, GetAvailablePreloadLibrariesData, GetAvailablePreloadLibrariesError, GetAvailablePreloadLibrariesErrors, GetAvailablePreloadLibrariesResponse, GetAvailablePreloadLibrariesResponses, GetConnectionUriData, GetConnectionUriError, GetConnectionUriErrors, GetConnectionUriResponse, GetConnectionUriResponses, GetConsumptionHistoryPerBranchV2Data, GetConsumptionHistoryPerBranchV2Error, GetConsumptionHistoryPerBranchV2Errors, GetConsumptionHistoryPerBranchV2Response, GetConsumptionHistoryPerBranchV2Responses, GetConsumptionHistoryPerProjectData, GetConsumptionHistoryPerProjectError, GetConsumptionHistoryPerProjectErrors, GetConsumptionHistoryPerProjectResponse, GetConsumptionHistoryPerProjectResponses, GetConsumptionHistoryPerProjectV2Data, GetConsumptionHistoryPerProjectV2Error, GetConsumptionHistoryPerProjectV2Errors, GetConsumptionHistoryPerProjectV2Response, GetConsumptionHistoryPerProjectV2Responses, GetCurrentUserInfoData, GetCurrentUserInfoError, GetCurrentUserInfoErrors, GetCurrentUserInfoResponse, GetCurrentUserInfoResponses, GetCurrentUserOrganizationsData, GetCurrentUserOrganizationsError, GetCurrentUserOrganizationsErrors, GetCurrentUserOrganizationsResponse, GetCurrentUserOrganizationsResponses, GetMaskingRulesData, GetMaskingRulesError, GetMaskingRulesErrors, GetMaskingRulesResponse, GetMaskingRulesResponses, GetNeonAuthAllowLocalhostData, GetNeonAuthAllowLocalhostError, GetNeonAuthAllowLocalhostErrors, GetNeonAuthAllowLocalhostResponse, GetNeonAuthAllowLocalhostResponses, GetNeonAuthData, GetNeonAuthEmailAndPasswordConfigData, GetNeonAuthEmailAndPasswordConfigError, GetNeonAuthEmailAndPasswordConfigErrors, GetNeonAuthEmailAndPasswordConfigResponse, GetNeonAuthEmailAndPasswordConfigResponses, GetNeonAuthEmailProviderData, GetNeonAuthEmailProviderError, GetNeonAuthEmailProviderErrors, GetNeonAuthEmailProviderResponse, GetNeonAuthEmailProviderResponses, GetNeonAuthEmailServerData, GetNeonAuthEmailServerError, GetNeonAuthEmailServerErrors, GetNeonAuthEmailServerResponse, GetNeonAuthEmailServerResponses, GetNeonAuthError, GetNeonAuthErrors, GetNeonAuthPhoneNumberPluginData, GetNeonAuthPhoneNumberPluginError, GetNeonAuthPhoneNumberPluginErrors, GetNeonAuthPhoneNumberPluginResponse, GetNeonAuthPhoneNumberPluginResponses, GetNeonAuthPluginConfigsData, GetNeonAuthPluginConfigsError, GetNeonAuthPluginConfigsErrors, GetNeonAuthPluginConfigsResponse, GetNeonAuthPluginConfigsResponses, GetNeonAuthResponse, GetNeonAuthResponses, GetNeonAuthWebhookConfigData, GetNeonAuthWebhookConfigError, GetNeonAuthWebhookConfigErrors, GetNeonAuthWebhookConfigResponse, GetNeonAuthWebhookConfigResponses, GetOrganizationData, GetOrganizationError, GetOrganizationErrors, GetOrganizationInvitationsData, GetOrganizationInvitationsError, GetOrganizationInvitationsErrors, GetOrganizationInvitationsResponse, GetOrganizationInvitationsResponses, GetOrganizationMemberData, GetOrganizationMemberError, GetOrganizationMemberErrors, GetOrganizationMemberResponse, GetOrganizationMemberResponses, GetOrganizationMembersData, GetOrganizationMembersError, GetOrganizationMembersErrors, GetOrganizationMembersResponse, GetOrganizationMembersResponses, GetOrganizationResponse, GetOrganizationResponses, GetOrganizationSpendingLimitData, GetOrganizationSpendingLimitError, GetOrganizationSpendingLimitErrors, GetOrganizationSpendingLimitResponse, GetOrganizationSpendingLimitResponses, GetOrganizationVpcEndpointDetailsData, GetOrganizationVpcEndpointDetailsError, GetOrganizationVpcEndpointDetailsErrors, GetOrganizationVpcEndpointDetailsResponse, GetOrganizationVpcEndpointDetailsResponses, GetProjectAdvisorSecurityIssuesData, GetProjectAdvisorSecurityIssuesError, GetProjectAdvisorSecurityIssuesErrors, GetProjectAdvisorSecurityIssuesResponse, GetProjectAdvisorSecurityIssuesResponses, GetProjectBranchAiGatewayData, GetProjectBranchAiGatewayError, GetProjectBranchAiGatewayErrors, GetProjectBranchAiGatewayResponse, GetProjectBranchAiGatewayResponses, GetProjectBranchBucketObjectData, GetProjectBranchBucketObjectError, GetProjectBranchBucketObjectErrors, GetProjectBranchBucketObjectResponse, GetProjectBranchBucketObjectResponses, GetProjectBranchData, GetProjectBranchDataApiData, GetProjectBranchDataApiError, GetProjectBranchDataApiErrors, GetProjectBranchDataApiResponse, GetProjectBranchDataApiResponses, GetProjectBranchDatabaseData, GetProjectBranchDatabaseError, GetProjectBranchDatabaseErrors, GetProjectBranchDatabaseResponse, GetProjectBranchDatabaseResponses, GetProjectBranchError, GetProjectBranchErrors, GetProjectBranchFunctionData, GetProjectBranchFunctionError, GetProjectBranchFunctionErrors, GetProjectBranchFunctionResponse, GetProjectBranchFunctionResponses, GetProjectBranchResponse, GetProjectBranchResponses, GetProjectBranchRoleData, GetProjectBranchRoleError, GetProjectBranchRoleErrors, GetProjectBranchRolePasswordData, GetProjectBranchRolePasswordError, GetProjectBranchRolePasswordErrors, GetProjectBranchRolePasswordResponse, GetProjectBranchRolePasswordResponses, GetProjectBranchRoleResponse, GetProjectBranchRoleResponses, GetProjectBranchSchemaComparisonData, GetProjectBranchSchemaComparisonError, GetProjectBranchSchemaComparisonErrors, GetProjectBranchSchemaComparisonResponse, GetProjectBranchSchemaComparisonResponses, GetProjectBranchSchemaData, GetProjectBranchSchemaError, GetProjectBranchSchemaErrors, GetProjectBranchSchemaResponse, GetProjectBranchSchemaResponses, GetProjectBranchStorageData, GetProjectBranchStorageError, GetProjectBranchStorageErrors, GetProjectBranchStorageResponse, GetProjectBranchStorageResponses, GetProjectData, GetProjectEndpointData, GetProjectEndpointError, GetProjectEndpointErrors, GetProjectEndpointResponse, GetProjectEndpointResponses, GetProjectError, GetProjectErrors, GetProjectJwksData, GetProjectJwksError, GetProjectJwksErrors, GetProjectJwksResponse, GetProjectJwksResponses, GetProjectOperationData, GetProjectOperationError, GetProjectOperationErrors, GetProjectOperationResponse, GetProjectOperationResponses, GetProjectResponse, GetProjectResponses, GetSnapshotScheduleData, GetSnapshotScheduleError, GetSnapshotScheduleErrors, GetSnapshotScheduleResponse, GetSnapshotScheduleResponses, GrantPermissionToProjectData, GrantPermissionToProjectError, GrantPermissionToProjectErrors, GrantPermissionToProjectRequest, GrantPermissionToProjectResponse, GrantPermissionToProjectResponses, IdentityProviderId, Invitation, Jwks, JwksCreationOperation, JwksResponse, LimitParam, LimitsUnsatisfiedResponse, ListApiKeysData, ListApiKeysError, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListBranchNeonAuthOauthProvidersData, ListBranchNeonAuthOauthProvidersError, ListBranchNeonAuthOauthProvidersErrors, ListBranchNeonAuthOauthProvidersResponse, ListBranchNeonAuthOauthProvidersResponses, ListBranchNeonAuthTrustedDomainsData, ListBranchNeonAuthTrustedDomainsError, ListBranchNeonAuthTrustedDomainsErrors, ListBranchNeonAuthTrustedDomainsResponse, ListBranchNeonAuthTrustedDomainsResponses, ListCredentialsData, ListCredentialsError, ListCredentialsErrors, ListCredentialsResponse, ListCredentialsResponse2, ListCredentialsResponses, ListNeonAuthIntegrationsData, ListNeonAuthIntegrationsError, ListNeonAuthIntegrationsErrors, ListNeonAuthIntegrationsResponse, ListNeonAuthIntegrationsResponse2, ListNeonAuthIntegrationsResponses, ListNeonAuthOauthProvidersData, ListNeonAuthOauthProvidersError, ListNeonAuthOauthProvidersErrors, ListNeonAuthOauthProvidersResponse, ListNeonAuthOauthProvidersResponse2, ListNeonAuthOauthProvidersResponses, ListNeonAuthRedirectUriWhitelistDomainsData, ListNeonAuthRedirectUriWhitelistDomainsError, ListNeonAuthRedirectUriWhitelistDomainsErrors, ListNeonAuthRedirectUriWhitelistDomainsResponse, ListNeonAuthRedirectUriWhitelistDomainsResponses, ListOrgApiKeysData, ListOrgApiKeysError, ListOrgApiKeysErrors, ListOrgApiKeysResponse, ListOrgApiKeysResponses, ListOrganizationVpcEndpointsAllRegionsData, ListOrganizationVpcEndpointsAllRegionsError, ListOrganizationVpcEndpointsAllRegionsErrors, ListOrganizationVpcEndpointsAllRegionsResponse, ListOrganizationVpcEndpointsAllRegionsResponses, ListOrganizationVpcEndpointsData, ListOrganizationVpcEndpointsError, ListOrganizationVpcEndpointsErrors, ListOrganizationVpcEndpointsResponse, ListOrganizationVpcEndpointsResponses, ListProjectBranchBucketObjectsData, ListProjectBranchBucketObjectsError, ListProjectBranchBucketObjectsErrors, ListProjectBranchBucketObjectsResponse, ListProjectBranchBucketObjectsResponses, ListProjectBranchBucketsData, ListProjectBranchBucketsError, ListProjectBranchBucketsErrors, ListProjectBranchBucketsResponse, ListProjectBranchBucketsResponses, ListProjectBranchDatabasesData, ListProjectBranchDatabasesError, ListProjectBranchDatabasesErrors, ListProjectBranchDatabasesResponse, ListProjectBranchDatabasesResponses, ListProjectBranchEndpointsData, ListProjectBranchEndpointsError, ListProjectBranchEndpointsErrors, ListProjectBranchEndpointsResponse, ListProjectBranchEndpointsResponses, ListProjectBranchFunctionsData, ListProjectBranchFunctionsError, ListProjectBranchFunctionsErrors, ListProjectBranchFunctionsResponse, ListProjectBranchFunctionsResponses, ListProjectBranchRolesData, ListProjectBranchRolesError, ListProjectBranchRolesErrors, ListProjectBranchRolesResponse, ListProjectBranchRolesResponses, ListProjectBranchesData, ListProjectBranchesError, ListProjectBranchesErrors, ListProjectBranchesResponse, ListProjectBranchesResponses, ListProjectEndpointsData, ListProjectEndpointsError, ListProjectEndpointsErrors, ListProjectEndpointsResponse, ListProjectEndpointsResponses, ListProjectOperationsData, ListProjectOperationsError, ListProjectOperationsErrors, ListProjectOperationsResponse, ListProjectOperationsResponses, ListProjectPermissionsData, ListProjectPermissionsError, ListProjectPermissionsErrors, ListProjectPermissionsResponse, ListProjectPermissionsResponses, ListProjectVpcEndpointsData, ListProjectVpcEndpointsError, ListProjectVpcEndpointsErrors, ListProjectVpcEndpointsResponse, ListProjectVpcEndpointsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListSharedProjectsData, ListSharedProjectsError, ListSharedProjectsErrors, ListSharedProjectsResponse, ListSharedProjectsResponses, ListSnapshotsData, ListSnapshotsError, ListSnapshotsErrors, ListSnapshotsResponse, ListSnapshotsResponses, MaintenanceWindow, MaskingRule, MaskingRulesResponse, MaskingRulesUpdateRequest, Member, MemberRole, MemberUserInfo, MemberWithUser, NeonAuthAddDomainToRedirectUriWhitelistRequest, NeonAuthAddOAuthProviderRequest, NeonAuthAllowLocalhostResponse, NeonAuthConfigResponse, NeonAuthConfigUpdate, NeonAuthCreateAuthProviderSdkKeysRequest, NeonAuthCreateIntegrationRequest, NeonAuthCreateIntegrationResponse, NeonAuthCreateNewUserRequest, NeonAuthCreateNewUserResponse, NeonAuthDeleteDomainFromRedirectUriWhitelistItem, NeonAuthDeleteDomainFromRedirectUriWhitelistRequest, NeonAuthEmailAndPasswordConfig, NeonAuthEmailAndPasswordConfigUpdate, NeonAuthEmailServerConfig, NeonAuthEmailVerificationMethod, NeonAuthIntegration, NeonAuthMagicLinkConfig, NeonAuthMagicLinkConfigUpdate, NeonAuthOauthProvider, NeonAuthOauthProviderId, NeonAuthOauthProviderType, NeonAuthOrganizationConfig, NeonAuthOrganizationConfigUpdate, NeonAuthPhoneNumberConfig, NeonAuthPhoneNumberConfigUpdate, NeonAuthPluginConfigs, NeonAuthProviderProjectOwnedBy, NeonAuthProviderProjectTransferStatus, NeonAuthRedirectUriWhitelistDomain, NeonAuthRedirectUriWhitelistResponse, NeonAuthSupportedAuthProvider, NeonAuthTransferAuthProviderProjectRequest, NeonAuthTransferAuthProviderProjectResponse, NeonAuthUpdateOAuthProviderRequest, NeonAuthWebhookConfig, NeonFunction, NeonFunctionDeployment, NeonFunctionDeploymentResponse, NeonFunctionResponse, NeonFunctionUpdateRequest, NeonFunctionsListResponse, Operation, OperationAction, OperationResponse, OperationStatus, OperationsResponse, OrgApiKeyCreateRequest, OrgApiKeyCreateResponse, OrgApiKeyRevokeResponse, OrgApiKeysListResponseItem, Organization, OrganizationInvitationsResponse, OrganizationInviteCreateRequest, OrganizationInvitesCreateRequest, OrganizationMemberUpdateRequest, OrganizationMembersResponse, OrganizationsResponse, Pagination, PaginationResponse, PaymentSource, PaymentSourceBankCard, PgSettingsData, PgVersion, PgbouncerSettingsData, PlanDetails, PlanVersion, PreloadLibraries, PresignProjectBranchBucketObjectData, PresignProjectBranchBucketObjectError, PresignProjectBranchBucketObjectErrors, PresignProjectBranchBucketObjectResponse, PresignProjectBranchBucketObjectResponses, PresignRequest, PresignResponse, Project, ProjectAuditLogLevel, ProjectCreateRequest, ProjectJwksResponse, ProjectListItem, ProjectOwnerData, ProjectPermission, ProjectPermissionLevel, ProjectPermissions, ProjectQuota, ProjectRecoverResponse, ProjectResponse, ProjectSettingsData, ProjectTransferRequestResponse, ProjectUpdateRequest, ProjectsApplicationsMapResponse, ProjectsIntegrationsMapResponse, ProjectsResponse, ProjectsWithIntegrationResponse, Provisioner, RecoverProjectBranchData, RecoverProjectBranchError, RecoverProjectBranchErrors, RecoverProjectBranchResponse, RecoverProjectBranchResponses, RecoverProjectData, RecoverProjectError, RecoverProjectErrors, RecoverProjectResponse, RecoverProjectResponses, RegionResponse, RemoveOrganizationMemberData, RemoveOrganizationMemberError, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponse, RemoveOrganizationMemberResponses, ResetProjectBranchRolePasswordData, ResetProjectBranchRolePasswordError, ResetProjectBranchRolePasswordErrors, ResetProjectBranchRolePasswordResponse, ResetProjectBranchRolePasswordResponses, RestartProjectEndpointData, RestartProjectEndpointError, RestartProjectEndpointErrors, RestartProjectEndpointResponse, RestartProjectEndpointResponses, RestoreProjectBranchData, RestoreProjectBranchError, RestoreProjectBranchErrors, RestoreProjectBranchResponse, RestoreProjectBranchResponses, RestoreSnapshotData, RestoreSnapshotError, RestoreSnapshotErrors, RestoreSnapshotResponse, RestoreSnapshotResponses, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyErrors, RevokeApiKeyResponse, RevokeApiKeyResponses, RevokeCredentialData, RevokeCredentialError, RevokeCredentialErrors, RevokeCredentialResponse, RevokeCredentialResponses, RevokeOrgApiKeyData, RevokeOrgApiKeyError, RevokeOrgApiKeyErrors, RevokeOrgApiKeyResponse, RevokeOrgApiKeyResponses, RevokePermissionFromProjectData, RevokePermissionFromProjectError, RevokePermissionFromProjectErrors, RevokePermissionFromProjectResponse, RevokePermissionFromProjectResponses, Role, RoleCreateRequest, RoleOperations, RolePasswordResponse, RoleResponse, RolesResponse, SendNeonAuthTestEmailData, SendNeonAuthTestEmailError, SendNeonAuthTestEmailErrors, SendNeonAuthTestEmailRequest, SendNeonAuthTestEmailResponse, SendNeonAuthTestEmailResponse2, SendNeonAuthTestEmailResponses, SetDefaultProjectBranchData, SetDefaultProjectBranchError, SetDefaultProjectBranchErrors, SetDefaultProjectBranchResponse, SetDefaultProjectBranchResponses, SetOrganizationSpendingLimitData, SetOrganizationSpendingLimitError, SetOrganizationSpendingLimitErrors, SetOrganizationSpendingLimitResponse, SetOrganizationSpendingLimitResponses, SetSnapshotScheduleData, SetSnapshotScheduleError, SetSnapshotScheduleErrors, SetSnapshotScheduleResponse, SetSnapshotScheduleResponses, SharedEmailServer, Snapshot, SnapshotUpdateRequest, SortOrderParam, SpendingLimitResponse, SpendingLimitUpdateRequest, StandardEmailServer, StartAnonymizationData, StartAnonymizationError, StartAnonymizationErrors, StartAnonymizationResponse, StartAnonymizationResponses, StartProjectEndpointData, StartProjectEndpointError, StartProjectEndpointErrors, StartProjectEndpointResponse, StartProjectEndpointResponses, SuspendProjectEndpointData, SuspendProjectEndpointError, SuspendProjectEndpointErrors, SuspendProjectEndpointResponse, SuspendProjectEndpointResponses, SuspendTimeoutSeconds, TimeoutParam, TransferNeonAuthProviderProjectData, TransferNeonAuthProviderProjectError, TransferNeonAuthProviderProjectErrors, TransferNeonAuthProviderProjectResponse, TransferNeonAuthProviderProjectResponses, TransferProjectsFromOrgToOrgData, TransferProjectsFromOrgToOrgError, TransferProjectsFromOrgToOrgErrors, TransferProjectsFromOrgToOrgResponse, TransferProjectsFromOrgToOrgResponses, TransferProjectsFromUserToOrgData, TransferProjectsFromUserToOrgError, TransferProjectsFromUserToOrgErrors, TransferProjectsFromUserToOrgResponse, TransferProjectsFromUserToOrgResponses, TransferProjectsToOrganizationRequest, UpdateBranchNeonAuthOauthProviderData, UpdateBranchNeonAuthOauthProviderError, UpdateBranchNeonAuthOauthProviderErrors, UpdateBranchNeonAuthOauthProviderResponse, UpdateBranchNeonAuthOauthProviderResponses, UpdateMaskingRulesData, UpdateMaskingRulesError, UpdateMaskingRulesErrors, UpdateMaskingRulesResponse, UpdateMaskingRulesResponses, UpdateNeonAuthAllowLocalhostData, UpdateNeonAuthAllowLocalhostError, UpdateNeonAuthAllowLocalhostErrors, UpdateNeonAuthAllowLocalhostRequest, UpdateNeonAuthAllowLocalhostResponse, UpdateNeonAuthAllowLocalhostResponses, UpdateNeonAuthConfigData, UpdateNeonAuthConfigError, UpdateNeonAuthConfigErrors, UpdateNeonAuthConfigResponse, UpdateNeonAuthConfigResponses, UpdateNeonAuthEmailAndPasswordConfigData, UpdateNeonAuthEmailAndPasswordConfigError, UpdateNeonAuthEmailAndPasswordConfigErrors, UpdateNeonAuthEmailAndPasswordConfigResponse, UpdateNeonAuthEmailAndPasswordConfigResponses, UpdateNeonAuthEmailProviderData, UpdateNeonAuthEmailProviderError, UpdateNeonAuthEmailProviderErrors, UpdateNeonAuthEmailProviderResponse, UpdateNeonAuthEmailProviderResponses, UpdateNeonAuthEmailServerData, UpdateNeonAuthEmailServerError, UpdateNeonAuthEmailServerErrors, UpdateNeonAuthEmailServerResponse, UpdateNeonAuthEmailServerResponses, UpdateNeonAuthMagicLinkPluginData, UpdateNeonAuthMagicLinkPluginError, UpdateNeonAuthMagicLinkPluginErrors, UpdateNeonAuthMagicLinkPluginResponse, UpdateNeonAuthMagicLinkPluginResponses, UpdateNeonAuthOauthProviderData, UpdateNeonAuthOauthProviderError, UpdateNeonAuthOauthProviderErrors, UpdateNeonAuthOauthProviderResponse, UpdateNeonAuthOauthProviderResponses, UpdateNeonAuthOrganizationPluginData, UpdateNeonAuthOrganizationPluginError, UpdateNeonAuthOrganizationPluginErrors, UpdateNeonAuthOrganizationPluginResponse, UpdateNeonAuthOrganizationPluginResponses, UpdateNeonAuthPhoneNumberPluginData, UpdateNeonAuthPhoneNumberPluginError, UpdateNeonAuthPhoneNumberPluginErrors, UpdateNeonAuthPhoneNumberPluginResponse, UpdateNeonAuthPhoneNumberPluginResponses, UpdateNeonAuthUserRoleData, UpdateNeonAuthUserRoleError, UpdateNeonAuthUserRoleErrors, UpdateNeonAuthUserRoleRequest, UpdateNeonAuthUserRoleResponse, UpdateNeonAuthUserRoleResponse2, UpdateNeonAuthUserRoleResponses, UpdateNeonAuthWebhookConfigData, UpdateNeonAuthWebhookConfigError, UpdateNeonAuthWebhookConfigErrors, UpdateNeonAuthWebhookConfigResponse, UpdateNeonAuthWebhookConfigResponses, UpdateOrganizationMemberData, UpdateOrganizationMemberError, UpdateOrganizationMemberErrors, UpdateOrganizationMemberResponse, UpdateOrganizationMemberResponses, UpdateProjectBranchData, UpdateProjectBranchDataApiData, UpdateProjectBranchDataApiError, UpdateProjectBranchDataApiErrors, UpdateProjectBranchDataApiResponse, UpdateProjectBranchDataApiResponses, UpdateProjectBranchDatabaseData, UpdateProjectBranchDatabaseError, UpdateProjectBranchDatabaseErrors, UpdateProjectBranchDatabaseResponse, UpdateProjectBranchDatabaseResponses, UpdateProjectBranchError, UpdateProjectBranchErrors, UpdateProjectBranchFunctionData, UpdateProjectBranchFunctionError, UpdateProjectBranchFunctionErrors, UpdateProjectBranchFunctionResponse, UpdateProjectBranchFunctionResponses, UpdateProjectBranchResponse, UpdateProjectBranchResponses, UpdateProjectData, UpdateProjectEndpointData, UpdateProjectEndpointError, UpdateProjectEndpointErrors, UpdateProjectEndpointResponse, UpdateProjectEndpointResponses, UpdateProjectError, UpdateProjectErrors, UpdateProjectResponse, UpdateProjectResponses, UpdateSnapshotData, UpdateSnapshotError, UpdateSnapshotErrors, UpdateSnapshotResponse, UpdateSnapshotResponses, VpcEndpoint, VpcEndpointAssignment, VpcEndpointDetails, VpcEndpointWithRegion, VpcEndpointsResponse, VpcEndpointsWithRegionResponse };
|
|
12099
|
+
export { AcceptProjectTransferRequestData, AcceptProjectTransferRequestError, AcceptProjectTransferRequestErrors, AcceptProjectTransferRequestResponse, AcceptProjectTransferRequestResponses, AcceptProjectTransferRequestSatisfiesPlanError, ActiveRegionsResponse, AddBranchNeonAuthOauthProviderData, AddBranchNeonAuthOauthProviderError, AddBranchNeonAuthOauthProviderErrors, AddBranchNeonAuthOauthProviderResponse, AddBranchNeonAuthOauthProviderResponses, AddBranchNeonAuthTrustedDomainData, AddBranchNeonAuthTrustedDomainError, AddBranchNeonAuthTrustedDomainErrors, AddBranchNeonAuthTrustedDomainResponses, AddNeonAuthDomainToRedirectUriWhitelistData, AddNeonAuthDomainToRedirectUriWhitelistError, AddNeonAuthDomainToRedirectUriWhitelistErrors, AddNeonAuthDomainToRedirectUriWhitelistResponses, AddNeonAuthOauthProviderData, AddNeonAuthOauthProviderError, AddNeonAuthOauthProviderErrors, AddNeonAuthOauthProviderResponse, AddNeonAuthOauthProviderResponses, AddProjectJwksData, AddProjectJwksError, AddProjectJwksErrors, AddProjectJwksRequest, AddProjectJwksResponse, AddProjectJwksResponses, AdvisorCategory, AdvisorIssue, AllowedIps, AnnotationCreateValueRequest, AnnotationData, AnnotationObjectData, AnnotationResponse, AnnotationValueData, AnnotationsMapResponse, AnonymizationRunMetadata, AnonymizedBranchStatusResponse, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyCreatorData, ApiKeyRevokeResponse, ApiKeysListResponseItem, ApplicationType, AssignOrganizationVpcEndpointData, AssignOrganizationVpcEndpointError, AssignOrganizationVpcEndpointErrors, AssignOrganizationVpcEndpointResponses, AssignProjectVpcEndpointData, AssignProjectVpcEndpointError, AssignProjectVpcEndpointErrors, AssignProjectVpcEndpointResponses, AuthDetailsResponse, AvailablePreloadLibraries, AvailablePreloadLibrary, BackupSchedule, BackupScheduleItem, BillingAccount, BillingAccountState, BillingPaymentMethod, BillingSubscriptionType, Branch, BranchAiGateway, BranchAiGatewayNotEnabled, BranchAnonymizedCreateRequest, BranchCreateRequest, BranchCreateRequestEndpointOptions, BranchOperations, BranchRecoverResponse, BranchRecoveryInfo, BranchResponse, BranchRestoreRequest, BranchRestoreStatus, BranchRestrictedAction, BranchSchemaCompareResponse, BranchSchemaJson, BranchSchemaResponse, BranchState, BranchStorage, BranchStorageNotEnabled, BranchUpdateRequest, BranchesCountResponse, BranchesResponse, Bucket, BucketAccessLevel, BucketCreateRequest, BucketObject, BucketObjectsDeletePrefixResponse, BucketObjectsListResponse, BucketResponse, BucketsListResponse, ClientOptions, ComputeUnit, ConnectionDetails, ConnectionParameters, ConnectionUriResponse, ConnectionUrisOptionalResponse, ConnectionUrisResponse, ConsumptionHistoryGranularity, ConsumptionHistoryPerBranchV2, ConsumptionHistoryPerBranchV2Response, ConsumptionHistoryPerPeriod, ConsumptionHistoryPerPeriodV2, ConsumptionHistoryPerProject, ConsumptionHistoryPerProjectResponse, ConsumptionHistoryPerProjectV2, ConsumptionHistoryPerProjectV2Response, ConsumptionHistoryPerTimeframe, ConsumptionHistoryPerTimeframeV2, ConsumptionHistoryQueryMetrics, ConsumptionMetricValue, CountProjectBranchesData, CountProjectBranchesError, CountProjectBranchesErrors, CountProjectBranchesResponse, CountProjectBranchesResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateBranchNeonAuthNewUserData, CreateBranchNeonAuthNewUserError, CreateBranchNeonAuthNewUserErrors, CreateBranchNeonAuthNewUserRequest, CreateBranchNeonAuthNewUserResponse, CreateBranchNeonAuthNewUserResponses, CreateCredentialData, CreateCredentialError, CreateCredentialErrors, CreateCredentialRequest, CreateCredentialResponse, CreateCredentialResponse2, CreateCredentialResponses, CreateNeonAuthData, CreateNeonAuthError, CreateNeonAuthErrors, CreateNeonAuthIntegrationData, CreateNeonAuthIntegrationError, CreateNeonAuthIntegrationErrors, CreateNeonAuthIntegrationResponse, CreateNeonAuthIntegrationResponses, CreateNeonAuthNewUserData, CreateNeonAuthNewUserError, CreateNeonAuthNewUserErrors, CreateNeonAuthNewUserResponse, CreateNeonAuthNewUserResponses, CreateNeonAuthProviderSdkKeysData, CreateNeonAuthProviderSdkKeysError, CreateNeonAuthProviderSdkKeysErrors, CreateNeonAuthProviderSdkKeysResponse, CreateNeonAuthProviderSdkKeysResponses, CreateNeonAuthResponse, CreateNeonAuthResponses, CreateOrgApiKeyData, CreateOrgApiKeyError, CreateOrgApiKeyErrors, CreateOrgApiKeyResponse, CreateOrgApiKeyResponses, CreateOrganizationInvitationsData, CreateOrganizationInvitationsError, CreateOrganizationInvitationsErrors, CreateOrganizationInvitationsResponse, CreateOrganizationInvitationsResponses, CreateProjectBranchAnonymizedData, CreateProjectBranchAnonymizedError, CreateProjectBranchAnonymizedErrors, CreateProjectBranchAnonymizedResponse, CreateProjectBranchAnonymizedResponses, CreateProjectBranchBucketData, CreateProjectBranchBucketError, CreateProjectBranchBucketErrors, CreateProjectBranchBucketResponse, CreateProjectBranchBucketResponses, CreateProjectBranchData, CreateProjectBranchDataApiData, CreateProjectBranchDataApiError, CreateProjectBranchDataApiErrors, CreateProjectBranchDataApiResponse, CreateProjectBranchDataApiResponses, CreateProjectBranchDatabaseData, CreateProjectBranchDatabaseError, CreateProjectBranchDatabaseErrors, CreateProjectBranchDatabaseResponse, CreateProjectBranchDatabaseResponses, CreateProjectBranchError, CreateProjectBranchErrors, CreateProjectBranchFunctionDeploymentData, CreateProjectBranchFunctionDeploymentError, CreateProjectBranchFunctionDeploymentErrors, CreateProjectBranchFunctionDeploymentResponse, CreateProjectBranchFunctionDeploymentResponses, CreateProjectBranchResponse, CreateProjectBranchResponses, CreateProjectBranchRoleData, CreateProjectBranchRoleError, CreateProjectBranchRoleErrors, CreateProjectBranchRoleResponse, CreateProjectBranchRoleResponses, CreateProjectData, CreateProjectEndpointData, CreateProjectEndpointError, CreateProjectEndpointErrors, CreateProjectEndpointResponse, CreateProjectEndpointResponses, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateProjectTransferRequestData, CreateProjectTransferRequestError, CreateProjectTransferRequestErrors, CreateProjectTransferRequestResponse, CreateProjectTransferRequestResponses, CreateSnapshotData, CreateSnapshotError, CreateSnapshotErrors, CreateSnapshotResponse, CreateSnapshotResponses, CredentialMeta, CredentialScope, CurrentUserAuthAccount, CurrentUserInfoResponse, CursorPagination, CursorPaginationResponse, CursorParam, DataApiCreateRequest, DataApiCreateResponse, DataApiReponse, DataApiSettings, DataApiUpdateRequest, Database, DatabaseCreateRequest, DatabaseOperations, DatabaseResponse, DatabaseUpdateRequest, DatabasesResponse, DefaultEndpointSettings, DeleteBranchNeonAuthOauthProviderData, DeleteBranchNeonAuthOauthProviderError, DeleteBranchNeonAuthOauthProviderErrors, DeleteBranchNeonAuthOauthProviderResponses, DeleteBranchNeonAuthTrustedDomainData, DeleteBranchNeonAuthTrustedDomainError, DeleteBranchNeonAuthTrustedDomainErrors, DeleteBranchNeonAuthTrustedDomainResponses, DeleteBranchNeonAuthUserData, DeleteBranchNeonAuthUserError, DeleteBranchNeonAuthUserErrors, DeleteBranchNeonAuthUserResponse, DeleteBranchNeonAuthUserResponses, DeleteNeonAuthDomainFromRedirectUriWhitelistData, DeleteNeonAuthDomainFromRedirectUriWhitelistError, DeleteNeonAuthDomainFromRedirectUriWhitelistErrors, DeleteNeonAuthDomainFromRedirectUriWhitelistResponses, DeleteNeonAuthIntegrationData, DeleteNeonAuthIntegrationError, DeleteNeonAuthIntegrationErrors, DeleteNeonAuthIntegrationResponses, DeleteNeonAuthOauthProviderData, DeleteNeonAuthOauthProviderError, DeleteNeonAuthOauthProviderErrors, DeleteNeonAuthOauthProviderResponses, DeleteNeonAuthUserData, DeleteNeonAuthUserError, DeleteNeonAuthUserErrors, DeleteNeonAuthUserResponse, DeleteNeonAuthUserResponses, DeleteOrganizationSpendingLimitData, DeleteOrganizationSpendingLimitError, DeleteOrganizationSpendingLimitErrors, DeleteOrganizationSpendingLimitResponse, DeleteOrganizationSpendingLimitResponses, DeleteOrganizationVpcEndpointData, DeleteOrganizationVpcEndpointError, DeleteOrganizationVpcEndpointErrors, DeleteOrganizationVpcEndpointResponses, DeleteProjectBranchBucketData, DeleteProjectBranchBucketError, DeleteProjectBranchBucketErrors, DeleteProjectBranchBucketObjectData, DeleteProjectBranchBucketObjectError, DeleteProjectBranchBucketObjectErrors, DeleteProjectBranchBucketObjectResponse, DeleteProjectBranchBucketObjectResponses, DeleteProjectBranchBucketObjectsByPrefixData, DeleteProjectBranchBucketObjectsByPrefixError, DeleteProjectBranchBucketObjectsByPrefixErrors, DeleteProjectBranchBucketObjectsByPrefixResponse, DeleteProjectBranchBucketObjectsByPrefixResponses, DeleteProjectBranchBucketResponse, DeleteProjectBranchBucketResponses, DeleteProjectBranchData, DeleteProjectBranchDataApiData, DeleteProjectBranchDataApiError, DeleteProjectBranchDataApiErrors, DeleteProjectBranchDataApiResponse, DeleteProjectBranchDataApiResponses, DeleteProjectBranchDatabaseData, DeleteProjectBranchDatabaseError, DeleteProjectBranchDatabaseErrors, DeleteProjectBranchDatabaseResponse, DeleteProjectBranchDatabaseResponses, DeleteProjectBranchError, DeleteProjectBranchErrors, DeleteProjectBranchFunctionData, DeleteProjectBranchFunctionError, DeleteProjectBranchFunctionErrors, DeleteProjectBranchFunctionResponse, DeleteProjectBranchFunctionResponses, DeleteProjectBranchResponse, DeleteProjectBranchResponses, DeleteProjectBranchRoleData, DeleteProjectBranchRoleError, DeleteProjectBranchRoleErrors, DeleteProjectBranchRoleResponse, DeleteProjectBranchRoleResponses, DeleteProjectData, DeleteProjectEndpointData, DeleteProjectEndpointError, DeleteProjectEndpointErrors, DeleteProjectEndpointResponse, DeleteProjectEndpointResponses, DeleteProjectError, DeleteProjectErrors, DeleteProjectJwksData, DeleteProjectJwksError, DeleteProjectJwksErrors, DeleteProjectJwksResponse, DeleteProjectJwksResponses, DeleteProjectResponse, DeleteProjectResponses, DeleteProjectVpcEndpointData, DeleteProjectVpcEndpointError, DeleteProjectVpcEndpointErrors, DeleteProjectVpcEndpointResponses, DeleteSnapshotData, DeleteSnapshotError, DeleteSnapshotErrors, DeleteSnapshotResponse, DeleteSnapshotResponses, DisableNeonAuthData, DisableNeonAuthError, DisableNeonAuthErrors, DisableNeonAuthResponses, EmptyResponse, EnableNeonAuthIntegrationRequest, Endpoint, EndpointCreateRequest, EndpointOperations, EndpointPoolerMode, EndpointResponse, EndpointSettingsData, EndpointState, EndpointType, EndpointUpdateRequest, EndpointsOptionalResponse, EndpointsResponse, ErrorCode, FinalizeRestoreBranchData, FinalizeRestoreBranchError, FinalizeRestoreBranchErrors, FinalizeRestoreBranchResponse, FinalizeRestoreBranchResponses, FunctionDeployRequest, GeneralError, GetActiveRegionsData, GetActiveRegionsError, GetActiveRegionsErrors, GetActiveRegionsResponse, GetActiveRegionsResponses, GetAnonymizedBranchStatusData, GetAnonymizedBranchStatusError, GetAnonymizedBranchStatusErrors, GetAnonymizedBranchStatusResponse, GetAnonymizedBranchStatusResponses, GetAuthDetailsData, GetAuthDetailsError, GetAuthDetailsErrors, GetAuthDetailsResponse, GetAuthDetailsResponses, GetAvailablePreloadLibrariesData, GetAvailablePreloadLibrariesError, GetAvailablePreloadLibrariesErrors, GetAvailablePreloadLibrariesResponse, GetAvailablePreloadLibrariesResponses, GetConnectionUriData, GetConnectionUriError, GetConnectionUriErrors, GetConnectionUriResponse, GetConnectionUriResponses, GetConsumptionHistoryPerBranchV2Data, GetConsumptionHistoryPerBranchV2Error, GetConsumptionHistoryPerBranchV2Errors, GetConsumptionHistoryPerBranchV2Response, GetConsumptionHistoryPerBranchV2Responses, GetConsumptionHistoryPerProjectData, GetConsumptionHistoryPerProjectError, GetConsumptionHistoryPerProjectErrors, GetConsumptionHistoryPerProjectResponse, GetConsumptionHistoryPerProjectResponses, GetConsumptionHistoryPerProjectV2Data, GetConsumptionHistoryPerProjectV2Error, GetConsumptionHistoryPerProjectV2Errors, GetConsumptionHistoryPerProjectV2Response, GetConsumptionHistoryPerProjectV2Responses, GetCurrentUserInfoData, GetCurrentUserInfoError, GetCurrentUserInfoErrors, GetCurrentUserInfoResponse, GetCurrentUserInfoResponses, GetCurrentUserOrganizationsData, GetCurrentUserOrganizationsError, GetCurrentUserOrganizationsErrors, GetCurrentUserOrganizationsResponse, GetCurrentUserOrganizationsResponses, GetMaskingRulesData, GetMaskingRulesError, GetMaskingRulesErrors, GetMaskingRulesResponse, GetMaskingRulesResponses, GetNeonAuthAllowLocalhostData, GetNeonAuthAllowLocalhostError, GetNeonAuthAllowLocalhostErrors, GetNeonAuthAllowLocalhostResponse, GetNeonAuthAllowLocalhostResponses, GetNeonAuthData, GetNeonAuthEmailAndPasswordConfigData, GetNeonAuthEmailAndPasswordConfigError, GetNeonAuthEmailAndPasswordConfigErrors, GetNeonAuthEmailAndPasswordConfigResponse, GetNeonAuthEmailAndPasswordConfigResponses, GetNeonAuthEmailProviderData, GetNeonAuthEmailProviderError, GetNeonAuthEmailProviderErrors, GetNeonAuthEmailProviderResponse, GetNeonAuthEmailProviderResponses, GetNeonAuthEmailServerData, GetNeonAuthEmailServerError, GetNeonAuthEmailServerErrors, GetNeonAuthEmailServerResponse, GetNeonAuthEmailServerResponses, GetNeonAuthError, GetNeonAuthErrors, GetNeonAuthPhoneNumberPluginData, GetNeonAuthPhoneNumberPluginError, GetNeonAuthPhoneNumberPluginErrors, GetNeonAuthPhoneNumberPluginResponse, GetNeonAuthPhoneNumberPluginResponses, GetNeonAuthPluginConfigsData, GetNeonAuthPluginConfigsError, GetNeonAuthPluginConfigsErrors, GetNeonAuthPluginConfigsResponse, GetNeonAuthPluginConfigsResponses, GetNeonAuthResponse, GetNeonAuthResponses, GetNeonAuthWebhookConfigData, GetNeonAuthWebhookConfigError, GetNeonAuthWebhookConfigErrors, GetNeonAuthWebhookConfigResponse, GetNeonAuthWebhookConfigResponses, GetOrganizationData, GetOrganizationError, GetOrganizationErrors, GetOrganizationInvitationsData, GetOrganizationInvitationsError, GetOrganizationInvitationsErrors, GetOrganizationInvitationsResponse, GetOrganizationInvitationsResponses, GetOrganizationMemberData, GetOrganizationMemberError, GetOrganizationMemberErrors, GetOrganizationMemberResponse, GetOrganizationMemberResponses, GetOrganizationMembersData, GetOrganizationMembersError, GetOrganizationMembersErrors, GetOrganizationMembersResponse, GetOrganizationMembersResponses, GetOrganizationResponse, GetOrganizationResponses, GetOrganizationSpendingLimitData, GetOrganizationSpendingLimitError, GetOrganizationSpendingLimitErrors, GetOrganizationSpendingLimitResponse, GetOrganizationSpendingLimitResponses, GetOrganizationVpcEndpointDetailsData, GetOrganizationVpcEndpointDetailsError, GetOrganizationVpcEndpointDetailsErrors, GetOrganizationVpcEndpointDetailsResponse, GetOrganizationVpcEndpointDetailsResponses, GetProjectAdvisorSecurityIssuesData, GetProjectAdvisorSecurityIssuesError, GetProjectAdvisorSecurityIssuesErrors, GetProjectAdvisorSecurityIssuesResponse, GetProjectAdvisorSecurityIssuesResponses, GetProjectBranchAiGatewayData, GetProjectBranchAiGatewayError, GetProjectBranchAiGatewayErrors, GetProjectBranchAiGatewayResponse, GetProjectBranchAiGatewayResponses, GetProjectBranchBucketObjectData, GetProjectBranchBucketObjectError, GetProjectBranchBucketObjectErrors, GetProjectBranchBucketObjectResponse, GetProjectBranchBucketObjectResponses, GetProjectBranchData, GetProjectBranchDataApiData, GetProjectBranchDataApiError, GetProjectBranchDataApiErrors, GetProjectBranchDataApiResponse, GetProjectBranchDataApiResponses, GetProjectBranchDatabaseData, GetProjectBranchDatabaseError, GetProjectBranchDatabaseErrors, GetProjectBranchDatabaseResponse, GetProjectBranchDatabaseResponses, GetProjectBranchError, GetProjectBranchErrors, GetProjectBranchFunctionData, GetProjectBranchFunctionError, GetProjectBranchFunctionErrors, GetProjectBranchFunctionResponse, GetProjectBranchFunctionResponses, GetProjectBranchResponse, GetProjectBranchResponses, GetProjectBranchRoleData, GetProjectBranchRoleError, GetProjectBranchRoleErrors, GetProjectBranchRolePasswordData, GetProjectBranchRolePasswordError, GetProjectBranchRolePasswordErrors, GetProjectBranchRolePasswordResponse, GetProjectBranchRolePasswordResponses, GetProjectBranchRoleResponse, GetProjectBranchRoleResponses, GetProjectBranchSchemaComparisonData, GetProjectBranchSchemaComparisonError, GetProjectBranchSchemaComparisonErrors, GetProjectBranchSchemaComparisonResponse, GetProjectBranchSchemaComparisonResponses, GetProjectBranchSchemaData, GetProjectBranchSchemaError, GetProjectBranchSchemaErrors, GetProjectBranchSchemaResponse, GetProjectBranchSchemaResponses, GetProjectBranchStorageData, GetProjectBranchStorageError, GetProjectBranchStorageErrors, GetProjectBranchStorageResponse, GetProjectBranchStorageResponses, GetProjectData, GetProjectEndpointData, GetProjectEndpointError, GetProjectEndpointErrors, GetProjectEndpointResponse, GetProjectEndpointResponses, GetProjectError, GetProjectErrors, GetProjectJwksData, GetProjectJwksError, GetProjectJwksErrors, GetProjectJwksResponse, GetProjectJwksResponses, GetProjectOperationData, GetProjectOperationError, GetProjectOperationErrors, GetProjectOperationResponse, GetProjectOperationResponses, GetProjectResponse, GetProjectResponses, GetSnapshotScheduleData, GetSnapshotScheduleError, GetSnapshotScheduleErrors, GetSnapshotScheduleResponse, GetSnapshotScheduleResponses, GrantPermissionToProjectData, GrantPermissionToProjectError, GrantPermissionToProjectErrors, GrantPermissionToProjectRequest, GrantPermissionToProjectResponse, GrantPermissionToProjectResponses, IdentityProviderId, Invitation, Jwks, JwksCreationOperation, JwksResponse, LimitParam, LimitsUnsatisfiedResponse, ListApiKeysData, ListApiKeysError, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListBranchNeonAuthOauthProvidersData, ListBranchNeonAuthOauthProvidersError, ListBranchNeonAuthOauthProvidersErrors, ListBranchNeonAuthOauthProvidersResponse, ListBranchNeonAuthOauthProvidersResponses, ListBranchNeonAuthTrustedDomainsData, ListBranchNeonAuthTrustedDomainsError, ListBranchNeonAuthTrustedDomainsErrors, ListBranchNeonAuthTrustedDomainsResponse, ListBranchNeonAuthTrustedDomainsResponses, ListCredentialsData, ListCredentialsError, ListCredentialsErrors, ListCredentialsResponse, ListCredentialsResponse2, ListCredentialsResponses, ListNeonAuthIntegrationsData, ListNeonAuthIntegrationsError, ListNeonAuthIntegrationsErrors, ListNeonAuthIntegrationsResponse, ListNeonAuthIntegrationsResponse2, ListNeonAuthIntegrationsResponses, ListNeonAuthOauthProvidersData, ListNeonAuthOauthProvidersError, ListNeonAuthOauthProvidersErrors, ListNeonAuthOauthProvidersResponse, ListNeonAuthOauthProvidersResponse2, ListNeonAuthOauthProvidersResponses, ListNeonAuthRedirectUriWhitelistDomainsData, ListNeonAuthRedirectUriWhitelistDomainsError, ListNeonAuthRedirectUriWhitelistDomainsErrors, ListNeonAuthRedirectUriWhitelistDomainsResponse, ListNeonAuthRedirectUriWhitelistDomainsResponses, ListOrgApiKeysData, ListOrgApiKeysError, ListOrgApiKeysErrors, ListOrgApiKeysResponse, ListOrgApiKeysResponses, ListOrganizationVpcEndpointsAllRegionsData, ListOrganizationVpcEndpointsAllRegionsError, ListOrganizationVpcEndpointsAllRegionsErrors, ListOrganizationVpcEndpointsAllRegionsResponse, ListOrganizationVpcEndpointsAllRegionsResponses, ListOrganizationVpcEndpointsData, ListOrganizationVpcEndpointsError, ListOrganizationVpcEndpointsErrors, ListOrganizationVpcEndpointsResponse, ListOrganizationVpcEndpointsResponses, ListProjectBranchBucketObjectsData, ListProjectBranchBucketObjectsError, ListProjectBranchBucketObjectsErrors, ListProjectBranchBucketObjectsResponse, ListProjectBranchBucketObjectsResponses, ListProjectBranchBucketsData, ListProjectBranchBucketsError, ListProjectBranchBucketsErrors, ListProjectBranchBucketsResponse, ListProjectBranchBucketsResponses, ListProjectBranchDatabasesData, ListProjectBranchDatabasesError, ListProjectBranchDatabasesErrors, ListProjectBranchDatabasesResponse, ListProjectBranchDatabasesResponses, ListProjectBranchEndpointsData, ListProjectBranchEndpointsError, ListProjectBranchEndpointsErrors, ListProjectBranchEndpointsResponse, ListProjectBranchEndpointsResponses, ListProjectBranchFunctionsData, ListProjectBranchFunctionsError, ListProjectBranchFunctionsErrors, ListProjectBranchFunctionsResponse, ListProjectBranchFunctionsResponses, ListProjectBranchLogFieldValuesData, ListProjectBranchLogFieldValuesError, ListProjectBranchLogFieldValuesErrors, ListProjectBranchLogFieldValuesResponse, ListProjectBranchLogFieldValuesResponses, ListProjectBranchLogFieldsData, ListProjectBranchLogFieldsError, ListProjectBranchLogFieldsErrors, ListProjectBranchLogFieldsResponse, ListProjectBranchLogFieldsResponses, ListProjectBranchRolesData, ListProjectBranchRolesError, ListProjectBranchRolesErrors, ListProjectBranchRolesResponse, ListProjectBranchRolesResponses, ListProjectBranchesData, ListProjectBranchesError, ListProjectBranchesErrors, ListProjectBranchesResponse, ListProjectBranchesResponses, ListProjectEndpointsData, ListProjectEndpointsError, ListProjectEndpointsErrors, ListProjectEndpointsResponse, ListProjectEndpointsResponses, ListProjectMembersData, ListProjectMembersError, ListProjectMembersErrors, ListProjectMembersResponse, ListProjectMembersResponses, ListProjectOperationsData, ListProjectOperationsError, ListProjectOperationsErrors, ListProjectOperationsResponse, ListProjectOperationsResponses, ListProjectPermissionsData, ListProjectPermissionsError, ListProjectPermissionsErrors, ListProjectPermissionsResponse, ListProjectPermissionsResponses, ListProjectVpcEndpointsData, ListProjectVpcEndpointsError, ListProjectVpcEndpointsErrors, ListProjectVpcEndpointsResponse, ListProjectVpcEndpointsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListSharedProjectsData, ListSharedProjectsError, ListSharedProjectsErrors, ListSharedProjectsResponse, ListSharedProjectsResponses, ListSnapshotsData, ListSnapshotsError, ListSnapshotsErrors, ListSnapshotsResponse, ListSnapshotsResponses, MaintenanceWindow, MaskingRule, MaskingRulesResponse, MaskingRulesUpdateRequest, Member, MemberRole, MemberUserInfo, MemberWithUser, NeonAuthAddDomainToRedirectUriWhitelistRequest, NeonAuthAddOAuthProviderRequest, NeonAuthAllowLocalhostResponse, NeonAuthConfigResponse, NeonAuthConfigUpdate, NeonAuthCreateAuthProviderSdkKeysRequest, NeonAuthCreateIntegrationRequest, NeonAuthCreateIntegrationResponse, NeonAuthCreateNewUserRequest, NeonAuthCreateNewUserResponse, NeonAuthDeleteDomainFromRedirectUriWhitelistItem, NeonAuthDeleteDomainFromRedirectUriWhitelistRequest, NeonAuthEmailAndPasswordConfig, NeonAuthEmailAndPasswordConfigUpdate, NeonAuthEmailServerConfig, NeonAuthEmailVerificationMethod, NeonAuthIntegration, NeonAuthMagicLinkConfig, NeonAuthMagicLinkConfigUpdate, NeonAuthOauthProvider, NeonAuthOauthProviderId, NeonAuthOauthProviderType, NeonAuthOrganizationConfig, NeonAuthOrganizationConfigUpdate, NeonAuthPhoneNumberConfig, NeonAuthPhoneNumberConfigUpdate, NeonAuthPluginConfigs, NeonAuthProviderProjectOwnedBy, NeonAuthProviderProjectTransferStatus, NeonAuthRedirectUriWhitelistDomain, NeonAuthRedirectUriWhitelistResponse, NeonAuthSupportedAuthProvider, NeonAuthTransferAuthProviderProjectRequest, NeonAuthTransferAuthProviderProjectResponse, NeonAuthUpdateOAuthProviderRequest, NeonAuthWebhookConfig, NeonFunction, NeonFunctionDeployment, NeonFunctionDeploymentResponse, NeonFunctionResponse, NeonFunctionUpdateRequest, NeonFunctionsListResponse, Operation, OperationAction, OperationResponse, OperationStatus, OperationsResponse, OrgApiKeyCreateRequest, OrgApiKeyCreateResponse, OrgApiKeyRevokeResponse, OrgApiKeysListResponseItem, Organization, OrganizationInvitationsResponse, OrganizationInviteCreateRequest, OrganizationInvitesCreateRequest, OrganizationMemberUpdateRequest, OrganizationMembersResponse, OrganizationsResponse, Pagination, PaginationResponse, PaymentSource, PaymentSourceBankCard, PgSettingsData, PgVersion, PgbouncerSettingsData, PlanDetails, PlanVersion, PreloadLibraries, PresignProjectBranchBucketObjectData, PresignProjectBranchBucketObjectError, PresignProjectBranchBucketObjectErrors, PresignProjectBranchBucketObjectResponse, PresignProjectBranchBucketObjectResponses, PresignRequest, PresignResponse, Project, ProjectAuditLogLevel, ProjectBranchLogDuration, ProjectBranchLogFieldValuesResponse, ProjectBranchLogFieldsResponse, ProjectBranchLogRecord, ProjectBranchLogSeverity, ProjectBranchLogSource, ProjectBranchLogsInvalidQuery, ProjectBranchLogsNotAvailable, ProjectBranchLogsQueryRequest, ProjectBranchLogsQueryResponse, ProjectCreateRequest, ProjectJwksResponse, ProjectListItem, ProjectMember, ProjectMemberGrantSource, ProjectMemberOrgRole, ProjectMemberRoleResponse, ProjectMembers, ProjectOwnerData, ProjectPermission, ProjectPermissionLevel, ProjectPermissions, ProjectQuota, ProjectRecoverResponse, ProjectResponse, ProjectRole, ProjectSettingsData, ProjectTransferRequestResponse, ProjectUpdateRequest, ProjectsApplicationsMapResponse, ProjectsIntegrationsMapResponse, ProjectsResponse, ProjectsWithIntegrationResponse, Provisioner, QueryProjectBranchLogsData, QueryProjectBranchLogsError, QueryProjectBranchLogsErrors, QueryProjectBranchLogsResponse, QueryProjectBranchLogsResponses, RecoverProjectData, RecoverProjectError, RecoverProjectErrors, RecoverProjectResponse, RecoverProjectResponses, RegionResponse, RemoveOrganizationMemberData, RemoveOrganizationMemberError, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponse, RemoveOrganizationMemberResponses, RemoveProjectMemberRoleData, RemoveProjectMemberRoleError, RemoveProjectMemberRoleErrors, RemoveProjectMemberRoleResponse, RemoveProjectMemberRoleResponses, ResetProjectBranchRolePasswordData, ResetProjectBranchRolePasswordError, ResetProjectBranchRolePasswordErrors, ResetProjectBranchRolePasswordResponse, ResetProjectBranchRolePasswordResponses, RestartProjectEndpointData, RestartProjectEndpointError, RestartProjectEndpointErrors, RestartProjectEndpointResponse, RestartProjectEndpointResponses, RestoreProjectBranchData, RestoreProjectBranchError, RestoreProjectBranchErrors, RestoreProjectBranchResponse, RestoreProjectBranchResponses, RestoreSnapshotData, RestoreSnapshotError, RestoreSnapshotErrors, RestoreSnapshotResponse, RestoreSnapshotResponses, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyErrors, RevokeApiKeyResponse, RevokeApiKeyResponses, RevokeCredentialData, RevokeCredentialError, RevokeCredentialErrors, RevokeCredentialResponse, RevokeCredentialResponses, RevokeOrgApiKeyData, RevokeOrgApiKeyError, RevokeOrgApiKeyErrors, RevokeOrgApiKeyResponse, RevokeOrgApiKeyResponses, RevokePermissionFromProjectData, RevokePermissionFromProjectError, RevokePermissionFromProjectErrors, RevokePermissionFromProjectResponse, RevokePermissionFromProjectResponses, Role, RoleCreateRequest, RoleOperations, RolePasswordResponse, RoleResponse, RolesResponse, SendNeonAuthTestEmailData, SendNeonAuthTestEmailError, SendNeonAuthTestEmailErrors, SendNeonAuthTestEmailRequest, SendNeonAuthTestEmailResponse, SendNeonAuthTestEmailResponse2, SendNeonAuthTestEmailResponses, SetDefaultProjectBranchData, SetDefaultProjectBranchError, SetDefaultProjectBranchErrors, SetDefaultProjectBranchResponse, SetDefaultProjectBranchResponses, SetOrganizationSpendingLimitData, SetOrganizationSpendingLimitError, SetOrganizationSpendingLimitErrors, SetOrganizationSpendingLimitResponse, SetOrganizationSpendingLimitResponses, SetProjectMemberRoleData, SetProjectMemberRoleError, SetProjectMemberRoleErrors, SetProjectMemberRoleRequest, SetProjectMemberRoleResponse, SetProjectMemberRoleResponses, SetSnapshotScheduleData, SetSnapshotScheduleError, SetSnapshotScheduleErrors, SetSnapshotScheduleResponse, SetSnapshotScheduleResponses, SharedEmailServer, Snapshot, SnapshotUpdateRequest, SortOrderParam, SpendingLimitResponse, SpendingLimitUpdateRequest, StandardEmailServer, StartAnonymizationData, StartAnonymizationError, StartAnonymizationErrors, StartAnonymizationResponse, StartAnonymizationResponses, StartProjectEndpointData, StartProjectEndpointError, StartProjectEndpointErrors, StartProjectEndpointResponse, StartProjectEndpointResponses, SuspendProjectEndpointData, SuspendProjectEndpointError, SuspendProjectEndpointErrors, SuspendProjectEndpointResponse, SuspendProjectEndpointResponses, SuspendTimeoutSeconds, TimeoutParam, TransferNeonAuthProviderProjectData, TransferNeonAuthProviderProjectError, TransferNeonAuthProviderProjectErrors, TransferNeonAuthProviderProjectResponse, TransferNeonAuthProviderProjectResponses, TransferProjectsFromOrgToOrgData, TransferProjectsFromOrgToOrgError, TransferProjectsFromOrgToOrgErrors, TransferProjectsFromOrgToOrgResponse, TransferProjectsFromOrgToOrgResponses, TransferProjectsFromUserToOrgData, TransferProjectsFromUserToOrgError, TransferProjectsFromUserToOrgErrors, TransferProjectsFromUserToOrgResponse, TransferProjectsFromUserToOrgResponses, TransferProjectsToOrganizationRequest, UpdateBranchNeonAuthOauthProviderData, UpdateBranchNeonAuthOauthProviderError, UpdateBranchNeonAuthOauthProviderErrors, UpdateBranchNeonAuthOauthProviderResponse, UpdateBranchNeonAuthOauthProviderResponses, UpdateMaskingRulesData, UpdateMaskingRulesError, UpdateMaskingRulesErrors, UpdateMaskingRulesResponse, UpdateMaskingRulesResponses, UpdateNeonAuthAllowLocalhostData, UpdateNeonAuthAllowLocalhostError, UpdateNeonAuthAllowLocalhostErrors, UpdateNeonAuthAllowLocalhostRequest, UpdateNeonAuthAllowLocalhostResponse, UpdateNeonAuthAllowLocalhostResponses, UpdateNeonAuthConfigData, UpdateNeonAuthConfigError, UpdateNeonAuthConfigErrors, UpdateNeonAuthConfigResponse, UpdateNeonAuthConfigResponses, UpdateNeonAuthEmailAndPasswordConfigData, UpdateNeonAuthEmailAndPasswordConfigError, UpdateNeonAuthEmailAndPasswordConfigErrors, UpdateNeonAuthEmailAndPasswordConfigResponse, UpdateNeonAuthEmailAndPasswordConfigResponses, UpdateNeonAuthEmailProviderData, UpdateNeonAuthEmailProviderError, UpdateNeonAuthEmailProviderErrors, UpdateNeonAuthEmailProviderResponse, UpdateNeonAuthEmailProviderResponses, UpdateNeonAuthEmailServerData, UpdateNeonAuthEmailServerError, UpdateNeonAuthEmailServerErrors, UpdateNeonAuthEmailServerResponse, UpdateNeonAuthEmailServerResponses, UpdateNeonAuthMagicLinkPluginData, UpdateNeonAuthMagicLinkPluginError, UpdateNeonAuthMagicLinkPluginErrors, UpdateNeonAuthMagicLinkPluginResponse, UpdateNeonAuthMagicLinkPluginResponses, UpdateNeonAuthOauthProviderData, UpdateNeonAuthOauthProviderError, UpdateNeonAuthOauthProviderErrors, UpdateNeonAuthOauthProviderResponse, UpdateNeonAuthOauthProviderResponses, UpdateNeonAuthOrganizationPluginData, UpdateNeonAuthOrganizationPluginError, UpdateNeonAuthOrganizationPluginErrors, UpdateNeonAuthOrganizationPluginResponse, UpdateNeonAuthOrganizationPluginResponses, UpdateNeonAuthPhoneNumberPluginData, UpdateNeonAuthPhoneNumberPluginError, UpdateNeonAuthPhoneNumberPluginErrors, UpdateNeonAuthPhoneNumberPluginResponse, UpdateNeonAuthPhoneNumberPluginResponses, UpdateNeonAuthUserRoleData, UpdateNeonAuthUserRoleError, UpdateNeonAuthUserRoleErrors, UpdateNeonAuthUserRoleRequest, UpdateNeonAuthUserRoleResponse, UpdateNeonAuthUserRoleResponse2, UpdateNeonAuthUserRoleResponses, UpdateNeonAuthWebhookConfigData, UpdateNeonAuthWebhookConfigError, UpdateNeonAuthWebhookConfigErrors, UpdateNeonAuthWebhookConfigResponse, UpdateNeonAuthWebhookConfigResponses, UpdateOrganizationMemberData, UpdateOrganizationMemberError, UpdateOrganizationMemberErrors, UpdateOrganizationMemberResponse, UpdateOrganizationMemberResponses, UpdateProjectBranchData, UpdateProjectBranchDataApiData, UpdateProjectBranchDataApiError, UpdateProjectBranchDataApiErrors, UpdateProjectBranchDataApiResponse, UpdateProjectBranchDataApiResponses, UpdateProjectBranchDatabaseData, UpdateProjectBranchDatabaseError, UpdateProjectBranchDatabaseErrors, UpdateProjectBranchDatabaseResponse, UpdateProjectBranchDatabaseResponses, UpdateProjectBranchError, UpdateProjectBranchErrors, UpdateProjectBranchFunctionData, UpdateProjectBranchFunctionError, UpdateProjectBranchFunctionErrors, UpdateProjectBranchFunctionResponse, UpdateProjectBranchFunctionResponses, UpdateProjectBranchResponse, UpdateProjectBranchResponses, UpdateProjectData, UpdateProjectEndpointData, UpdateProjectEndpointError, UpdateProjectEndpointErrors, UpdateProjectEndpointResponse, UpdateProjectEndpointResponses, UpdateProjectError, UpdateProjectErrors, UpdateProjectResponse, UpdateProjectResponses, UpdateSnapshotData, UpdateSnapshotError, UpdateSnapshotErrors, UpdateSnapshotResponse, UpdateSnapshotResponses, VpcEndpoint, VpcEndpointAssignment, VpcEndpointDetails, VpcEndpointWithRegion, VpcEndpointsResponse, VpcEndpointsWithRegionResponse };
|
|
11018
12100
|
//# sourceMappingURL=types.gen.d.ts.map
|