pgbeam 0.4.8 → 0.4.10
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 +4 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/{operations-map.gen-oqab3wi9.d.ts → operations-map.gen-d7lzb0ad.d.ts} +197 -25
- package/dist/operations.cjs +95 -3
- package/dist/operations.d.cts +1 -1
- package/dist/operations.d.mts +1 -1
- package/dist/operations.mjs +95 -3
- package/package.json +1 -1
package/dist/operations.cjs
CHANGED
|
@@ -69,6 +69,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
69
69
|
"required": true,
|
|
70
70
|
"type": "string",
|
|
71
71
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "Idempotency-Key",
|
|
75
|
+
"in": "header",
|
|
76
|
+
"required": false,
|
|
77
|
+
"type": "string",
|
|
78
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
72
79
|
}
|
|
73
80
|
],
|
|
74
81
|
"requestBodyType": "{ expires_at?: string; name: string; policy_profile_id: string; principal_type?: \"agent\" | \"human\" }",
|
|
@@ -177,6 +184,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
177
184
|
"required": true,
|
|
178
185
|
"type": "string",
|
|
179
186
|
"description": "Unique agent credential identifier (prefixed, e.g. agt_xxx)."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "Idempotency-Key",
|
|
190
|
+
"in": "header",
|
|
191
|
+
"required": false,
|
|
192
|
+
"type": "string",
|
|
193
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
180
194
|
}
|
|
181
195
|
],
|
|
182
196
|
"requestBodyType": "",
|
|
@@ -407,7 +421,7 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
407
421
|
"in": "query",
|
|
408
422
|
"required": false,
|
|
409
423
|
"type": "\"allow\" | \"block\" | \"mask\" | \"truncate\"",
|
|
410
|
-
"description": "Coarse outcome filter that groups events. `allow` = query; `block` = blocked, budget_exhausted, auth_failed, credential_expired; `mask` = masked; `truncate` = truncated."
|
|
424
|
+
"description": "Coarse outcome filter that groups events. `allow` = query, auto_approved; `block` = blocked, budget_exhausted, auth_failed, credential_expired, canary_tripped, rejected, approval_expired; `mask` = masked; `truncate` = truncated."
|
|
411
425
|
},
|
|
412
426
|
{
|
|
413
427
|
"name": "source",
|
|
@@ -483,7 +497,7 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
483
497
|
"in": "query",
|
|
484
498
|
"required": false,
|
|
485
499
|
"type": "\"allow\" | \"block\" | \"mask\" | \"truncate\"",
|
|
486
|
-
"description": "Coarse outcome filter that groups events. `allow` = query; `block` = blocked, budget_exhausted, auth_failed, credential_expired; `mask` = masked; `truncate` = truncated."
|
|
500
|
+
"description": "Coarse outcome filter that groups events. `allow` = query, auto_approved; `block` = blocked, budget_exhausted, auth_failed, credential_expired, canary_tripped, rejected, approval_expired; `mask` = masked; `truncate` = truncated."
|
|
487
501
|
},
|
|
488
502
|
{
|
|
489
503
|
"name": "source",
|
|
@@ -869,6 +883,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
869
883
|
"required": true,
|
|
870
884
|
"type": "string",
|
|
871
885
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"name": "Idempotency-Key",
|
|
889
|
+
"in": "header",
|
|
890
|
+
"required": false,
|
|
891
|
+
"type": "string",
|
|
892
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
872
893
|
}
|
|
873
894
|
],
|
|
874
895
|
"requestBodyType": "{ auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }",
|
|
@@ -1085,6 +1106,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1085
1106
|
"required": true,
|
|
1086
1107
|
"type": "string",
|
|
1087
1108
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"name": "Idempotency-Key",
|
|
1112
|
+
"in": "header",
|
|
1113
|
+
"required": false,
|
|
1114
|
+
"type": "string",
|
|
1115
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1088
1116
|
}
|
|
1089
1117
|
],
|
|
1090
1118
|
"requestBodyType": "{ domain: string }",
|
|
@@ -1205,6 +1233,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1205
1233
|
"required": true,
|
|
1206
1234
|
"type": "string",
|
|
1207
1235
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"name": "Idempotency-Key",
|
|
1239
|
+
"in": "header",
|
|
1240
|
+
"required": false,
|
|
1241
|
+
"type": "string",
|
|
1242
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1208
1243
|
}
|
|
1209
1244
|
],
|
|
1210
1245
|
"requestBodyType": "{ action: \"audit_only\" | \"kill\"; relation_name: string; schema_name?: string }",
|
|
@@ -1446,6 +1481,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1446
1481
|
"required": true,
|
|
1447
1482
|
"type": "string",
|
|
1448
1483
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"name": "Idempotency-Key",
|
|
1487
|
+
"in": "header",
|
|
1488
|
+
"required": false,
|
|
1489
|
+
"type": "string",
|
|
1490
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1449
1491
|
}
|
|
1450
1492
|
],
|
|
1451
1493
|
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
@@ -1621,7 +1663,15 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1621
1663
|
"path": "/v1/projects",
|
|
1622
1664
|
"summary": "Create a project",
|
|
1623
1665
|
"description": "Creates a new project within the specified organization.",
|
|
1624
|
-
"parameters": [
|
|
1666
|
+
"parameters": [
|
|
1667
|
+
{
|
|
1668
|
+
"name": "Idempotency-Key",
|
|
1669
|
+
"in": "header",
|
|
1670
|
+
"required": false,
|
|
1671
|
+
"type": "string",
|
|
1672
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1673
|
+
}
|
|
1674
|
+
],
|
|
1625
1675
|
"requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; self_hosted?: boolean; tags?: string[] }",
|
|
1626
1676
|
"requestBodyRequired": true,
|
|
1627
1677
|
"responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
|
|
@@ -1766,6 +1816,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1766
1816
|
"required": true,
|
|
1767
1817
|
"type": "string",
|
|
1768
1818
|
"description": "Unique database identifier (prefixed, e.g. db_xxx)."
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
"name": "Idempotency-Key",
|
|
1822
|
+
"in": "header",
|
|
1823
|
+
"required": false,
|
|
1824
|
+
"type": "string",
|
|
1825
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1769
1826
|
}
|
|
1770
1827
|
],
|
|
1771
1828
|
"requestBodyType": "{ host: string; port: number; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\" }",
|
|
@@ -1928,6 +1985,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1928
1985
|
"required": true,
|
|
1929
1986
|
"type": "string",
|
|
1930
1987
|
"description": "Unique organization identifier."
|
|
1988
|
+
},
|
|
1989
|
+
{
|
|
1990
|
+
"name": "Idempotency-Key",
|
|
1991
|
+
"in": "header",
|
|
1992
|
+
"required": false,
|
|
1993
|
+
"type": "string",
|
|
1994
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1931
1995
|
}
|
|
1932
1996
|
],
|
|
1933
1997
|
"requestBodyType": "{ description?: string; expires_at?: string; region_label?: string }",
|
|
@@ -1982,6 +2046,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
1982
2046
|
"required": true,
|
|
1983
2047
|
"type": "string",
|
|
1984
2048
|
"description": "Unique enrollment identifier."
|
|
2049
|
+
},
|
|
2050
|
+
{
|
|
2051
|
+
"name": "Idempotency-Key",
|
|
2052
|
+
"in": "header",
|
|
2053
|
+
"required": false,
|
|
2054
|
+
"type": "string",
|
|
2055
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1985
2056
|
}
|
|
1986
2057
|
],
|
|
1987
2058
|
"requestBodyType": "",
|
|
@@ -2050,6 +2121,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
2050
2121
|
"required": true,
|
|
2051
2122
|
"type": "string",
|
|
2052
2123
|
"description": "Unique organization identifier."
|
|
2124
|
+
},
|
|
2125
|
+
{
|
|
2126
|
+
"name": "Idempotency-Key",
|
|
2127
|
+
"in": "header",
|
|
2128
|
+
"required": false,
|
|
2129
|
+
"type": "string",
|
|
2130
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2053
2131
|
}
|
|
2054
2132
|
],
|
|
2055
2133
|
"requestBodyType": "{ body: string; org_id: string; severity?: number; title: string }",
|
|
@@ -2131,6 +2209,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
2131
2209
|
"required": true,
|
|
2132
2210
|
"type": "string",
|
|
2133
2211
|
"description": "Unique support case identifier (prefixed, e.g. sc_xxx)."
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"name": "Idempotency-Key",
|
|
2215
|
+
"in": "header",
|
|
2216
|
+
"required": false,
|
|
2217
|
+
"type": "string",
|
|
2218
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2134
2219
|
}
|
|
2135
2220
|
],
|
|
2136
2221
|
"requestBodyType": "{ body: string }",
|
|
@@ -2299,6 +2384,13 @@ var operationsMap_gen = require('./operations-map.gen-gco09oqg.cjs');
|
|
|
2299
2384
|
"required": true,
|
|
2300
2385
|
"type": "string",
|
|
2301
2386
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
2387
|
+
},
|
|
2388
|
+
{
|
|
2389
|
+
"name": "Idempotency-Key",
|
|
2390
|
+
"in": "header",
|
|
2391
|
+
"required": false,
|
|
2392
|
+
"type": "string",
|
|
2393
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2302
2394
|
}
|
|
2303
2395
|
],
|
|
2304
2396
|
"requestBodyType": "{ description?: string; enabled?: boolean; event_types?: string[]; format?: \"json\" | \"splunk_hec\" | \"datadog\" | \"elastic\"; secret?: string; url: string }",
|
package/dist/operations.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { qx as ApiOperations, qy as ApiTag, qz as RequestMap, qA as Route, qB as operationsByPath, qC as operationsByTag } from './operations-map.gen-d7lzb0ad.js';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Generated by generate-sdk-ts-maps.ts from backend/openapi/bundles/public.yaml — do not edit manually.
|
package/dist/operations.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { qx as ApiOperations, qy as ApiTag, qz as RequestMap, qA as Route, qB as operationsByPath, qC as operationsByTag } from './operations-map.gen-d7lzb0ad.js';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Generated by generate-sdk-ts-maps.ts from backend/openapi/bundles/public.yaml — do not edit manually.
|
package/dist/operations.mjs
CHANGED
|
@@ -67,6 +67,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
67
67
|
"required": true,
|
|
68
68
|
"type": "string",
|
|
69
69
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "Idempotency-Key",
|
|
73
|
+
"in": "header",
|
|
74
|
+
"required": false,
|
|
75
|
+
"type": "string",
|
|
76
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
70
77
|
}
|
|
71
78
|
],
|
|
72
79
|
"requestBodyType": "{ expires_at?: string; name: string; policy_profile_id: string; principal_type?: \"agent\" | \"human\" }",
|
|
@@ -175,6 +182,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
175
182
|
"required": true,
|
|
176
183
|
"type": "string",
|
|
177
184
|
"description": "Unique agent credential identifier (prefixed, e.g. agt_xxx)."
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"name": "Idempotency-Key",
|
|
188
|
+
"in": "header",
|
|
189
|
+
"required": false,
|
|
190
|
+
"type": "string",
|
|
191
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
178
192
|
}
|
|
179
193
|
],
|
|
180
194
|
"requestBodyType": "",
|
|
@@ -405,7 +419,7 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
405
419
|
"in": "query",
|
|
406
420
|
"required": false,
|
|
407
421
|
"type": "\"allow\" | \"block\" | \"mask\" | \"truncate\"",
|
|
408
|
-
"description": "Coarse outcome filter that groups events. `allow` = query; `block` = blocked, budget_exhausted, auth_failed, credential_expired; `mask` = masked; `truncate` = truncated."
|
|
422
|
+
"description": "Coarse outcome filter that groups events. `allow` = query, auto_approved; `block` = blocked, budget_exhausted, auth_failed, credential_expired, canary_tripped, rejected, approval_expired; `mask` = masked; `truncate` = truncated."
|
|
409
423
|
},
|
|
410
424
|
{
|
|
411
425
|
"name": "source",
|
|
@@ -481,7 +495,7 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
481
495
|
"in": "query",
|
|
482
496
|
"required": false,
|
|
483
497
|
"type": "\"allow\" | \"block\" | \"mask\" | \"truncate\"",
|
|
484
|
-
"description": "Coarse outcome filter that groups events. `allow` = query; `block` = blocked, budget_exhausted, auth_failed, credential_expired; `mask` = masked; `truncate` = truncated."
|
|
498
|
+
"description": "Coarse outcome filter that groups events. `allow` = query, auto_approved; `block` = blocked, budget_exhausted, auth_failed, credential_expired, canary_tripped, rejected, approval_expired; `mask` = masked; `truncate` = truncated."
|
|
485
499
|
},
|
|
486
500
|
{
|
|
487
501
|
"name": "source",
|
|
@@ -867,6 +881,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
867
881
|
"required": true,
|
|
868
882
|
"type": "string",
|
|
869
883
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
884
|
+
},
|
|
885
|
+
{
|
|
886
|
+
"name": "Idempotency-Key",
|
|
887
|
+
"in": "header",
|
|
888
|
+
"required": false,
|
|
889
|
+
"type": "string",
|
|
890
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
870
891
|
}
|
|
871
892
|
],
|
|
872
893
|
"requestBodyType": "{ auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }",
|
|
@@ -1083,6 +1104,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1083
1104
|
"required": true,
|
|
1084
1105
|
"type": "string",
|
|
1085
1106
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "Idempotency-Key",
|
|
1110
|
+
"in": "header",
|
|
1111
|
+
"required": false,
|
|
1112
|
+
"type": "string",
|
|
1113
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1086
1114
|
}
|
|
1087
1115
|
],
|
|
1088
1116
|
"requestBodyType": "{ domain: string }",
|
|
@@ -1203,6 +1231,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1203
1231
|
"required": true,
|
|
1204
1232
|
"type": "string",
|
|
1205
1233
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "Idempotency-Key",
|
|
1237
|
+
"in": "header",
|
|
1238
|
+
"required": false,
|
|
1239
|
+
"type": "string",
|
|
1240
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1206
1241
|
}
|
|
1207
1242
|
],
|
|
1208
1243
|
"requestBodyType": "{ action: \"audit_only\" | \"kill\"; relation_name: string; schema_name?: string }",
|
|
@@ -1444,6 +1479,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1444
1479
|
"required": true,
|
|
1445
1480
|
"type": "string",
|
|
1446
1481
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"name": "Idempotency-Key",
|
|
1485
|
+
"in": "header",
|
|
1486
|
+
"required": false,
|
|
1487
|
+
"type": "string",
|
|
1488
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1447
1489
|
}
|
|
1448
1490
|
],
|
|
1449
1491
|
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
@@ -1619,7 +1661,15 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1619
1661
|
"path": "/v1/projects",
|
|
1620
1662
|
"summary": "Create a project",
|
|
1621
1663
|
"description": "Creates a new project within the specified organization.",
|
|
1622
|
-
"parameters": [
|
|
1664
|
+
"parameters": [
|
|
1665
|
+
{
|
|
1666
|
+
"name": "Idempotency-Key",
|
|
1667
|
+
"in": "header",
|
|
1668
|
+
"required": false,
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1671
|
+
}
|
|
1672
|
+
],
|
|
1623
1673
|
"requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; self_hosted?: boolean; tags?: string[] }",
|
|
1624
1674
|
"requestBodyRequired": true,
|
|
1625
1675
|
"responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
|
|
@@ -1764,6 +1814,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1764
1814
|
"required": true,
|
|
1765
1815
|
"type": "string",
|
|
1766
1816
|
"description": "Unique database identifier (prefixed, e.g. db_xxx)."
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
"name": "Idempotency-Key",
|
|
1820
|
+
"in": "header",
|
|
1821
|
+
"required": false,
|
|
1822
|
+
"type": "string",
|
|
1823
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1767
1824
|
}
|
|
1768
1825
|
],
|
|
1769
1826
|
"requestBodyType": "{ host: string; port: number; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\" }",
|
|
@@ -1926,6 +1983,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1926
1983
|
"required": true,
|
|
1927
1984
|
"type": "string",
|
|
1928
1985
|
"description": "Unique organization identifier."
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"name": "Idempotency-Key",
|
|
1989
|
+
"in": "header",
|
|
1990
|
+
"required": false,
|
|
1991
|
+
"type": "string",
|
|
1992
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1929
1993
|
}
|
|
1930
1994
|
],
|
|
1931
1995
|
"requestBodyType": "{ description?: string; expires_at?: string; region_label?: string }",
|
|
@@ -1980,6 +2044,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
1980
2044
|
"required": true,
|
|
1981
2045
|
"type": "string",
|
|
1982
2046
|
"description": "Unique enrollment identifier."
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"name": "Idempotency-Key",
|
|
2050
|
+
"in": "header",
|
|
2051
|
+
"required": false,
|
|
2052
|
+
"type": "string",
|
|
2053
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
1983
2054
|
}
|
|
1984
2055
|
],
|
|
1985
2056
|
"requestBodyType": "",
|
|
@@ -2048,6 +2119,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
2048
2119
|
"required": true,
|
|
2049
2120
|
"type": "string",
|
|
2050
2121
|
"description": "Unique organization identifier."
|
|
2122
|
+
},
|
|
2123
|
+
{
|
|
2124
|
+
"name": "Idempotency-Key",
|
|
2125
|
+
"in": "header",
|
|
2126
|
+
"required": false,
|
|
2127
|
+
"type": "string",
|
|
2128
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2051
2129
|
}
|
|
2052
2130
|
],
|
|
2053
2131
|
"requestBodyType": "{ body: string; org_id: string; severity?: number; title: string }",
|
|
@@ -2129,6 +2207,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
2129
2207
|
"required": true,
|
|
2130
2208
|
"type": "string",
|
|
2131
2209
|
"description": "Unique support case identifier (prefixed, e.g. sc_xxx)."
|
|
2210
|
+
},
|
|
2211
|
+
{
|
|
2212
|
+
"name": "Idempotency-Key",
|
|
2213
|
+
"in": "header",
|
|
2214
|
+
"required": false,
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2132
2217
|
}
|
|
2133
2218
|
],
|
|
2134
2219
|
"requestBodyType": "{ body: string }",
|
|
@@ -2297,6 +2382,13 @@ export { o as operationsByPath, a as operationsByTag } from './operations-map.ge
|
|
|
2297
2382
|
"required": true,
|
|
2298
2383
|
"type": "string",
|
|
2299
2384
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"name": "Idempotency-Key",
|
|
2388
|
+
"in": "header",
|
|
2389
|
+
"required": false,
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"description": "Client-generated key that makes a retry of this request safe. The first request carrying a given key executes normally and its response (status, content type and body) is stored for 24 hours; a later request with the same key returns that stored response without running the operation again, so a retry after a lost or timed-out response cannot create a second resource.\n\nReusing a key with a different request body returns `409 Conflict`: a key is a promise about one specific request, so a changed body is a client bug rather than a retry. Keys are scoped to the calling organization (or to the user, for account-scoped tokens), so one tenant can never read another's stored response.\n\nA `5xx`, `408` or `429` is never stored, because those describe a request that produced no settled answer and the next attempt with the same key must run for real. A `4xx` is stored: it is the server's settled answer about this exact request.\n\nUse a fresh UUID per logical operation. The PgBeam SDKs generate one per call and reuse it across their own automatic retries."
|
|
2300
2392
|
}
|
|
2301
2393
|
],
|
|
2302
2394
|
"requestBodyType": "{ description?: string; enabled?: boolean; event_types?: string[]; format?: \"json\" | \"splunk_hec\" | \"datadog\" | \"elastic\"; secret?: string; url: string }",
|
package/package.json
CHANGED