@deepraxis/sdk 0.1.0-dev.fe2a6ba → 0.1.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/METHODS.md +152 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +348 -24
- package/dist/generated/sdk.gen.js +1058 -23
- package/dist/generated/types.gen.d.ts +16690 -11162
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1631 -106
- package/dist/operations.generated.js +1974 -64
- package/dist/resources.generated.d.ts +673 -0
- package/dist/resources.generated.js +97 -0
- package/package.json +1 -1
|
@@ -102,6 +102,12 @@ export declare const operations: readonly [{
|
|
|
102
102
|
readonly itemType: "object";
|
|
103
103
|
readonly required: false;
|
|
104
104
|
readonly description: "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed.";
|
|
105
|
+
}, {
|
|
106
|
+
readonly name: "bindings";
|
|
107
|
+
readonly type: "array";
|
|
108
|
+
readonly itemType: "object";
|
|
109
|
+
readonly required: false;
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file_..., read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. A resource that is not bound returns 404, a service that is not opened returns 403, and writes to read_only resources are refused. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.";
|
|
105
111
|
}, {
|
|
106
112
|
readonly name: "kind";
|
|
107
113
|
readonly type: "string";
|
|
@@ -140,6 +146,22 @@ export declare const operations: readonly [{
|
|
|
140
146
|
readonly type: "object";
|
|
141
147
|
readonly required: false;
|
|
142
148
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
149
|
+
}, {
|
|
150
|
+
readonly name: "avatar";
|
|
151
|
+
readonly type: "string";
|
|
152
|
+
readonly required: false;
|
|
153
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
154
|
+
}, {
|
|
155
|
+
readonly name: "environment_id";
|
|
156
|
+
readonly type: "string";
|
|
157
|
+
readonly required: false;
|
|
158
|
+
readonly description: "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
159
|
+
}, {
|
|
160
|
+
readonly name: "vault_ids";
|
|
161
|
+
readonly type: "array";
|
|
162
|
+
readonly itemType: "string";
|
|
163
|
+
readonly required: false;
|
|
164
|
+
readonly description: "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
143
165
|
}, {
|
|
144
166
|
readonly name: "preset";
|
|
145
167
|
readonly type: "string";
|
|
@@ -171,7 +193,7 @@ export declare const operations: readonly [{
|
|
|
171
193
|
readonly resource: "agent.agents";
|
|
172
194
|
readonly method: "update";
|
|
173
195
|
readonly summary: "Update agent";
|
|
174
|
-
readonly description: "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version
|
|
196
|
+
readonly description: "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.";
|
|
175
197
|
readonly http: "POST";
|
|
176
198
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
177
199
|
readonly streaming: "no";
|
|
@@ -236,6 +258,22 @@ export declare const operations: readonly [{
|
|
|
236
258
|
readonly type: "number";
|
|
237
259
|
readonly required: false;
|
|
238
260
|
readonly description: "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally.";
|
|
261
|
+
}, {
|
|
262
|
+
readonly name: "apply";
|
|
263
|
+
readonly type: "boolean";
|
|
264
|
+
readonly required: false;
|
|
265
|
+
readonly description: "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate.";
|
|
266
|
+
}, {
|
|
267
|
+
readonly name: "version_note";
|
|
268
|
+
readonly type: "string";
|
|
269
|
+
readonly required: false;
|
|
270
|
+
readonly description: "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note.";
|
|
271
|
+
}, {
|
|
272
|
+
readonly name: "bindings";
|
|
273
|
+
readonly type: "array";
|
|
274
|
+
readonly itemType: "object";
|
|
275
|
+
readonly required: false;
|
|
276
|
+
readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept a nonempty list.";
|
|
239
277
|
}, {
|
|
240
278
|
readonly name: "kind";
|
|
241
279
|
readonly type: "string";
|
|
@@ -274,6 +312,22 @@ export declare const operations: readonly [{
|
|
|
274
312
|
readonly type: "object";
|
|
275
313
|
readonly required: false;
|
|
276
314
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
315
|
+
}, {
|
|
316
|
+
readonly name: "avatar";
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly required: false;
|
|
319
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
320
|
+
}, {
|
|
321
|
+
readonly name: "environment_id";
|
|
322
|
+
readonly type: "string";
|
|
323
|
+
readonly required: false;
|
|
324
|
+
readonly description: "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
325
|
+
}, {
|
|
326
|
+
readonly name: "vault_ids";
|
|
327
|
+
readonly type: "array";
|
|
328
|
+
readonly itemType: "string";
|
|
329
|
+
readonly required: false;
|
|
330
|
+
readonly description: "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
277
331
|
}, {
|
|
278
332
|
readonly name: "preset";
|
|
279
333
|
readonly type: "string";
|
|
@@ -470,6 +524,23 @@ export declare const operations: readonly [{
|
|
|
470
524
|
readonly required: false;
|
|
471
525
|
readonly description: "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400.";
|
|
472
526
|
}];
|
|
527
|
+
}, {
|
|
528
|
+
readonly resource: "agent.agents.versions";
|
|
529
|
+
readonly method: "apply";
|
|
530
|
+
readonly summary: "Apply Agent Version";
|
|
531
|
+
readonly description: "Apply a version from agents.versions.list by its version number. This idempotent operation changes active_version without creating a version; existing sessions and tokens keep their version. The response is the latest saved agent with its current active_version. Missing versions return 404 Agent version not found; archived agents return 409 Agent is archived. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.";
|
|
532
|
+
readonly http: "POST";
|
|
533
|
+
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
534
|
+
readonly streaming: "no";
|
|
535
|
+
readonly pagination: false;
|
|
536
|
+
readonly pathParams: readonly [{
|
|
537
|
+
readonly name: "agent_id";
|
|
538
|
+
readonly sdkName: "agent_id";
|
|
539
|
+
}, {
|
|
540
|
+
readonly name: "version";
|
|
541
|
+
readonly sdkName: "version";
|
|
542
|
+
}];
|
|
543
|
+
readonly query: readonly [];
|
|
473
544
|
}, {
|
|
474
545
|
readonly resource: "agent.computers";
|
|
475
546
|
readonly method: "list";
|
|
@@ -608,7 +679,7 @@ export declare const operations: readonly [{
|
|
|
608
679
|
readonly resource: "agent.computers";
|
|
609
680
|
readonly method: "connect";
|
|
610
681
|
readonly summary: "Connect computer";
|
|
611
|
-
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy.
|
|
682
|
+
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.";
|
|
612
683
|
readonly http: "POST";
|
|
613
684
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
614
685
|
readonly streaming: "no";
|
|
@@ -1442,7 +1513,7 @@ export declare const operations: readonly [{
|
|
|
1442
1513
|
readonly resource: "agent.sessions";
|
|
1443
1514
|
readonly method: "create";
|
|
1444
1515
|
readonly summary: "Create session";
|
|
1445
|
-
readonly description: "Create a session: one conversation with an agent
|
|
1516
|
+
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id (active_version) or {id, version, type:\"agent\"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.";
|
|
1446
1517
|
readonly http: "POST";
|
|
1447
1518
|
readonly path: "/agent/v1/sessions";
|
|
1448
1519
|
readonly streaming: "no";
|
|
@@ -1460,7 +1531,7 @@ export declare const operations: readonly [{
|
|
|
1460
1531
|
readonly name: "environment_id";
|
|
1461
1532
|
readonly type: "string";
|
|
1462
1533
|
readonly required: false;
|
|
1463
|
-
readonly description: "
|
|
1534
|
+
readonly description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.";
|
|
1464
1535
|
}, {
|
|
1465
1536
|
readonly name: "budget";
|
|
1466
1537
|
readonly type: "object";
|
|
@@ -2153,6 +2224,187 @@ export declare const operations: readonly [{
|
|
|
2153
2224
|
readonly required: false;
|
|
2154
2225
|
readonly description: "When set, this connection also receives streaming deltas\n(`event_start`, `event_delta`) while an event is being produced, before the\nevent itself arrives. Deltas are best-effort; when the final event is produced\nit carries the complete content. A model request that ends early (an error or\ninterrupt) produces no final event — its terminal `span.model_request_end`\ncloses the preview. Accepts one or more event types to preview and may be\nrepeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is\nstart-only — a signal that the agent has begun extended thinking, concluded by\nthe `agent.thinking` event itself. Only previews of the requested event types\nare sent.";
|
|
2155
2226
|
}];
|
|
2227
|
+
}, {
|
|
2228
|
+
readonly resource: "agent.skills";
|
|
2229
|
+
readonly method: "list";
|
|
2230
|
+
readonly summary: "List skills";
|
|
2231
|
+
readonly description: "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
2232
|
+
readonly http: "GET";
|
|
2233
|
+
readonly path: "/agent/v1/skills";
|
|
2234
|
+
readonly streaming: "no";
|
|
2235
|
+
readonly pagination: false;
|
|
2236
|
+
readonly pathParams: readonly [];
|
|
2237
|
+
readonly query: readonly [{
|
|
2238
|
+
readonly name: "source";
|
|
2239
|
+
readonly type: "string";
|
|
2240
|
+
readonly required: false;
|
|
2241
|
+
readonly description: "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills";
|
|
2242
|
+
}, {
|
|
2243
|
+
readonly name: "limit";
|
|
2244
|
+
readonly type: "number";
|
|
2245
|
+
readonly required: false;
|
|
2246
|
+
readonly description: "Number of items per page.";
|
|
2247
|
+
}, {
|
|
2248
|
+
readonly name: "page";
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly required: false;
|
|
2251
|
+
readonly description: "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400.";
|
|
2252
|
+
}];
|
|
2253
|
+
}, {
|
|
2254
|
+
readonly resource: "agent.skills";
|
|
2255
|
+
readonly method: "create";
|
|
2256
|
+
readonly summary: "Create skill";
|
|
2257
|
+
readonly description: "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.";
|
|
2258
|
+
readonly http: "POST";
|
|
2259
|
+
readonly path: "/agent/v1/skills";
|
|
2260
|
+
readonly streaming: "no";
|
|
2261
|
+
readonly pagination: false;
|
|
2262
|
+
readonly multipart: true;
|
|
2263
|
+
readonly pathParams: readonly [];
|
|
2264
|
+
readonly query: readonly [];
|
|
2265
|
+
readonly body: {
|
|
2266
|
+
readonly required: true;
|
|
2267
|
+
readonly fields: readonly [{
|
|
2268
|
+
readonly name: "files";
|
|
2269
|
+
readonly type: "array";
|
|
2270
|
+
readonly itemType: "string";
|
|
2271
|
+
readonly required: true;
|
|
2272
|
+
readonly description: "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory.";
|
|
2273
|
+
}, {
|
|
2274
|
+
readonly name: "display_name";
|
|
2275
|
+
readonly type: "string";
|
|
2276
|
+
readonly required: false;
|
|
2277
|
+
readonly description: "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique.";
|
|
2278
|
+
}];
|
|
2279
|
+
};
|
|
2280
|
+
}, {
|
|
2281
|
+
readonly resource: "agent.skills";
|
|
2282
|
+
readonly method: "delete";
|
|
2283
|
+
readonly summary: "Delete skill";
|
|
2284
|
+
readonly description: "Delete a skill that has no live versions. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.";
|
|
2285
|
+
readonly http: "DELETE";
|
|
2286
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2287
|
+
readonly streaming: "no";
|
|
2288
|
+
readonly pagination: false;
|
|
2289
|
+
readonly pathParams: readonly [{
|
|
2290
|
+
readonly name: "skill_id";
|
|
2291
|
+
readonly sdkName: "skill_id";
|
|
2292
|
+
}];
|
|
2293
|
+
readonly query: readonly [];
|
|
2294
|
+
}, {
|
|
2295
|
+
readonly resource: "agent.skills";
|
|
2296
|
+
readonly method: "retrieve";
|
|
2297
|
+
readonly summary: "Get skill";
|
|
2298
|
+
readonly description: "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.";
|
|
2299
|
+
readonly http: "GET";
|
|
2300
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2301
|
+
readonly streaming: "no";
|
|
2302
|
+
readonly pagination: false;
|
|
2303
|
+
readonly pathParams: readonly [{
|
|
2304
|
+
readonly name: "skill_id";
|
|
2305
|
+
readonly sdkName: "skill_id";
|
|
2306
|
+
}];
|
|
2307
|
+
readonly query: readonly [];
|
|
2308
|
+
}, {
|
|
2309
|
+
readonly resource: "agent.skills.versions";
|
|
2310
|
+
readonly method: "list";
|
|
2311
|
+
readonly summary: "List skill versions";
|
|
2312
|
+
readonly description: "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
2313
|
+
readonly http: "GET";
|
|
2314
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2315
|
+
readonly streaming: "no";
|
|
2316
|
+
readonly pagination: false;
|
|
2317
|
+
readonly pathParams: readonly [{
|
|
2318
|
+
readonly name: "skill_id";
|
|
2319
|
+
readonly sdkName: "skill_id";
|
|
2320
|
+
}];
|
|
2321
|
+
readonly query: readonly [{
|
|
2322
|
+
readonly name: "limit";
|
|
2323
|
+
readonly type: "number";
|
|
2324
|
+
readonly required: false;
|
|
2325
|
+
readonly description: "Number of items per page.";
|
|
2326
|
+
}, {
|
|
2327
|
+
readonly name: "page";
|
|
2328
|
+
readonly type: "string";
|
|
2329
|
+
readonly required: false;
|
|
2330
|
+
readonly description: "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400.";
|
|
2331
|
+
}];
|
|
2332
|
+
}, {
|
|
2333
|
+
readonly resource: "agent.skills.versions";
|
|
2334
|
+
readonly method: "create";
|
|
2335
|
+
readonly summary: "Create skill version";
|
|
2336
|
+
readonly description: "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.";
|
|
2337
|
+
readonly http: "POST";
|
|
2338
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2339
|
+
readonly streaming: "no";
|
|
2340
|
+
readonly pagination: false;
|
|
2341
|
+
readonly multipart: true;
|
|
2342
|
+
readonly pathParams: readonly [{
|
|
2343
|
+
readonly name: "skill_id";
|
|
2344
|
+
readonly sdkName: "skill_id";
|
|
2345
|
+
}];
|
|
2346
|
+
readonly query: readonly [];
|
|
2347
|
+
readonly body: {
|
|
2348
|
+
readonly required: true;
|
|
2349
|
+
readonly fields: readonly [{
|
|
2350
|
+
readonly name: "files";
|
|
2351
|
+
readonly type: "array";
|
|
2352
|
+
readonly itemType: "string";
|
|
2353
|
+
readonly required: true;
|
|
2354
|
+
readonly description: "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory.";
|
|
2355
|
+
}];
|
|
2356
|
+
};
|
|
2357
|
+
}, {
|
|
2358
|
+
readonly resource: "agent.skills.versions";
|
|
2359
|
+
readonly method: "delete";
|
|
2360
|
+
readonly summary: "Delete skill version";
|
|
2361
|
+
readonly description: "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted.";
|
|
2362
|
+
readonly http: "DELETE";
|
|
2363
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2364
|
+
readonly streaming: "no";
|
|
2365
|
+
readonly pagination: false;
|
|
2366
|
+
readonly pathParams: readonly [{
|
|
2367
|
+
readonly name: "skill_id";
|
|
2368
|
+
readonly sdkName: "skill_id";
|
|
2369
|
+
}, {
|
|
2370
|
+
readonly name: "version";
|
|
2371
|
+
readonly sdkName: "version";
|
|
2372
|
+
}];
|
|
2373
|
+
readonly query: readonly [];
|
|
2374
|
+
}, {
|
|
2375
|
+
readonly resource: "agent.skills.versions";
|
|
2376
|
+
readonly method: "retrieve";
|
|
2377
|
+
readonly summary: "Get skill version";
|
|
2378
|
+
readonly description: "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.";
|
|
2379
|
+
readonly http: "GET";
|
|
2380
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2381
|
+
readonly streaming: "no";
|
|
2382
|
+
readonly pagination: false;
|
|
2383
|
+
readonly pathParams: readonly [{
|
|
2384
|
+
readonly name: "skill_id";
|
|
2385
|
+
readonly sdkName: "skill_id";
|
|
2386
|
+
}, {
|
|
2387
|
+
readonly name: "version";
|
|
2388
|
+
readonly sdkName: "version";
|
|
2389
|
+
}];
|
|
2390
|
+
readonly query: readonly [];
|
|
2391
|
+
}, {
|
|
2392
|
+
readonly resource: "agent.skills.versions";
|
|
2393
|
+
readonly method: "retrieveContent";
|
|
2394
|
+
readonly summary: "Download skill version";
|
|
2395
|
+
readonly description: "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.";
|
|
2396
|
+
readonly http: "GET";
|
|
2397
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}/content";
|
|
2398
|
+
readonly streaming: "no";
|
|
2399
|
+
readonly pagination: false;
|
|
2400
|
+
readonly pathParams: readonly [{
|
|
2401
|
+
readonly name: "skill_id";
|
|
2402
|
+
readonly sdkName: "skill_id";
|
|
2403
|
+
}, {
|
|
2404
|
+
readonly name: "version";
|
|
2405
|
+
readonly sdkName: "version";
|
|
2406
|
+
}];
|
|
2407
|
+
readonly query: readonly [];
|
|
2156
2408
|
}, {
|
|
2157
2409
|
readonly resource: "agent.toolsets";
|
|
2158
2410
|
readonly method: "list";
|
|
@@ -2844,12 +3096,12 @@ export declare const operations: readonly [{
|
|
|
2844
3096
|
readonly name: "namespace";
|
|
2845
3097
|
readonly type: "string";
|
|
2846
3098
|
readonly required: true;
|
|
2847
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3099
|
+
readonly description: "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2848
3100
|
}, {
|
|
2849
3101
|
readonly name: "name";
|
|
2850
3102
|
readonly type: "string";
|
|
2851
3103
|
readonly required: true;
|
|
2852
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3104
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2853
3105
|
}, {
|
|
2854
3106
|
readonly name: "description";
|
|
2855
3107
|
readonly type: "string";
|
|
@@ -2901,8 +3153,8 @@ export declare const operations: readonly [{
|
|
|
2901
3153
|
}, {
|
|
2902
3154
|
readonly resource: "automation.actions";
|
|
2903
3155
|
readonly method: "retrieve";
|
|
2904
|
-
readonly summary: "Get an
|
|
2905
|
-
readonly description: "Read the
|
|
3156
|
+
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3157
|
+
readonly description: "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.";
|
|
2906
3158
|
readonly http: "GET";
|
|
2907
3159
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2908
3160
|
readonly streaming: "no";
|
|
@@ -3346,8 +3598,8 @@ export declare const operations: readonly [{
|
|
|
3346
3598
|
}, {
|
|
3347
3599
|
readonly resource: "automation.runs";
|
|
3348
3600
|
readonly method: "create";
|
|
3349
|
-
readonly summary: "
|
|
3350
|
-
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters
|
|
3601
|
+
readonly summary: "Run a published target or execute draft source";
|
|
3602
|
+
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 7 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.";
|
|
3351
3603
|
readonly http: "POST";
|
|
3352
3604
|
readonly path: "/automation/v1/runs";
|
|
3353
3605
|
readonly streaming: "no";
|
|
@@ -3730,7 +3982,7 @@ export declare const operations: readonly [{
|
|
|
3730
3982
|
readonly resource: "automation.scripts";
|
|
3731
3983
|
readonly method: "create";
|
|
3732
3984
|
readonly summary: "Create a script";
|
|
3733
|
-
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is
|
|
3985
|
+
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.";
|
|
3734
3986
|
readonly http: "POST";
|
|
3735
3987
|
readonly path: "/automation/v1/scripts";
|
|
3736
3988
|
readonly streaming: "no";
|
|
@@ -3743,12 +3995,12 @@ export declare const operations: readonly [{
|
|
|
3743
3995
|
readonly name: "namespace";
|
|
3744
3996
|
readonly type: "string";
|
|
3745
3997
|
readonly required: true;
|
|
3746
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3998
|
+
readonly description: "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3747
3999
|
}, {
|
|
3748
4000
|
readonly name: "name";
|
|
3749
4001
|
readonly type: "string";
|
|
3750
4002
|
readonly required: true;
|
|
3751
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4003
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3752
4004
|
}, {
|
|
3753
4005
|
readonly name: "description";
|
|
3754
4006
|
readonly type: "string";
|
|
@@ -3787,7 +4039,7 @@ export declare const operations: readonly [{
|
|
|
3787
4039
|
readonly resource: "automation.scripts";
|
|
3788
4040
|
readonly method: "update";
|
|
3789
4041
|
readonly summary: "Update a script draft";
|
|
3790
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
4042
|
+
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist.";
|
|
3791
4043
|
readonly http: "PATCH";
|
|
3792
4044
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3793
4045
|
readonly streaming: "no";
|
|
@@ -4546,7 +4798,7 @@ export declare const operations: readonly [{
|
|
|
4546
4798
|
readonly resource: "automation.workflows";
|
|
4547
4799
|
readonly method: "create";
|
|
4548
4800
|
readonly summary: "Create a workflow";
|
|
4549
|
-
readonly description: "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is
|
|
4801
|
+
readonly description: "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. To test the draft, send its source and language=yaml to praxis.automation.runs.create. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.";
|
|
4550
4802
|
readonly http: "POST";
|
|
4551
4803
|
readonly path: "/automation/v1/workflows";
|
|
4552
4804
|
readonly streaming: "no";
|
|
@@ -4559,12 +4811,12 @@ export declare const operations: readonly [{
|
|
|
4559
4811
|
readonly name: "namespace";
|
|
4560
4812
|
readonly type: "string";
|
|
4561
4813
|
readonly required: true;
|
|
4562
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4814
|
+
readonly description: "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4563
4815
|
}, {
|
|
4564
4816
|
readonly name: "name";
|
|
4565
4817
|
readonly type: "string";
|
|
4566
4818
|
readonly required: true;
|
|
4567
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4819
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4568
4820
|
}, {
|
|
4569
4821
|
readonly name: "description";
|
|
4570
4822
|
readonly type: "string";
|
|
@@ -5502,7 +5754,7 @@ export declare const operations: readonly [{
|
|
|
5502
5754
|
readonly name: "{column}";
|
|
5503
5755
|
readonly type: "string";
|
|
5504
5756
|
readonly required: false;
|
|
5505
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5757
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5506
5758
|
}, {
|
|
5507
5759
|
readonly name: "and";
|
|
5508
5760
|
readonly type: "string";
|
|
@@ -5542,7 +5794,7 @@ export declare const operations: readonly [{
|
|
|
5542
5794
|
readonly name: "on_conflict";
|
|
5543
5795
|
readonly type: "string";
|
|
5544
5796
|
readonly required: false;
|
|
5545
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5797
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5546
5798
|
}, {
|
|
5547
5799
|
readonly name: "columns";
|
|
5548
5800
|
readonly type: "string";
|
|
@@ -5553,7 +5805,7 @@ export declare const operations: readonly [{
|
|
|
5553
5805
|
readonly resource: "database.databases.rest";
|
|
5554
5806
|
readonly method: "retrieve";
|
|
5555
5807
|
readonly summary: "Select rows";
|
|
5556
|
-
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
5808
|
+
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.";
|
|
5557
5809
|
readonly http: "GET";
|
|
5558
5810
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5559
5811
|
readonly streaming: "no";
|
|
@@ -5574,7 +5826,7 @@ export declare const operations: readonly [{
|
|
|
5574
5826
|
readonly name: "{column}";
|
|
5575
5827
|
readonly type: "string";
|
|
5576
5828
|
readonly required: false;
|
|
5577
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5829
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5578
5830
|
}, {
|
|
5579
5831
|
readonly name: "and";
|
|
5580
5832
|
readonly type: "string";
|
|
@@ -5614,7 +5866,7 @@ export declare const operations: readonly [{
|
|
|
5614
5866
|
readonly name: "on_conflict";
|
|
5615
5867
|
readonly type: "string";
|
|
5616
5868
|
readonly required: false;
|
|
5617
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5869
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5618
5870
|
}, {
|
|
5619
5871
|
readonly name: "columns";
|
|
5620
5872
|
readonly type: "string";
|
|
@@ -5625,7 +5877,7 @@ export declare const operations: readonly [{
|
|
|
5625
5877
|
readonly resource: "database.databases.rest";
|
|
5626
5878
|
readonly method: "head";
|
|
5627
5879
|
readonly summary: "Count rows";
|
|
5628
|
-
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
5880
|
+
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.";
|
|
5629
5881
|
readonly http: "HEAD";
|
|
5630
5882
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5631
5883
|
readonly streaming: "no";
|
|
@@ -5646,7 +5898,7 @@ export declare const operations: readonly [{
|
|
|
5646
5898
|
readonly name: "{column}";
|
|
5647
5899
|
readonly type: "string";
|
|
5648
5900
|
readonly required: false;
|
|
5649
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5901
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5650
5902
|
}, {
|
|
5651
5903
|
readonly name: "and";
|
|
5652
5904
|
readonly type: "string";
|
|
@@ -5686,7 +5938,7 @@ export declare const operations: readonly [{
|
|
|
5686
5938
|
readonly name: "on_conflict";
|
|
5687
5939
|
readonly type: "string";
|
|
5688
5940
|
readonly required: false;
|
|
5689
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5941
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5690
5942
|
}, {
|
|
5691
5943
|
readonly name: "columns";
|
|
5692
5944
|
readonly type: "string";
|
|
@@ -5718,7 +5970,7 @@ export declare const operations: readonly [{
|
|
|
5718
5970
|
readonly name: "{column}";
|
|
5719
5971
|
readonly type: "string";
|
|
5720
5972
|
readonly required: false;
|
|
5721
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5973
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5722
5974
|
}, {
|
|
5723
5975
|
readonly name: "and";
|
|
5724
5976
|
readonly type: "string";
|
|
@@ -5758,7 +6010,7 @@ export declare const operations: readonly [{
|
|
|
5758
6010
|
readonly name: "on_conflict";
|
|
5759
6011
|
readonly type: "string";
|
|
5760
6012
|
readonly required: false;
|
|
5761
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
6013
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5762
6014
|
}, {
|
|
5763
6015
|
readonly name: "columns";
|
|
5764
6016
|
readonly type: "string";
|
|
@@ -5773,7 +6025,7 @@ export declare const operations: readonly [{
|
|
|
5773
6025
|
readonly resource: "database.databases.rest";
|
|
5774
6026
|
readonly method: "create";
|
|
5775
6027
|
readonly summary: "Insert rows";
|
|
5776
|
-
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
6028
|
+
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5777
6029
|
readonly http: "POST";
|
|
5778
6030
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5779
6031
|
readonly streaming: "no";
|
|
@@ -5794,7 +6046,7 @@ export declare const operations: readonly [{
|
|
|
5794
6046
|
readonly name: "{column}";
|
|
5795
6047
|
readonly type: "string";
|
|
5796
6048
|
readonly required: false;
|
|
5797
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
6049
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5798
6050
|
}, {
|
|
5799
6051
|
readonly name: "and";
|
|
5800
6052
|
readonly type: "string";
|
|
@@ -5834,7 +6086,7 @@ export declare const operations: readonly [{
|
|
|
5834
6086
|
readonly name: "on_conflict";
|
|
5835
6087
|
readonly type: "string";
|
|
5836
6088
|
readonly required: false;
|
|
5837
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
6089
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5838
6090
|
}, {
|
|
5839
6091
|
readonly name: "columns";
|
|
5840
6092
|
readonly type: "string";
|
|
@@ -5877,7 +6129,7 @@ export declare const operations: readonly [{
|
|
|
5877
6129
|
readonly resource: "database.databases.tables";
|
|
5878
6130
|
readonly method: "create";
|
|
5879
6131
|
readonly summary: "Create table";
|
|
5880
|
-
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
6132
|
+
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5881
6133
|
readonly http: "POST";
|
|
5882
6134
|
readonly path: "/database/v1/databases/{database_id}/tables";
|
|
5883
6135
|
readonly streaming: "no";
|
|
@@ -5976,7 +6228,7 @@ export declare const operations: readonly [{
|
|
|
5976
6228
|
readonly resource: "database.databases.tables.fields";
|
|
5977
6229
|
readonly method: "create";
|
|
5978
6230
|
readonly summary: "Add field";
|
|
5979
|
-
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
6231
|
+
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.";
|
|
5980
6232
|
readonly http: "POST";
|
|
5981
6233
|
readonly path: "/database/v1/databases/{database_id}/tables/{table}/fields";
|
|
5982
6234
|
readonly streaming: "no";
|
|
@@ -6113,7 +6365,7 @@ export declare const operations: readonly [{
|
|
|
6113
6365
|
readonly resource: "file.files";
|
|
6114
6366
|
readonly method: "create";
|
|
6115
6367
|
readonly summary: "Upload file";
|
|
6116
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
6368
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.";
|
|
6117
6369
|
readonly http: "POST";
|
|
6118
6370
|
readonly path: "/file/v1/files";
|
|
6119
6371
|
readonly streaming: "no";
|
|
@@ -6127,7 +6379,7 @@ export declare const operations: readonly [{
|
|
|
6127
6379
|
readonly name: "file";
|
|
6128
6380
|
readonly type: "string";
|
|
6129
6381
|
readonly required: true;
|
|
6130
|
-
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
6382
|
+
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type.";
|
|
6131
6383
|
}, {
|
|
6132
6384
|
readonly name: "purpose";
|
|
6133
6385
|
readonly type: "string";
|
|
@@ -6164,7 +6416,7 @@ export declare const operations: readonly [{
|
|
|
6164
6416
|
readonly resource: "file.files";
|
|
6165
6417
|
readonly method: "retrieve";
|
|
6166
6418
|
readonly summary: "Retrieve file";
|
|
6167
|
-
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its
|
|
6419
|
+
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.";
|
|
6168
6420
|
readonly http: "GET";
|
|
6169
6421
|
readonly path: "/file/v1/files/{file_id}";
|
|
6170
6422
|
readonly streaming: "no";
|
|
@@ -6178,7 +6430,7 @@ export declare const operations: readonly [{
|
|
|
6178
6430
|
readonly resource: "file.files";
|
|
6179
6431
|
readonly method: "retrieveContent";
|
|
6180
6432
|
readonly summary: "Retrieve file content";
|
|
6181
|
-
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its
|
|
6433
|
+
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.";
|
|
6182
6434
|
readonly http: "GET";
|
|
6183
6435
|
readonly path: "/file/v1/files/{file_id}/content";
|
|
6184
6436
|
readonly streaming: "no";
|
|
@@ -6189,50 +6441,12 @@ export declare const operations: readonly [{
|
|
|
6189
6441
|
}];
|
|
6190
6442
|
readonly query: readonly [];
|
|
6191
6443
|
}, {
|
|
6192
|
-
readonly resource: "
|
|
6193
|
-
readonly method: "list";
|
|
6194
|
-
readonly summary: "List knowledge bases";
|
|
6195
|
-
readonly description: "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.";
|
|
6196
|
-
readonly http: "GET";
|
|
6197
|
-
readonly path: "/knowledge/v1/vector_stores";
|
|
6198
|
-
readonly streaming: "no";
|
|
6199
|
-
readonly pagination: false;
|
|
6200
|
-
readonly pathParams: readonly [];
|
|
6201
|
-
readonly query: readonly [{
|
|
6202
|
-
readonly name: "status";
|
|
6203
|
-
readonly type: "string";
|
|
6204
|
-
readonly enum: readonly ["active", "deleting"];
|
|
6205
|
-
readonly required: false;
|
|
6206
|
-
readonly description: "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores.";
|
|
6207
|
-
}, {
|
|
6208
|
-
readonly name: "after";
|
|
6209
|
-
readonly type: "string";
|
|
6210
|
-
readonly required: false;
|
|
6211
|
-
readonly description: "Cursor ID from the previous page.";
|
|
6212
|
-
}, {
|
|
6213
|
-
readonly name: "before";
|
|
6214
|
-
readonly type: "string";
|
|
6215
|
-
readonly required: false;
|
|
6216
|
-
readonly description: "Return items before this ID.";
|
|
6217
|
-
}, {
|
|
6218
|
-
readonly name: "limit";
|
|
6219
|
-
readonly type: "integer";
|
|
6220
|
-
readonly required: false;
|
|
6221
|
-
readonly description: "Page size.";
|
|
6222
|
-
}, {
|
|
6223
|
-
readonly name: "order";
|
|
6224
|
-
readonly type: "string";
|
|
6225
|
-
readonly enum: readonly ["asc", "desc"];
|
|
6226
|
-
readonly required: false;
|
|
6227
|
-
readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
|
|
6228
|
-
}];
|
|
6229
|
-
}, {
|
|
6230
|
-
readonly resource: "knowledge.vectorStores";
|
|
6444
|
+
readonly resource: "file.uploads";
|
|
6231
6445
|
readonly method: "create";
|
|
6232
|
-
readonly summary: "Create
|
|
6233
|
-
readonly description: "
|
|
6446
|
+
readonly summary: "Create an upload";
|
|
6447
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
6234
6448
|
readonly http: "POST";
|
|
6235
|
-
readonly path: "/
|
|
6449
|
+
readonly path: "/file/v1/uploads";
|
|
6236
6450
|
readonly streaming: "no";
|
|
6237
6451
|
readonly pagination: false;
|
|
6238
6452
|
readonly pathParams: readonly [];
|
|
@@ -6240,34 +6454,190 @@ export declare const operations: readonly [{
|
|
|
6240
6454
|
readonly body: {
|
|
6241
6455
|
readonly required: true;
|
|
6242
6456
|
readonly fields: readonly [{
|
|
6243
|
-
readonly name: "
|
|
6244
|
-
readonly type: "
|
|
6245
|
-
readonly required:
|
|
6246
|
-
readonly description: "
|
|
6457
|
+
readonly name: "bytes";
|
|
6458
|
+
readonly type: "integer";
|
|
6459
|
+
readonly required: true;
|
|
6460
|
+
readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
|
|
6247
6461
|
}, {
|
|
6248
|
-
readonly name: "
|
|
6249
|
-
readonly type: "
|
|
6250
|
-
readonly required:
|
|
6251
|
-
readonly description: "
|
|
6462
|
+
readonly name: "filename";
|
|
6463
|
+
readonly type: "string";
|
|
6464
|
+
readonly required: true;
|
|
6465
|
+
readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
|
|
6252
6466
|
}, {
|
|
6253
|
-
readonly name: "
|
|
6254
|
-
readonly type: "
|
|
6255
|
-
readonly required:
|
|
6256
|
-
readonly description: "
|
|
6467
|
+
readonly name: "mime_type";
|
|
6468
|
+
readonly type: "string";
|
|
6469
|
+
readonly required: true;
|
|
6470
|
+
readonly description: "Declared MIME type; validated against the assembled content.";
|
|
6257
6471
|
}, {
|
|
6258
|
-
readonly name: "
|
|
6259
|
-
readonly type: "
|
|
6260
|
-
readonly
|
|
6261
|
-
readonly required:
|
|
6262
|
-
readonly description: "
|
|
6472
|
+
readonly name: "purpose";
|
|
6473
|
+
readonly type: "string";
|
|
6474
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
6475
|
+
readonly required: true;
|
|
6476
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6263
6477
|
}, {
|
|
6264
|
-
readonly name: "
|
|
6478
|
+
readonly name: "expires_after";
|
|
6265
6479
|
readonly type: "object";
|
|
6266
6480
|
readonly required: false;
|
|
6267
|
-
readonly description: "
|
|
6481
|
+
readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
|
|
6268
6482
|
}, {
|
|
6269
|
-
readonly name: "
|
|
6270
|
-
readonly type: "
|
|
6483
|
+
readonly name: "part_size";
|
|
6484
|
+
readonly type: "integer";
|
|
6485
|
+
readonly required: false;
|
|
6486
|
+
readonly description: "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts.";
|
|
6487
|
+
}];
|
|
6488
|
+
};
|
|
6489
|
+
}, {
|
|
6490
|
+
readonly resource: "file.uploads";
|
|
6491
|
+
readonly method: "cancel";
|
|
6492
|
+
readonly summary: "Cancel an upload";
|
|
6493
|
+
readonly description: "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.";
|
|
6494
|
+
readonly http: "POST";
|
|
6495
|
+
readonly path: "/file/v1/uploads/{upload_id}/cancel";
|
|
6496
|
+
readonly streaming: "no";
|
|
6497
|
+
readonly pagination: false;
|
|
6498
|
+
readonly pathParams: readonly [{
|
|
6499
|
+
readonly name: "upload_id";
|
|
6500
|
+
readonly sdkName: "upload_id";
|
|
6501
|
+
}];
|
|
6502
|
+
readonly query: readonly [];
|
|
6503
|
+
}, {
|
|
6504
|
+
readonly resource: "file.uploads";
|
|
6505
|
+
readonly method: "complete";
|
|
6506
|
+
readonly summary: "Complete an upload";
|
|
6507
|
+
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
6508
|
+
readonly http: "POST";
|
|
6509
|
+
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
6510
|
+
readonly streaming: "no";
|
|
6511
|
+
readonly pagination: false;
|
|
6512
|
+
readonly pathParams: readonly [{
|
|
6513
|
+
readonly name: "upload_id";
|
|
6514
|
+
readonly sdkName: "upload_id";
|
|
6515
|
+
}];
|
|
6516
|
+
readonly query: readonly [];
|
|
6517
|
+
readonly body: {
|
|
6518
|
+
readonly required: true;
|
|
6519
|
+
readonly fields: readonly [{
|
|
6520
|
+
readonly name: "part_ids";
|
|
6521
|
+
readonly type: "array";
|
|
6522
|
+
readonly itemType: "string";
|
|
6523
|
+
readonly required: true;
|
|
6524
|
+
readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
|
|
6525
|
+
}, {
|
|
6526
|
+
readonly name: "md5";
|
|
6527
|
+
readonly type: "string";
|
|
6528
|
+
readonly required: false;
|
|
6529
|
+
readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
|
|
6530
|
+
}];
|
|
6531
|
+
};
|
|
6532
|
+
}, {
|
|
6533
|
+
readonly resource: "file.uploads.parts";
|
|
6534
|
+
readonly method: "create";
|
|
6535
|
+
readonly summary: "Add an upload part";
|
|
6536
|
+
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
6537
|
+
readonly http: "POST";
|
|
6538
|
+
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
6539
|
+
readonly streaming: "no";
|
|
6540
|
+
readonly pagination: false;
|
|
6541
|
+
readonly multipart: true;
|
|
6542
|
+
readonly pathParams: readonly [{
|
|
6543
|
+
readonly name: "upload_id";
|
|
6544
|
+
readonly sdkName: "upload_id";
|
|
6545
|
+
}];
|
|
6546
|
+
readonly query: readonly [{
|
|
6547
|
+
readonly name: "part_number";
|
|
6548
|
+
readonly type: "integer";
|
|
6549
|
+
readonly required: false;
|
|
6550
|
+
readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
|
|
6551
|
+
}];
|
|
6552
|
+
readonly body: {
|
|
6553
|
+
readonly required: true;
|
|
6554
|
+
readonly fields: readonly [{
|
|
6555
|
+
readonly name: "data";
|
|
6556
|
+
readonly type: "string";
|
|
6557
|
+
readonly required: true;
|
|
6558
|
+
readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
|
|
6559
|
+
}];
|
|
6560
|
+
};
|
|
6561
|
+
}, {
|
|
6562
|
+
readonly resource: "knowledge.vectorStores";
|
|
6563
|
+
readonly method: "list";
|
|
6564
|
+
readonly summary: "List knowledge bases";
|
|
6565
|
+
readonly description: "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.";
|
|
6566
|
+
readonly http: "GET";
|
|
6567
|
+
readonly path: "/knowledge/v1/vector_stores";
|
|
6568
|
+
readonly streaming: "no";
|
|
6569
|
+
readonly pagination: false;
|
|
6570
|
+
readonly pathParams: readonly [];
|
|
6571
|
+
readonly query: readonly [{
|
|
6572
|
+
readonly name: "status";
|
|
6573
|
+
readonly type: "string";
|
|
6574
|
+
readonly enum: readonly ["active", "deleting"];
|
|
6575
|
+
readonly required: false;
|
|
6576
|
+
readonly description: "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores.";
|
|
6577
|
+
}, {
|
|
6578
|
+
readonly name: "after";
|
|
6579
|
+
readonly type: "string";
|
|
6580
|
+
readonly required: false;
|
|
6581
|
+
readonly description: "Cursor ID from the previous page.";
|
|
6582
|
+
}, {
|
|
6583
|
+
readonly name: "before";
|
|
6584
|
+
readonly type: "string";
|
|
6585
|
+
readonly required: false;
|
|
6586
|
+
readonly description: "Return items before this ID.";
|
|
6587
|
+
}, {
|
|
6588
|
+
readonly name: "limit";
|
|
6589
|
+
readonly type: "integer";
|
|
6590
|
+
readonly required: false;
|
|
6591
|
+
readonly description: "Page size.";
|
|
6592
|
+
}, {
|
|
6593
|
+
readonly name: "order";
|
|
6594
|
+
readonly type: "string";
|
|
6595
|
+
readonly enum: readonly ["asc", "desc"];
|
|
6596
|
+
readonly required: false;
|
|
6597
|
+
readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
|
|
6598
|
+
}];
|
|
6599
|
+
}, {
|
|
6600
|
+
readonly resource: "knowledge.vectorStores";
|
|
6601
|
+
readonly method: "create";
|
|
6602
|
+
readonly summary: "Create knowledge base";
|
|
6603
|
+
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Unlike OpenAI vector stores, each file is limited to 100000000 bytes and each account to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
|
|
6604
|
+
readonly http: "POST";
|
|
6605
|
+
readonly path: "/knowledge/v1/vector_stores";
|
|
6606
|
+
readonly streaming: "no";
|
|
6607
|
+
readonly pagination: false;
|
|
6608
|
+
readonly pathParams: readonly [];
|
|
6609
|
+
readonly query: readonly [];
|
|
6610
|
+
readonly body: {
|
|
6611
|
+
readonly required: true;
|
|
6612
|
+
readonly fields: readonly [{
|
|
6613
|
+
readonly name: "name";
|
|
6614
|
+
readonly type: "string";
|
|
6615
|
+
readonly required: false;
|
|
6616
|
+
readonly description: "Omitted name becomes an empty string; null is rejected.";
|
|
6617
|
+
}, {
|
|
6618
|
+
readonly name: "metadata";
|
|
6619
|
+
readonly type: "object";
|
|
6620
|
+
readonly required: false;
|
|
6621
|
+
readonly description: "User-defined string metadata for the store; omission or null creates an empty map.";
|
|
6622
|
+
}, {
|
|
6623
|
+
readonly name: "expires_after";
|
|
6624
|
+
readonly type: "object";
|
|
6625
|
+
readonly required: false;
|
|
6626
|
+
readonly description: "Expiry policy from last activity; omission or null disables automatic expiry.";
|
|
6627
|
+
}, {
|
|
6628
|
+
readonly name: "file_ids";
|
|
6629
|
+
readonly type: "array";
|
|
6630
|
+
readonly itemType: "string";
|
|
6631
|
+
readonly required: false;
|
|
6632
|
+
readonly description: "Existing File IDs to attach; the store allows up to 10,000 files.";
|
|
6633
|
+
}, {
|
|
6634
|
+
readonly name: "chunking_strategy";
|
|
6635
|
+
readonly type: "object";
|
|
6636
|
+
readonly required: false;
|
|
6637
|
+
readonly description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up.";
|
|
6638
|
+
}, {
|
|
6639
|
+
readonly name: "description";
|
|
6640
|
+
readonly type: "string";
|
|
6271
6641
|
readonly required: false;
|
|
6272
6642
|
readonly description: "Accepted but not saved or returned; its type is not validated.";
|
|
6273
6643
|
}, {
|
|
@@ -9462,7 +9832,7 @@ export declare const operations: readonly [{
|
|
|
9462
9832
|
readonly name: "message";
|
|
9463
9833
|
readonly type: "string";
|
|
9464
9834
|
readonly required: true;
|
|
9465
|
-
readonly description: "Problem description
|
|
9835
|
+
readonly description: "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string.";
|
|
9466
9836
|
}, {
|
|
9467
9837
|
readonly name: "contact_email";
|
|
9468
9838
|
readonly type: "string";
|
|
@@ -9697,7 +10067,7 @@ export declare const operations: readonly [{
|
|
|
9697
10067
|
readonly resource: "sandbox.sandboxes";
|
|
9698
10068
|
readonly method: "create";
|
|
9699
10069
|
readonly summary: "Create sandbox (v2)";
|
|
9700
|
-
readonly description: "
|
|
10070
|
+
readonly description: "Create a sandbox from the template. All system communication with the sandbox is secured.";
|
|
9701
10071
|
readonly http: "POST";
|
|
9702
10072
|
readonly path: "/sandbox/v1/sandboxes";
|
|
9703
10073
|
readonly streaming: "no";
|
|
@@ -9710,7 +10080,7 @@ export declare const operations: readonly [{
|
|
|
9710
10080
|
readonly name: "templateID";
|
|
9711
10081
|
readonly type: "string";
|
|
9712
10082
|
readonly required: true;
|
|
9713
|
-
readonly description: "
|
|
10083
|
+
readonly description: "Identifier of the required template";
|
|
9714
10084
|
}, {
|
|
9715
10085
|
readonly name: "timeout";
|
|
9716
10086
|
readonly type: "integer";
|
|
@@ -9824,7 +10194,7 @@ export declare const operations: readonly [{
|
|
|
9824
10194
|
readonly resource: "sandbox.sandboxes";
|
|
9825
10195
|
readonly method: "connect";
|
|
9826
10196
|
readonly summary: "Connect sandbox (v2)";
|
|
9827
|
-
readonly description: "
|
|
10197
|
+
readonly description: "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.";
|
|
9828
10198
|
readonly http: "POST";
|
|
9829
10199
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/connect";
|
|
9830
10200
|
readonly streaming: "no";
|
|
@@ -9945,7 +10315,7 @@ export declare const operations: readonly [{
|
|
|
9945
10315
|
readonly resource: "sandbox.sandboxes.metrics";
|
|
9946
10316
|
readonly method: "list";
|
|
9947
10317
|
readonly summary: "Sandbox metrics";
|
|
9948
|
-
readonly description: "Read CPU, memory and disk usage over
|
|
10318
|
+
readonly description: "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.";
|
|
9949
10319
|
readonly http: "GET";
|
|
9950
10320
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/metrics";
|
|
9951
10321
|
readonly streaming: "no";
|
|
@@ -10014,7 +10384,7 @@ export declare const operations: readonly [{
|
|
|
10014
10384
|
readonly resource: "sandbox.sandboxes";
|
|
10015
10385
|
readonly method: "pause";
|
|
10016
10386
|
readonly summary: "Pause sandbox";
|
|
10017
|
-
readonly description: "
|
|
10387
|
+
readonly description: "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.";
|
|
10018
10388
|
readonly http: "POST";
|
|
10019
10389
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/pause";
|
|
10020
10390
|
readonly streaming: "no";
|
|
@@ -10330,7 +10700,7 @@ export declare const operations: readonly [{
|
|
|
10330
10700
|
readonly resource: "sandbox.templates";
|
|
10331
10701
|
readonly method: "list";
|
|
10332
10702
|
readonly summary: "List templates (v2)";
|
|
10333
|
-
readonly description: "
|
|
10703
|
+
readonly description: "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.";
|
|
10334
10704
|
readonly http: "GET";
|
|
10335
10705
|
readonly path: "/sandbox/v1/templates";
|
|
10336
10706
|
readonly streaming: "no";
|
|
@@ -10805,6 +11175,1161 @@ export declare const operations: readonly [{
|
|
|
10805
11175
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10806
11176
|
}];
|
|
10807
11177
|
};
|
|
11178
|
+
}, {
|
|
11179
|
+
readonly resource: "ticket.activity";
|
|
11180
|
+
readonly method: "retrieve";
|
|
11181
|
+
readonly summary: "List activity";
|
|
11182
|
+
readonly description: "List activity within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11183
|
+
readonly http: "GET";
|
|
11184
|
+
readonly path: "/ticket/v1/activity";
|
|
11185
|
+
readonly streaming: "no";
|
|
11186
|
+
readonly pagination: false;
|
|
11187
|
+
readonly pathParams: readonly [];
|
|
11188
|
+
readonly query: readonly [{
|
|
11189
|
+
readonly name: "repository";
|
|
11190
|
+
readonly type: "string";
|
|
11191
|
+
readonly required: false;
|
|
11192
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11193
|
+
}, {
|
|
11194
|
+
readonly name: "page_size";
|
|
11195
|
+
readonly type: "integer";
|
|
11196
|
+
readonly required: false;
|
|
11197
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11198
|
+
}, {
|
|
11199
|
+
readonly name: "page_token";
|
|
11200
|
+
readonly type: "string";
|
|
11201
|
+
readonly required: false;
|
|
11202
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11203
|
+
}, {
|
|
11204
|
+
readonly name: "filter";
|
|
11205
|
+
readonly type: "string";
|
|
11206
|
+
readonly required: false;
|
|
11207
|
+
readonly description: "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service.";
|
|
11208
|
+
}];
|
|
11209
|
+
}, {
|
|
11210
|
+
readonly resource: "ticket.comments";
|
|
11211
|
+
readonly method: "delete";
|
|
11212
|
+
readonly summary: "Remove comments";
|
|
11213
|
+
readonly description: "Remove comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11214
|
+
readonly http: "DELETE";
|
|
11215
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11216
|
+
readonly streaming: "no";
|
|
11217
|
+
readonly pagination: false;
|
|
11218
|
+
readonly pathParams: readonly [{
|
|
11219
|
+
readonly name: "id";
|
|
11220
|
+
readonly sdkName: "id";
|
|
11221
|
+
}];
|
|
11222
|
+
readonly query: readonly [{
|
|
11223
|
+
readonly name: "repository";
|
|
11224
|
+
readonly type: "string";
|
|
11225
|
+
readonly required: false;
|
|
11226
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11227
|
+
}];
|
|
11228
|
+
}, {
|
|
11229
|
+
readonly resource: "ticket.comments";
|
|
11230
|
+
readonly method: "retrieve";
|
|
11231
|
+
readonly summary: "Read comments";
|
|
11232
|
+
readonly description: "Read comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11233
|
+
readonly http: "GET";
|
|
11234
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11235
|
+
readonly streaming: "no";
|
|
11236
|
+
readonly pagination: false;
|
|
11237
|
+
readonly pathParams: readonly [{
|
|
11238
|
+
readonly name: "id";
|
|
11239
|
+
readonly sdkName: "id";
|
|
11240
|
+
}];
|
|
11241
|
+
readonly query: readonly [{
|
|
11242
|
+
readonly name: "repository";
|
|
11243
|
+
readonly type: "string";
|
|
11244
|
+
readonly required: false;
|
|
11245
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11246
|
+
}];
|
|
11247
|
+
}, {
|
|
11248
|
+
readonly resource: "ticket.comments";
|
|
11249
|
+
readonly method: "update";
|
|
11250
|
+
readonly summary: "Update comments";
|
|
11251
|
+
readonly description: "Update comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11252
|
+
readonly http: "PATCH";
|
|
11253
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11254
|
+
readonly streaming: "no";
|
|
11255
|
+
readonly pagination: false;
|
|
11256
|
+
readonly pathParams: readonly [{
|
|
11257
|
+
readonly name: "id";
|
|
11258
|
+
readonly sdkName: "id";
|
|
11259
|
+
}];
|
|
11260
|
+
readonly query: readonly [{
|
|
11261
|
+
readonly name: "repository";
|
|
11262
|
+
readonly type: "string";
|
|
11263
|
+
readonly required: false;
|
|
11264
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11265
|
+
}];
|
|
11266
|
+
readonly body: {
|
|
11267
|
+
readonly required: true;
|
|
11268
|
+
readonly fields: readonly [{
|
|
11269
|
+
readonly name: "body";
|
|
11270
|
+
readonly type: "string";
|
|
11271
|
+
readonly required: true;
|
|
11272
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11273
|
+
}, {
|
|
11274
|
+
readonly name: "in_reply_to";
|
|
11275
|
+
readonly type: "string";
|
|
11276
|
+
readonly required: false;
|
|
11277
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11278
|
+
}];
|
|
11279
|
+
};
|
|
11280
|
+
}, {
|
|
11281
|
+
readonly resource: "ticket.comments.reactions";
|
|
11282
|
+
readonly method: "list";
|
|
11283
|
+
readonly summary: "List reactions";
|
|
11284
|
+
readonly description: "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11285
|
+
readonly http: "GET";
|
|
11286
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11287
|
+
readonly streaming: "no";
|
|
11288
|
+
readonly pagination: false;
|
|
11289
|
+
readonly pathParams: readonly [{
|
|
11290
|
+
readonly name: "id";
|
|
11291
|
+
readonly sdkName: "id";
|
|
11292
|
+
}];
|
|
11293
|
+
readonly query: readonly [{
|
|
11294
|
+
readonly name: "repository";
|
|
11295
|
+
readonly type: "string";
|
|
11296
|
+
readonly required: false;
|
|
11297
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11298
|
+
}, {
|
|
11299
|
+
readonly name: "page_size";
|
|
11300
|
+
readonly type: "integer";
|
|
11301
|
+
readonly required: false;
|
|
11302
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11303
|
+
}, {
|
|
11304
|
+
readonly name: "page_token";
|
|
11305
|
+
readonly type: "string";
|
|
11306
|
+
readonly required: false;
|
|
11307
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11308
|
+
}];
|
|
11309
|
+
}, {
|
|
11310
|
+
readonly resource: "ticket.comments.reactions";
|
|
11311
|
+
readonly method: "create";
|
|
11312
|
+
readonly summary: "Create or add reactions";
|
|
11313
|
+
readonly description: "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11314
|
+
readonly http: "POST";
|
|
11315
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11316
|
+
readonly streaming: "no";
|
|
11317
|
+
readonly pagination: false;
|
|
11318
|
+
readonly pathParams: readonly [{
|
|
11319
|
+
readonly name: "id";
|
|
11320
|
+
readonly sdkName: "id";
|
|
11321
|
+
}];
|
|
11322
|
+
readonly query: readonly [{
|
|
11323
|
+
readonly name: "repository";
|
|
11324
|
+
readonly type: "string";
|
|
11325
|
+
readonly required: false;
|
|
11326
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11327
|
+
}];
|
|
11328
|
+
readonly body: {
|
|
11329
|
+
readonly required: true;
|
|
11330
|
+
readonly fields: readonly [{
|
|
11331
|
+
readonly name: "content";
|
|
11332
|
+
readonly type: "string";
|
|
11333
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11334
|
+
readonly required: true;
|
|
11335
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11336
|
+
}];
|
|
11337
|
+
};
|
|
11338
|
+
}, {
|
|
11339
|
+
readonly resource: "ticket.comments.reactions";
|
|
11340
|
+
readonly method: "delete";
|
|
11341
|
+
readonly summary: "Remove reactions";
|
|
11342
|
+
readonly description: "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11343
|
+
readonly http: "DELETE";
|
|
11344
|
+
readonly path: "/ticket/v1/comments/{id}/reactions/{content}";
|
|
11345
|
+
readonly streaming: "no";
|
|
11346
|
+
readonly pagination: false;
|
|
11347
|
+
readonly pathParams: readonly [{
|
|
11348
|
+
readonly name: "id";
|
|
11349
|
+
readonly sdkName: "id";
|
|
11350
|
+
}, {
|
|
11351
|
+
readonly name: "content";
|
|
11352
|
+
readonly sdkName: "content";
|
|
11353
|
+
}];
|
|
11354
|
+
readonly query: readonly [{
|
|
11355
|
+
readonly name: "repository";
|
|
11356
|
+
readonly type: "string";
|
|
11357
|
+
readonly required: false;
|
|
11358
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11359
|
+
}];
|
|
11360
|
+
}, {
|
|
11361
|
+
readonly resource: "ticket.labels";
|
|
11362
|
+
readonly method: "list";
|
|
11363
|
+
readonly summary: "List labels";
|
|
11364
|
+
readonly description: "List labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11365
|
+
readonly http: "GET";
|
|
11366
|
+
readonly path: "/ticket/v1/labels";
|
|
11367
|
+
readonly streaming: "no";
|
|
11368
|
+
readonly pagination: false;
|
|
11369
|
+
readonly pathParams: readonly [];
|
|
11370
|
+
readonly query: readonly [{
|
|
11371
|
+
readonly name: "repository";
|
|
11372
|
+
readonly type: "string";
|
|
11373
|
+
readonly required: false;
|
|
11374
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11375
|
+
}, {
|
|
11376
|
+
readonly name: "page_size";
|
|
11377
|
+
readonly type: "integer";
|
|
11378
|
+
readonly required: false;
|
|
11379
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11380
|
+
}, {
|
|
11381
|
+
readonly name: "page_token";
|
|
11382
|
+
readonly type: "string";
|
|
11383
|
+
readonly required: false;
|
|
11384
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11385
|
+
}];
|
|
11386
|
+
}, {
|
|
11387
|
+
readonly resource: "ticket.labels";
|
|
11388
|
+
readonly method: "create";
|
|
11389
|
+
readonly summary: "Create or add labels";
|
|
11390
|
+
readonly description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11391
|
+
readonly http: "POST";
|
|
11392
|
+
readonly path: "/ticket/v1/labels";
|
|
11393
|
+
readonly streaming: "no";
|
|
11394
|
+
readonly pagination: false;
|
|
11395
|
+
readonly pathParams: readonly [];
|
|
11396
|
+
readonly query: readonly [{
|
|
11397
|
+
readonly name: "repository";
|
|
11398
|
+
readonly type: "string";
|
|
11399
|
+
readonly required: false;
|
|
11400
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11401
|
+
}];
|
|
11402
|
+
readonly body: {
|
|
11403
|
+
readonly required: true;
|
|
11404
|
+
readonly fields: readonly [{
|
|
11405
|
+
readonly name: "name";
|
|
11406
|
+
readonly type: "string";
|
|
11407
|
+
readonly required: true;
|
|
11408
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11409
|
+
}, {
|
|
11410
|
+
readonly name: "color";
|
|
11411
|
+
readonly type: "string";
|
|
11412
|
+
readonly required: true;
|
|
11413
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11414
|
+
}, {
|
|
11415
|
+
readonly name: "description";
|
|
11416
|
+
readonly type: "string";
|
|
11417
|
+
readonly required: false;
|
|
11418
|
+
readonly description: "Label's purpose.";
|
|
11419
|
+
}];
|
|
11420
|
+
};
|
|
11421
|
+
}, {
|
|
11422
|
+
readonly resource: "ticket.labels";
|
|
11423
|
+
readonly method: "delete";
|
|
11424
|
+
readonly summary: "Remove labels";
|
|
11425
|
+
readonly description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11426
|
+
readonly http: "DELETE";
|
|
11427
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11428
|
+
readonly streaming: "no";
|
|
11429
|
+
readonly pagination: false;
|
|
11430
|
+
readonly pathParams: readonly [{
|
|
11431
|
+
readonly name: "name";
|
|
11432
|
+
readonly sdkName: "name";
|
|
11433
|
+
}];
|
|
11434
|
+
readonly query: readonly [{
|
|
11435
|
+
readonly name: "repository";
|
|
11436
|
+
readonly type: "string";
|
|
11437
|
+
readonly required: false;
|
|
11438
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11439
|
+
}];
|
|
11440
|
+
}, {
|
|
11441
|
+
readonly resource: "ticket.labels";
|
|
11442
|
+
readonly method: "update";
|
|
11443
|
+
readonly summary: "Update labels";
|
|
11444
|
+
readonly description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11445
|
+
readonly http: "PATCH";
|
|
11446
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11447
|
+
readonly streaming: "no";
|
|
11448
|
+
readonly pagination: false;
|
|
11449
|
+
readonly pathParams: readonly [{
|
|
11450
|
+
readonly name: "name";
|
|
11451
|
+
readonly sdkName: "name";
|
|
11452
|
+
}];
|
|
11453
|
+
readonly query: readonly [{
|
|
11454
|
+
readonly name: "repository";
|
|
11455
|
+
readonly type: "string";
|
|
11456
|
+
readonly required: false;
|
|
11457
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11458
|
+
}];
|
|
11459
|
+
readonly body: {
|
|
11460
|
+
readonly required: true;
|
|
11461
|
+
readonly fields: readonly [{
|
|
11462
|
+
readonly name: "color";
|
|
11463
|
+
readonly type: "string";
|
|
11464
|
+
readonly required: false;
|
|
11465
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11466
|
+
}, {
|
|
11467
|
+
readonly name: "description";
|
|
11468
|
+
readonly type: "string";
|
|
11469
|
+
readonly required: false;
|
|
11470
|
+
readonly description: "Label's purpose.";
|
|
11471
|
+
}, {
|
|
11472
|
+
readonly name: "new_name";
|
|
11473
|
+
readonly type: "string";
|
|
11474
|
+
readonly required: false;
|
|
11475
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11476
|
+
}];
|
|
11477
|
+
};
|
|
11478
|
+
}, {
|
|
11479
|
+
readonly resource: "ticket.milestones";
|
|
11480
|
+
readonly method: "list";
|
|
11481
|
+
readonly summary: "List milestones";
|
|
11482
|
+
readonly description: "List milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11483
|
+
readonly http: "GET";
|
|
11484
|
+
readonly path: "/ticket/v1/milestones";
|
|
11485
|
+
readonly streaming: "no";
|
|
11486
|
+
readonly pagination: false;
|
|
11487
|
+
readonly pathParams: readonly [];
|
|
11488
|
+
readonly query: readonly [{
|
|
11489
|
+
readonly name: "repository";
|
|
11490
|
+
readonly type: "string";
|
|
11491
|
+
readonly required: false;
|
|
11492
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11493
|
+
}, {
|
|
11494
|
+
readonly name: "page_size";
|
|
11495
|
+
readonly type: "integer";
|
|
11496
|
+
readonly required: false;
|
|
11497
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11498
|
+
}, {
|
|
11499
|
+
readonly name: "page_token";
|
|
11500
|
+
readonly type: "string";
|
|
11501
|
+
readonly required: false;
|
|
11502
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11503
|
+
}];
|
|
11504
|
+
}, {
|
|
11505
|
+
readonly resource: "ticket.milestones";
|
|
11506
|
+
readonly method: "create";
|
|
11507
|
+
readonly summary: "Create or add milestones";
|
|
11508
|
+
readonly description: "Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11509
|
+
readonly http: "POST";
|
|
11510
|
+
readonly path: "/ticket/v1/milestones";
|
|
11511
|
+
readonly streaming: "no";
|
|
11512
|
+
readonly pagination: false;
|
|
11513
|
+
readonly pathParams: readonly [];
|
|
11514
|
+
readonly query: readonly [{
|
|
11515
|
+
readonly name: "repository";
|
|
11516
|
+
readonly type: "string";
|
|
11517
|
+
readonly required: false;
|
|
11518
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11519
|
+
}];
|
|
11520
|
+
readonly body: {
|
|
11521
|
+
readonly required: true;
|
|
11522
|
+
readonly fields: readonly [{
|
|
11523
|
+
readonly name: "title";
|
|
11524
|
+
readonly type: "string";
|
|
11525
|
+
readonly required: true;
|
|
11526
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11527
|
+
}, {
|
|
11528
|
+
readonly name: "description";
|
|
11529
|
+
readonly type: "string";
|
|
11530
|
+
readonly required: false;
|
|
11531
|
+
readonly description: "Milestone description.";
|
|
11532
|
+
}, {
|
|
11533
|
+
readonly name: "due_on";
|
|
11534
|
+
readonly type: "string";
|
|
11535
|
+
readonly required: false;
|
|
11536
|
+
readonly description: "Due date, or null if unset.";
|
|
11537
|
+
}, {
|
|
11538
|
+
readonly name: "state";
|
|
11539
|
+
readonly type: "string";
|
|
11540
|
+
readonly enum: readonly ["open", "closed"];
|
|
11541
|
+
readonly required: false;
|
|
11542
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11543
|
+
}];
|
|
11544
|
+
};
|
|
11545
|
+
}, {
|
|
11546
|
+
readonly resource: "ticket.milestones";
|
|
11547
|
+
readonly method: "delete";
|
|
11548
|
+
readonly summary: "Remove milestones";
|
|
11549
|
+
readonly description: "Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11550
|
+
readonly http: "DELETE";
|
|
11551
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11552
|
+
readonly streaming: "no";
|
|
11553
|
+
readonly pagination: false;
|
|
11554
|
+
readonly pathParams: readonly [{
|
|
11555
|
+
readonly name: "number";
|
|
11556
|
+
readonly sdkName: "number";
|
|
11557
|
+
}];
|
|
11558
|
+
readonly query: readonly [{
|
|
11559
|
+
readonly name: "repository";
|
|
11560
|
+
readonly type: "string";
|
|
11561
|
+
readonly required: false;
|
|
11562
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11563
|
+
}];
|
|
11564
|
+
}, {
|
|
11565
|
+
readonly resource: "ticket.milestones";
|
|
11566
|
+
readonly method: "retrieve";
|
|
11567
|
+
readonly summary: "Read milestones";
|
|
11568
|
+
readonly description: "Read milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11569
|
+
readonly http: "GET";
|
|
11570
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11571
|
+
readonly streaming: "no";
|
|
11572
|
+
readonly pagination: false;
|
|
11573
|
+
readonly pathParams: readonly [{
|
|
11574
|
+
readonly name: "number";
|
|
11575
|
+
readonly sdkName: "number";
|
|
11576
|
+
}];
|
|
11577
|
+
readonly query: readonly [{
|
|
11578
|
+
readonly name: "repository";
|
|
11579
|
+
readonly type: "string";
|
|
11580
|
+
readonly required: false;
|
|
11581
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11582
|
+
}];
|
|
11583
|
+
}, {
|
|
11584
|
+
readonly resource: "ticket.milestones";
|
|
11585
|
+
readonly method: "update";
|
|
11586
|
+
readonly summary: "Update milestones";
|
|
11587
|
+
readonly description: "Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
11588
|
+
readonly http: "PATCH";
|
|
11589
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11590
|
+
readonly streaming: "no";
|
|
11591
|
+
readonly pagination: false;
|
|
11592
|
+
readonly pathParams: readonly [{
|
|
11593
|
+
readonly name: "number";
|
|
11594
|
+
readonly sdkName: "number";
|
|
11595
|
+
}];
|
|
11596
|
+
readonly query: readonly [{
|
|
11597
|
+
readonly name: "repository";
|
|
11598
|
+
readonly type: "string";
|
|
11599
|
+
readonly required: false;
|
|
11600
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11601
|
+
}];
|
|
11602
|
+
readonly body: {
|
|
11603
|
+
readonly required: true;
|
|
11604
|
+
readonly fields: readonly [{
|
|
11605
|
+
readonly name: "title";
|
|
11606
|
+
readonly type: "string";
|
|
11607
|
+
readonly required: false;
|
|
11608
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11609
|
+
}, {
|
|
11610
|
+
readonly name: "description";
|
|
11611
|
+
readonly type: "string";
|
|
11612
|
+
readonly required: false;
|
|
11613
|
+
readonly description: "Milestone description.";
|
|
11614
|
+
}, {
|
|
11615
|
+
readonly name: "due_on";
|
|
11616
|
+
readonly type: "string";
|
|
11617
|
+
readonly required: false;
|
|
11618
|
+
readonly description: "Due date, or null if unset.";
|
|
11619
|
+
}, {
|
|
11620
|
+
readonly name: "state";
|
|
11621
|
+
readonly type: "string";
|
|
11622
|
+
readonly enum: readonly ["open", "closed"];
|
|
11623
|
+
readonly required: false;
|
|
11624
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11625
|
+
}];
|
|
11626
|
+
};
|
|
11627
|
+
}, {
|
|
11628
|
+
readonly resource: "ticket.repositories";
|
|
11629
|
+
readonly method: "list";
|
|
11630
|
+
readonly summary: "List repositories";
|
|
11631
|
+
readonly description: "List repositories within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11632
|
+
readonly http: "GET";
|
|
11633
|
+
readonly path: "/ticket/v1/repositories";
|
|
11634
|
+
readonly streaming: "no";
|
|
11635
|
+
readonly pagination: false;
|
|
11636
|
+
readonly pathParams: readonly [];
|
|
11637
|
+
readonly query: readonly [{
|
|
11638
|
+
readonly name: "page_size";
|
|
11639
|
+
readonly type: "integer";
|
|
11640
|
+
readonly required: false;
|
|
11641
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11642
|
+
}, {
|
|
11643
|
+
readonly name: "page_token";
|
|
11644
|
+
readonly type: "string";
|
|
11645
|
+
readonly required: false;
|
|
11646
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11647
|
+
}];
|
|
11648
|
+
}, {
|
|
11649
|
+
readonly resource: "ticket.tickets";
|
|
11650
|
+
readonly method: "list";
|
|
11651
|
+
readonly summary: "List tickets";
|
|
11652
|
+
readonly description: "List tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11653
|
+
readonly http: "GET";
|
|
11654
|
+
readonly path: "/ticket/v1/tickets";
|
|
11655
|
+
readonly streaming: "no";
|
|
11656
|
+
readonly pagination: false;
|
|
11657
|
+
readonly pathParams: readonly [];
|
|
11658
|
+
readonly query: readonly [{
|
|
11659
|
+
readonly name: "repository";
|
|
11660
|
+
readonly type: "string";
|
|
11661
|
+
readonly required: false;
|
|
11662
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11663
|
+
}, {
|
|
11664
|
+
readonly name: "page_size";
|
|
11665
|
+
readonly type: "integer";
|
|
11666
|
+
readonly required: false;
|
|
11667
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11668
|
+
}, {
|
|
11669
|
+
readonly name: "page_token";
|
|
11670
|
+
readonly type: "string";
|
|
11671
|
+
readonly required: false;
|
|
11672
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11673
|
+
}, {
|
|
11674
|
+
readonly name: "filter";
|
|
11675
|
+
readonly type: "string";
|
|
11676
|
+
readonly required: false;
|
|
11677
|
+
readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
|
|
11678
|
+
}];
|
|
11679
|
+
}, {
|
|
11680
|
+
readonly resource: "ticket.tickets";
|
|
11681
|
+
readonly method: "create";
|
|
11682
|
+
readonly summary: "Create or add tickets";
|
|
11683
|
+
readonly description: "Create or add tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11684
|
+
readonly http: "POST";
|
|
11685
|
+
readonly path: "/ticket/v1/tickets";
|
|
11686
|
+
readonly streaming: "no";
|
|
11687
|
+
readonly pagination: false;
|
|
11688
|
+
readonly pathParams: readonly [];
|
|
11689
|
+
readonly query: readonly [{
|
|
11690
|
+
readonly name: "repository";
|
|
11691
|
+
readonly type: "string";
|
|
11692
|
+
readonly required: false;
|
|
11693
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11694
|
+
}];
|
|
11695
|
+
readonly body: {
|
|
11696
|
+
readonly required: true;
|
|
11697
|
+
readonly fields: readonly [{
|
|
11698
|
+
readonly name: "title";
|
|
11699
|
+
readonly type: "string";
|
|
11700
|
+
readonly required: true;
|
|
11701
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11702
|
+
}, {
|
|
11703
|
+
readonly name: "body";
|
|
11704
|
+
readonly type: "string";
|
|
11705
|
+
readonly required: false;
|
|
11706
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11707
|
+
}, {
|
|
11708
|
+
readonly name: "type";
|
|
11709
|
+
readonly type: "string";
|
|
11710
|
+
readonly required: false;
|
|
11711
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11712
|
+
}, {
|
|
11713
|
+
readonly name: "labels";
|
|
11714
|
+
readonly type: "array";
|
|
11715
|
+
readonly itemType: "string";
|
|
11716
|
+
readonly required: false;
|
|
11717
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11718
|
+
}, {
|
|
11719
|
+
readonly name: "assignees";
|
|
11720
|
+
readonly type: "array";
|
|
11721
|
+
readonly itemType: "string";
|
|
11722
|
+
readonly required: false;
|
|
11723
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11724
|
+
}, {
|
|
11725
|
+
readonly name: "milestone";
|
|
11726
|
+
readonly type: "integer";
|
|
11727
|
+
readonly required: false;
|
|
11728
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11729
|
+
}, {
|
|
11730
|
+
readonly name: "parent";
|
|
11731
|
+
readonly type: "integer";
|
|
11732
|
+
readonly required: false;
|
|
11733
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11734
|
+
}];
|
|
11735
|
+
};
|
|
11736
|
+
}, {
|
|
11737
|
+
readonly resource: "ticket.tickets";
|
|
11738
|
+
readonly method: "retrieve";
|
|
11739
|
+
readonly summary: "Read tickets";
|
|
11740
|
+
readonly description: "Read tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11741
|
+
readonly http: "GET";
|
|
11742
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11743
|
+
readonly streaming: "no";
|
|
11744
|
+
readonly pagination: false;
|
|
11745
|
+
readonly pathParams: readonly [{
|
|
11746
|
+
readonly name: "number";
|
|
11747
|
+
readonly sdkName: "number";
|
|
11748
|
+
}];
|
|
11749
|
+
readonly query: readonly [{
|
|
11750
|
+
readonly name: "repository";
|
|
11751
|
+
readonly type: "string";
|
|
11752
|
+
readonly required: false;
|
|
11753
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11754
|
+
}];
|
|
11755
|
+
}, {
|
|
11756
|
+
readonly resource: "ticket.tickets";
|
|
11757
|
+
readonly method: "update";
|
|
11758
|
+
readonly summary: "Update tickets";
|
|
11759
|
+
readonly description: "Update tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11760
|
+
readonly http: "PATCH";
|
|
11761
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11762
|
+
readonly streaming: "no";
|
|
11763
|
+
readonly pagination: false;
|
|
11764
|
+
readonly pathParams: readonly [{
|
|
11765
|
+
readonly name: "number";
|
|
11766
|
+
readonly sdkName: "number";
|
|
11767
|
+
}];
|
|
11768
|
+
readonly query: readonly [{
|
|
11769
|
+
readonly name: "repository";
|
|
11770
|
+
readonly type: "string";
|
|
11771
|
+
readonly required: false;
|
|
11772
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11773
|
+
}];
|
|
11774
|
+
readonly body: {
|
|
11775
|
+
readonly required: true;
|
|
11776
|
+
readonly fields: readonly [{
|
|
11777
|
+
readonly name: "title";
|
|
11778
|
+
readonly type: "string";
|
|
11779
|
+
readonly required: false;
|
|
11780
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11781
|
+
}, {
|
|
11782
|
+
readonly name: "body";
|
|
11783
|
+
readonly type: "string";
|
|
11784
|
+
readonly required: false;
|
|
11785
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11786
|
+
}, {
|
|
11787
|
+
readonly name: "type";
|
|
11788
|
+
readonly type: "string";
|
|
11789
|
+
readonly required: false;
|
|
11790
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11791
|
+
}, {
|
|
11792
|
+
readonly name: "labels";
|
|
11793
|
+
readonly type: "array";
|
|
11794
|
+
readonly itemType: "string";
|
|
11795
|
+
readonly required: false;
|
|
11796
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11797
|
+
}, {
|
|
11798
|
+
readonly name: "assignees";
|
|
11799
|
+
readonly type: "array";
|
|
11800
|
+
readonly itemType: "string";
|
|
11801
|
+
readonly required: false;
|
|
11802
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11803
|
+
}, {
|
|
11804
|
+
readonly name: "milestone";
|
|
11805
|
+
readonly type: "integer";
|
|
11806
|
+
readonly required: false;
|
|
11807
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11808
|
+
}, {
|
|
11809
|
+
readonly name: "state";
|
|
11810
|
+
readonly type: "string";
|
|
11811
|
+
readonly enum: readonly ["open", "closed"];
|
|
11812
|
+
readonly required: false;
|
|
11813
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11814
|
+
}, {
|
|
11815
|
+
readonly name: "state_reason";
|
|
11816
|
+
readonly type: "string";
|
|
11817
|
+
readonly enum: readonly ["completed", "not_planned", "duplicate"];
|
|
11818
|
+
readonly required: false;
|
|
11819
|
+
readonly description: "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate.";
|
|
11820
|
+
}, {
|
|
11821
|
+
readonly name: "duplicate_of";
|
|
11822
|
+
readonly type: "integer";
|
|
11823
|
+
readonly required: false;
|
|
11824
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11825
|
+
}];
|
|
11826
|
+
};
|
|
11827
|
+
}, {
|
|
11828
|
+
readonly resource: "ticket.tickets.comments";
|
|
11829
|
+
readonly method: "list";
|
|
11830
|
+
readonly summary: "List comments";
|
|
11831
|
+
readonly description: "List comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11832
|
+
readonly http: "GET";
|
|
11833
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11834
|
+
readonly streaming: "no";
|
|
11835
|
+
readonly pagination: false;
|
|
11836
|
+
readonly pathParams: readonly [{
|
|
11837
|
+
readonly name: "number";
|
|
11838
|
+
readonly sdkName: "number";
|
|
11839
|
+
}];
|
|
11840
|
+
readonly query: readonly [{
|
|
11841
|
+
readonly name: "repository";
|
|
11842
|
+
readonly type: "string";
|
|
11843
|
+
readonly required: false;
|
|
11844
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11845
|
+
}, {
|
|
11846
|
+
readonly name: "page_size";
|
|
11847
|
+
readonly type: "integer";
|
|
11848
|
+
readonly required: false;
|
|
11849
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11850
|
+
}, {
|
|
11851
|
+
readonly name: "page_token";
|
|
11852
|
+
readonly type: "string";
|
|
11853
|
+
readonly required: false;
|
|
11854
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11855
|
+
}];
|
|
11856
|
+
}, {
|
|
11857
|
+
readonly resource: "ticket.tickets.comments";
|
|
11858
|
+
readonly method: "create";
|
|
11859
|
+
readonly summary: "Create or add comments";
|
|
11860
|
+
readonly description: "Create or add comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11861
|
+
readonly http: "POST";
|
|
11862
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11863
|
+
readonly streaming: "no";
|
|
11864
|
+
readonly pagination: false;
|
|
11865
|
+
readonly pathParams: readonly [{
|
|
11866
|
+
readonly name: "number";
|
|
11867
|
+
readonly sdkName: "number";
|
|
11868
|
+
}];
|
|
11869
|
+
readonly query: readonly [{
|
|
11870
|
+
readonly name: "repository";
|
|
11871
|
+
readonly type: "string";
|
|
11872
|
+
readonly required: false;
|
|
11873
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11874
|
+
}];
|
|
11875
|
+
readonly body: {
|
|
11876
|
+
readonly required: true;
|
|
11877
|
+
readonly fields: readonly [{
|
|
11878
|
+
readonly name: "body";
|
|
11879
|
+
readonly type: "string";
|
|
11880
|
+
readonly required: true;
|
|
11881
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11882
|
+
}, {
|
|
11883
|
+
readonly name: "in_reply_to";
|
|
11884
|
+
readonly type: "string";
|
|
11885
|
+
readonly required: false;
|
|
11886
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11887
|
+
}];
|
|
11888
|
+
};
|
|
11889
|
+
}, {
|
|
11890
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11891
|
+
readonly method: "retrieveBlockedBy";
|
|
11892
|
+
readonly summary: "List blocked by";
|
|
11893
|
+
readonly description: "List blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11894
|
+
readonly http: "GET";
|
|
11895
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11896
|
+
readonly streaming: "no";
|
|
11897
|
+
readonly pagination: false;
|
|
11898
|
+
readonly pathParams: readonly [{
|
|
11899
|
+
readonly name: "number";
|
|
11900
|
+
readonly sdkName: "number";
|
|
11901
|
+
}];
|
|
11902
|
+
readonly query: readonly [{
|
|
11903
|
+
readonly name: "repository";
|
|
11904
|
+
readonly type: "string";
|
|
11905
|
+
readonly required: false;
|
|
11906
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11907
|
+
}, {
|
|
11908
|
+
readonly name: "page_size";
|
|
11909
|
+
readonly type: "integer";
|
|
11910
|
+
readonly required: false;
|
|
11911
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11912
|
+
}, {
|
|
11913
|
+
readonly name: "page_token";
|
|
11914
|
+
readonly type: "string";
|
|
11915
|
+
readonly required: false;
|
|
11916
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11917
|
+
}];
|
|
11918
|
+
}, {
|
|
11919
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11920
|
+
readonly method: "create";
|
|
11921
|
+
readonly summary: "Create or add blocked by";
|
|
11922
|
+
readonly description: "Create or add blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11923
|
+
readonly http: "POST";
|
|
11924
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11925
|
+
readonly streaming: "no";
|
|
11926
|
+
readonly pagination: false;
|
|
11927
|
+
readonly pathParams: readonly [{
|
|
11928
|
+
readonly name: "number";
|
|
11929
|
+
readonly sdkName: "number";
|
|
11930
|
+
}];
|
|
11931
|
+
readonly query: readonly [{
|
|
11932
|
+
readonly name: "repository";
|
|
11933
|
+
readonly type: "string";
|
|
11934
|
+
readonly required: false;
|
|
11935
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11936
|
+
}];
|
|
11937
|
+
readonly body: {
|
|
11938
|
+
readonly required: true;
|
|
11939
|
+
readonly fields: readonly [{
|
|
11940
|
+
readonly name: "blocked_by";
|
|
11941
|
+
readonly type: "integer";
|
|
11942
|
+
readonly required: true;
|
|
11943
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11944
|
+
}];
|
|
11945
|
+
};
|
|
11946
|
+
}, {
|
|
11947
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11948
|
+
readonly method: "delete";
|
|
11949
|
+
readonly summary: "Remove blocked by";
|
|
11950
|
+
readonly description: "Remove blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
11951
|
+
readonly http: "DELETE";
|
|
11952
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}";
|
|
11953
|
+
readonly streaming: "no";
|
|
11954
|
+
readonly pagination: false;
|
|
11955
|
+
readonly pathParams: readonly [{
|
|
11956
|
+
readonly name: "number";
|
|
11957
|
+
readonly sdkName: "number";
|
|
11958
|
+
}, {
|
|
11959
|
+
readonly name: "n";
|
|
11960
|
+
readonly sdkName: "n";
|
|
11961
|
+
}];
|
|
11962
|
+
readonly query: readonly [{
|
|
11963
|
+
readonly name: "repository";
|
|
11964
|
+
readonly type: "string";
|
|
11965
|
+
readonly required: false;
|
|
11966
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11967
|
+
}];
|
|
11968
|
+
}, {
|
|
11969
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11970
|
+
readonly method: "retrieveBlocking";
|
|
11971
|
+
readonly summary: "List blocking";
|
|
11972
|
+
readonly description: "List blocking within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
11973
|
+
readonly http: "GET";
|
|
11974
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocking";
|
|
11975
|
+
readonly streaming: "no";
|
|
11976
|
+
readonly pagination: false;
|
|
11977
|
+
readonly pathParams: readonly [{
|
|
11978
|
+
readonly name: "number";
|
|
11979
|
+
readonly sdkName: "number";
|
|
11980
|
+
}];
|
|
11981
|
+
readonly query: readonly [{
|
|
11982
|
+
readonly name: "repository";
|
|
11983
|
+
readonly type: "string";
|
|
11984
|
+
readonly required: false;
|
|
11985
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11986
|
+
}, {
|
|
11987
|
+
readonly name: "page_size";
|
|
11988
|
+
readonly type: "integer";
|
|
11989
|
+
readonly required: false;
|
|
11990
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11991
|
+
}, {
|
|
11992
|
+
readonly name: "page_token";
|
|
11993
|
+
readonly type: "string";
|
|
11994
|
+
readonly required: false;
|
|
11995
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11996
|
+
}];
|
|
11997
|
+
}, {
|
|
11998
|
+
readonly resource: "ticket.tickets.events";
|
|
11999
|
+
readonly method: "list";
|
|
12000
|
+
readonly summary: "List events";
|
|
12001
|
+
readonly description: "List events within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
12002
|
+
readonly http: "GET";
|
|
12003
|
+
readonly path: "/ticket/v1/tickets/{number}/events";
|
|
12004
|
+
readonly streaming: "no";
|
|
12005
|
+
readonly pagination: false;
|
|
12006
|
+
readonly pathParams: readonly [{
|
|
12007
|
+
readonly name: "number";
|
|
12008
|
+
readonly sdkName: "number";
|
|
12009
|
+
}];
|
|
12010
|
+
readonly query: readonly [{
|
|
12011
|
+
readonly name: "repository";
|
|
12012
|
+
readonly type: "string";
|
|
12013
|
+
readonly required: false;
|
|
12014
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12015
|
+
}, {
|
|
12016
|
+
readonly name: "page_size";
|
|
12017
|
+
readonly type: "integer";
|
|
12018
|
+
readonly required: false;
|
|
12019
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12020
|
+
}, {
|
|
12021
|
+
readonly name: "page_token";
|
|
12022
|
+
readonly type: "string";
|
|
12023
|
+
readonly required: false;
|
|
12024
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12025
|
+
}];
|
|
12026
|
+
}, {
|
|
12027
|
+
readonly resource: "ticket.tickets";
|
|
12028
|
+
readonly method: "deleteLock";
|
|
12029
|
+
readonly summary: "Remove lock";
|
|
12030
|
+
readonly description: "Remove lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
12031
|
+
readonly http: "DELETE";
|
|
12032
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12033
|
+
readonly streaming: "no";
|
|
12034
|
+
readonly pagination: false;
|
|
12035
|
+
readonly pathParams: readonly [{
|
|
12036
|
+
readonly name: "number";
|
|
12037
|
+
readonly sdkName: "number";
|
|
12038
|
+
}];
|
|
12039
|
+
readonly query: readonly [{
|
|
12040
|
+
readonly name: "repository";
|
|
12041
|
+
readonly type: "string";
|
|
12042
|
+
readonly required: false;
|
|
12043
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12044
|
+
}];
|
|
12045
|
+
}, {
|
|
12046
|
+
readonly resource: "ticket.tickets";
|
|
12047
|
+
readonly method: "updateLock";
|
|
12048
|
+
readonly summary: "Update lock";
|
|
12049
|
+
readonly description: "Update lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.";
|
|
12050
|
+
readonly http: "PUT";
|
|
12051
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12052
|
+
readonly streaming: "no";
|
|
12053
|
+
readonly pagination: false;
|
|
12054
|
+
readonly pathParams: readonly [{
|
|
12055
|
+
readonly name: "number";
|
|
12056
|
+
readonly sdkName: "number";
|
|
12057
|
+
}];
|
|
12058
|
+
readonly query: readonly [{
|
|
12059
|
+
readonly name: "repository";
|
|
12060
|
+
readonly type: "string";
|
|
12061
|
+
readonly required: false;
|
|
12062
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12063
|
+
}];
|
|
12064
|
+
readonly body: {
|
|
12065
|
+
readonly required: false;
|
|
12066
|
+
readonly fields: readonly [{
|
|
12067
|
+
readonly name: "lock_reason";
|
|
12068
|
+
readonly type: "string";
|
|
12069
|
+
readonly enum: readonly ["off-topic", "too heated", "resolved", "spam"];
|
|
12070
|
+
readonly required: false;
|
|
12071
|
+
readonly description: "Reason for locking: off-topic, too heated, resolved, or spam.";
|
|
12072
|
+
}];
|
|
12073
|
+
};
|
|
12074
|
+
}, {
|
|
12075
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12076
|
+
readonly method: "list";
|
|
12077
|
+
readonly summary: "List reactions";
|
|
12078
|
+
readonly description: "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
12079
|
+
readonly http: "GET";
|
|
12080
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12081
|
+
readonly streaming: "no";
|
|
12082
|
+
readonly pagination: false;
|
|
12083
|
+
readonly pathParams: readonly [{
|
|
12084
|
+
readonly name: "number";
|
|
12085
|
+
readonly sdkName: "number";
|
|
12086
|
+
}];
|
|
12087
|
+
readonly query: readonly [{
|
|
12088
|
+
readonly name: "repository";
|
|
12089
|
+
readonly type: "string";
|
|
12090
|
+
readonly required: false;
|
|
12091
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12092
|
+
}, {
|
|
12093
|
+
readonly name: "page_size";
|
|
12094
|
+
readonly type: "integer";
|
|
12095
|
+
readonly required: false;
|
|
12096
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12097
|
+
}, {
|
|
12098
|
+
readonly name: "page_token";
|
|
12099
|
+
readonly type: "string";
|
|
12100
|
+
readonly required: false;
|
|
12101
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12102
|
+
}];
|
|
12103
|
+
}, {
|
|
12104
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12105
|
+
readonly method: "create";
|
|
12106
|
+
readonly summary: "Create or add reactions";
|
|
12107
|
+
readonly description: "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12108
|
+
readonly http: "POST";
|
|
12109
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12110
|
+
readonly streaming: "no";
|
|
12111
|
+
readonly pagination: false;
|
|
12112
|
+
readonly pathParams: readonly [{
|
|
12113
|
+
readonly name: "number";
|
|
12114
|
+
readonly sdkName: "number";
|
|
12115
|
+
}];
|
|
12116
|
+
readonly query: readonly [{
|
|
12117
|
+
readonly name: "repository";
|
|
12118
|
+
readonly type: "string";
|
|
12119
|
+
readonly required: false;
|
|
12120
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12121
|
+
}];
|
|
12122
|
+
readonly body: {
|
|
12123
|
+
readonly required: true;
|
|
12124
|
+
readonly fields: readonly [{
|
|
12125
|
+
readonly name: "content";
|
|
12126
|
+
readonly type: "string";
|
|
12127
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
12128
|
+
readonly required: true;
|
|
12129
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
12130
|
+
}];
|
|
12131
|
+
};
|
|
12132
|
+
}, {
|
|
12133
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12134
|
+
readonly method: "delete";
|
|
12135
|
+
readonly summary: "Remove reactions";
|
|
12136
|
+
readonly description: "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12137
|
+
readonly http: "DELETE";
|
|
12138
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions/{content}";
|
|
12139
|
+
readonly streaming: "no";
|
|
12140
|
+
readonly pagination: false;
|
|
12141
|
+
readonly pathParams: readonly [{
|
|
12142
|
+
readonly name: "number";
|
|
12143
|
+
readonly sdkName: "number";
|
|
12144
|
+
}, {
|
|
12145
|
+
readonly name: "content";
|
|
12146
|
+
readonly sdkName: "content";
|
|
12147
|
+
}];
|
|
12148
|
+
readonly query: readonly [{
|
|
12149
|
+
readonly name: "repository";
|
|
12150
|
+
readonly type: "string";
|
|
12151
|
+
readonly required: false;
|
|
12152
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12153
|
+
}];
|
|
12154
|
+
}, {
|
|
12155
|
+
readonly resource: "ticket.tickets.relations";
|
|
12156
|
+
readonly method: "list";
|
|
12157
|
+
readonly summary: "List relations";
|
|
12158
|
+
readonly description: "List relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
12159
|
+
readonly http: "GET";
|
|
12160
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12161
|
+
readonly streaming: "no";
|
|
12162
|
+
readonly pagination: false;
|
|
12163
|
+
readonly pathParams: readonly [{
|
|
12164
|
+
readonly name: "number";
|
|
12165
|
+
readonly sdkName: "number";
|
|
12166
|
+
}];
|
|
12167
|
+
readonly query: readonly [{
|
|
12168
|
+
readonly name: "repository";
|
|
12169
|
+
readonly type: "string";
|
|
12170
|
+
readonly required: false;
|
|
12171
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12172
|
+
}, {
|
|
12173
|
+
readonly name: "page_size";
|
|
12174
|
+
readonly type: "integer";
|
|
12175
|
+
readonly required: false;
|
|
12176
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12177
|
+
}, {
|
|
12178
|
+
readonly name: "page_token";
|
|
12179
|
+
readonly type: "string";
|
|
12180
|
+
readonly required: false;
|
|
12181
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12182
|
+
}];
|
|
12183
|
+
}, {
|
|
12184
|
+
readonly resource: "ticket.tickets.relations";
|
|
12185
|
+
readonly method: "create";
|
|
12186
|
+
readonly summary: "Create or add relations";
|
|
12187
|
+
readonly description: "Create or add relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12188
|
+
readonly http: "POST";
|
|
12189
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12190
|
+
readonly streaming: "no";
|
|
12191
|
+
readonly pagination: false;
|
|
12192
|
+
readonly pathParams: readonly [{
|
|
12193
|
+
readonly name: "number";
|
|
12194
|
+
readonly sdkName: "number";
|
|
12195
|
+
}];
|
|
12196
|
+
readonly query: readonly [{
|
|
12197
|
+
readonly name: "repository";
|
|
12198
|
+
readonly type: "string";
|
|
12199
|
+
readonly required: false;
|
|
12200
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12201
|
+
}];
|
|
12202
|
+
readonly body: {
|
|
12203
|
+
readonly required: true;
|
|
12204
|
+
readonly fields: readonly [{
|
|
12205
|
+
readonly name: "relates_to";
|
|
12206
|
+
readonly type: "integer";
|
|
12207
|
+
readonly required: true;
|
|
12208
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12209
|
+
}];
|
|
12210
|
+
};
|
|
12211
|
+
}, {
|
|
12212
|
+
readonly resource: "ticket.tickets.relations";
|
|
12213
|
+
readonly method: "delete";
|
|
12214
|
+
readonly summary: "Remove relations";
|
|
12215
|
+
readonly description: "Remove relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12216
|
+
readonly http: "DELETE";
|
|
12217
|
+
readonly path: "/ticket/v1/tickets/{number}/relations/{n}";
|
|
12218
|
+
readonly streaming: "no";
|
|
12219
|
+
readonly pagination: false;
|
|
12220
|
+
readonly pathParams: readonly [{
|
|
12221
|
+
readonly name: "number";
|
|
12222
|
+
readonly sdkName: "number";
|
|
12223
|
+
}, {
|
|
12224
|
+
readonly name: "n";
|
|
12225
|
+
readonly sdkName: "n";
|
|
12226
|
+
}];
|
|
12227
|
+
readonly query: readonly [{
|
|
12228
|
+
readonly name: "repository";
|
|
12229
|
+
readonly type: "string";
|
|
12230
|
+
readonly required: false;
|
|
12231
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12232
|
+
}];
|
|
12233
|
+
}, {
|
|
12234
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12235
|
+
readonly method: "list";
|
|
12236
|
+
readonly summary: "List sub tickets";
|
|
12237
|
+
readonly description: "List sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.";
|
|
12238
|
+
readonly http: "GET";
|
|
12239
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12240
|
+
readonly streaming: "no";
|
|
12241
|
+
readonly pagination: false;
|
|
12242
|
+
readonly pathParams: readonly [{
|
|
12243
|
+
readonly name: "number";
|
|
12244
|
+
readonly sdkName: "number";
|
|
12245
|
+
}];
|
|
12246
|
+
readonly query: readonly [{
|
|
12247
|
+
readonly name: "repository";
|
|
12248
|
+
readonly type: "string";
|
|
12249
|
+
readonly required: false;
|
|
12250
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12251
|
+
}, {
|
|
12252
|
+
readonly name: "page_size";
|
|
12253
|
+
readonly type: "integer";
|
|
12254
|
+
readonly required: false;
|
|
12255
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12256
|
+
}, {
|
|
12257
|
+
readonly name: "page_token";
|
|
12258
|
+
readonly type: "string";
|
|
12259
|
+
readonly required: false;
|
|
12260
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12261
|
+
}];
|
|
12262
|
+
}, {
|
|
12263
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12264
|
+
readonly method: "create";
|
|
12265
|
+
readonly summary: "Create or add sub tickets";
|
|
12266
|
+
readonly description: "Create or add sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12267
|
+
readonly http: "POST";
|
|
12268
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12269
|
+
readonly streaming: "no";
|
|
12270
|
+
readonly pagination: false;
|
|
12271
|
+
readonly pathParams: readonly [{
|
|
12272
|
+
readonly name: "number";
|
|
12273
|
+
readonly sdkName: "number";
|
|
12274
|
+
}];
|
|
12275
|
+
readonly query: readonly [{
|
|
12276
|
+
readonly name: "repository";
|
|
12277
|
+
readonly type: "string";
|
|
12278
|
+
readonly required: false;
|
|
12279
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12280
|
+
}];
|
|
12281
|
+
readonly body: {
|
|
12282
|
+
readonly required: true;
|
|
12283
|
+
readonly fields: readonly [{
|
|
12284
|
+
readonly name: "child";
|
|
12285
|
+
readonly type: "integer";
|
|
12286
|
+
readonly required: true;
|
|
12287
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12288
|
+
}, {
|
|
12289
|
+
readonly name: "replace_parent";
|
|
12290
|
+
readonly type: "boolean";
|
|
12291
|
+
readonly required: false;
|
|
12292
|
+
readonly description: "Allow replacing an existing parent.";
|
|
12293
|
+
}];
|
|
12294
|
+
};
|
|
12295
|
+
}, {
|
|
12296
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12297
|
+
readonly method: "delete";
|
|
12298
|
+
readonly summary: "Remove sub tickets";
|
|
12299
|
+
readonly description: "Remove sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12300
|
+
readonly http: "DELETE";
|
|
12301
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets/{child}";
|
|
12302
|
+
readonly streaming: "no";
|
|
12303
|
+
readonly pagination: false;
|
|
12304
|
+
readonly pathParams: readonly [{
|
|
12305
|
+
readonly name: "number";
|
|
12306
|
+
readonly sdkName: "number";
|
|
12307
|
+
}, {
|
|
12308
|
+
readonly name: "child";
|
|
12309
|
+
readonly sdkName: "child";
|
|
12310
|
+
}];
|
|
12311
|
+
readonly query: readonly [{
|
|
12312
|
+
readonly name: "repository";
|
|
12313
|
+
readonly type: "string";
|
|
12314
|
+
readonly required: false;
|
|
12315
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12316
|
+
}];
|
|
12317
|
+
}, {
|
|
12318
|
+
readonly resource: "ticket.types";
|
|
12319
|
+
readonly method: "list";
|
|
12320
|
+
readonly summary: "Read types";
|
|
12321
|
+
readonly description: "Read types within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.";
|
|
12322
|
+
readonly http: "GET";
|
|
12323
|
+
readonly path: "/ticket/v1/types";
|
|
12324
|
+
readonly streaming: "no";
|
|
12325
|
+
readonly pagination: false;
|
|
12326
|
+
readonly pathParams: readonly [];
|
|
12327
|
+
readonly query: readonly [{
|
|
12328
|
+
readonly name: "repository";
|
|
12329
|
+
readonly type: "string";
|
|
12330
|
+
readonly required: false;
|
|
12331
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12332
|
+
}];
|
|
10808
12333
|
}, {
|
|
10809
12334
|
readonly resource: "vault.authorizations";
|
|
10810
12335
|
readonly method: "create";
|