@deepraxis/sdk 0.1.0-dev.13103a0 → 0.1.0-dev.331f4e7
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 +133 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +295 -23
- package/dist/generated/sdk.gen.js +892 -23
- package/dist/generated/types.gen.d.ts +13158 -7848
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1389 -43
- package/dist/operations.generated.js +1740 -44
- package/dist/resources.generated.d.ts +681 -0
- package/dist/resources.generated.js +84 -0
- package/package.json +1 -1
|
@@ -102,6 +102,24 @@ 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: "databases";
|
|
107
|
+
readonly type: "array";
|
|
108
|
+
readonly itemType: "object";
|
|
109
|
+
readonly required: false;
|
|
110
|
+
readonly description: "Database allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
111
|
+
}, {
|
|
112
|
+
readonly name: "vector_stores";
|
|
113
|
+
readonly type: "array";
|
|
114
|
+
readonly itemType: "object";
|
|
115
|
+
readonly required: false;
|
|
116
|
+
readonly description: "Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
117
|
+
}, {
|
|
118
|
+
readonly name: "files";
|
|
119
|
+
readonly type: "array";
|
|
120
|
+
readonly itemType: "object";
|
|
121
|
+
readonly required: false;
|
|
122
|
+
readonly description: "File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
105
123
|
}, {
|
|
106
124
|
readonly name: "kind";
|
|
107
125
|
readonly type: "string";
|
|
@@ -171,7 +189,7 @@ export declare const operations: readonly [{
|
|
|
171
189
|
readonly resource: "agent.agents";
|
|
172
190
|
readonly method: "update";
|
|
173
191
|
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
|
|
192
|
+
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
193
|
readonly http: "POST";
|
|
176
194
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
177
195
|
readonly streaming: "no";
|
|
@@ -236,6 +254,34 @@ export declare const operations: readonly [{
|
|
|
236
254
|
readonly type: "number";
|
|
237
255
|
readonly required: false;
|
|
238
256
|
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.";
|
|
257
|
+
}, {
|
|
258
|
+
readonly name: "apply";
|
|
259
|
+
readonly type: "boolean";
|
|
260
|
+
readonly required: false;
|
|
261
|
+
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.";
|
|
262
|
+
}, {
|
|
263
|
+
readonly name: "version_note";
|
|
264
|
+
readonly type: "string";
|
|
265
|
+
readonly required: false;
|
|
266
|
+
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.";
|
|
267
|
+
}, {
|
|
268
|
+
readonly name: "databases";
|
|
269
|
+
readonly type: "array";
|
|
270
|
+
readonly itemType: "object";
|
|
271
|
+
readonly required: false;
|
|
272
|
+
readonly description: "Replace this resource allowlist; 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 nonempty bindings.";
|
|
273
|
+
}, {
|
|
274
|
+
readonly name: "vector_stores";
|
|
275
|
+
readonly type: "array";
|
|
276
|
+
readonly itemType: "object";
|
|
277
|
+
readonly required: false;
|
|
278
|
+
readonly description: "Replace this resource allowlist; 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 nonempty bindings.";
|
|
279
|
+
}, {
|
|
280
|
+
readonly name: "files";
|
|
281
|
+
readonly type: "array";
|
|
282
|
+
readonly itemType: "object";
|
|
283
|
+
readonly required: false;
|
|
284
|
+
readonly description: "Replace this resource allowlist; 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 nonempty bindings.";
|
|
239
285
|
}, {
|
|
240
286
|
readonly name: "kind";
|
|
241
287
|
readonly type: "string";
|
|
@@ -470,6 +516,23 @@ export declare const operations: readonly [{
|
|
|
470
516
|
readonly required: false;
|
|
471
517
|
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
518
|
}];
|
|
519
|
+
}, {
|
|
520
|
+
readonly resource: "agent.agents.versions";
|
|
521
|
+
readonly method: "apply";
|
|
522
|
+
readonly summary: "Apply Agent Version";
|
|
523
|
+
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.";
|
|
524
|
+
readonly http: "POST";
|
|
525
|
+
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
526
|
+
readonly streaming: "no";
|
|
527
|
+
readonly pagination: false;
|
|
528
|
+
readonly pathParams: readonly [{
|
|
529
|
+
readonly name: "agent_id";
|
|
530
|
+
readonly sdkName: "agent_id";
|
|
531
|
+
}, {
|
|
532
|
+
readonly name: "version";
|
|
533
|
+
readonly sdkName: "version";
|
|
534
|
+
}];
|
|
535
|
+
readonly query: readonly [];
|
|
473
536
|
}, {
|
|
474
537
|
readonly resource: "agent.computers";
|
|
475
538
|
readonly method: "list";
|
|
@@ -608,7 +671,7 @@ export declare const operations: readonly [{
|
|
|
608
671
|
readonly resource: "agent.computers";
|
|
609
672
|
readonly method: "connect";
|
|
610
673
|
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.";
|
|
674
|
+
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
675
|
readonly http: "POST";
|
|
613
676
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
614
677
|
readonly streaming: "no";
|
|
@@ -618,6 +681,16 @@ export declare const operations: readonly [{
|
|
|
618
681
|
readonly sdkName: "computer_id";
|
|
619
682
|
}];
|
|
620
683
|
readonly query: readonly [];
|
|
684
|
+
readonly body: {
|
|
685
|
+
readonly required: false;
|
|
686
|
+
readonly fields: readonly [{
|
|
687
|
+
readonly name: "need";
|
|
688
|
+
readonly type: "string";
|
|
689
|
+
readonly enum: readonly ["light", "heavy"];
|
|
690
|
+
readonly required: false;
|
|
691
|
+
readonly description: "Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds.";
|
|
692
|
+
}];
|
|
693
|
+
};
|
|
621
694
|
}, {
|
|
622
695
|
readonly resource: "agent.computers.files";
|
|
623
696
|
readonly method: "list";
|
|
@@ -1432,7 +1505,7 @@ export declare const operations: readonly [{
|
|
|
1432
1505
|
readonly resource: "agent.sessions";
|
|
1433
1506
|
readonly method: "create";
|
|
1434
1507
|
readonly summary: "Create session";
|
|
1435
|
-
readonly description: "Create a session: one conversation with an agent
|
|
1508
|
+
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.";
|
|
1436
1509
|
readonly http: "POST";
|
|
1437
1510
|
readonly path: "/agent/v1/sessions";
|
|
1438
1511
|
readonly streaming: "no";
|
|
@@ -1450,7 +1523,7 @@ export declare const operations: readonly [{
|
|
|
1450
1523
|
readonly name: "environment_id";
|
|
1451
1524
|
readonly type: "string";
|
|
1452
1525
|
readonly required: false;
|
|
1453
|
-
readonly description: "
|
|
1526
|
+
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.";
|
|
1454
1527
|
}, {
|
|
1455
1528
|
readonly name: "budget";
|
|
1456
1529
|
readonly type: "object";
|
|
@@ -2834,12 +2907,12 @@ export declare const operations: readonly [{
|
|
|
2834
2907
|
readonly name: "namespace";
|
|
2835
2908
|
readonly type: "string";
|
|
2836
2909
|
readonly required: true;
|
|
2837
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
2910
|
+
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}.";
|
|
2838
2911
|
}, {
|
|
2839
2912
|
readonly name: "name";
|
|
2840
2913
|
readonly type: "string";
|
|
2841
2914
|
readonly required: true;
|
|
2842
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
2915
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2843
2916
|
}, {
|
|
2844
2917
|
readonly name: "description";
|
|
2845
2918
|
readonly type: "string";
|
|
@@ -2891,8 +2964,8 @@ export declare const operations: readonly [{
|
|
|
2891
2964
|
}, {
|
|
2892
2965
|
readonly resource: "automation.actions";
|
|
2893
2966
|
readonly method: "retrieve";
|
|
2894
|
-
readonly summary: "Get an
|
|
2895
|
-
readonly description: "Read the
|
|
2967
|
+
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
2968
|
+
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.";
|
|
2896
2969
|
readonly http: "GET";
|
|
2897
2970
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2898
2971
|
readonly streaming: "no";
|
|
@@ -3336,8 +3409,8 @@ export declare const operations: readonly [{
|
|
|
3336
3409
|
}, {
|
|
3337
3410
|
readonly resource: "automation.runs";
|
|
3338
3411
|
readonly method: "create";
|
|
3339
|
-
readonly summary: "
|
|
3340
|
-
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
|
|
3412
|
+
readonly summary: "Run a published target or execute draft source";
|
|
3413
|
+
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.";
|
|
3341
3414
|
readonly http: "POST";
|
|
3342
3415
|
readonly path: "/automation/v1/runs";
|
|
3343
3416
|
readonly streaming: "no";
|
|
@@ -3720,7 +3793,7 @@ export declare const operations: readonly [{
|
|
|
3720
3793
|
readonly resource: "automation.scripts";
|
|
3721
3794
|
readonly method: "create";
|
|
3722
3795
|
readonly summary: "Create a script";
|
|
3723
|
-
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
|
|
3796
|
+
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.";
|
|
3724
3797
|
readonly http: "POST";
|
|
3725
3798
|
readonly path: "/automation/v1/scripts";
|
|
3726
3799
|
readonly streaming: "no";
|
|
@@ -3733,12 +3806,12 @@ export declare const operations: readonly [{
|
|
|
3733
3806
|
readonly name: "namespace";
|
|
3734
3807
|
readonly type: "string";
|
|
3735
3808
|
readonly required: true;
|
|
3736
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3809
|
+
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}.";
|
|
3737
3810
|
}, {
|
|
3738
3811
|
readonly name: "name";
|
|
3739
3812
|
readonly type: "string";
|
|
3740
3813
|
readonly required: true;
|
|
3741
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3814
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3742
3815
|
}, {
|
|
3743
3816
|
readonly name: "description";
|
|
3744
3817
|
readonly type: "string";
|
|
@@ -3777,7 +3850,7 @@ export declare const operations: readonly [{
|
|
|
3777
3850
|
readonly resource: "automation.scripts";
|
|
3778
3851
|
readonly method: "update";
|
|
3779
3852
|
readonly summary: "Update a script draft";
|
|
3780
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
3853
|
+
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.";
|
|
3781
3854
|
readonly http: "PATCH";
|
|
3782
3855
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3783
3856
|
readonly streaming: "no";
|
|
@@ -4536,7 +4609,7 @@ export declare const operations: readonly [{
|
|
|
4536
4609
|
readonly resource: "automation.workflows";
|
|
4537
4610
|
readonly method: "create";
|
|
4538
4611
|
readonly summary: "Create a workflow";
|
|
4539
|
-
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
|
|
4612
|
+
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.";
|
|
4540
4613
|
readonly http: "POST";
|
|
4541
4614
|
readonly path: "/automation/v1/workflows";
|
|
4542
4615
|
readonly streaming: "no";
|
|
@@ -4549,12 +4622,12 @@ export declare const operations: readonly [{
|
|
|
4549
4622
|
readonly name: "namespace";
|
|
4550
4623
|
readonly type: "string";
|
|
4551
4624
|
readonly required: true;
|
|
4552
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4625
|
+
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}.";
|
|
4553
4626
|
}, {
|
|
4554
4627
|
readonly name: "name";
|
|
4555
4628
|
readonly type: "string";
|
|
4556
4629
|
readonly required: true;
|
|
4557
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4630
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4558
4631
|
}, {
|
|
4559
4632
|
readonly name: "description";
|
|
4560
4633
|
readonly type: "string";
|
|
@@ -5492,7 +5565,7 @@ export declare const operations: readonly [{
|
|
|
5492
5565
|
readonly name: "{column}";
|
|
5493
5566
|
readonly type: "string";
|
|
5494
5567
|
readonly required: false;
|
|
5495
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5568
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5496
5569
|
}, {
|
|
5497
5570
|
readonly name: "and";
|
|
5498
5571
|
readonly type: "string";
|
|
@@ -5532,7 +5605,7 @@ export declare const operations: readonly [{
|
|
|
5532
5605
|
readonly name: "on_conflict";
|
|
5533
5606
|
readonly type: "string";
|
|
5534
5607
|
readonly required: false;
|
|
5535
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5608
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5536
5609
|
}, {
|
|
5537
5610
|
readonly name: "columns";
|
|
5538
5611
|
readonly type: "string";
|
|
@@ -5543,7 +5616,7 @@ export declare const operations: readonly [{
|
|
|
5543
5616
|
readonly resource: "database.databases.rest";
|
|
5544
5617
|
readonly method: "retrieve";
|
|
5545
5618
|
readonly summary: "Select rows";
|
|
5546
|
-
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
5619
|
+
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.";
|
|
5547
5620
|
readonly http: "GET";
|
|
5548
5621
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5549
5622
|
readonly streaming: "no";
|
|
@@ -5564,7 +5637,7 @@ export declare const operations: readonly [{
|
|
|
5564
5637
|
readonly name: "{column}";
|
|
5565
5638
|
readonly type: "string";
|
|
5566
5639
|
readonly required: false;
|
|
5567
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5640
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5568
5641
|
}, {
|
|
5569
5642
|
readonly name: "and";
|
|
5570
5643
|
readonly type: "string";
|
|
@@ -5604,7 +5677,7 @@ export declare const operations: readonly [{
|
|
|
5604
5677
|
readonly name: "on_conflict";
|
|
5605
5678
|
readonly type: "string";
|
|
5606
5679
|
readonly required: false;
|
|
5607
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5680
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5608
5681
|
}, {
|
|
5609
5682
|
readonly name: "columns";
|
|
5610
5683
|
readonly type: "string";
|
|
@@ -5615,7 +5688,7 @@ export declare const operations: readonly [{
|
|
|
5615
5688
|
readonly resource: "database.databases.rest";
|
|
5616
5689
|
readonly method: "head";
|
|
5617
5690
|
readonly summary: "Count rows";
|
|
5618
|
-
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
5691
|
+
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.";
|
|
5619
5692
|
readonly http: "HEAD";
|
|
5620
5693
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5621
5694
|
readonly streaming: "no";
|
|
@@ -5636,7 +5709,7 @@ export declare const operations: readonly [{
|
|
|
5636
5709
|
readonly name: "{column}";
|
|
5637
5710
|
readonly type: "string";
|
|
5638
5711
|
readonly required: false;
|
|
5639
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5712
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5640
5713
|
}, {
|
|
5641
5714
|
readonly name: "and";
|
|
5642
5715
|
readonly type: "string";
|
|
@@ -5676,7 +5749,7 @@ export declare const operations: readonly [{
|
|
|
5676
5749
|
readonly name: "on_conflict";
|
|
5677
5750
|
readonly type: "string";
|
|
5678
5751
|
readonly required: false;
|
|
5679
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5752
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5680
5753
|
}, {
|
|
5681
5754
|
readonly name: "columns";
|
|
5682
5755
|
readonly type: "string";
|
|
@@ -5708,7 +5781,7 @@ export declare const operations: readonly [{
|
|
|
5708
5781
|
readonly name: "{column}";
|
|
5709
5782
|
readonly type: "string";
|
|
5710
5783
|
readonly required: false;
|
|
5711
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5784
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5712
5785
|
}, {
|
|
5713
5786
|
readonly name: "and";
|
|
5714
5787
|
readonly type: "string";
|
|
@@ -5748,7 +5821,7 @@ export declare const operations: readonly [{
|
|
|
5748
5821
|
readonly name: "on_conflict";
|
|
5749
5822
|
readonly type: "string";
|
|
5750
5823
|
readonly required: false;
|
|
5751
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5824
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5752
5825
|
}, {
|
|
5753
5826
|
readonly name: "columns";
|
|
5754
5827
|
readonly type: "string";
|
|
@@ -5763,7 +5836,7 @@ export declare const operations: readonly [{
|
|
|
5763
5836
|
readonly resource: "database.databases.rest";
|
|
5764
5837
|
readonly method: "create";
|
|
5765
5838
|
readonly summary: "Insert rows";
|
|
5766
|
-
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5839
|
+
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5767
5840
|
readonly http: "POST";
|
|
5768
5841
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5769
5842
|
readonly streaming: "no";
|
|
@@ -5784,7 +5857,7 @@ export declare const operations: readonly [{
|
|
|
5784
5857
|
readonly name: "{column}";
|
|
5785
5858
|
readonly type: "string";
|
|
5786
5859
|
readonly required: false;
|
|
5787
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5860
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5788
5861
|
}, {
|
|
5789
5862
|
readonly name: "and";
|
|
5790
5863
|
readonly type: "string";
|
|
@@ -5824,7 +5897,7 @@ export declare const operations: readonly [{
|
|
|
5824
5897
|
readonly name: "on_conflict";
|
|
5825
5898
|
readonly type: "string";
|
|
5826
5899
|
readonly required: false;
|
|
5827
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5900
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5828
5901
|
}, {
|
|
5829
5902
|
readonly name: "columns";
|
|
5830
5903
|
readonly type: "string";
|
|
@@ -5867,7 +5940,7 @@ export declare const operations: readonly [{
|
|
|
5867
5940
|
readonly resource: "database.databases.tables";
|
|
5868
5941
|
readonly method: "create";
|
|
5869
5942
|
readonly summary: "Create table";
|
|
5870
|
-
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5943
|
+
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5871
5944
|
readonly http: "POST";
|
|
5872
5945
|
readonly path: "/database/v1/databases/{database_id}/tables";
|
|
5873
5946
|
readonly streaming: "no";
|
|
@@ -5966,7 +6039,7 @@ export declare const operations: readonly [{
|
|
|
5966
6039
|
readonly resource: "database.databases.tables.fields";
|
|
5967
6040
|
readonly method: "create";
|
|
5968
6041
|
readonly summary: "Add field";
|
|
5969
|
-
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
6042
|
+
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.";
|
|
5970
6043
|
readonly http: "POST";
|
|
5971
6044
|
readonly path: "/database/v1/databases/{database_id}/tables/{table}/fields";
|
|
5972
6045
|
readonly streaming: "no";
|
|
@@ -6103,7 +6176,7 @@ export declare const operations: readonly [{
|
|
|
6103
6176
|
readonly resource: "file.files";
|
|
6104
6177
|
readonly method: "create";
|
|
6105
6178
|
readonly summary: "Upload file";
|
|
6106
|
-
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
|
|
6179
|
+
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.";
|
|
6107
6180
|
readonly http: "POST";
|
|
6108
6181
|
readonly path: "/file/v1/files";
|
|
6109
6182
|
readonly streaming: "no";
|
|
@@ -6117,7 +6190,7 @@ export declare const operations: readonly [{
|
|
|
6117
6190
|
readonly name: "file";
|
|
6118
6191
|
readonly type: "string";
|
|
6119
6192
|
readonly required: true;
|
|
6120
|
-
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
6193
|
+
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.";
|
|
6121
6194
|
}, {
|
|
6122
6195
|
readonly name: "purpose";
|
|
6123
6196
|
readonly type: "string";
|
|
@@ -6154,7 +6227,7 @@ export declare const operations: readonly [{
|
|
|
6154
6227
|
readonly resource: "file.files";
|
|
6155
6228
|
readonly method: "retrieve";
|
|
6156
6229
|
readonly summary: "Retrieve file";
|
|
6157
|
-
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its
|
|
6230
|
+
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.";
|
|
6158
6231
|
readonly http: "GET";
|
|
6159
6232
|
readonly path: "/file/v1/files/{file_id}";
|
|
6160
6233
|
readonly streaming: "no";
|
|
@@ -6168,7 +6241,7 @@ export declare const operations: readonly [{
|
|
|
6168
6241
|
readonly resource: "file.files";
|
|
6169
6242
|
readonly method: "retrieveContent";
|
|
6170
6243
|
readonly summary: "Retrieve file content";
|
|
6171
|
-
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its
|
|
6244
|
+
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.";
|
|
6172
6245
|
readonly http: "GET";
|
|
6173
6246
|
readonly path: "/file/v1/files/{file_id}/content";
|
|
6174
6247
|
readonly streaming: "no";
|
|
@@ -6178,6 +6251,124 @@ export declare const operations: readonly [{
|
|
|
6178
6251
|
readonly sdkName: "file_id";
|
|
6179
6252
|
}];
|
|
6180
6253
|
readonly query: readonly [];
|
|
6254
|
+
}, {
|
|
6255
|
+
readonly resource: "file.uploads";
|
|
6256
|
+
readonly method: "create";
|
|
6257
|
+
readonly summary: "Create an upload";
|
|
6258
|
+
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.";
|
|
6259
|
+
readonly http: "POST";
|
|
6260
|
+
readonly path: "/file/v1/uploads";
|
|
6261
|
+
readonly streaming: "no";
|
|
6262
|
+
readonly pagination: false;
|
|
6263
|
+
readonly pathParams: readonly [];
|
|
6264
|
+
readonly query: readonly [];
|
|
6265
|
+
readonly body: {
|
|
6266
|
+
readonly required: true;
|
|
6267
|
+
readonly fields: readonly [{
|
|
6268
|
+
readonly name: "bytes";
|
|
6269
|
+
readonly type: "integer";
|
|
6270
|
+
readonly required: true;
|
|
6271
|
+
readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
|
|
6272
|
+
}, {
|
|
6273
|
+
readonly name: "filename";
|
|
6274
|
+
readonly type: "string";
|
|
6275
|
+
readonly required: true;
|
|
6276
|
+
readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
|
|
6277
|
+
}, {
|
|
6278
|
+
readonly name: "mime_type";
|
|
6279
|
+
readonly type: "string";
|
|
6280
|
+
readonly required: true;
|
|
6281
|
+
readonly description: "Declared MIME type; validated against the assembled content.";
|
|
6282
|
+
}, {
|
|
6283
|
+
readonly name: "purpose";
|
|
6284
|
+
readonly type: "string";
|
|
6285
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
6286
|
+
readonly required: true;
|
|
6287
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6288
|
+
}, {
|
|
6289
|
+
readonly name: "expires_after";
|
|
6290
|
+
readonly type: "object";
|
|
6291
|
+
readonly required: false;
|
|
6292
|
+
readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
|
|
6293
|
+
}, {
|
|
6294
|
+
readonly name: "part_size";
|
|
6295
|
+
readonly type: "integer";
|
|
6296
|
+
readonly required: false;
|
|
6297
|
+
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.";
|
|
6298
|
+
}];
|
|
6299
|
+
};
|
|
6300
|
+
}, {
|
|
6301
|
+
readonly resource: "file.uploads";
|
|
6302
|
+
readonly method: "cancel";
|
|
6303
|
+
readonly summary: "Cancel an upload";
|
|
6304
|
+
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.";
|
|
6305
|
+
readonly http: "POST";
|
|
6306
|
+
readonly path: "/file/v1/uploads/{upload_id}/cancel";
|
|
6307
|
+
readonly streaming: "no";
|
|
6308
|
+
readonly pagination: false;
|
|
6309
|
+
readonly pathParams: readonly [{
|
|
6310
|
+
readonly name: "upload_id";
|
|
6311
|
+
readonly sdkName: "upload_id";
|
|
6312
|
+
}];
|
|
6313
|
+
readonly query: readonly [];
|
|
6314
|
+
}, {
|
|
6315
|
+
readonly resource: "file.uploads";
|
|
6316
|
+
readonly method: "complete";
|
|
6317
|
+
readonly summary: "Complete an upload";
|
|
6318
|
+
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.";
|
|
6319
|
+
readonly http: "POST";
|
|
6320
|
+
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
6321
|
+
readonly streaming: "no";
|
|
6322
|
+
readonly pagination: false;
|
|
6323
|
+
readonly pathParams: readonly [{
|
|
6324
|
+
readonly name: "upload_id";
|
|
6325
|
+
readonly sdkName: "upload_id";
|
|
6326
|
+
}];
|
|
6327
|
+
readonly query: readonly [];
|
|
6328
|
+
readonly body: {
|
|
6329
|
+
readonly required: true;
|
|
6330
|
+
readonly fields: readonly [{
|
|
6331
|
+
readonly name: "part_ids";
|
|
6332
|
+
readonly type: "array";
|
|
6333
|
+
readonly itemType: "string";
|
|
6334
|
+
readonly required: true;
|
|
6335
|
+
readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
|
|
6336
|
+
}, {
|
|
6337
|
+
readonly name: "md5";
|
|
6338
|
+
readonly type: "string";
|
|
6339
|
+
readonly required: false;
|
|
6340
|
+
readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
|
|
6341
|
+
}];
|
|
6342
|
+
};
|
|
6343
|
+
}, {
|
|
6344
|
+
readonly resource: "file.uploads.parts";
|
|
6345
|
+
readonly method: "create";
|
|
6346
|
+
readonly summary: "Add an upload part";
|
|
6347
|
+
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.";
|
|
6348
|
+
readonly http: "POST";
|
|
6349
|
+
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
6350
|
+
readonly streaming: "no";
|
|
6351
|
+
readonly pagination: false;
|
|
6352
|
+
readonly multipart: true;
|
|
6353
|
+
readonly pathParams: readonly [{
|
|
6354
|
+
readonly name: "upload_id";
|
|
6355
|
+
readonly sdkName: "upload_id";
|
|
6356
|
+
}];
|
|
6357
|
+
readonly query: readonly [{
|
|
6358
|
+
readonly name: "part_number";
|
|
6359
|
+
readonly type: "integer";
|
|
6360
|
+
readonly required: false;
|
|
6361
|
+
readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
|
|
6362
|
+
}];
|
|
6363
|
+
readonly body: {
|
|
6364
|
+
readonly required: true;
|
|
6365
|
+
readonly fields: readonly [{
|
|
6366
|
+
readonly name: "data";
|
|
6367
|
+
readonly type: "string";
|
|
6368
|
+
readonly required: true;
|
|
6369
|
+
readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
|
|
6370
|
+
}];
|
|
6371
|
+
};
|
|
6181
6372
|
}, {
|
|
6182
6373
|
readonly resource: "knowledge.vectorStores";
|
|
6183
6374
|
readonly method: "list";
|
|
@@ -9452,7 +9643,7 @@ export declare const operations: readonly [{
|
|
|
9452
9643
|
readonly name: "message";
|
|
9453
9644
|
readonly type: "string";
|
|
9454
9645
|
readonly required: true;
|
|
9455
|
-
readonly description: "Problem description
|
|
9646
|
+
readonly description: "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string.";
|
|
9456
9647
|
}, {
|
|
9457
9648
|
readonly name: "contact_email";
|
|
9458
9649
|
readonly type: "string";
|
|
@@ -9687,7 +9878,7 @@ export declare const operations: readonly [{
|
|
|
9687
9878
|
readonly resource: "sandbox.sandboxes";
|
|
9688
9879
|
readonly method: "create";
|
|
9689
9880
|
readonly summary: "Create sandbox (v2)";
|
|
9690
|
-
readonly description: "
|
|
9881
|
+
readonly description: "Create a sandbox from the template. All system communication with the sandbox is secured.";
|
|
9691
9882
|
readonly http: "POST";
|
|
9692
9883
|
readonly path: "/sandbox/v1/sandboxes";
|
|
9693
9884
|
readonly streaming: "no";
|
|
@@ -9700,7 +9891,7 @@ export declare const operations: readonly [{
|
|
|
9700
9891
|
readonly name: "templateID";
|
|
9701
9892
|
readonly type: "string";
|
|
9702
9893
|
readonly required: true;
|
|
9703
|
-
readonly description: "
|
|
9894
|
+
readonly description: "Identifier of the required template";
|
|
9704
9895
|
}, {
|
|
9705
9896
|
readonly name: "timeout";
|
|
9706
9897
|
readonly type: "integer";
|
|
@@ -9814,7 +10005,7 @@ export declare const operations: readonly [{
|
|
|
9814
10005
|
readonly resource: "sandbox.sandboxes";
|
|
9815
10006
|
readonly method: "connect";
|
|
9816
10007
|
readonly summary: "Connect sandbox (v2)";
|
|
9817
|
-
readonly description: "
|
|
10008
|
+
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.";
|
|
9818
10009
|
readonly http: "POST";
|
|
9819
10010
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/connect";
|
|
9820
10011
|
readonly streaming: "no";
|
|
@@ -9935,7 +10126,7 @@ export declare const operations: readonly [{
|
|
|
9935
10126
|
readonly resource: "sandbox.sandboxes.metrics";
|
|
9936
10127
|
readonly method: "list";
|
|
9937
10128
|
readonly summary: "Sandbox metrics";
|
|
9938
|
-
readonly description: "Read CPU, memory and disk usage over
|
|
10129
|
+
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.";
|
|
9939
10130
|
readonly http: "GET";
|
|
9940
10131
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/metrics";
|
|
9941
10132
|
readonly streaming: "no";
|
|
@@ -10004,7 +10195,7 @@ export declare const operations: readonly [{
|
|
|
10004
10195
|
readonly resource: "sandbox.sandboxes";
|
|
10005
10196
|
readonly method: "pause";
|
|
10006
10197
|
readonly summary: "Pause sandbox";
|
|
10007
|
-
readonly description: "
|
|
10198
|
+
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.";
|
|
10008
10199
|
readonly http: "POST";
|
|
10009
10200
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/pause";
|
|
10010
10201
|
readonly streaming: "no";
|
|
@@ -10320,7 +10511,7 @@ export declare const operations: readonly [{
|
|
|
10320
10511
|
readonly resource: "sandbox.templates";
|
|
10321
10512
|
readonly method: "list";
|
|
10322
10513
|
readonly summary: "List templates (v2)";
|
|
10323
|
-
readonly description: "
|
|
10514
|
+
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.";
|
|
10324
10515
|
readonly http: "GET";
|
|
10325
10516
|
readonly path: "/sandbox/v1/templates";
|
|
10326
10517
|
readonly streaming: "no";
|
|
@@ -10795,6 +10986,1161 @@ export declare const operations: readonly [{
|
|
|
10795
10986
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10796
10987
|
}];
|
|
10797
10988
|
};
|
|
10989
|
+
}, {
|
|
10990
|
+
readonly resource: "ticket.activity";
|
|
10991
|
+
readonly method: "retrieve";
|
|
10992
|
+
readonly summary: "List activity";
|
|
10993
|
+
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.";
|
|
10994
|
+
readonly http: "GET";
|
|
10995
|
+
readonly path: "/ticket/v1/activity";
|
|
10996
|
+
readonly streaming: "no";
|
|
10997
|
+
readonly pagination: false;
|
|
10998
|
+
readonly pathParams: readonly [];
|
|
10999
|
+
readonly query: readonly [{
|
|
11000
|
+
readonly name: "repository";
|
|
11001
|
+
readonly type: "string";
|
|
11002
|
+
readonly required: false;
|
|
11003
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11004
|
+
}, {
|
|
11005
|
+
readonly name: "page_size";
|
|
11006
|
+
readonly type: "integer";
|
|
11007
|
+
readonly required: false;
|
|
11008
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11009
|
+
}, {
|
|
11010
|
+
readonly name: "page_token";
|
|
11011
|
+
readonly type: "string";
|
|
11012
|
+
readonly required: false;
|
|
11013
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11014
|
+
}, {
|
|
11015
|
+
readonly name: "filter";
|
|
11016
|
+
readonly type: "string";
|
|
11017
|
+
readonly required: false;
|
|
11018
|
+
readonly description: "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service.";
|
|
11019
|
+
}];
|
|
11020
|
+
}, {
|
|
11021
|
+
readonly resource: "ticket.comments";
|
|
11022
|
+
readonly method: "delete";
|
|
11023
|
+
readonly summary: "Remove comments";
|
|
11024
|
+
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.";
|
|
11025
|
+
readonly http: "DELETE";
|
|
11026
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11027
|
+
readonly streaming: "no";
|
|
11028
|
+
readonly pagination: false;
|
|
11029
|
+
readonly pathParams: readonly [{
|
|
11030
|
+
readonly name: "id";
|
|
11031
|
+
readonly sdkName: "id";
|
|
11032
|
+
}];
|
|
11033
|
+
readonly query: readonly [{
|
|
11034
|
+
readonly name: "repository";
|
|
11035
|
+
readonly type: "string";
|
|
11036
|
+
readonly required: false;
|
|
11037
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11038
|
+
}];
|
|
11039
|
+
}, {
|
|
11040
|
+
readonly resource: "ticket.comments";
|
|
11041
|
+
readonly method: "retrieve";
|
|
11042
|
+
readonly summary: "Read comments";
|
|
11043
|
+
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.";
|
|
11044
|
+
readonly http: "GET";
|
|
11045
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11046
|
+
readonly streaming: "no";
|
|
11047
|
+
readonly pagination: false;
|
|
11048
|
+
readonly pathParams: readonly [{
|
|
11049
|
+
readonly name: "id";
|
|
11050
|
+
readonly sdkName: "id";
|
|
11051
|
+
}];
|
|
11052
|
+
readonly query: readonly [{
|
|
11053
|
+
readonly name: "repository";
|
|
11054
|
+
readonly type: "string";
|
|
11055
|
+
readonly required: false;
|
|
11056
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11057
|
+
}];
|
|
11058
|
+
}, {
|
|
11059
|
+
readonly resource: "ticket.comments";
|
|
11060
|
+
readonly method: "update";
|
|
11061
|
+
readonly summary: "Update comments";
|
|
11062
|
+
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.";
|
|
11063
|
+
readonly http: "PATCH";
|
|
11064
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11065
|
+
readonly streaming: "no";
|
|
11066
|
+
readonly pagination: false;
|
|
11067
|
+
readonly pathParams: readonly [{
|
|
11068
|
+
readonly name: "id";
|
|
11069
|
+
readonly sdkName: "id";
|
|
11070
|
+
}];
|
|
11071
|
+
readonly query: readonly [{
|
|
11072
|
+
readonly name: "repository";
|
|
11073
|
+
readonly type: "string";
|
|
11074
|
+
readonly required: false;
|
|
11075
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11076
|
+
}];
|
|
11077
|
+
readonly body: {
|
|
11078
|
+
readonly required: true;
|
|
11079
|
+
readonly fields: readonly [{
|
|
11080
|
+
readonly name: "body";
|
|
11081
|
+
readonly type: "string";
|
|
11082
|
+
readonly required: true;
|
|
11083
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11084
|
+
}, {
|
|
11085
|
+
readonly name: "in_reply_to";
|
|
11086
|
+
readonly type: "string";
|
|
11087
|
+
readonly required: false;
|
|
11088
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11089
|
+
}];
|
|
11090
|
+
};
|
|
11091
|
+
}, {
|
|
11092
|
+
readonly resource: "ticket.comments.reactions";
|
|
11093
|
+
readonly method: "list";
|
|
11094
|
+
readonly summary: "List reactions";
|
|
11095
|
+
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.";
|
|
11096
|
+
readonly http: "GET";
|
|
11097
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11098
|
+
readonly streaming: "no";
|
|
11099
|
+
readonly pagination: false;
|
|
11100
|
+
readonly pathParams: readonly [{
|
|
11101
|
+
readonly name: "id";
|
|
11102
|
+
readonly sdkName: "id";
|
|
11103
|
+
}];
|
|
11104
|
+
readonly query: readonly [{
|
|
11105
|
+
readonly name: "repository";
|
|
11106
|
+
readonly type: "string";
|
|
11107
|
+
readonly required: false;
|
|
11108
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11109
|
+
}, {
|
|
11110
|
+
readonly name: "page_size";
|
|
11111
|
+
readonly type: "integer";
|
|
11112
|
+
readonly required: false;
|
|
11113
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11114
|
+
}, {
|
|
11115
|
+
readonly name: "page_token";
|
|
11116
|
+
readonly type: "string";
|
|
11117
|
+
readonly required: false;
|
|
11118
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11119
|
+
}];
|
|
11120
|
+
}, {
|
|
11121
|
+
readonly resource: "ticket.comments.reactions";
|
|
11122
|
+
readonly method: "create";
|
|
11123
|
+
readonly summary: "Create or add reactions";
|
|
11124
|
+
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.";
|
|
11125
|
+
readonly http: "POST";
|
|
11126
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11127
|
+
readonly streaming: "no";
|
|
11128
|
+
readonly pagination: false;
|
|
11129
|
+
readonly pathParams: readonly [{
|
|
11130
|
+
readonly name: "id";
|
|
11131
|
+
readonly sdkName: "id";
|
|
11132
|
+
}];
|
|
11133
|
+
readonly query: readonly [{
|
|
11134
|
+
readonly name: "repository";
|
|
11135
|
+
readonly type: "string";
|
|
11136
|
+
readonly required: false;
|
|
11137
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11138
|
+
}];
|
|
11139
|
+
readonly body: {
|
|
11140
|
+
readonly required: true;
|
|
11141
|
+
readonly fields: readonly [{
|
|
11142
|
+
readonly name: "content";
|
|
11143
|
+
readonly type: "string";
|
|
11144
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11145
|
+
readonly required: true;
|
|
11146
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11147
|
+
}];
|
|
11148
|
+
};
|
|
11149
|
+
}, {
|
|
11150
|
+
readonly resource: "ticket.comments.reactions";
|
|
11151
|
+
readonly method: "delete";
|
|
11152
|
+
readonly summary: "Remove reactions";
|
|
11153
|
+
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.";
|
|
11154
|
+
readonly http: "DELETE";
|
|
11155
|
+
readonly path: "/ticket/v1/comments/{id}/reactions/{content}";
|
|
11156
|
+
readonly streaming: "no";
|
|
11157
|
+
readonly pagination: false;
|
|
11158
|
+
readonly pathParams: readonly [{
|
|
11159
|
+
readonly name: "id";
|
|
11160
|
+
readonly sdkName: "id";
|
|
11161
|
+
}, {
|
|
11162
|
+
readonly name: "content";
|
|
11163
|
+
readonly sdkName: "content";
|
|
11164
|
+
}];
|
|
11165
|
+
readonly query: readonly [{
|
|
11166
|
+
readonly name: "repository";
|
|
11167
|
+
readonly type: "string";
|
|
11168
|
+
readonly required: false;
|
|
11169
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11170
|
+
}];
|
|
11171
|
+
}, {
|
|
11172
|
+
readonly resource: "ticket.labels";
|
|
11173
|
+
readonly method: "list";
|
|
11174
|
+
readonly summary: "List labels";
|
|
11175
|
+
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.";
|
|
11176
|
+
readonly http: "GET";
|
|
11177
|
+
readonly path: "/ticket/v1/labels";
|
|
11178
|
+
readonly streaming: "no";
|
|
11179
|
+
readonly pagination: false;
|
|
11180
|
+
readonly pathParams: readonly [];
|
|
11181
|
+
readonly query: readonly [{
|
|
11182
|
+
readonly name: "repository";
|
|
11183
|
+
readonly type: "string";
|
|
11184
|
+
readonly required: false;
|
|
11185
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11186
|
+
}, {
|
|
11187
|
+
readonly name: "page_size";
|
|
11188
|
+
readonly type: "integer";
|
|
11189
|
+
readonly required: false;
|
|
11190
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11191
|
+
}, {
|
|
11192
|
+
readonly name: "page_token";
|
|
11193
|
+
readonly type: "string";
|
|
11194
|
+
readonly required: false;
|
|
11195
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11196
|
+
}];
|
|
11197
|
+
}, {
|
|
11198
|
+
readonly resource: "ticket.labels";
|
|
11199
|
+
readonly method: "create";
|
|
11200
|
+
readonly summary: "Create or add labels";
|
|
11201
|
+
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.";
|
|
11202
|
+
readonly http: "POST";
|
|
11203
|
+
readonly path: "/ticket/v1/labels";
|
|
11204
|
+
readonly streaming: "no";
|
|
11205
|
+
readonly pagination: false;
|
|
11206
|
+
readonly pathParams: readonly [];
|
|
11207
|
+
readonly query: readonly [{
|
|
11208
|
+
readonly name: "repository";
|
|
11209
|
+
readonly type: "string";
|
|
11210
|
+
readonly required: false;
|
|
11211
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11212
|
+
}];
|
|
11213
|
+
readonly body: {
|
|
11214
|
+
readonly required: true;
|
|
11215
|
+
readonly fields: readonly [{
|
|
11216
|
+
readonly name: "name";
|
|
11217
|
+
readonly type: "string";
|
|
11218
|
+
readonly required: true;
|
|
11219
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11220
|
+
}, {
|
|
11221
|
+
readonly name: "color";
|
|
11222
|
+
readonly type: "string";
|
|
11223
|
+
readonly required: true;
|
|
11224
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11225
|
+
}, {
|
|
11226
|
+
readonly name: "description";
|
|
11227
|
+
readonly type: "string";
|
|
11228
|
+
readonly required: false;
|
|
11229
|
+
readonly description: "Label's purpose.";
|
|
11230
|
+
}];
|
|
11231
|
+
};
|
|
11232
|
+
}, {
|
|
11233
|
+
readonly resource: "ticket.labels";
|
|
11234
|
+
readonly method: "delete";
|
|
11235
|
+
readonly summary: "Remove labels";
|
|
11236
|
+
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.";
|
|
11237
|
+
readonly http: "DELETE";
|
|
11238
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11239
|
+
readonly streaming: "no";
|
|
11240
|
+
readonly pagination: false;
|
|
11241
|
+
readonly pathParams: readonly [{
|
|
11242
|
+
readonly name: "name";
|
|
11243
|
+
readonly sdkName: "name";
|
|
11244
|
+
}];
|
|
11245
|
+
readonly query: readonly [{
|
|
11246
|
+
readonly name: "repository";
|
|
11247
|
+
readonly type: "string";
|
|
11248
|
+
readonly required: false;
|
|
11249
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11250
|
+
}];
|
|
11251
|
+
}, {
|
|
11252
|
+
readonly resource: "ticket.labels";
|
|
11253
|
+
readonly method: "update";
|
|
11254
|
+
readonly summary: "Update labels";
|
|
11255
|
+
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.";
|
|
11256
|
+
readonly http: "PATCH";
|
|
11257
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11258
|
+
readonly streaming: "no";
|
|
11259
|
+
readonly pagination: false;
|
|
11260
|
+
readonly pathParams: readonly [{
|
|
11261
|
+
readonly name: "name";
|
|
11262
|
+
readonly sdkName: "name";
|
|
11263
|
+
}];
|
|
11264
|
+
readonly query: readonly [{
|
|
11265
|
+
readonly name: "repository";
|
|
11266
|
+
readonly type: "string";
|
|
11267
|
+
readonly required: false;
|
|
11268
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11269
|
+
}];
|
|
11270
|
+
readonly body: {
|
|
11271
|
+
readonly required: true;
|
|
11272
|
+
readonly fields: readonly [{
|
|
11273
|
+
readonly name: "color";
|
|
11274
|
+
readonly type: "string";
|
|
11275
|
+
readonly required: false;
|
|
11276
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11277
|
+
}, {
|
|
11278
|
+
readonly name: "description";
|
|
11279
|
+
readonly type: "string";
|
|
11280
|
+
readonly required: false;
|
|
11281
|
+
readonly description: "Label's purpose.";
|
|
11282
|
+
}, {
|
|
11283
|
+
readonly name: "new_name";
|
|
11284
|
+
readonly type: "string";
|
|
11285
|
+
readonly required: false;
|
|
11286
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11287
|
+
}];
|
|
11288
|
+
};
|
|
11289
|
+
}, {
|
|
11290
|
+
readonly resource: "ticket.milestones";
|
|
11291
|
+
readonly method: "list";
|
|
11292
|
+
readonly summary: "List milestones";
|
|
11293
|
+
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.";
|
|
11294
|
+
readonly http: "GET";
|
|
11295
|
+
readonly path: "/ticket/v1/milestones";
|
|
11296
|
+
readonly streaming: "no";
|
|
11297
|
+
readonly pagination: false;
|
|
11298
|
+
readonly pathParams: readonly [];
|
|
11299
|
+
readonly query: readonly [{
|
|
11300
|
+
readonly name: "repository";
|
|
11301
|
+
readonly type: "string";
|
|
11302
|
+
readonly required: false;
|
|
11303
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11304
|
+
}, {
|
|
11305
|
+
readonly name: "page_size";
|
|
11306
|
+
readonly type: "integer";
|
|
11307
|
+
readonly required: false;
|
|
11308
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11309
|
+
}, {
|
|
11310
|
+
readonly name: "page_token";
|
|
11311
|
+
readonly type: "string";
|
|
11312
|
+
readonly required: false;
|
|
11313
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11314
|
+
}];
|
|
11315
|
+
}, {
|
|
11316
|
+
readonly resource: "ticket.milestones";
|
|
11317
|
+
readonly method: "create";
|
|
11318
|
+
readonly summary: "Create or add milestones";
|
|
11319
|
+
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.";
|
|
11320
|
+
readonly http: "POST";
|
|
11321
|
+
readonly path: "/ticket/v1/milestones";
|
|
11322
|
+
readonly streaming: "no";
|
|
11323
|
+
readonly pagination: false;
|
|
11324
|
+
readonly pathParams: readonly [];
|
|
11325
|
+
readonly query: readonly [{
|
|
11326
|
+
readonly name: "repository";
|
|
11327
|
+
readonly type: "string";
|
|
11328
|
+
readonly required: false;
|
|
11329
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11330
|
+
}];
|
|
11331
|
+
readonly body: {
|
|
11332
|
+
readonly required: true;
|
|
11333
|
+
readonly fields: readonly [{
|
|
11334
|
+
readonly name: "title";
|
|
11335
|
+
readonly type: "string";
|
|
11336
|
+
readonly required: true;
|
|
11337
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11338
|
+
}, {
|
|
11339
|
+
readonly name: "description";
|
|
11340
|
+
readonly type: "string";
|
|
11341
|
+
readonly required: false;
|
|
11342
|
+
readonly description: "Milestone description.";
|
|
11343
|
+
}, {
|
|
11344
|
+
readonly name: "due_on";
|
|
11345
|
+
readonly type: "string";
|
|
11346
|
+
readonly required: false;
|
|
11347
|
+
readonly description: "Due date, or null if unset.";
|
|
11348
|
+
}, {
|
|
11349
|
+
readonly name: "state";
|
|
11350
|
+
readonly type: "string";
|
|
11351
|
+
readonly enum: readonly ["open", "closed"];
|
|
11352
|
+
readonly required: false;
|
|
11353
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11354
|
+
}];
|
|
11355
|
+
};
|
|
11356
|
+
}, {
|
|
11357
|
+
readonly resource: "ticket.milestones";
|
|
11358
|
+
readonly method: "delete";
|
|
11359
|
+
readonly summary: "Remove milestones";
|
|
11360
|
+
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.";
|
|
11361
|
+
readonly http: "DELETE";
|
|
11362
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11363
|
+
readonly streaming: "no";
|
|
11364
|
+
readonly pagination: false;
|
|
11365
|
+
readonly pathParams: readonly [{
|
|
11366
|
+
readonly name: "number";
|
|
11367
|
+
readonly sdkName: "number";
|
|
11368
|
+
}];
|
|
11369
|
+
readonly query: readonly [{
|
|
11370
|
+
readonly name: "repository";
|
|
11371
|
+
readonly type: "string";
|
|
11372
|
+
readonly required: false;
|
|
11373
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11374
|
+
}];
|
|
11375
|
+
}, {
|
|
11376
|
+
readonly resource: "ticket.milestones";
|
|
11377
|
+
readonly method: "retrieve";
|
|
11378
|
+
readonly summary: "Read milestones";
|
|
11379
|
+
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.";
|
|
11380
|
+
readonly http: "GET";
|
|
11381
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11382
|
+
readonly streaming: "no";
|
|
11383
|
+
readonly pagination: false;
|
|
11384
|
+
readonly pathParams: readonly [{
|
|
11385
|
+
readonly name: "number";
|
|
11386
|
+
readonly sdkName: "number";
|
|
11387
|
+
}];
|
|
11388
|
+
readonly query: readonly [{
|
|
11389
|
+
readonly name: "repository";
|
|
11390
|
+
readonly type: "string";
|
|
11391
|
+
readonly required: false;
|
|
11392
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11393
|
+
}];
|
|
11394
|
+
}, {
|
|
11395
|
+
readonly resource: "ticket.milestones";
|
|
11396
|
+
readonly method: "update";
|
|
11397
|
+
readonly summary: "Update milestones";
|
|
11398
|
+
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.";
|
|
11399
|
+
readonly http: "PATCH";
|
|
11400
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11401
|
+
readonly streaming: "no";
|
|
11402
|
+
readonly pagination: false;
|
|
11403
|
+
readonly pathParams: readonly [{
|
|
11404
|
+
readonly name: "number";
|
|
11405
|
+
readonly sdkName: "number";
|
|
11406
|
+
}];
|
|
11407
|
+
readonly query: readonly [{
|
|
11408
|
+
readonly name: "repository";
|
|
11409
|
+
readonly type: "string";
|
|
11410
|
+
readonly required: false;
|
|
11411
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11412
|
+
}];
|
|
11413
|
+
readonly body: {
|
|
11414
|
+
readonly required: true;
|
|
11415
|
+
readonly fields: readonly [{
|
|
11416
|
+
readonly name: "title";
|
|
11417
|
+
readonly type: "string";
|
|
11418
|
+
readonly required: false;
|
|
11419
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11420
|
+
}, {
|
|
11421
|
+
readonly name: "description";
|
|
11422
|
+
readonly type: "string";
|
|
11423
|
+
readonly required: false;
|
|
11424
|
+
readonly description: "Milestone description.";
|
|
11425
|
+
}, {
|
|
11426
|
+
readonly name: "due_on";
|
|
11427
|
+
readonly type: "string";
|
|
11428
|
+
readonly required: false;
|
|
11429
|
+
readonly description: "Due date, or null if unset.";
|
|
11430
|
+
}, {
|
|
11431
|
+
readonly name: "state";
|
|
11432
|
+
readonly type: "string";
|
|
11433
|
+
readonly enum: readonly ["open", "closed"];
|
|
11434
|
+
readonly required: false;
|
|
11435
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11436
|
+
}];
|
|
11437
|
+
};
|
|
11438
|
+
}, {
|
|
11439
|
+
readonly resource: "ticket.repositories";
|
|
11440
|
+
readonly method: "list";
|
|
11441
|
+
readonly summary: "List repositories";
|
|
11442
|
+
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.";
|
|
11443
|
+
readonly http: "GET";
|
|
11444
|
+
readonly path: "/ticket/v1/repositories";
|
|
11445
|
+
readonly streaming: "no";
|
|
11446
|
+
readonly pagination: false;
|
|
11447
|
+
readonly pathParams: readonly [];
|
|
11448
|
+
readonly query: readonly [{
|
|
11449
|
+
readonly name: "page_size";
|
|
11450
|
+
readonly type: "integer";
|
|
11451
|
+
readonly required: false;
|
|
11452
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11453
|
+
}, {
|
|
11454
|
+
readonly name: "page_token";
|
|
11455
|
+
readonly type: "string";
|
|
11456
|
+
readonly required: false;
|
|
11457
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11458
|
+
}];
|
|
11459
|
+
}, {
|
|
11460
|
+
readonly resource: "ticket.tickets";
|
|
11461
|
+
readonly method: "list";
|
|
11462
|
+
readonly summary: "List tickets";
|
|
11463
|
+
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.";
|
|
11464
|
+
readonly http: "GET";
|
|
11465
|
+
readonly path: "/ticket/v1/tickets";
|
|
11466
|
+
readonly streaming: "no";
|
|
11467
|
+
readonly pagination: false;
|
|
11468
|
+
readonly pathParams: readonly [];
|
|
11469
|
+
readonly query: readonly [{
|
|
11470
|
+
readonly name: "repository";
|
|
11471
|
+
readonly type: "string";
|
|
11472
|
+
readonly required: false;
|
|
11473
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11474
|
+
}, {
|
|
11475
|
+
readonly name: "page_size";
|
|
11476
|
+
readonly type: "integer";
|
|
11477
|
+
readonly required: false;
|
|
11478
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11479
|
+
}, {
|
|
11480
|
+
readonly name: "page_token";
|
|
11481
|
+
readonly type: "string";
|
|
11482
|
+
readonly required: false;
|
|
11483
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11484
|
+
}, {
|
|
11485
|
+
readonly name: "filter";
|
|
11486
|
+
readonly type: "string";
|
|
11487
|
+
readonly required: false;
|
|
11488
|
+
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.";
|
|
11489
|
+
}];
|
|
11490
|
+
}, {
|
|
11491
|
+
readonly resource: "ticket.tickets";
|
|
11492
|
+
readonly method: "create";
|
|
11493
|
+
readonly summary: "Create or add tickets";
|
|
11494
|
+
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.";
|
|
11495
|
+
readonly http: "POST";
|
|
11496
|
+
readonly path: "/ticket/v1/tickets";
|
|
11497
|
+
readonly streaming: "no";
|
|
11498
|
+
readonly pagination: false;
|
|
11499
|
+
readonly pathParams: readonly [];
|
|
11500
|
+
readonly query: readonly [{
|
|
11501
|
+
readonly name: "repository";
|
|
11502
|
+
readonly type: "string";
|
|
11503
|
+
readonly required: false;
|
|
11504
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11505
|
+
}];
|
|
11506
|
+
readonly body: {
|
|
11507
|
+
readonly required: true;
|
|
11508
|
+
readonly fields: readonly [{
|
|
11509
|
+
readonly name: "title";
|
|
11510
|
+
readonly type: "string";
|
|
11511
|
+
readonly required: true;
|
|
11512
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11513
|
+
}, {
|
|
11514
|
+
readonly name: "body";
|
|
11515
|
+
readonly type: "string";
|
|
11516
|
+
readonly required: false;
|
|
11517
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11518
|
+
}, {
|
|
11519
|
+
readonly name: "type";
|
|
11520
|
+
readonly type: "string";
|
|
11521
|
+
readonly required: false;
|
|
11522
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11523
|
+
}, {
|
|
11524
|
+
readonly name: "labels";
|
|
11525
|
+
readonly type: "array";
|
|
11526
|
+
readonly itemType: "string";
|
|
11527
|
+
readonly required: false;
|
|
11528
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11529
|
+
}, {
|
|
11530
|
+
readonly name: "assignees";
|
|
11531
|
+
readonly type: "array";
|
|
11532
|
+
readonly itemType: "string";
|
|
11533
|
+
readonly required: false;
|
|
11534
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11535
|
+
}, {
|
|
11536
|
+
readonly name: "milestone";
|
|
11537
|
+
readonly type: "integer";
|
|
11538
|
+
readonly required: false;
|
|
11539
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11540
|
+
}, {
|
|
11541
|
+
readonly name: "parent";
|
|
11542
|
+
readonly type: "integer";
|
|
11543
|
+
readonly required: false;
|
|
11544
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11545
|
+
}];
|
|
11546
|
+
};
|
|
11547
|
+
}, {
|
|
11548
|
+
readonly resource: "ticket.tickets";
|
|
11549
|
+
readonly method: "retrieve";
|
|
11550
|
+
readonly summary: "Read tickets";
|
|
11551
|
+
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.";
|
|
11552
|
+
readonly http: "GET";
|
|
11553
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11554
|
+
readonly streaming: "no";
|
|
11555
|
+
readonly pagination: false;
|
|
11556
|
+
readonly pathParams: readonly [{
|
|
11557
|
+
readonly name: "number";
|
|
11558
|
+
readonly sdkName: "number";
|
|
11559
|
+
}];
|
|
11560
|
+
readonly query: readonly [{
|
|
11561
|
+
readonly name: "repository";
|
|
11562
|
+
readonly type: "string";
|
|
11563
|
+
readonly required: false;
|
|
11564
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11565
|
+
}];
|
|
11566
|
+
}, {
|
|
11567
|
+
readonly resource: "ticket.tickets";
|
|
11568
|
+
readonly method: "update";
|
|
11569
|
+
readonly summary: "Update tickets";
|
|
11570
|
+
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.";
|
|
11571
|
+
readonly http: "PATCH";
|
|
11572
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11573
|
+
readonly streaming: "no";
|
|
11574
|
+
readonly pagination: false;
|
|
11575
|
+
readonly pathParams: readonly [{
|
|
11576
|
+
readonly name: "number";
|
|
11577
|
+
readonly sdkName: "number";
|
|
11578
|
+
}];
|
|
11579
|
+
readonly query: readonly [{
|
|
11580
|
+
readonly name: "repository";
|
|
11581
|
+
readonly type: "string";
|
|
11582
|
+
readonly required: false;
|
|
11583
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11584
|
+
}];
|
|
11585
|
+
readonly body: {
|
|
11586
|
+
readonly required: true;
|
|
11587
|
+
readonly fields: readonly [{
|
|
11588
|
+
readonly name: "title";
|
|
11589
|
+
readonly type: "string";
|
|
11590
|
+
readonly required: false;
|
|
11591
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11592
|
+
}, {
|
|
11593
|
+
readonly name: "body";
|
|
11594
|
+
readonly type: "string";
|
|
11595
|
+
readonly required: false;
|
|
11596
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11597
|
+
}, {
|
|
11598
|
+
readonly name: "type";
|
|
11599
|
+
readonly type: "string";
|
|
11600
|
+
readonly required: false;
|
|
11601
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11602
|
+
}, {
|
|
11603
|
+
readonly name: "labels";
|
|
11604
|
+
readonly type: "array";
|
|
11605
|
+
readonly itemType: "string";
|
|
11606
|
+
readonly required: false;
|
|
11607
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11608
|
+
}, {
|
|
11609
|
+
readonly name: "assignees";
|
|
11610
|
+
readonly type: "array";
|
|
11611
|
+
readonly itemType: "string";
|
|
11612
|
+
readonly required: false;
|
|
11613
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11614
|
+
}, {
|
|
11615
|
+
readonly name: "milestone";
|
|
11616
|
+
readonly type: "integer";
|
|
11617
|
+
readonly required: false;
|
|
11618
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11619
|
+
}, {
|
|
11620
|
+
readonly name: "state";
|
|
11621
|
+
readonly type: "string";
|
|
11622
|
+
readonly enum: readonly ["open", "closed"];
|
|
11623
|
+
readonly required: false;
|
|
11624
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11625
|
+
}, {
|
|
11626
|
+
readonly name: "state_reason";
|
|
11627
|
+
readonly type: "string";
|
|
11628
|
+
readonly enum: readonly ["completed", "not_planned", "duplicate"];
|
|
11629
|
+
readonly required: false;
|
|
11630
|
+
readonly description: "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate.";
|
|
11631
|
+
}, {
|
|
11632
|
+
readonly name: "duplicate_of";
|
|
11633
|
+
readonly type: "integer";
|
|
11634
|
+
readonly required: false;
|
|
11635
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11636
|
+
}];
|
|
11637
|
+
};
|
|
11638
|
+
}, {
|
|
11639
|
+
readonly resource: "ticket.tickets.comments";
|
|
11640
|
+
readonly method: "list";
|
|
11641
|
+
readonly summary: "List comments";
|
|
11642
|
+
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.";
|
|
11643
|
+
readonly http: "GET";
|
|
11644
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11645
|
+
readonly streaming: "no";
|
|
11646
|
+
readonly pagination: false;
|
|
11647
|
+
readonly pathParams: readonly [{
|
|
11648
|
+
readonly name: "number";
|
|
11649
|
+
readonly sdkName: "number";
|
|
11650
|
+
}];
|
|
11651
|
+
readonly query: readonly [{
|
|
11652
|
+
readonly name: "repository";
|
|
11653
|
+
readonly type: "string";
|
|
11654
|
+
readonly required: false;
|
|
11655
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11656
|
+
}, {
|
|
11657
|
+
readonly name: "page_size";
|
|
11658
|
+
readonly type: "integer";
|
|
11659
|
+
readonly required: false;
|
|
11660
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11661
|
+
}, {
|
|
11662
|
+
readonly name: "page_token";
|
|
11663
|
+
readonly type: "string";
|
|
11664
|
+
readonly required: false;
|
|
11665
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11666
|
+
}];
|
|
11667
|
+
}, {
|
|
11668
|
+
readonly resource: "ticket.tickets.comments";
|
|
11669
|
+
readonly method: "create";
|
|
11670
|
+
readonly summary: "Create or add comments";
|
|
11671
|
+
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.";
|
|
11672
|
+
readonly http: "POST";
|
|
11673
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11674
|
+
readonly streaming: "no";
|
|
11675
|
+
readonly pagination: false;
|
|
11676
|
+
readonly pathParams: readonly [{
|
|
11677
|
+
readonly name: "number";
|
|
11678
|
+
readonly sdkName: "number";
|
|
11679
|
+
}];
|
|
11680
|
+
readonly query: readonly [{
|
|
11681
|
+
readonly name: "repository";
|
|
11682
|
+
readonly type: "string";
|
|
11683
|
+
readonly required: false;
|
|
11684
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11685
|
+
}];
|
|
11686
|
+
readonly body: {
|
|
11687
|
+
readonly required: true;
|
|
11688
|
+
readonly fields: readonly [{
|
|
11689
|
+
readonly name: "body";
|
|
11690
|
+
readonly type: "string";
|
|
11691
|
+
readonly required: true;
|
|
11692
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11693
|
+
}, {
|
|
11694
|
+
readonly name: "in_reply_to";
|
|
11695
|
+
readonly type: "string";
|
|
11696
|
+
readonly required: false;
|
|
11697
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11698
|
+
}];
|
|
11699
|
+
};
|
|
11700
|
+
}, {
|
|
11701
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11702
|
+
readonly method: "retrieveBlockedBy";
|
|
11703
|
+
readonly summary: "List blocked by";
|
|
11704
|
+
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.";
|
|
11705
|
+
readonly http: "GET";
|
|
11706
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11707
|
+
readonly streaming: "no";
|
|
11708
|
+
readonly pagination: false;
|
|
11709
|
+
readonly pathParams: readonly [{
|
|
11710
|
+
readonly name: "number";
|
|
11711
|
+
readonly sdkName: "number";
|
|
11712
|
+
}];
|
|
11713
|
+
readonly query: readonly [{
|
|
11714
|
+
readonly name: "repository";
|
|
11715
|
+
readonly type: "string";
|
|
11716
|
+
readonly required: false;
|
|
11717
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11718
|
+
}, {
|
|
11719
|
+
readonly name: "page_size";
|
|
11720
|
+
readonly type: "integer";
|
|
11721
|
+
readonly required: false;
|
|
11722
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11723
|
+
}, {
|
|
11724
|
+
readonly name: "page_token";
|
|
11725
|
+
readonly type: "string";
|
|
11726
|
+
readonly required: false;
|
|
11727
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11728
|
+
}];
|
|
11729
|
+
}, {
|
|
11730
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11731
|
+
readonly method: "create";
|
|
11732
|
+
readonly summary: "Create or add blocked by";
|
|
11733
|
+
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.";
|
|
11734
|
+
readonly http: "POST";
|
|
11735
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11736
|
+
readonly streaming: "no";
|
|
11737
|
+
readonly pagination: false;
|
|
11738
|
+
readonly pathParams: readonly [{
|
|
11739
|
+
readonly name: "number";
|
|
11740
|
+
readonly sdkName: "number";
|
|
11741
|
+
}];
|
|
11742
|
+
readonly query: readonly [{
|
|
11743
|
+
readonly name: "repository";
|
|
11744
|
+
readonly type: "string";
|
|
11745
|
+
readonly required: false;
|
|
11746
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11747
|
+
}];
|
|
11748
|
+
readonly body: {
|
|
11749
|
+
readonly required: true;
|
|
11750
|
+
readonly fields: readonly [{
|
|
11751
|
+
readonly name: "blocked_by";
|
|
11752
|
+
readonly type: "integer";
|
|
11753
|
+
readonly required: true;
|
|
11754
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11755
|
+
}];
|
|
11756
|
+
};
|
|
11757
|
+
}, {
|
|
11758
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11759
|
+
readonly method: "delete";
|
|
11760
|
+
readonly summary: "Remove blocked by";
|
|
11761
|
+
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.";
|
|
11762
|
+
readonly http: "DELETE";
|
|
11763
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}";
|
|
11764
|
+
readonly streaming: "no";
|
|
11765
|
+
readonly pagination: false;
|
|
11766
|
+
readonly pathParams: readonly [{
|
|
11767
|
+
readonly name: "number";
|
|
11768
|
+
readonly sdkName: "number";
|
|
11769
|
+
}, {
|
|
11770
|
+
readonly name: "n";
|
|
11771
|
+
readonly sdkName: "n";
|
|
11772
|
+
}];
|
|
11773
|
+
readonly query: readonly [{
|
|
11774
|
+
readonly name: "repository";
|
|
11775
|
+
readonly type: "string";
|
|
11776
|
+
readonly required: false;
|
|
11777
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11778
|
+
}];
|
|
11779
|
+
}, {
|
|
11780
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11781
|
+
readonly method: "retrieveBlocking";
|
|
11782
|
+
readonly summary: "List blocking";
|
|
11783
|
+
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.";
|
|
11784
|
+
readonly http: "GET";
|
|
11785
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocking";
|
|
11786
|
+
readonly streaming: "no";
|
|
11787
|
+
readonly pagination: false;
|
|
11788
|
+
readonly pathParams: readonly [{
|
|
11789
|
+
readonly name: "number";
|
|
11790
|
+
readonly sdkName: "number";
|
|
11791
|
+
}];
|
|
11792
|
+
readonly query: readonly [{
|
|
11793
|
+
readonly name: "repository";
|
|
11794
|
+
readonly type: "string";
|
|
11795
|
+
readonly required: false;
|
|
11796
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11797
|
+
}, {
|
|
11798
|
+
readonly name: "page_size";
|
|
11799
|
+
readonly type: "integer";
|
|
11800
|
+
readonly required: false;
|
|
11801
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11802
|
+
}, {
|
|
11803
|
+
readonly name: "page_token";
|
|
11804
|
+
readonly type: "string";
|
|
11805
|
+
readonly required: false;
|
|
11806
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11807
|
+
}];
|
|
11808
|
+
}, {
|
|
11809
|
+
readonly resource: "ticket.tickets.events";
|
|
11810
|
+
readonly method: "list";
|
|
11811
|
+
readonly summary: "List events";
|
|
11812
|
+
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.";
|
|
11813
|
+
readonly http: "GET";
|
|
11814
|
+
readonly path: "/ticket/v1/tickets/{number}/events";
|
|
11815
|
+
readonly streaming: "no";
|
|
11816
|
+
readonly pagination: false;
|
|
11817
|
+
readonly pathParams: readonly [{
|
|
11818
|
+
readonly name: "number";
|
|
11819
|
+
readonly sdkName: "number";
|
|
11820
|
+
}];
|
|
11821
|
+
readonly query: readonly [{
|
|
11822
|
+
readonly name: "repository";
|
|
11823
|
+
readonly type: "string";
|
|
11824
|
+
readonly required: false;
|
|
11825
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11826
|
+
}, {
|
|
11827
|
+
readonly name: "page_size";
|
|
11828
|
+
readonly type: "integer";
|
|
11829
|
+
readonly required: false;
|
|
11830
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11831
|
+
}, {
|
|
11832
|
+
readonly name: "page_token";
|
|
11833
|
+
readonly type: "string";
|
|
11834
|
+
readonly required: false;
|
|
11835
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11836
|
+
}];
|
|
11837
|
+
}, {
|
|
11838
|
+
readonly resource: "ticket.tickets";
|
|
11839
|
+
readonly method: "deleteLock";
|
|
11840
|
+
readonly summary: "Remove lock";
|
|
11841
|
+
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.";
|
|
11842
|
+
readonly http: "DELETE";
|
|
11843
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
11844
|
+
readonly streaming: "no";
|
|
11845
|
+
readonly pagination: false;
|
|
11846
|
+
readonly pathParams: readonly [{
|
|
11847
|
+
readonly name: "number";
|
|
11848
|
+
readonly sdkName: "number";
|
|
11849
|
+
}];
|
|
11850
|
+
readonly query: readonly [{
|
|
11851
|
+
readonly name: "repository";
|
|
11852
|
+
readonly type: "string";
|
|
11853
|
+
readonly required: false;
|
|
11854
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11855
|
+
}];
|
|
11856
|
+
}, {
|
|
11857
|
+
readonly resource: "ticket.tickets";
|
|
11858
|
+
readonly method: "updateLock";
|
|
11859
|
+
readonly summary: "Update lock";
|
|
11860
|
+
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.";
|
|
11861
|
+
readonly http: "PUT";
|
|
11862
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
11863
|
+
readonly streaming: "no";
|
|
11864
|
+
readonly pagination: false;
|
|
11865
|
+
readonly pathParams: readonly [{
|
|
11866
|
+
readonly name: "number";
|
|
11867
|
+
readonly sdkName: "number";
|
|
11868
|
+
}];
|
|
11869
|
+
readonly query: readonly [{
|
|
11870
|
+
readonly name: "repository";
|
|
11871
|
+
readonly type: "string";
|
|
11872
|
+
readonly required: false;
|
|
11873
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11874
|
+
}];
|
|
11875
|
+
readonly body: {
|
|
11876
|
+
readonly required: false;
|
|
11877
|
+
readonly fields: readonly [{
|
|
11878
|
+
readonly name: "lock_reason";
|
|
11879
|
+
readonly type: "string";
|
|
11880
|
+
readonly enum: readonly ["off-topic", "too heated", "resolved", "spam"];
|
|
11881
|
+
readonly required: false;
|
|
11882
|
+
readonly description: "Reason for locking: off-topic, too heated, resolved, or spam.";
|
|
11883
|
+
}];
|
|
11884
|
+
};
|
|
11885
|
+
}, {
|
|
11886
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11887
|
+
readonly method: "list";
|
|
11888
|
+
readonly summary: "List reactions";
|
|
11889
|
+
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.";
|
|
11890
|
+
readonly http: "GET";
|
|
11891
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
11892
|
+
readonly streaming: "no";
|
|
11893
|
+
readonly pagination: false;
|
|
11894
|
+
readonly pathParams: readonly [{
|
|
11895
|
+
readonly name: "number";
|
|
11896
|
+
readonly sdkName: "number";
|
|
11897
|
+
}];
|
|
11898
|
+
readonly query: readonly [{
|
|
11899
|
+
readonly name: "repository";
|
|
11900
|
+
readonly type: "string";
|
|
11901
|
+
readonly required: false;
|
|
11902
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11903
|
+
}, {
|
|
11904
|
+
readonly name: "page_size";
|
|
11905
|
+
readonly type: "integer";
|
|
11906
|
+
readonly required: false;
|
|
11907
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11908
|
+
}, {
|
|
11909
|
+
readonly name: "page_token";
|
|
11910
|
+
readonly type: "string";
|
|
11911
|
+
readonly required: false;
|
|
11912
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11913
|
+
}];
|
|
11914
|
+
}, {
|
|
11915
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11916
|
+
readonly method: "create";
|
|
11917
|
+
readonly summary: "Create or add reactions";
|
|
11918
|
+
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.";
|
|
11919
|
+
readonly http: "POST";
|
|
11920
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
11921
|
+
readonly streaming: "no";
|
|
11922
|
+
readonly pagination: false;
|
|
11923
|
+
readonly pathParams: readonly [{
|
|
11924
|
+
readonly name: "number";
|
|
11925
|
+
readonly sdkName: "number";
|
|
11926
|
+
}];
|
|
11927
|
+
readonly query: readonly [{
|
|
11928
|
+
readonly name: "repository";
|
|
11929
|
+
readonly type: "string";
|
|
11930
|
+
readonly required: false;
|
|
11931
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11932
|
+
}];
|
|
11933
|
+
readonly body: {
|
|
11934
|
+
readonly required: true;
|
|
11935
|
+
readonly fields: readonly [{
|
|
11936
|
+
readonly name: "content";
|
|
11937
|
+
readonly type: "string";
|
|
11938
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11939
|
+
readonly required: true;
|
|
11940
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11941
|
+
}];
|
|
11942
|
+
};
|
|
11943
|
+
}, {
|
|
11944
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11945
|
+
readonly method: "delete";
|
|
11946
|
+
readonly summary: "Remove reactions";
|
|
11947
|
+
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.";
|
|
11948
|
+
readonly http: "DELETE";
|
|
11949
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions/{content}";
|
|
11950
|
+
readonly streaming: "no";
|
|
11951
|
+
readonly pagination: false;
|
|
11952
|
+
readonly pathParams: readonly [{
|
|
11953
|
+
readonly name: "number";
|
|
11954
|
+
readonly sdkName: "number";
|
|
11955
|
+
}, {
|
|
11956
|
+
readonly name: "content";
|
|
11957
|
+
readonly sdkName: "content";
|
|
11958
|
+
}];
|
|
11959
|
+
readonly query: readonly [{
|
|
11960
|
+
readonly name: "repository";
|
|
11961
|
+
readonly type: "string";
|
|
11962
|
+
readonly required: false;
|
|
11963
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11964
|
+
}];
|
|
11965
|
+
}, {
|
|
11966
|
+
readonly resource: "ticket.tickets.relations";
|
|
11967
|
+
readonly method: "list";
|
|
11968
|
+
readonly summary: "List relations";
|
|
11969
|
+
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.";
|
|
11970
|
+
readonly http: "GET";
|
|
11971
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
11972
|
+
readonly streaming: "no";
|
|
11973
|
+
readonly pagination: false;
|
|
11974
|
+
readonly pathParams: readonly [{
|
|
11975
|
+
readonly name: "number";
|
|
11976
|
+
readonly sdkName: "number";
|
|
11977
|
+
}];
|
|
11978
|
+
readonly query: readonly [{
|
|
11979
|
+
readonly name: "repository";
|
|
11980
|
+
readonly type: "string";
|
|
11981
|
+
readonly required: false;
|
|
11982
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11983
|
+
}, {
|
|
11984
|
+
readonly name: "page_size";
|
|
11985
|
+
readonly type: "integer";
|
|
11986
|
+
readonly required: false;
|
|
11987
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11988
|
+
}, {
|
|
11989
|
+
readonly name: "page_token";
|
|
11990
|
+
readonly type: "string";
|
|
11991
|
+
readonly required: false;
|
|
11992
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11993
|
+
}];
|
|
11994
|
+
}, {
|
|
11995
|
+
readonly resource: "ticket.tickets.relations";
|
|
11996
|
+
readonly method: "create";
|
|
11997
|
+
readonly summary: "Create or add relations";
|
|
11998
|
+
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.";
|
|
11999
|
+
readonly http: "POST";
|
|
12000
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12001
|
+
readonly streaming: "no";
|
|
12002
|
+
readonly pagination: false;
|
|
12003
|
+
readonly pathParams: readonly [{
|
|
12004
|
+
readonly name: "number";
|
|
12005
|
+
readonly sdkName: "number";
|
|
12006
|
+
}];
|
|
12007
|
+
readonly query: readonly [{
|
|
12008
|
+
readonly name: "repository";
|
|
12009
|
+
readonly type: "string";
|
|
12010
|
+
readonly required: false;
|
|
12011
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12012
|
+
}];
|
|
12013
|
+
readonly body: {
|
|
12014
|
+
readonly required: true;
|
|
12015
|
+
readonly fields: readonly [{
|
|
12016
|
+
readonly name: "relates_to";
|
|
12017
|
+
readonly type: "integer";
|
|
12018
|
+
readonly required: true;
|
|
12019
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12020
|
+
}];
|
|
12021
|
+
};
|
|
12022
|
+
}, {
|
|
12023
|
+
readonly resource: "ticket.tickets.relations";
|
|
12024
|
+
readonly method: "delete";
|
|
12025
|
+
readonly summary: "Remove relations";
|
|
12026
|
+
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.";
|
|
12027
|
+
readonly http: "DELETE";
|
|
12028
|
+
readonly path: "/ticket/v1/tickets/{number}/relations/{n}";
|
|
12029
|
+
readonly streaming: "no";
|
|
12030
|
+
readonly pagination: false;
|
|
12031
|
+
readonly pathParams: readonly [{
|
|
12032
|
+
readonly name: "number";
|
|
12033
|
+
readonly sdkName: "number";
|
|
12034
|
+
}, {
|
|
12035
|
+
readonly name: "n";
|
|
12036
|
+
readonly sdkName: "n";
|
|
12037
|
+
}];
|
|
12038
|
+
readonly query: readonly [{
|
|
12039
|
+
readonly name: "repository";
|
|
12040
|
+
readonly type: "string";
|
|
12041
|
+
readonly required: false;
|
|
12042
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12043
|
+
}];
|
|
12044
|
+
}, {
|
|
12045
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12046
|
+
readonly method: "list";
|
|
12047
|
+
readonly summary: "List sub tickets";
|
|
12048
|
+
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.";
|
|
12049
|
+
readonly http: "GET";
|
|
12050
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12051
|
+
readonly streaming: "no";
|
|
12052
|
+
readonly pagination: false;
|
|
12053
|
+
readonly pathParams: readonly [{
|
|
12054
|
+
readonly name: "number";
|
|
12055
|
+
readonly sdkName: "number";
|
|
12056
|
+
}];
|
|
12057
|
+
readonly query: readonly [{
|
|
12058
|
+
readonly name: "repository";
|
|
12059
|
+
readonly type: "string";
|
|
12060
|
+
readonly required: false;
|
|
12061
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12062
|
+
}, {
|
|
12063
|
+
readonly name: "page_size";
|
|
12064
|
+
readonly type: "integer";
|
|
12065
|
+
readonly required: false;
|
|
12066
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12067
|
+
}, {
|
|
12068
|
+
readonly name: "page_token";
|
|
12069
|
+
readonly type: "string";
|
|
12070
|
+
readonly required: false;
|
|
12071
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12072
|
+
}];
|
|
12073
|
+
}, {
|
|
12074
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12075
|
+
readonly method: "create";
|
|
12076
|
+
readonly summary: "Create or add sub tickets";
|
|
12077
|
+
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.";
|
|
12078
|
+
readonly http: "POST";
|
|
12079
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12080
|
+
readonly streaming: "no";
|
|
12081
|
+
readonly pagination: false;
|
|
12082
|
+
readonly pathParams: readonly [{
|
|
12083
|
+
readonly name: "number";
|
|
12084
|
+
readonly sdkName: "number";
|
|
12085
|
+
}];
|
|
12086
|
+
readonly query: readonly [{
|
|
12087
|
+
readonly name: "repository";
|
|
12088
|
+
readonly type: "string";
|
|
12089
|
+
readonly required: false;
|
|
12090
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12091
|
+
}];
|
|
12092
|
+
readonly body: {
|
|
12093
|
+
readonly required: true;
|
|
12094
|
+
readonly fields: readonly [{
|
|
12095
|
+
readonly name: "child";
|
|
12096
|
+
readonly type: "integer";
|
|
12097
|
+
readonly required: true;
|
|
12098
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12099
|
+
}, {
|
|
12100
|
+
readonly name: "replace_parent";
|
|
12101
|
+
readonly type: "boolean";
|
|
12102
|
+
readonly required: false;
|
|
12103
|
+
readonly description: "Allow replacing an existing parent.";
|
|
12104
|
+
}];
|
|
12105
|
+
};
|
|
12106
|
+
}, {
|
|
12107
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12108
|
+
readonly method: "delete";
|
|
12109
|
+
readonly summary: "Remove sub tickets";
|
|
12110
|
+
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.";
|
|
12111
|
+
readonly http: "DELETE";
|
|
12112
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets/{child}";
|
|
12113
|
+
readonly streaming: "no";
|
|
12114
|
+
readonly pagination: false;
|
|
12115
|
+
readonly pathParams: readonly [{
|
|
12116
|
+
readonly name: "number";
|
|
12117
|
+
readonly sdkName: "number";
|
|
12118
|
+
}, {
|
|
12119
|
+
readonly name: "child";
|
|
12120
|
+
readonly sdkName: "child";
|
|
12121
|
+
}];
|
|
12122
|
+
readonly query: readonly [{
|
|
12123
|
+
readonly name: "repository";
|
|
12124
|
+
readonly type: "string";
|
|
12125
|
+
readonly required: false;
|
|
12126
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12127
|
+
}];
|
|
12128
|
+
}, {
|
|
12129
|
+
readonly resource: "ticket.types";
|
|
12130
|
+
readonly method: "list";
|
|
12131
|
+
readonly summary: "Read types";
|
|
12132
|
+
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.";
|
|
12133
|
+
readonly http: "GET";
|
|
12134
|
+
readonly path: "/ticket/v1/types";
|
|
12135
|
+
readonly streaming: "no";
|
|
12136
|
+
readonly pagination: false;
|
|
12137
|
+
readonly pathParams: readonly [];
|
|
12138
|
+
readonly query: readonly [{
|
|
12139
|
+
readonly name: "repository";
|
|
12140
|
+
readonly type: "string";
|
|
12141
|
+
readonly required: false;
|
|
12142
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12143
|
+
}];
|
|
10798
12144
|
}, {
|
|
10799
12145
|
readonly resource: "vault.authorizations";
|
|
10800
12146
|
readonly method: "create";
|