@deepraxis/sdk 0.1.0-dev.a5cf3ce → 0.1.0-dev.b7ae389
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 +5 -1
- package/dist/core/client.js +3 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +343 -19
- package/dist/generated/sdk.gen.js +1053 -18
- package/dist/generated/types.gen.d.ts +26651 -21213
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/operations.generated.d.ts +1541 -28
- package/dist/operations.generated.js +1957 -61
- package/dist/resources.generated.d.ts +651 -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,16 @@ 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.";
|
|
143
159
|
}, {
|
|
144
160
|
readonly name: "preset";
|
|
145
161
|
readonly type: "string";
|
|
@@ -171,7 +187,7 @@ export declare const operations: readonly [{
|
|
|
171
187
|
readonly resource: "agent.agents";
|
|
172
188
|
readonly method: "update";
|
|
173
189
|
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
|
|
190
|
+
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
191
|
readonly http: "POST";
|
|
176
192
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
177
193
|
readonly streaming: "no";
|
|
@@ -236,6 +252,22 @@ export declare const operations: readonly [{
|
|
|
236
252
|
readonly type: "number";
|
|
237
253
|
readonly required: false;
|
|
238
254
|
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.";
|
|
255
|
+
}, {
|
|
256
|
+
readonly name: "apply";
|
|
257
|
+
readonly type: "boolean";
|
|
258
|
+
readonly required: false;
|
|
259
|
+
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.";
|
|
260
|
+
}, {
|
|
261
|
+
readonly name: "version_note";
|
|
262
|
+
readonly type: "string";
|
|
263
|
+
readonly required: false;
|
|
264
|
+
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.";
|
|
265
|
+
}, {
|
|
266
|
+
readonly name: "bindings";
|
|
267
|
+
readonly type: "array";
|
|
268
|
+
readonly itemType: "object";
|
|
269
|
+
readonly required: false;
|
|
270
|
+
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
271
|
}, {
|
|
240
272
|
readonly name: "kind";
|
|
241
273
|
readonly type: "string";
|
|
@@ -274,6 +306,16 @@ export declare const operations: readonly [{
|
|
|
274
306
|
readonly type: "object";
|
|
275
307
|
readonly required: false;
|
|
276
308
|
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.";
|
|
309
|
+
}, {
|
|
310
|
+
readonly name: "avatar";
|
|
311
|
+
readonly type: "string";
|
|
312
|
+
readonly required: false;
|
|
313
|
+
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.";
|
|
314
|
+
}, {
|
|
315
|
+
readonly name: "environment_id";
|
|
316
|
+
readonly type: "string";
|
|
317
|
+
readonly required: false;
|
|
318
|
+
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.";
|
|
277
319
|
}, {
|
|
278
320
|
readonly name: "preset";
|
|
279
321
|
readonly type: "string";
|
|
@@ -470,6 +512,23 @@ export declare const operations: readonly [{
|
|
|
470
512
|
readonly required: false;
|
|
471
513
|
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
514
|
}];
|
|
515
|
+
}, {
|
|
516
|
+
readonly resource: "agent.agents.versions";
|
|
517
|
+
readonly method: "apply";
|
|
518
|
+
readonly summary: "Apply Agent Version";
|
|
519
|
+
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.";
|
|
520
|
+
readonly http: "POST";
|
|
521
|
+
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
522
|
+
readonly streaming: "no";
|
|
523
|
+
readonly pagination: false;
|
|
524
|
+
readonly pathParams: readonly [{
|
|
525
|
+
readonly name: "agent_id";
|
|
526
|
+
readonly sdkName: "agent_id";
|
|
527
|
+
}, {
|
|
528
|
+
readonly name: "version";
|
|
529
|
+
readonly sdkName: "version";
|
|
530
|
+
}];
|
|
531
|
+
readonly query: readonly [];
|
|
473
532
|
}, {
|
|
474
533
|
readonly resource: "agent.computers";
|
|
475
534
|
readonly method: "list";
|
|
@@ -608,7 +667,7 @@ export declare const operations: readonly [{
|
|
|
608
667
|
readonly resource: "agent.computers";
|
|
609
668
|
readonly method: "connect";
|
|
610
669
|
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.
|
|
670
|
+
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
671
|
readonly http: "POST";
|
|
613
672
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
614
673
|
readonly streaming: "no";
|
|
@@ -1442,7 +1501,7 @@ export declare const operations: readonly [{
|
|
|
1442
1501
|
readonly resource: "agent.sessions";
|
|
1443
1502
|
readonly method: "create";
|
|
1444
1503
|
readonly summary: "Create session";
|
|
1445
|
-
readonly description: "Create a session: one conversation with an agent
|
|
1504
|
+
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
1505
|
readonly http: "POST";
|
|
1447
1506
|
readonly path: "/agent/v1/sessions";
|
|
1448
1507
|
readonly streaming: "no";
|
|
@@ -1460,7 +1519,7 @@ export declare const operations: readonly [{
|
|
|
1460
1519
|
readonly name: "environment_id";
|
|
1461
1520
|
readonly type: "string";
|
|
1462
1521
|
readonly required: false;
|
|
1463
|
-
readonly description: "
|
|
1522
|
+
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
1523
|
}, {
|
|
1465
1524
|
readonly name: "budget";
|
|
1466
1525
|
readonly type: "object";
|
|
@@ -2153,6 +2212,187 @@ export declare const operations: readonly [{
|
|
|
2153
2212
|
readonly required: false;
|
|
2154
2213
|
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
2214
|
}];
|
|
2215
|
+
}, {
|
|
2216
|
+
readonly resource: "agent.skills";
|
|
2217
|
+
readonly method: "list";
|
|
2218
|
+
readonly summary: "List skills";
|
|
2219
|
+
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.";
|
|
2220
|
+
readonly http: "GET";
|
|
2221
|
+
readonly path: "/agent/v1/skills";
|
|
2222
|
+
readonly streaming: "no";
|
|
2223
|
+
readonly pagination: false;
|
|
2224
|
+
readonly pathParams: readonly [];
|
|
2225
|
+
readonly query: readonly [{
|
|
2226
|
+
readonly name: "source";
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly required: false;
|
|
2229
|
+
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";
|
|
2230
|
+
}, {
|
|
2231
|
+
readonly name: "limit";
|
|
2232
|
+
readonly type: "number";
|
|
2233
|
+
readonly required: false;
|
|
2234
|
+
readonly description: "Number of items per page.";
|
|
2235
|
+
}, {
|
|
2236
|
+
readonly name: "page";
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
readonly required: false;
|
|
2239
|
+
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.";
|
|
2240
|
+
}];
|
|
2241
|
+
}, {
|
|
2242
|
+
readonly resource: "agent.skills";
|
|
2243
|
+
readonly method: "create";
|
|
2244
|
+
readonly summary: "Create skill";
|
|
2245
|
+
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.";
|
|
2246
|
+
readonly http: "POST";
|
|
2247
|
+
readonly path: "/agent/v1/skills";
|
|
2248
|
+
readonly streaming: "no";
|
|
2249
|
+
readonly pagination: false;
|
|
2250
|
+
readonly multipart: true;
|
|
2251
|
+
readonly pathParams: readonly [];
|
|
2252
|
+
readonly query: readonly [];
|
|
2253
|
+
readonly body: {
|
|
2254
|
+
readonly required: true;
|
|
2255
|
+
readonly fields: readonly [{
|
|
2256
|
+
readonly name: "files";
|
|
2257
|
+
readonly type: "array";
|
|
2258
|
+
readonly itemType: "string";
|
|
2259
|
+
readonly required: true;
|
|
2260
|
+
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.";
|
|
2261
|
+
}, {
|
|
2262
|
+
readonly name: "display_name";
|
|
2263
|
+
readonly type: "string";
|
|
2264
|
+
readonly required: false;
|
|
2265
|
+
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.";
|
|
2266
|
+
}];
|
|
2267
|
+
};
|
|
2268
|
+
}, {
|
|
2269
|
+
readonly resource: "agent.skills";
|
|
2270
|
+
readonly method: "delete";
|
|
2271
|
+
readonly summary: "Delete skill";
|
|
2272
|
+
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.";
|
|
2273
|
+
readonly http: "DELETE";
|
|
2274
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2275
|
+
readonly streaming: "no";
|
|
2276
|
+
readonly pagination: false;
|
|
2277
|
+
readonly pathParams: readonly [{
|
|
2278
|
+
readonly name: "skill_id";
|
|
2279
|
+
readonly sdkName: "skill_id";
|
|
2280
|
+
}];
|
|
2281
|
+
readonly query: readonly [];
|
|
2282
|
+
}, {
|
|
2283
|
+
readonly resource: "agent.skills";
|
|
2284
|
+
readonly method: "retrieve";
|
|
2285
|
+
readonly summary: "Get skill";
|
|
2286
|
+
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.";
|
|
2287
|
+
readonly http: "GET";
|
|
2288
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2289
|
+
readonly streaming: "no";
|
|
2290
|
+
readonly pagination: false;
|
|
2291
|
+
readonly pathParams: readonly [{
|
|
2292
|
+
readonly name: "skill_id";
|
|
2293
|
+
readonly sdkName: "skill_id";
|
|
2294
|
+
}];
|
|
2295
|
+
readonly query: readonly [];
|
|
2296
|
+
}, {
|
|
2297
|
+
readonly resource: "agent.skills.versions";
|
|
2298
|
+
readonly method: "list";
|
|
2299
|
+
readonly summary: "List skill versions";
|
|
2300
|
+
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.";
|
|
2301
|
+
readonly http: "GET";
|
|
2302
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2303
|
+
readonly streaming: "no";
|
|
2304
|
+
readonly pagination: false;
|
|
2305
|
+
readonly pathParams: readonly [{
|
|
2306
|
+
readonly name: "skill_id";
|
|
2307
|
+
readonly sdkName: "skill_id";
|
|
2308
|
+
}];
|
|
2309
|
+
readonly query: readonly [{
|
|
2310
|
+
readonly name: "limit";
|
|
2311
|
+
readonly type: "number";
|
|
2312
|
+
readonly required: false;
|
|
2313
|
+
readonly description: "Number of items per page.";
|
|
2314
|
+
}, {
|
|
2315
|
+
readonly name: "page";
|
|
2316
|
+
readonly type: "string";
|
|
2317
|
+
readonly required: false;
|
|
2318
|
+
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.";
|
|
2319
|
+
}];
|
|
2320
|
+
}, {
|
|
2321
|
+
readonly resource: "agent.skills.versions";
|
|
2322
|
+
readonly method: "create";
|
|
2323
|
+
readonly summary: "Create skill version";
|
|
2324
|
+
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.";
|
|
2325
|
+
readonly http: "POST";
|
|
2326
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2327
|
+
readonly streaming: "no";
|
|
2328
|
+
readonly pagination: false;
|
|
2329
|
+
readonly multipart: true;
|
|
2330
|
+
readonly pathParams: readonly [{
|
|
2331
|
+
readonly name: "skill_id";
|
|
2332
|
+
readonly sdkName: "skill_id";
|
|
2333
|
+
}];
|
|
2334
|
+
readonly query: readonly [];
|
|
2335
|
+
readonly body: {
|
|
2336
|
+
readonly required: true;
|
|
2337
|
+
readonly fields: readonly [{
|
|
2338
|
+
readonly name: "files";
|
|
2339
|
+
readonly type: "array";
|
|
2340
|
+
readonly itemType: "string";
|
|
2341
|
+
readonly required: true;
|
|
2342
|
+
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.";
|
|
2343
|
+
}];
|
|
2344
|
+
};
|
|
2345
|
+
}, {
|
|
2346
|
+
readonly resource: "agent.skills.versions";
|
|
2347
|
+
readonly method: "delete";
|
|
2348
|
+
readonly summary: "Delete skill version";
|
|
2349
|
+
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.";
|
|
2350
|
+
readonly http: "DELETE";
|
|
2351
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2352
|
+
readonly streaming: "no";
|
|
2353
|
+
readonly pagination: false;
|
|
2354
|
+
readonly pathParams: readonly [{
|
|
2355
|
+
readonly name: "skill_id";
|
|
2356
|
+
readonly sdkName: "skill_id";
|
|
2357
|
+
}, {
|
|
2358
|
+
readonly name: "version";
|
|
2359
|
+
readonly sdkName: "version";
|
|
2360
|
+
}];
|
|
2361
|
+
readonly query: readonly [];
|
|
2362
|
+
}, {
|
|
2363
|
+
readonly resource: "agent.skills.versions";
|
|
2364
|
+
readonly method: "retrieve";
|
|
2365
|
+
readonly summary: "Get skill version";
|
|
2366
|
+
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.";
|
|
2367
|
+
readonly http: "GET";
|
|
2368
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2369
|
+
readonly streaming: "no";
|
|
2370
|
+
readonly pagination: false;
|
|
2371
|
+
readonly pathParams: readonly [{
|
|
2372
|
+
readonly name: "skill_id";
|
|
2373
|
+
readonly sdkName: "skill_id";
|
|
2374
|
+
}, {
|
|
2375
|
+
readonly name: "version";
|
|
2376
|
+
readonly sdkName: "version";
|
|
2377
|
+
}];
|
|
2378
|
+
readonly query: readonly [];
|
|
2379
|
+
}, {
|
|
2380
|
+
readonly resource: "agent.skills.versions";
|
|
2381
|
+
readonly method: "retrieveContent";
|
|
2382
|
+
readonly summary: "Download skill version";
|
|
2383
|
+
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.";
|
|
2384
|
+
readonly http: "GET";
|
|
2385
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}/content";
|
|
2386
|
+
readonly streaming: "no";
|
|
2387
|
+
readonly pagination: false;
|
|
2388
|
+
readonly pathParams: readonly [{
|
|
2389
|
+
readonly name: "skill_id";
|
|
2390
|
+
readonly sdkName: "skill_id";
|
|
2391
|
+
}, {
|
|
2392
|
+
readonly name: "version";
|
|
2393
|
+
readonly sdkName: "version";
|
|
2394
|
+
}];
|
|
2395
|
+
readonly query: readonly [];
|
|
2156
2396
|
}, {
|
|
2157
2397
|
readonly resource: "agent.toolsets";
|
|
2158
2398
|
readonly method: "list";
|
|
@@ -2844,12 +3084,12 @@ export declare const operations: readonly [{
|
|
|
2844
3084
|
readonly name: "namespace";
|
|
2845
3085
|
readonly type: "string";
|
|
2846
3086
|
readonly required: true;
|
|
2847
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3087
|
+
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
3088
|
}, {
|
|
2849
3089
|
readonly name: "name";
|
|
2850
3090
|
readonly type: "string";
|
|
2851
3091
|
readonly required: true;
|
|
2852
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3092
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2853
3093
|
}, {
|
|
2854
3094
|
readonly name: "description";
|
|
2855
3095
|
readonly type: "string";
|
|
@@ -2901,8 +3141,8 @@ export declare const operations: readonly [{
|
|
|
2901
3141
|
}, {
|
|
2902
3142
|
readonly resource: "automation.actions";
|
|
2903
3143
|
readonly method: "retrieve";
|
|
2904
|
-
readonly summary: "Get an
|
|
2905
|
-
readonly description: "Read the
|
|
3144
|
+
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3145
|
+
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
3146
|
readonly http: "GET";
|
|
2907
3147
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2908
3148
|
readonly streaming: "no";
|
|
@@ -3346,8 +3586,8 @@ export declare const operations: readonly [{
|
|
|
3346
3586
|
}, {
|
|
3347
3587
|
readonly resource: "automation.runs";
|
|
3348
3588
|
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
|
|
3589
|
+
readonly summary: "Run a published target or execute draft source";
|
|
3590
|
+
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
3591
|
readonly http: "POST";
|
|
3352
3592
|
readonly path: "/automation/v1/runs";
|
|
3353
3593
|
readonly streaming: "no";
|
|
@@ -3730,7 +3970,7 @@ export declare const operations: readonly [{
|
|
|
3730
3970
|
readonly resource: "automation.scripts";
|
|
3731
3971
|
readonly method: "create";
|
|
3732
3972
|
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
|
|
3973
|
+
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
3974
|
readonly http: "POST";
|
|
3735
3975
|
readonly path: "/automation/v1/scripts";
|
|
3736
3976
|
readonly streaming: "no";
|
|
@@ -3743,12 +3983,12 @@ export declare const operations: readonly [{
|
|
|
3743
3983
|
readonly name: "namespace";
|
|
3744
3984
|
readonly type: "string";
|
|
3745
3985
|
readonly required: true;
|
|
3746
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3986
|
+
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
3987
|
}, {
|
|
3748
3988
|
readonly name: "name";
|
|
3749
3989
|
readonly type: "string";
|
|
3750
3990
|
readonly required: true;
|
|
3751
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3991
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3752
3992
|
}, {
|
|
3753
3993
|
readonly name: "description";
|
|
3754
3994
|
readonly type: "string";
|
|
@@ -3787,7 +4027,7 @@ export declare const operations: readonly [{
|
|
|
3787
4027
|
readonly resource: "automation.scripts";
|
|
3788
4028
|
readonly method: "update";
|
|
3789
4029
|
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.";
|
|
4030
|
+
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
4031
|
readonly http: "PATCH";
|
|
3792
4032
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3793
4033
|
readonly streaming: "no";
|
|
@@ -4546,7 +4786,7 @@ export declare const operations: readonly [{
|
|
|
4546
4786
|
readonly resource: "automation.workflows";
|
|
4547
4787
|
readonly method: "create";
|
|
4548
4788
|
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
|
|
4789
|
+
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
4790
|
readonly http: "POST";
|
|
4551
4791
|
readonly path: "/automation/v1/workflows";
|
|
4552
4792
|
readonly streaming: "no";
|
|
@@ -4559,12 +4799,12 @@ export declare const operations: readonly [{
|
|
|
4559
4799
|
readonly name: "namespace";
|
|
4560
4800
|
readonly type: "string";
|
|
4561
4801
|
readonly required: true;
|
|
4562
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4802
|
+
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
4803
|
}, {
|
|
4564
4804
|
readonly name: "name";
|
|
4565
4805
|
readonly type: "string";
|
|
4566
4806
|
readonly required: true;
|
|
4567
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4807
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4568
4808
|
}, {
|
|
4569
4809
|
readonly name: "description";
|
|
4570
4810
|
readonly type: "string";
|
|
@@ -6113,7 +6353,7 @@ export declare const operations: readonly [{
|
|
|
6113
6353
|
readonly resource: "file.files";
|
|
6114
6354
|
readonly method: "create";
|
|
6115
6355
|
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
|
|
6356
|
+
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
6357
|
readonly http: "POST";
|
|
6118
6358
|
readonly path: "/file/v1/files";
|
|
6119
6359
|
readonly streaming: "no";
|
|
@@ -6127,7 +6367,7 @@ export declare const operations: readonly [{
|
|
|
6127
6367
|
readonly name: "file";
|
|
6128
6368
|
readonly type: "string";
|
|
6129
6369
|
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
|
|
6370
|
+
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
6371
|
}, {
|
|
6132
6372
|
readonly name: "purpose";
|
|
6133
6373
|
readonly type: "string";
|
|
@@ -6164,7 +6404,7 @@ export declare const operations: readonly [{
|
|
|
6164
6404
|
readonly resource: "file.files";
|
|
6165
6405
|
readonly method: "retrieve";
|
|
6166
6406
|
readonly summary: "Retrieve file";
|
|
6167
|
-
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its
|
|
6407
|
+
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
6408
|
readonly http: "GET";
|
|
6169
6409
|
readonly path: "/file/v1/files/{file_id}";
|
|
6170
6410
|
readonly streaming: "no";
|
|
@@ -6178,7 +6418,7 @@ export declare const operations: readonly [{
|
|
|
6178
6418
|
readonly resource: "file.files";
|
|
6179
6419
|
readonly method: "retrieveContent";
|
|
6180
6420
|
readonly summary: "Retrieve file content";
|
|
6181
|
-
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its
|
|
6421
|
+
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
6422
|
readonly http: "GET";
|
|
6183
6423
|
readonly path: "/file/v1/files/{file_id}/content";
|
|
6184
6424
|
readonly streaming: "no";
|
|
@@ -6188,6 +6428,124 @@ export declare const operations: readonly [{
|
|
|
6188
6428
|
readonly sdkName: "file_id";
|
|
6189
6429
|
}];
|
|
6190
6430
|
readonly query: readonly [];
|
|
6431
|
+
}, {
|
|
6432
|
+
readonly resource: "file.uploads";
|
|
6433
|
+
readonly method: "create";
|
|
6434
|
+
readonly summary: "Create an upload";
|
|
6435
|
+
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.";
|
|
6436
|
+
readonly http: "POST";
|
|
6437
|
+
readonly path: "/file/v1/uploads";
|
|
6438
|
+
readonly streaming: "no";
|
|
6439
|
+
readonly pagination: false;
|
|
6440
|
+
readonly pathParams: readonly [];
|
|
6441
|
+
readonly query: readonly [];
|
|
6442
|
+
readonly body: {
|
|
6443
|
+
readonly required: true;
|
|
6444
|
+
readonly fields: readonly [{
|
|
6445
|
+
readonly name: "bytes";
|
|
6446
|
+
readonly type: "integer";
|
|
6447
|
+
readonly required: true;
|
|
6448
|
+
readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
|
|
6449
|
+
}, {
|
|
6450
|
+
readonly name: "filename";
|
|
6451
|
+
readonly type: "string";
|
|
6452
|
+
readonly required: true;
|
|
6453
|
+
readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
|
|
6454
|
+
}, {
|
|
6455
|
+
readonly name: "mime_type";
|
|
6456
|
+
readonly type: "string";
|
|
6457
|
+
readonly required: true;
|
|
6458
|
+
readonly description: "Declared MIME type; validated against the assembled content.";
|
|
6459
|
+
}, {
|
|
6460
|
+
readonly name: "purpose";
|
|
6461
|
+
readonly type: "string";
|
|
6462
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
6463
|
+
readonly required: true;
|
|
6464
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6465
|
+
}, {
|
|
6466
|
+
readonly name: "expires_after";
|
|
6467
|
+
readonly type: "object";
|
|
6468
|
+
readonly required: false;
|
|
6469
|
+
readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
|
|
6470
|
+
}, {
|
|
6471
|
+
readonly name: "part_size";
|
|
6472
|
+
readonly type: "integer";
|
|
6473
|
+
readonly required: false;
|
|
6474
|
+
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.";
|
|
6475
|
+
}];
|
|
6476
|
+
};
|
|
6477
|
+
}, {
|
|
6478
|
+
readonly resource: "file.uploads";
|
|
6479
|
+
readonly method: "cancel";
|
|
6480
|
+
readonly summary: "Cancel an upload";
|
|
6481
|
+
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.";
|
|
6482
|
+
readonly http: "POST";
|
|
6483
|
+
readonly path: "/file/v1/uploads/{upload_id}/cancel";
|
|
6484
|
+
readonly streaming: "no";
|
|
6485
|
+
readonly pagination: false;
|
|
6486
|
+
readonly pathParams: readonly [{
|
|
6487
|
+
readonly name: "upload_id";
|
|
6488
|
+
readonly sdkName: "upload_id";
|
|
6489
|
+
}];
|
|
6490
|
+
readonly query: readonly [];
|
|
6491
|
+
}, {
|
|
6492
|
+
readonly resource: "file.uploads";
|
|
6493
|
+
readonly method: "complete";
|
|
6494
|
+
readonly summary: "Complete an upload";
|
|
6495
|
+
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.";
|
|
6496
|
+
readonly http: "POST";
|
|
6497
|
+
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
6498
|
+
readonly streaming: "no";
|
|
6499
|
+
readonly pagination: false;
|
|
6500
|
+
readonly pathParams: readonly [{
|
|
6501
|
+
readonly name: "upload_id";
|
|
6502
|
+
readonly sdkName: "upload_id";
|
|
6503
|
+
}];
|
|
6504
|
+
readonly query: readonly [];
|
|
6505
|
+
readonly body: {
|
|
6506
|
+
readonly required: true;
|
|
6507
|
+
readonly fields: readonly [{
|
|
6508
|
+
readonly name: "part_ids";
|
|
6509
|
+
readonly type: "array";
|
|
6510
|
+
readonly itemType: "string";
|
|
6511
|
+
readonly required: true;
|
|
6512
|
+
readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
|
|
6513
|
+
}, {
|
|
6514
|
+
readonly name: "md5";
|
|
6515
|
+
readonly type: "string";
|
|
6516
|
+
readonly required: false;
|
|
6517
|
+
readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
|
|
6518
|
+
}];
|
|
6519
|
+
};
|
|
6520
|
+
}, {
|
|
6521
|
+
readonly resource: "file.uploads.parts";
|
|
6522
|
+
readonly method: "create";
|
|
6523
|
+
readonly summary: "Add an upload part";
|
|
6524
|
+
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.";
|
|
6525
|
+
readonly http: "POST";
|
|
6526
|
+
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
6527
|
+
readonly streaming: "no";
|
|
6528
|
+
readonly pagination: false;
|
|
6529
|
+
readonly multipart: true;
|
|
6530
|
+
readonly pathParams: readonly [{
|
|
6531
|
+
readonly name: "upload_id";
|
|
6532
|
+
readonly sdkName: "upload_id";
|
|
6533
|
+
}];
|
|
6534
|
+
readonly query: readonly [{
|
|
6535
|
+
readonly name: "part_number";
|
|
6536
|
+
readonly type: "integer";
|
|
6537
|
+
readonly required: false;
|
|
6538
|
+
readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
|
|
6539
|
+
}];
|
|
6540
|
+
readonly body: {
|
|
6541
|
+
readonly required: true;
|
|
6542
|
+
readonly fields: readonly [{
|
|
6543
|
+
readonly name: "data";
|
|
6544
|
+
readonly type: "string";
|
|
6545
|
+
readonly required: true;
|
|
6546
|
+
readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
|
|
6547
|
+
}];
|
|
6548
|
+
};
|
|
6191
6549
|
}, {
|
|
6192
6550
|
readonly resource: "knowledge.vectorStores";
|
|
6193
6551
|
readonly method: "list";
|
|
@@ -9462,7 +9820,7 @@ export declare const operations: readonly [{
|
|
|
9462
9820
|
readonly name: "message";
|
|
9463
9821
|
readonly type: "string";
|
|
9464
9822
|
readonly required: true;
|
|
9465
|
-
readonly description: "Problem description
|
|
9823
|
+
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
9824
|
}, {
|
|
9467
9825
|
readonly name: "contact_email";
|
|
9468
9826
|
readonly type: "string";
|
|
@@ -9697,7 +10055,7 @@ export declare const operations: readonly [{
|
|
|
9697
10055
|
readonly resource: "sandbox.sandboxes";
|
|
9698
10056
|
readonly method: "create";
|
|
9699
10057
|
readonly summary: "Create sandbox (v2)";
|
|
9700
|
-
readonly description: "
|
|
10058
|
+
readonly description: "Create a sandbox from the template. All system communication with the sandbox is secured.";
|
|
9701
10059
|
readonly http: "POST";
|
|
9702
10060
|
readonly path: "/sandbox/v1/sandboxes";
|
|
9703
10061
|
readonly streaming: "no";
|
|
@@ -9710,7 +10068,7 @@ export declare const operations: readonly [{
|
|
|
9710
10068
|
readonly name: "templateID";
|
|
9711
10069
|
readonly type: "string";
|
|
9712
10070
|
readonly required: true;
|
|
9713
|
-
readonly description: "
|
|
10071
|
+
readonly description: "Identifier of the required template";
|
|
9714
10072
|
}, {
|
|
9715
10073
|
readonly name: "timeout";
|
|
9716
10074
|
readonly type: "integer";
|
|
@@ -9824,7 +10182,7 @@ export declare const operations: readonly [{
|
|
|
9824
10182
|
readonly resource: "sandbox.sandboxes";
|
|
9825
10183
|
readonly method: "connect";
|
|
9826
10184
|
readonly summary: "Connect sandbox (v2)";
|
|
9827
|
-
readonly description: "
|
|
10185
|
+
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
10186
|
readonly http: "POST";
|
|
9829
10187
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/connect";
|
|
9830
10188
|
readonly streaming: "no";
|
|
@@ -9945,7 +10303,7 @@ export declare const operations: readonly [{
|
|
|
9945
10303
|
readonly resource: "sandbox.sandboxes.metrics";
|
|
9946
10304
|
readonly method: "list";
|
|
9947
10305
|
readonly summary: "Sandbox metrics";
|
|
9948
|
-
readonly description: "Read CPU, memory and disk usage over
|
|
10306
|
+
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
10307
|
readonly http: "GET";
|
|
9950
10308
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/metrics";
|
|
9951
10309
|
readonly streaming: "no";
|
|
@@ -10014,7 +10372,7 @@ export declare const operations: readonly [{
|
|
|
10014
10372
|
readonly resource: "sandbox.sandboxes";
|
|
10015
10373
|
readonly method: "pause";
|
|
10016
10374
|
readonly summary: "Pause sandbox";
|
|
10017
|
-
readonly description: "
|
|
10375
|
+
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
10376
|
readonly http: "POST";
|
|
10019
10377
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/pause";
|
|
10020
10378
|
readonly streaming: "no";
|
|
@@ -10330,7 +10688,7 @@ export declare const operations: readonly [{
|
|
|
10330
10688
|
readonly resource: "sandbox.templates";
|
|
10331
10689
|
readonly method: "list";
|
|
10332
10690
|
readonly summary: "List templates (v2)";
|
|
10333
|
-
readonly description: "
|
|
10691
|
+
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
10692
|
readonly http: "GET";
|
|
10335
10693
|
readonly path: "/sandbox/v1/templates";
|
|
10336
10694
|
readonly streaming: "no";
|
|
@@ -10805,6 +11163,1161 @@ export declare const operations: readonly [{
|
|
|
10805
11163
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10806
11164
|
}];
|
|
10807
11165
|
};
|
|
11166
|
+
}, {
|
|
11167
|
+
readonly resource: "ticket.activity";
|
|
11168
|
+
readonly method: "retrieve";
|
|
11169
|
+
readonly summary: "List activity";
|
|
11170
|
+
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.";
|
|
11171
|
+
readonly http: "GET";
|
|
11172
|
+
readonly path: "/ticket/v1/activity";
|
|
11173
|
+
readonly streaming: "no";
|
|
11174
|
+
readonly pagination: false;
|
|
11175
|
+
readonly pathParams: readonly [];
|
|
11176
|
+
readonly query: readonly [{
|
|
11177
|
+
readonly name: "repository";
|
|
11178
|
+
readonly type: "string";
|
|
11179
|
+
readonly required: false;
|
|
11180
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11181
|
+
}, {
|
|
11182
|
+
readonly name: "page_size";
|
|
11183
|
+
readonly type: "integer";
|
|
11184
|
+
readonly required: false;
|
|
11185
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11186
|
+
}, {
|
|
11187
|
+
readonly name: "page_token";
|
|
11188
|
+
readonly type: "string";
|
|
11189
|
+
readonly required: false;
|
|
11190
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11191
|
+
}, {
|
|
11192
|
+
readonly name: "filter";
|
|
11193
|
+
readonly type: "string";
|
|
11194
|
+
readonly required: false;
|
|
11195
|
+
readonly description: "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service.";
|
|
11196
|
+
}];
|
|
11197
|
+
}, {
|
|
11198
|
+
readonly resource: "ticket.comments";
|
|
11199
|
+
readonly method: "delete";
|
|
11200
|
+
readonly summary: "Remove comments";
|
|
11201
|
+
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.";
|
|
11202
|
+
readonly http: "DELETE";
|
|
11203
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11204
|
+
readonly streaming: "no";
|
|
11205
|
+
readonly pagination: false;
|
|
11206
|
+
readonly pathParams: readonly [{
|
|
11207
|
+
readonly name: "id";
|
|
11208
|
+
readonly sdkName: "id";
|
|
11209
|
+
}];
|
|
11210
|
+
readonly query: readonly [{
|
|
11211
|
+
readonly name: "repository";
|
|
11212
|
+
readonly type: "string";
|
|
11213
|
+
readonly required: false;
|
|
11214
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11215
|
+
}];
|
|
11216
|
+
}, {
|
|
11217
|
+
readonly resource: "ticket.comments";
|
|
11218
|
+
readonly method: "retrieve";
|
|
11219
|
+
readonly summary: "Read comments";
|
|
11220
|
+
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.";
|
|
11221
|
+
readonly http: "GET";
|
|
11222
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11223
|
+
readonly streaming: "no";
|
|
11224
|
+
readonly pagination: false;
|
|
11225
|
+
readonly pathParams: readonly [{
|
|
11226
|
+
readonly name: "id";
|
|
11227
|
+
readonly sdkName: "id";
|
|
11228
|
+
}];
|
|
11229
|
+
readonly query: readonly [{
|
|
11230
|
+
readonly name: "repository";
|
|
11231
|
+
readonly type: "string";
|
|
11232
|
+
readonly required: false;
|
|
11233
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11234
|
+
}];
|
|
11235
|
+
}, {
|
|
11236
|
+
readonly resource: "ticket.comments";
|
|
11237
|
+
readonly method: "update";
|
|
11238
|
+
readonly summary: "Update comments";
|
|
11239
|
+
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.";
|
|
11240
|
+
readonly http: "PATCH";
|
|
11241
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11242
|
+
readonly streaming: "no";
|
|
11243
|
+
readonly pagination: false;
|
|
11244
|
+
readonly pathParams: readonly [{
|
|
11245
|
+
readonly name: "id";
|
|
11246
|
+
readonly sdkName: "id";
|
|
11247
|
+
}];
|
|
11248
|
+
readonly query: readonly [{
|
|
11249
|
+
readonly name: "repository";
|
|
11250
|
+
readonly type: "string";
|
|
11251
|
+
readonly required: false;
|
|
11252
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11253
|
+
}];
|
|
11254
|
+
readonly body: {
|
|
11255
|
+
readonly required: true;
|
|
11256
|
+
readonly fields: readonly [{
|
|
11257
|
+
readonly name: "body";
|
|
11258
|
+
readonly type: "string";
|
|
11259
|
+
readonly required: true;
|
|
11260
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11261
|
+
}, {
|
|
11262
|
+
readonly name: "in_reply_to";
|
|
11263
|
+
readonly type: "string";
|
|
11264
|
+
readonly required: false;
|
|
11265
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11266
|
+
}];
|
|
11267
|
+
};
|
|
11268
|
+
}, {
|
|
11269
|
+
readonly resource: "ticket.comments.reactions";
|
|
11270
|
+
readonly method: "list";
|
|
11271
|
+
readonly summary: "List reactions";
|
|
11272
|
+
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.";
|
|
11273
|
+
readonly http: "GET";
|
|
11274
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11275
|
+
readonly streaming: "no";
|
|
11276
|
+
readonly pagination: false;
|
|
11277
|
+
readonly pathParams: readonly [{
|
|
11278
|
+
readonly name: "id";
|
|
11279
|
+
readonly sdkName: "id";
|
|
11280
|
+
}];
|
|
11281
|
+
readonly query: readonly [{
|
|
11282
|
+
readonly name: "repository";
|
|
11283
|
+
readonly type: "string";
|
|
11284
|
+
readonly required: false;
|
|
11285
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11286
|
+
}, {
|
|
11287
|
+
readonly name: "page_size";
|
|
11288
|
+
readonly type: "integer";
|
|
11289
|
+
readonly required: false;
|
|
11290
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11291
|
+
}, {
|
|
11292
|
+
readonly name: "page_token";
|
|
11293
|
+
readonly type: "string";
|
|
11294
|
+
readonly required: false;
|
|
11295
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11296
|
+
}];
|
|
11297
|
+
}, {
|
|
11298
|
+
readonly resource: "ticket.comments.reactions";
|
|
11299
|
+
readonly method: "create";
|
|
11300
|
+
readonly summary: "Create or add reactions";
|
|
11301
|
+
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.";
|
|
11302
|
+
readonly http: "POST";
|
|
11303
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11304
|
+
readonly streaming: "no";
|
|
11305
|
+
readonly pagination: false;
|
|
11306
|
+
readonly pathParams: readonly [{
|
|
11307
|
+
readonly name: "id";
|
|
11308
|
+
readonly sdkName: "id";
|
|
11309
|
+
}];
|
|
11310
|
+
readonly query: readonly [{
|
|
11311
|
+
readonly name: "repository";
|
|
11312
|
+
readonly type: "string";
|
|
11313
|
+
readonly required: false;
|
|
11314
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11315
|
+
}];
|
|
11316
|
+
readonly body: {
|
|
11317
|
+
readonly required: true;
|
|
11318
|
+
readonly fields: readonly [{
|
|
11319
|
+
readonly name: "content";
|
|
11320
|
+
readonly type: "string";
|
|
11321
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11322
|
+
readonly required: true;
|
|
11323
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11324
|
+
}];
|
|
11325
|
+
};
|
|
11326
|
+
}, {
|
|
11327
|
+
readonly resource: "ticket.comments.reactions";
|
|
11328
|
+
readonly method: "delete";
|
|
11329
|
+
readonly summary: "Remove reactions";
|
|
11330
|
+
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.";
|
|
11331
|
+
readonly http: "DELETE";
|
|
11332
|
+
readonly path: "/ticket/v1/comments/{id}/reactions/{content}";
|
|
11333
|
+
readonly streaming: "no";
|
|
11334
|
+
readonly pagination: false;
|
|
11335
|
+
readonly pathParams: readonly [{
|
|
11336
|
+
readonly name: "id";
|
|
11337
|
+
readonly sdkName: "id";
|
|
11338
|
+
}, {
|
|
11339
|
+
readonly name: "content";
|
|
11340
|
+
readonly sdkName: "content";
|
|
11341
|
+
}];
|
|
11342
|
+
readonly query: readonly [{
|
|
11343
|
+
readonly name: "repository";
|
|
11344
|
+
readonly type: "string";
|
|
11345
|
+
readonly required: false;
|
|
11346
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11347
|
+
}];
|
|
11348
|
+
}, {
|
|
11349
|
+
readonly resource: "ticket.labels";
|
|
11350
|
+
readonly method: "list";
|
|
11351
|
+
readonly summary: "List labels";
|
|
11352
|
+
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.";
|
|
11353
|
+
readonly http: "GET";
|
|
11354
|
+
readonly path: "/ticket/v1/labels";
|
|
11355
|
+
readonly streaming: "no";
|
|
11356
|
+
readonly pagination: false;
|
|
11357
|
+
readonly pathParams: readonly [];
|
|
11358
|
+
readonly query: readonly [{
|
|
11359
|
+
readonly name: "repository";
|
|
11360
|
+
readonly type: "string";
|
|
11361
|
+
readonly required: false;
|
|
11362
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11363
|
+
}, {
|
|
11364
|
+
readonly name: "page_size";
|
|
11365
|
+
readonly type: "integer";
|
|
11366
|
+
readonly required: false;
|
|
11367
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11368
|
+
}, {
|
|
11369
|
+
readonly name: "page_token";
|
|
11370
|
+
readonly type: "string";
|
|
11371
|
+
readonly required: false;
|
|
11372
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11373
|
+
}];
|
|
11374
|
+
}, {
|
|
11375
|
+
readonly resource: "ticket.labels";
|
|
11376
|
+
readonly method: "create";
|
|
11377
|
+
readonly summary: "Create or add labels";
|
|
11378
|
+
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.";
|
|
11379
|
+
readonly http: "POST";
|
|
11380
|
+
readonly path: "/ticket/v1/labels";
|
|
11381
|
+
readonly streaming: "no";
|
|
11382
|
+
readonly pagination: false;
|
|
11383
|
+
readonly pathParams: readonly [];
|
|
11384
|
+
readonly query: readonly [{
|
|
11385
|
+
readonly name: "repository";
|
|
11386
|
+
readonly type: "string";
|
|
11387
|
+
readonly required: false;
|
|
11388
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11389
|
+
}];
|
|
11390
|
+
readonly body: {
|
|
11391
|
+
readonly required: true;
|
|
11392
|
+
readonly fields: readonly [{
|
|
11393
|
+
readonly name: "name";
|
|
11394
|
+
readonly type: "string";
|
|
11395
|
+
readonly required: true;
|
|
11396
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11397
|
+
}, {
|
|
11398
|
+
readonly name: "color";
|
|
11399
|
+
readonly type: "string";
|
|
11400
|
+
readonly required: true;
|
|
11401
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11402
|
+
}, {
|
|
11403
|
+
readonly name: "description";
|
|
11404
|
+
readonly type: "string";
|
|
11405
|
+
readonly required: false;
|
|
11406
|
+
readonly description: "Label's purpose.";
|
|
11407
|
+
}];
|
|
11408
|
+
};
|
|
11409
|
+
}, {
|
|
11410
|
+
readonly resource: "ticket.labels";
|
|
11411
|
+
readonly method: "delete";
|
|
11412
|
+
readonly summary: "Remove labels";
|
|
11413
|
+
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.";
|
|
11414
|
+
readonly http: "DELETE";
|
|
11415
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11416
|
+
readonly streaming: "no";
|
|
11417
|
+
readonly pagination: false;
|
|
11418
|
+
readonly pathParams: readonly [{
|
|
11419
|
+
readonly name: "name";
|
|
11420
|
+
readonly sdkName: "name";
|
|
11421
|
+
}];
|
|
11422
|
+
readonly query: readonly [{
|
|
11423
|
+
readonly name: "repository";
|
|
11424
|
+
readonly type: "string";
|
|
11425
|
+
readonly required: false;
|
|
11426
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11427
|
+
}];
|
|
11428
|
+
}, {
|
|
11429
|
+
readonly resource: "ticket.labels";
|
|
11430
|
+
readonly method: "update";
|
|
11431
|
+
readonly summary: "Update labels";
|
|
11432
|
+
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.";
|
|
11433
|
+
readonly http: "PATCH";
|
|
11434
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11435
|
+
readonly streaming: "no";
|
|
11436
|
+
readonly pagination: false;
|
|
11437
|
+
readonly pathParams: readonly [{
|
|
11438
|
+
readonly name: "name";
|
|
11439
|
+
readonly sdkName: "name";
|
|
11440
|
+
}];
|
|
11441
|
+
readonly query: readonly [{
|
|
11442
|
+
readonly name: "repository";
|
|
11443
|
+
readonly type: "string";
|
|
11444
|
+
readonly required: false;
|
|
11445
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11446
|
+
}];
|
|
11447
|
+
readonly body: {
|
|
11448
|
+
readonly required: true;
|
|
11449
|
+
readonly fields: readonly [{
|
|
11450
|
+
readonly name: "color";
|
|
11451
|
+
readonly type: "string";
|
|
11452
|
+
readonly required: false;
|
|
11453
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11454
|
+
}, {
|
|
11455
|
+
readonly name: "description";
|
|
11456
|
+
readonly type: "string";
|
|
11457
|
+
readonly required: false;
|
|
11458
|
+
readonly description: "Label's purpose.";
|
|
11459
|
+
}, {
|
|
11460
|
+
readonly name: "new_name";
|
|
11461
|
+
readonly type: "string";
|
|
11462
|
+
readonly required: false;
|
|
11463
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11464
|
+
}];
|
|
11465
|
+
};
|
|
11466
|
+
}, {
|
|
11467
|
+
readonly resource: "ticket.milestones";
|
|
11468
|
+
readonly method: "list";
|
|
11469
|
+
readonly summary: "List milestones";
|
|
11470
|
+
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.";
|
|
11471
|
+
readonly http: "GET";
|
|
11472
|
+
readonly path: "/ticket/v1/milestones";
|
|
11473
|
+
readonly streaming: "no";
|
|
11474
|
+
readonly pagination: false;
|
|
11475
|
+
readonly pathParams: readonly [];
|
|
11476
|
+
readonly query: readonly [{
|
|
11477
|
+
readonly name: "repository";
|
|
11478
|
+
readonly type: "string";
|
|
11479
|
+
readonly required: false;
|
|
11480
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11481
|
+
}, {
|
|
11482
|
+
readonly name: "page_size";
|
|
11483
|
+
readonly type: "integer";
|
|
11484
|
+
readonly required: false;
|
|
11485
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11486
|
+
}, {
|
|
11487
|
+
readonly name: "page_token";
|
|
11488
|
+
readonly type: "string";
|
|
11489
|
+
readonly required: false;
|
|
11490
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11491
|
+
}];
|
|
11492
|
+
}, {
|
|
11493
|
+
readonly resource: "ticket.milestones";
|
|
11494
|
+
readonly method: "create";
|
|
11495
|
+
readonly summary: "Create or add milestones";
|
|
11496
|
+
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.";
|
|
11497
|
+
readonly http: "POST";
|
|
11498
|
+
readonly path: "/ticket/v1/milestones";
|
|
11499
|
+
readonly streaming: "no";
|
|
11500
|
+
readonly pagination: false;
|
|
11501
|
+
readonly pathParams: readonly [];
|
|
11502
|
+
readonly query: readonly [{
|
|
11503
|
+
readonly name: "repository";
|
|
11504
|
+
readonly type: "string";
|
|
11505
|
+
readonly required: false;
|
|
11506
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11507
|
+
}];
|
|
11508
|
+
readonly body: {
|
|
11509
|
+
readonly required: true;
|
|
11510
|
+
readonly fields: readonly [{
|
|
11511
|
+
readonly name: "title";
|
|
11512
|
+
readonly type: "string";
|
|
11513
|
+
readonly required: true;
|
|
11514
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11515
|
+
}, {
|
|
11516
|
+
readonly name: "description";
|
|
11517
|
+
readonly type: "string";
|
|
11518
|
+
readonly required: false;
|
|
11519
|
+
readonly description: "Milestone description.";
|
|
11520
|
+
}, {
|
|
11521
|
+
readonly name: "due_on";
|
|
11522
|
+
readonly type: "string";
|
|
11523
|
+
readonly required: false;
|
|
11524
|
+
readonly description: "Due date, or null if unset.";
|
|
11525
|
+
}, {
|
|
11526
|
+
readonly name: "state";
|
|
11527
|
+
readonly type: "string";
|
|
11528
|
+
readonly enum: readonly ["open", "closed"];
|
|
11529
|
+
readonly required: false;
|
|
11530
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11531
|
+
}];
|
|
11532
|
+
};
|
|
11533
|
+
}, {
|
|
11534
|
+
readonly resource: "ticket.milestones";
|
|
11535
|
+
readonly method: "delete";
|
|
11536
|
+
readonly summary: "Remove milestones";
|
|
11537
|
+
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.";
|
|
11538
|
+
readonly http: "DELETE";
|
|
11539
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11540
|
+
readonly streaming: "no";
|
|
11541
|
+
readonly pagination: false;
|
|
11542
|
+
readonly pathParams: readonly [{
|
|
11543
|
+
readonly name: "number";
|
|
11544
|
+
readonly sdkName: "number";
|
|
11545
|
+
}];
|
|
11546
|
+
readonly query: readonly [{
|
|
11547
|
+
readonly name: "repository";
|
|
11548
|
+
readonly type: "string";
|
|
11549
|
+
readonly required: false;
|
|
11550
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11551
|
+
}];
|
|
11552
|
+
}, {
|
|
11553
|
+
readonly resource: "ticket.milestones";
|
|
11554
|
+
readonly method: "retrieve";
|
|
11555
|
+
readonly summary: "Read milestones";
|
|
11556
|
+
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.";
|
|
11557
|
+
readonly http: "GET";
|
|
11558
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11559
|
+
readonly streaming: "no";
|
|
11560
|
+
readonly pagination: false;
|
|
11561
|
+
readonly pathParams: readonly [{
|
|
11562
|
+
readonly name: "number";
|
|
11563
|
+
readonly sdkName: "number";
|
|
11564
|
+
}];
|
|
11565
|
+
readonly query: readonly [{
|
|
11566
|
+
readonly name: "repository";
|
|
11567
|
+
readonly type: "string";
|
|
11568
|
+
readonly required: false;
|
|
11569
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11570
|
+
}];
|
|
11571
|
+
}, {
|
|
11572
|
+
readonly resource: "ticket.milestones";
|
|
11573
|
+
readonly method: "update";
|
|
11574
|
+
readonly summary: "Update milestones";
|
|
11575
|
+
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.";
|
|
11576
|
+
readonly http: "PATCH";
|
|
11577
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11578
|
+
readonly streaming: "no";
|
|
11579
|
+
readonly pagination: false;
|
|
11580
|
+
readonly pathParams: readonly [{
|
|
11581
|
+
readonly name: "number";
|
|
11582
|
+
readonly sdkName: "number";
|
|
11583
|
+
}];
|
|
11584
|
+
readonly query: readonly [{
|
|
11585
|
+
readonly name: "repository";
|
|
11586
|
+
readonly type: "string";
|
|
11587
|
+
readonly required: false;
|
|
11588
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11589
|
+
}];
|
|
11590
|
+
readonly body: {
|
|
11591
|
+
readonly required: true;
|
|
11592
|
+
readonly fields: readonly [{
|
|
11593
|
+
readonly name: "title";
|
|
11594
|
+
readonly type: "string";
|
|
11595
|
+
readonly required: false;
|
|
11596
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11597
|
+
}, {
|
|
11598
|
+
readonly name: "description";
|
|
11599
|
+
readonly type: "string";
|
|
11600
|
+
readonly required: false;
|
|
11601
|
+
readonly description: "Milestone description.";
|
|
11602
|
+
}, {
|
|
11603
|
+
readonly name: "due_on";
|
|
11604
|
+
readonly type: "string";
|
|
11605
|
+
readonly required: false;
|
|
11606
|
+
readonly description: "Due date, or null if unset.";
|
|
11607
|
+
}, {
|
|
11608
|
+
readonly name: "state";
|
|
11609
|
+
readonly type: "string";
|
|
11610
|
+
readonly enum: readonly ["open", "closed"];
|
|
11611
|
+
readonly required: false;
|
|
11612
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11613
|
+
}];
|
|
11614
|
+
};
|
|
11615
|
+
}, {
|
|
11616
|
+
readonly resource: "ticket.repositories";
|
|
11617
|
+
readonly method: "list";
|
|
11618
|
+
readonly summary: "List repositories";
|
|
11619
|
+
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.";
|
|
11620
|
+
readonly http: "GET";
|
|
11621
|
+
readonly path: "/ticket/v1/repositories";
|
|
11622
|
+
readonly streaming: "no";
|
|
11623
|
+
readonly pagination: false;
|
|
11624
|
+
readonly pathParams: readonly [];
|
|
11625
|
+
readonly query: readonly [{
|
|
11626
|
+
readonly name: "page_size";
|
|
11627
|
+
readonly type: "integer";
|
|
11628
|
+
readonly required: false;
|
|
11629
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11630
|
+
}, {
|
|
11631
|
+
readonly name: "page_token";
|
|
11632
|
+
readonly type: "string";
|
|
11633
|
+
readonly required: false;
|
|
11634
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11635
|
+
}];
|
|
11636
|
+
}, {
|
|
11637
|
+
readonly resource: "ticket.tickets";
|
|
11638
|
+
readonly method: "list";
|
|
11639
|
+
readonly summary: "List tickets";
|
|
11640
|
+
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.";
|
|
11641
|
+
readonly http: "GET";
|
|
11642
|
+
readonly path: "/ticket/v1/tickets";
|
|
11643
|
+
readonly streaming: "no";
|
|
11644
|
+
readonly pagination: false;
|
|
11645
|
+
readonly pathParams: readonly [];
|
|
11646
|
+
readonly query: readonly [{
|
|
11647
|
+
readonly name: "repository";
|
|
11648
|
+
readonly type: "string";
|
|
11649
|
+
readonly required: false;
|
|
11650
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11651
|
+
}, {
|
|
11652
|
+
readonly name: "page_size";
|
|
11653
|
+
readonly type: "integer";
|
|
11654
|
+
readonly required: false;
|
|
11655
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11656
|
+
}, {
|
|
11657
|
+
readonly name: "page_token";
|
|
11658
|
+
readonly type: "string";
|
|
11659
|
+
readonly required: false;
|
|
11660
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11661
|
+
}, {
|
|
11662
|
+
readonly name: "filter";
|
|
11663
|
+
readonly type: "string";
|
|
11664
|
+
readonly required: false;
|
|
11665
|
+
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.";
|
|
11666
|
+
}];
|
|
11667
|
+
}, {
|
|
11668
|
+
readonly resource: "ticket.tickets";
|
|
11669
|
+
readonly method: "create";
|
|
11670
|
+
readonly summary: "Create or add tickets";
|
|
11671
|
+
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.";
|
|
11672
|
+
readonly http: "POST";
|
|
11673
|
+
readonly path: "/ticket/v1/tickets";
|
|
11674
|
+
readonly streaming: "no";
|
|
11675
|
+
readonly pagination: false;
|
|
11676
|
+
readonly pathParams: readonly [];
|
|
11677
|
+
readonly query: readonly [{
|
|
11678
|
+
readonly name: "repository";
|
|
11679
|
+
readonly type: "string";
|
|
11680
|
+
readonly required: false;
|
|
11681
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11682
|
+
}];
|
|
11683
|
+
readonly body: {
|
|
11684
|
+
readonly required: true;
|
|
11685
|
+
readonly fields: readonly [{
|
|
11686
|
+
readonly name: "title";
|
|
11687
|
+
readonly type: "string";
|
|
11688
|
+
readonly required: true;
|
|
11689
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11690
|
+
}, {
|
|
11691
|
+
readonly name: "body";
|
|
11692
|
+
readonly type: "string";
|
|
11693
|
+
readonly required: false;
|
|
11694
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11695
|
+
}, {
|
|
11696
|
+
readonly name: "type";
|
|
11697
|
+
readonly type: "string";
|
|
11698
|
+
readonly required: false;
|
|
11699
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11700
|
+
}, {
|
|
11701
|
+
readonly name: "labels";
|
|
11702
|
+
readonly type: "array";
|
|
11703
|
+
readonly itemType: "string";
|
|
11704
|
+
readonly required: false;
|
|
11705
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11706
|
+
}, {
|
|
11707
|
+
readonly name: "assignees";
|
|
11708
|
+
readonly type: "array";
|
|
11709
|
+
readonly itemType: "string";
|
|
11710
|
+
readonly required: false;
|
|
11711
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11712
|
+
}, {
|
|
11713
|
+
readonly name: "milestone";
|
|
11714
|
+
readonly type: "integer";
|
|
11715
|
+
readonly required: false;
|
|
11716
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11717
|
+
}, {
|
|
11718
|
+
readonly name: "parent";
|
|
11719
|
+
readonly type: "integer";
|
|
11720
|
+
readonly required: false;
|
|
11721
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11722
|
+
}];
|
|
11723
|
+
};
|
|
11724
|
+
}, {
|
|
11725
|
+
readonly resource: "ticket.tickets";
|
|
11726
|
+
readonly method: "retrieve";
|
|
11727
|
+
readonly summary: "Read tickets";
|
|
11728
|
+
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.";
|
|
11729
|
+
readonly http: "GET";
|
|
11730
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11731
|
+
readonly streaming: "no";
|
|
11732
|
+
readonly pagination: false;
|
|
11733
|
+
readonly pathParams: readonly [{
|
|
11734
|
+
readonly name: "number";
|
|
11735
|
+
readonly sdkName: "number";
|
|
11736
|
+
}];
|
|
11737
|
+
readonly query: readonly [{
|
|
11738
|
+
readonly name: "repository";
|
|
11739
|
+
readonly type: "string";
|
|
11740
|
+
readonly required: false;
|
|
11741
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11742
|
+
}];
|
|
11743
|
+
}, {
|
|
11744
|
+
readonly resource: "ticket.tickets";
|
|
11745
|
+
readonly method: "update";
|
|
11746
|
+
readonly summary: "Update tickets";
|
|
11747
|
+
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.";
|
|
11748
|
+
readonly http: "PATCH";
|
|
11749
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11750
|
+
readonly streaming: "no";
|
|
11751
|
+
readonly pagination: false;
|
|
11752
|
+
readonly pathParams: readonly [{
|
|
11753
|
+
readonly name: "number";
|
|
11754
|
+
readonly sdkName: "number";
|
|
11755
|
+
}];
|
|
11756
|
+
readonly query: readonly [{
|
|
11757
|
+
readonly name: "repository";
|
|
11758
|
+
readonly type: "string";
|
|
11759
|
+
readonly required: false;
|
|
11760
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11761
|
+
}];
|
|
11762
|
+
readonly body: {
|
|
11763
|
+
readonly required: true;
|
|
11764
|
+
readonly fields: readonly [{
|
|
11765
|
+
readonly name: "title";
|
|
11766
|
+
readonly type: "string";
|
|
11767
|
+
readonly required: false;
|
|
11768
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11769
|
+
}, {
|
|
11770
|
+
readonly name: "body";
|
|
11771
|
+
readonly type: "string";
|
|
11772
|
+
readonly required: false;
|
|
11773
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11774
|
+
}, {
|
|
11775
|
+
readonly name: "type";
|
|
11776
|
+
readonly type: "string";
|
|
11777
|
+
readonly required: false;
|
|
11778
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11779
|
+
}, {
|
|
11780
|
+
readonly name: "labels";
|
|
11781
|
+
readonly type: "array";
|
|
11782
|
+
readonly itemType: "string";
|
|
11783
|
+
readonly required: false;
|
|
11784
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11785
|
+
}, {
|
|
11786
|
+
readonly name: "assignees";
|
|
11787
|
+
readonly type: "array";
|
|
11788
|
+
readonly itemType: "string";
|
|
11789
|
+
readonly required: false;
|
|
11790
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11791
|
+
}, {
|
|
11792
|
+
readonly name: "milestone";
|
|
11793
|
+
readonly type: "integer";
|
|
11794
|
+
readonly required: false;
|
|
11795
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11796
|
+
}, {
|
|
11797
|
+
readonly name: "state";
|
|
11798
|
+
readonly type: "string";
|
|
11799
|
+
readonly enum: readonly ["open", "closed"];
|
|
11800
|
+
readonly required: false;
|
|
11801
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11802
|
+
}, {
|
|
11803
|
+
readonly name: "state_reason";
|
|
11804
|
+
readonly type: "string";
|
|
11805
|
+
readonly enum: readonly ["completed", "not_planned", "duplicate"];
|
|
11806
|
+
readonly required: false;
|
|
11807
|
+
readonly description: "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate.";
|
|
11808
|
+
}, {
|
|
11809
|
+
readonly name: "duplicate_of";
|
|
11810
|
+
readonly type: "integer";
|
|
11811
|
+
readonly required: false;
|
|
11812
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11813
|
+
}];
|
|
11814
|
+
};
|
|
11815
|
+
}, {
|
|
11816
|
+
readonly resource: "ticket.tickets.comments";
|
|
11817
|
+
readonly method: "list";
|
|
11818
|
+
readonly summary: "List comments";
|
|
11819
|
+
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.";
|
|
11820
|
+
readonly http: "GET";
|
|
11821
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11822
|
+
readonly streaming: "no";
|
|
11823
|
+
readonly pagination: false;
|
|
11824
|
+
readonly pathParams: readonly [{
|
|
11825
|
+
readonly name: "number";
|
|
11826
|
+
readonly sdkName: "number";
|
|
11827
|
+
}];
|
|
11828
|
+
readonly query: readonly [{
|
|
11829
|
+
readonly name: "repository";
|
|
11830
|
+
readonly type: "string";
|
|
11831
|
+
readonly required: false;
|
|
11832
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11833
|
+
}, {
|
|
11834
|
+
readonly name: "page_size";
|
|
11835
|
+
readonly type: "integer";
|
|
11836
|
+
readonly required: false;
|
|
11837
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11838
|
+
}, {
|
|
11839
|
+
readonly name: "page_token";
|
|
11840
|
+
readonly type: "string";
|
|
11841
|
+
readonly required: false;
|
|
11842
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11843
|
+
}];
|
|
11844
|
+
}, {
|
|
11845
|
+
readonly resource: "ticket.tickets.comments";
|
|
11846
|
+
readonly method: "create";
|
|
11847
|
+
readonly summary: "Create or add comments";
|
|
11848
|
+
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.";
|
|
11849
|
+
readonly http: "POST";
|
|
11850
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11851
|
+
readonly streaming: "no";
|
|
11852
|
+
readonly pagination: false;
|
|
11853
|
+
readonly pathParams: readonly [{
|
|
11854
|
+
readonly name: "number";
|
|
11855
|
+
readonly sdkName: "number";
|
|
11856
|
+
}];
|
|
11857
|
+
readonly query: readonly [{
|
|
11858
|
+
readonly name: "repository";
|
|
11859
|
+
readonly type: "string";
|
|
11860
|
+
readonly required: false;
|
|
11861
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11862
|
+
}];
|
|
11863
|
+
readonly body: {
|
|
11864
|
+
readonly required: true;
|
|
11865
|
+
readonly fields: readonly [{
|
|
11866
|
+
readonly name: "body";
|
|
11867
|
+
readonly type: "string";
|
|
11868
|
+
readonly required: true;
|
|
11869
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11870
|
+
}, {
|
|
11871
|
+
readonly name: "in_reply_to";
|
|
11872
|
+
readonly type: "string";
|
|
11873
|
+
readonly required: false;
|
|
11874
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11875
|
+
}];
|
|
11876
|
+
};
|
|
11877
|
+
}, {
|
|
11878
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11879
|
+
readonly method: "retrieveBlockedBy";
|
|
11880
|
+
readonly summary: "List blocked by";
|
|
11881
|
+
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.";
|
|
11882
|
+
readonly http: "GET";
|
|
11883
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11884
|
+
readonly streaming: "no";
|
|
11885
|
+
readonly pagination: false;
|
|
11886
|
+
readonly pathParams: readonly [{
|
|
11887
|
+
readonly name: "number";
|
|
11888
|
+
readonly sdkName: "number";
|
|
11889
|
+
}];
|
|
11890
|
+
readonly query: readonly [{
|
|
11891
|
+
readonly name: "repository";
|
|
11892
|
+
readonly type: "string";
|
|
11893
|
+
readonly required: false;
|
|
11894
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11895
|
+
}, {
|
|
11896
|
+
readonly name: "page_size";
|
|
11897
|
+
readonly type: "integer";
|
|
11898
|
+
readonly required: false;
|
|
11899
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11900
|
+
}, {
|
|
11901
|
+
readonly name: "page_token";
|
|
11902
|
+
readonly type: "string";
|
|
11903
|
+
readonly required: false;
|
|
11904
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11905
|
+
}];
|
|
11906
|
+
}, {
|
|
11907
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11908
|
+
readonly method: "create";
|
|
11909
|
+
readonly summary: "Create or add blocked by";
|
|
11910
|
+
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.";
|
|
11911
|
+
readonly http: "POST";
|
|
11912
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11913
|
+
readonly streaming: "no";
|
|
11914
|
+
readonly pagination: false;
|
|
11915
|
+
readonly pathParams: readonly [{
|
|
11916
|
+
readonly name: "number";
|
|
11917
|
+
readonly sdkName: "number";
|
|
11918
|
+
}];
|
|
11919
|
+
readonly query: readonly [{
|
|
11920
|
+
readonly name: "repository";
|
|
11921
|
+
readonly type: "string";
|
|
11922
|
+
readonly required: false;
|
|
11923
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11924
|
+
}];
|
|
11925
|
+
readonly body: {
|
|
11926
|
+
readonly required: true;
|
|
11927
|
+
readonly fields: readonly [{
|
|
11928
|
+
readonly name: "blocked_by";
|
|
11929
|
+
readonly type: "integer";
|
|
11930
|
+
readonly required: true;
|
|
11931
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11932
|
+
}];
|
|
11933
|
+
};
|
|
11934
|
+
}, {
|
|
11935
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11936
|
+
readonly method: "delete";
|
|
11937
|
+
readonly summary: "Remove blocked by";
|
|
11938
|
+
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.";
|
|
11939
|
+
readonly http: "DELETE";
|
|
11940
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}";
|
|
11941
|
+
readonly streaming: "no";
|
|
11942
|
+
readonly pagination: false;
|
|
11943
|
+
readonly pathParams: readonly [{
|
|
11944
|
+
readonly name: "number";
|
|
11945
|
+
readonly sdkName: "number";
|
|
11946
|
+
}, {
|
|
11947
|
+
readonly name: "n";
|
|
11948
|
+
readonly sdkName: "n";
|
|
11949
|
+
}];
|
|
11950
|
+
readonly query: readonly [{
|
|
11951
|
+
readonly name: "repository";
|
|
11952
|
+
readonly type: "string";
|
|
11953
|
+
readonly required: false;
|
|
11954
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11955
|
+
}];
|
|
11956
|
+
}, {
|
|
11957
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11958
|
+
readonly method: "retrieveBlocking";
|
|
11959
|
+
readonly summary: "List blocking";
|
|
11960
|
+
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.";
|
|
11961
|
+
readonly http: "GET";
|
|
11962
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocking";
|
|
11963
|
+
readonly streaming: "no";
|
|
11964
|
+
readonly pagination: false;
|
|
11965
|
+
readonly pathParams: readonly [{
|
|
11966
|
+
readonly name: "number";
|
|
11967
|
+
readonly sdkName: "number";
|
|
11968
|
+
}];
|
|
11969
|
+
readonly query: readonly [{
|
|
11970
|
+
readonly name: "repository";
|
|
11971
|
+
readonly type: "string";
|
|
11972
|
+
readonly required: false;
|
|
11973
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11974
|
+
}, {
|
|
11975
|
+
readonly name: "page_size";
|
|
11976
|
+
readonly type: "integer";
|
|
11977
|
+
readonly required: false;
|
|
11978
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11979
|
+
}, {
|
|
11980
|
+
readonly name: "page_token";
|
|
11981
|
+
readonly type: "string";
|
|
11982
|
+
readonly required: false;
|
|
11983
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11984
|
+
}];
|
|
11985
|
+
}, {
|
|
11986
|
+
readonly resource: "ticket.tickets.events";
|
|
11987
|
+
readonly method: "list";
|
|
11988
|
+
readonly summary: "List events";
|
|
11989
|
+
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.";
|
|
11990
|
+
readonly http: "GET";
|
|
11991
|
+
readonly path: "/ticket/v1/tickets/{number}/events";
|
|
11992
|
+
readonly streaming: "no";
|
|
11993
|
+
readonly pagination: false;
|
|
11994
|
+
readonly pathParams: readonly [{
|
|
11995
|
+
readonly name: "number";
|
|
11996
|
+
readonly sdkName: "number";
|
|
11997
|
+
}];
|
|
11998
|
+
readonly query: readonly [{
|
|
11999
|
+
readonly name: "repository";
|
|
12000
|
+
readonly type: "string";
|
|
12001
|
+
readonly required: false;
|
|
12002
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12003
|
+
}, {
|
|
12004
|
+
readonly name: "page_size";
|
|
12005
|
+
readonly type: "integer";
|
|
12006
|
+
readonly required: false;
|
|
12007
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12008
|
+
}, {
|
|
12009
|
+
readonly name: "page_token";
|
|
12010
|
+
readonly type: "string";
|
|
12011
|
+
readonly required: false;
|
|
12012
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12013
|
+
}];
|
|
12014
|
+
}, {
|
|
12015
|
+
readonly resource: "ticket.tickets";
|
|
12016
|
+
readonly method: "deleteLock";
|
|
12017
|
+
readonly summary: "Remove lock";
|
|
12018
|
+
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.";
|
|
12019
|
+
readonly http: "DELETE";
|
|
12020
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12021
|
+
readonly streaming: "no";
|
|
12022
|
+
readonly pagination: false;
|
|
12023
|
+
readonly pathParams: readonly [{
|
|
12024
|
+
readonly name: "number";
|
|
12025
|
+
readonly sdkName: "number";
|
|
12026
|
+
}];
|
|
12027
|
+
readonly query: readonly [{
|
|
12028
|
+
readonly name: "repository";
|
|
12029
|
+
readonly type: "string";
|
|
12030
|
+
readonly required: false;
|
|
12031
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12032
|
+
}];
|
|
12033
|
+
}, {
|
|
12034
|
+
readonly resource: "ticket.tickets";
|
|
12035
|
+
readonly method: "updateLock";
|
|
12036
|
+
readonly summary: "Update lock";
|
|
12037
|
+
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.";
|
|
12038
|
+
readonly http: "PUT";
|
|
12039
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12040
|
+
readonly streaming: "no";
|
|
12041
|
+
readonly pagination: false;
|
|
12042
|
+
readonly pathParams: readonly [{
|
|
12043
|
+
readonly name: "number";
|
|
12044
|
+
readonly sdkName: "number";
|
|
12045
|
+
}];
|
|
12046
|
+
readonly query: readonly [{
|
|
12047
|
+
readonly name: "repository";
|
|
12048
|
+
readonly type: "string";
|
|
12049
|
+
readonly required: false;
|
|
12050
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12051
|
+
}];
|
|
12052
|
+
readonly body: {
|
|
12053
|
+
readonly required: false;
|
|
12054
|
+
readonly fields: readonly [{
|
|
12055
|
+
readonly name: "lock_reason";
|
|
12056
|
+
readonly type: "string";
|
|
12057
|
+
readonly enum: readonly ["off-topic", "too heated", "resolved", "spam"];
|
|
12058
|
+
readonly required: false;
|
|
12059
|
+
readonly description: "Reason for locking: off-topic, too heated, resolved, or spam.";
|
|
12060
|
+
}];
|
|
12061
|
+
};
|
|
12062
|
+
}, {
|
|
12063
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12064
|
+
readonly method: "list";
|
|
12065
|
+
readonly summary: "List reactions";
|
|
12066
|
+
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.";
|
|
12067
|
+
readonly http: "GET";
|
|
12068
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12069
|
+
readonly streaming: "no";
|
|
12070
|
+
readonly pagination: false;
|
|
12071
|
+
readonly pathParams: readonly [{
|
|
12072
|
+
readonly name: "number";
|
|
12073
|
+
readonly sdkName: "number";
|
|
12074
|
+
}];
|
|
12075
|
+
readonly query: readonly [{
|
|
12076
|
+
readonly name: "repository";
|
|
12077
|
+
readonly type: "string";
|
|
12078
|
+
readonly required: false;
|
|
12079
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12080
|
+
}, {
|
|
12081
|
+
readonly name: "page_size";
|
|
12082
|
+
readonly type: "integer";
|
|
12083
|
+
readonly required: false;
|
|
12084
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12085
|
+
}, {
|
|
12086
|
+
readonly name: "page_token";
|
|
12087
|
+
readonly type: "string";
|
|
12088
|
+
readonly required: false;
|
|
12089
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12090
|
+
}];
|
|
12091
|
+
}, {
|
|
12092
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12093
|
+
readonly method: "create";
|
|
12094
|
+
readonly summary: "Create or add reactions";
|
|
12095
|
+
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.";
|
|
12096
|
+
readonly http: "POST";
|
|
12097
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12098
|
+
readonly streaming: "no";
|
|
12099
|
+
readonly pagination: false;
|
|
12100
|
+
readonly pathParams: readonly [{
|
|
12101
|
+
readonly name: "number";
|
|
12102
|
+
readonly sdkName: "number";
|
|
12103
|
+
}];
|
|
12104
|
+
readonly query: readonly [{
|
|
12105
|
+
readonly name: "repository";
|
|
12106
|
+
readonly type: "string";
|
|
12107
|
+
readonly required: false;
|
|
12108
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12109
|
+
}];
|
|
12110
|
+
readonly body: {
|
|
12111
|
+
readonly required: true;
|
|
12112
|
+
readonly fields: readonly [{
|
|
12113
|
+
readonly name: "content";
|
|
12114
|
+
readonly type: "string";
|
|
12115
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
12116
|
+
readonly required: true;
|
|
12117
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
12118
|
+
}];
|
|
12119
|
+
};
|
|
12120
|
+
}, {
|
|
12121
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12122
|
+
readonly method: "delete";
|
|
12123
|
+
readonly summary: "Remove reactions";
|
|
12124
|
+
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.";
|
|
12125
|
+
readonly http: "DELETE";
|
|
12126
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions/{content}";
|
|
12127
|
+
readonly streaming: "no";
|
|
12128
|
+
readonly pagination: false;
|
|
12129
|
+
readonly pathParams: readonly [{
|
|
12130
|
+
readonly name: "number";
|
|
12131
|
+
readonly sdkName: "number";
|
|
12132
|
+
}, {
|
|
12133
|
+
readonly name: "content";
|
|
12134
|
+
readonly sdkName: "content";
|
|
12135
|
+
}];
|
|
12136
|
+
readonly query: readonly [{
|
|
12137
|
+
readonly name: "repository";
|
|
12138
|
+
readonly type: "string";
|
|
12139
|
+
readonly required: false;
|
|
12140
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12141
|
+
}];
|
|
12142
|
+
}, {
|
|
12143
|
+
readonly resource: "ticket.tickets.relations";
|
|
12144
|
+
readonly method: "list";
|
|
12145
|
+
readonly summary: "List relations";
|
|
12146
|
+
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.";
|
|
12147
|
+
readonly http: "GET";
|
|
12148
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12149
|
+
readonly streaming: "no";
|
|
12150
|
+
readonly pagination: false;
|
|
12151
|
+
readonly pathParams: readonly [{
|
|
12152
|
+
readonly name: "number";
|
|
12153
|
+
readonly sdkName: "number";
|
|
12154
|
+
}];
|
|
12155
|
+
readonly query: readonly [{
|
|
12156
|
+
readonly name: "repository";
|
|
12157
|
+
readonly type: "string";
|
|
12158
|
+
readonly required: false;
|
|
12159
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12160
|
+
}, {
|
|
12161
|
+
readonly name: "page_size";
|
|
12162
|
+
readonly type: "integer";
|
|
12163
|
+
readonly required: false;
|
|
12164
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12165
|
+
}, {
|
|
12166
|
+
readonly name: "page_token";
|
|
12167
|
+
readonly type: "string";
|
|
12168
|
+
readonly required: false;
|
|
12169
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12170
|
+
}];
|
|
12171
|
+
}, {
|
|
12172
|
+
readonly resource: "ticket.tickets.relations";
|
|
12173
|
+
readonly method: "create";
|
|
12174
|
+
readonly summary: "Create or add relations";
|
|
12175
|
+
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.";
|
|
12176
|
+
readonly http: "POST";
|
|
12177
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12178
|
+
readonly streaming: "no";
|
|
12179
|
+
readonly pagination: false;
|
|
12180
|
+
readonly pathParams: readonly [{
|
|
12181
|
+
readonly name: "number";
|
|
12182
|
+
readonly sdkName: "number";
|
|
12183
|
+
}];
|
|
12184
|
+
readonly query: readonly [{
|
|
12185
|
+
readonly name: "repository";
|
|
12186
|
+
readonly type: "string";
|
|
12187
|
+
readonly required: false;
|
|
12188
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12189
|
+
}];
|
|
12190
|
+
readonly body: {
|
|
12191
|
+
readonly required: true;
|
|
12192
|
+
readonly fields: readonly [{
|
|
12193
|
+
readonly name: "relates_to";
|
|
12194
|
+
readonly type: "integer";
|
|
12195
|
+
readonly required: true;
|
|
12196
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12197
|
+
}];
|
|
12198
|
+
};
|
|
12199
|
+
}, {
|
|
12200
|
+
readonly resource: "ticket.tickets.relations";
|
|
12201
|
+
readonly method: "delete";
|
|
12202
|
+
readonly summary: "Remove relations";
|
|
12203
|
+
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.";
|
|
12204
|
+
readonly http: "DELETE";
|
|
12205
|
+
readonly path: "/ticket/v1/tickets/{number}/relations/{n}";
|
|
12206
|
+
readonly streaming: "no";
|
|
12207
|
+
readonly pagination: false;
|
|
12208
|
+
readonly pathParams: readonly [{
|
|
12209
|
+
readonly name: "number";
|
|
12210
|
+
readonly sdkName: "number";
|
|
12211
|
+
}, {
|
|
12212
|
+
readonly name: "n";
|
|
12213
|
+
readonly sdkName: "n";
|
|
12214
|
+
}];
|
|
12215
|
+
readonly query: readonly [{
|
|
12216
|
+
readonly name: "repository";
|
|
12217
|
+
readonly type: "string";
|
|
12218
|
+
readonly required: false;
|
|
12219
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12220
|
+
}];
|
|
12221
|
+
}, {
|
|
12222
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12223
|
+
readonly method: "list";
|
|
12224
|
+
readonly summary: "List sub tickets";
|
|
12225
|
+
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.";
|
|
12226
|
+
readonly http: "GET";
|
|
12227
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12228
|
+
readonly streaming: "no";
|
|
12229
|
+
readonly pagination: false;
|
|
12230
|
+
readonly pathParams: readonly [{
|
|
12231
|
+
readonly name: "number";
|
|
12232
|
+
readonly sdkName: "number";
|
|
12233
|
+
}];
|
|
12234
|
+
readonly query: readonly [{
|
|
12235
|
+
readonly name: "repository";
|
|
12236
|
+
readonly type: "string";
|
|
12237
|
+
readonly required: false;
|
|
12238
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12239
|
+
}, {
|
|
12240
|
+
readonly name: "page_size";
|
|
12241
|
+
readonly type: "integer";
|
|
12242
|
+
readonly required: false;
|
|
12243
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12244
|
+
}, {
|
|
12245
|
+
readonly name: "page_token";
|
|
12246
|
+
readonly type: "string";
|
|
12247
|
+
readonly required: false;
|
|
12248
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12249
|
+
}];
|
|
12250
|
+
}, {
|
|
12251
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12252
|
+
readonly method: "create";
|
|
12253
|
+
readonly summary: "Create or add sub tickets";
|
|
12254
|
+
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.";
|
|
12255
|
+
readonly http: "POST";
|
|
12256
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12257
|
+
readonly streaming: "no";
|
|
12258
|
+
readonly pagination: false;
|
|
12259
|
+
readonly pathParams: readonly [{
|
|
12260
|
+
readonly name: "number";
|
|
12261
|
+
readonly sdkName: "number";
|
|
12262
|
+
}];
|
|
12263
|
+
readonly query: readonly [{
|
|
12264
|
+
readonly name: "repository";
|
|
12265
|
+
readonly type: "string";
|
|
12266
|
+
readonly required: false;
|
|
12267
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12268
|
+
}];
|
|
12269
|
+
readonly body: {
|
|
12270
|
+
readonly required: true;
|
|
12271
|
+
readonly fields: readonly [{
|
|
12272
|
+
readonly name: "child";
|
|
12273
|
+
readonly type: "integer";
|
|
12274
|
+
readonly required: true;
|
|
12275
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12276
|
+
}, {
|
|
12277
|
+
readonly name: "replace_parent";
|
|
12278
|
+
readonly type: "boolean";
|
|
12279
|
+
readonly required: false;
|
|
12280
|
+
readonly description: "Allow replacing an existing parent.";
|
|
12281
|
+
}];
|
|
12282
|
+
};
|
|
12283
|
+
}, {
|
|
12284
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12285
|
+
readonly method: "delete";
|
|
12286
|
+
readonly summary: "Remove sub tickets";
|
|
12287
|
+
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.";
|
|
12288
|
+
readonly http: "DELETE";
|
|
12289
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets/{child}";
|
|
12290
|
+
readonly streaming: "no";
|
|
12291
|
+
readonly pagination: false;
|
|
12292
|
+
readonly pathParams: readonly [{
|
|
12293
|
+
readonly name: "number";
|
|
12294
|
+
readonly sdkName: "number";
|
|
12295
|
+
}, {
|
|
12296
|
+
readonly name: "child";
|
|
12297
|
+
readonly sdkName: "child";
|
|
12298
|
+
}];
|
|
12299
|
+
readonly query: readonly [{
|
|
12300
|
+
readonly name: "repository";
|
|
12301
|
+
readonly type: "string";
|
|
12302
|
+
readonly required: false;
|
|
12303
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12304
|
+
}];
|
|
12305
|
+
}, {
|
|
12306
|
+
readonly resource: "ticket.types";
|
|
12307
|
+
readonly method: "list";
|
|
12308
|
+
readonly summary: "Read types";
|
|
12309
|
+
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.";
|
|
12310
|
+
readonly http: "GET";
|
|
12311
|
+
readonly path: "/ticket/v1/types";
|
|
12312
|
+
readonly streaming: "no";
|
|
12313
|
+
readonly pagination: false;
|
|
12314
|
+
readonly pathParams: readonly [];
|
|
12315
|
+
readonly query: readonly [{
|
|
12316
|
+
readonly name: "repository";
|
|
12317
|
+
readonly type: "string";
|
|
12318
|
+
readonly required: false;
|
|
12319
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12320
|
+
}];
|
|
10808
12321
|
}, {
|
|
10809
12322
|
readonly resource: "vault.authorizations";
|
|
10810
12323
|
readonly method: "create";
|