@deepraxis/sdk 0.1.0-dev.c0c05d8 → 0.1.0-dev.c45414d
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 +119 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +256 -10
- package/dist/generated/sdk.gen.js +803 -9
- package/dist/generated/types.gen.d.ts +15805 -11590
- package/dist/operations.generated.d.ts +1207 -39
- package/dist/operations.generated.js +1518 -41
- package/dist/resources.generated.d.ts +574 -84
- package/dist/resources.generated.js +76 -0
- package/package.json +1 -1
|
@@ -103,23 +103,11 @@ export declare const operations: readonly [{
|
|
|
103
103
|
readonly required: false;
|
|
104
104
|
readonly description: "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed.";
|
|
105
105
|
}, {
|
|
106
|
-
readonly name: "
|
|
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";
|
|
106
|
+
readonly name: "bindings";
|
|
119
107
|
readonly type: "array";
|
|
120
108
|
readonly itemType: "object";
|
|
121
109
|
readonly required: false;
|
|
122
|
-
readonly description: "
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file_..., read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. A resource that is not bound returns 404, a service that is not opened returns 403, and writes to read_only resources are refused. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.";
|
|
123
111
|
}, {
|
|
124
112
|
readonly name: "kind";
|
|
125
113
|
readonly type: "string";
|
|
@@ -158,6 +146,11 @@ export declare const operations: readonly [{
|
|
|
158
146
|
readonly type: "object";
|
|
159
147
|
readonly required: false;
|
|
160
148
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
149
|
+
}, {
|
|
150
|
+
readonly name: "avatar";
|
|
151
|
+
readonly type: "string";
|
|
152
|
+
readonly required: false;
|
|
153
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
161
154
|
}, {
|
|
162
155
|
readonly name: "preset";
|
|
163
156
|
readonly type: "string";
|
|
@@ -189,7 +182,7 @@ export declare const operations: readonly [{
|
|
|
189
182
|
readonly resource: "agent.agents";
|
|
190
183
|
readonly method: "update";
|
|
191
184
|
readonly summary: "Update agent";
|
|
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
|
|
185
|
+
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.";
|
|
193
186
|
readonly http: "POST";
|
|
194
187
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
195
188
|
readonly streaming: "no";
|
|
@@ -255,23 +248,21 @@ export declare const operations: readonly [{
|
|
|
255
248
|
readonly required: false;
|
|
256
249
|
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
250
|
}, {
|
|
258
|
-
readonly name: "
|
|
259
|
-
readonly type: "
|
|
260
|
-
readonly itemType: "object";
|
|
251
|
+
readonly name: "apply";
|
|
252
|
+
readonly type: "boolean";
|
|
261
253
|
readonly required: false;
|
|
262
|
-
readonly description: "
|
|
254
|
+
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.";
|
|
263
255
|
}, {
|
|
264
|
-
readonly name: "
|
|
265
|
-
readonly type: "
|
|
266
|
-
readonly itemType: "object";
|
|
256
|
+
readonly name: "version_note";
|
|
257
|
+
readonly type: "string";
|
|
267
258
|
readonly required: false;
|
|
268
|
-
readonly description: "
|
|
259
|
+
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.";
|
|
269
260
|
}, {
|
|
270
|
-
readonly name: "
|
|
261
|
+
readonly name: "bindings";
|
|
271
262
|
readonly type: "array";
|
|
272
263
|
readonly itemType: "object";
|
|
273
264
|
readonly required: false;
|
|
274
|
-
readonly description: "Replace
|
|
265
|
+
readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept a nonempty list.";
|
|
275
266
|
}, {
|
|
276
267
|
readonly name: "kind";
|
|
277
268
|
readonly type: "string";
|
|
@@ -310,6 +301,11 @@ export declare const operations: readonly [{
|
|
|
310
301
|
readonly type: "object";
|
|
311
302
|
readonly required: false;
|
|
312
303
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
304
|
+
}, {
|
|
305
|
+
readonly name: "avatar";
|
|
306
|
+
readonly type: "string";
|
|
307
|
+
readonly required: false;
|
|
308
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
313
309
|
}, {
|
|
314
310
|
readonly name: "preset";
|
|
315
311
|
readonly type: "string";
|
|
@@ -506,6 +502,23 @@ export declare const operations: readonly [{
|
|
|
506
502
|
readonly required: false;
|
|
507
503
|
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.";
|
|
508
504
|
}];
|
|
505
|
+
}, {
|
|
506
|
+
readonly resource: "agent.agents.versions";
|
|
507
|
+
readonly method: "apply";
|
|
508
|
+
readonly summary: "Apply Agent Version";
|
|
509
|
+
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.";
|
|
510
|
+
readonly http: "POST";
|
|
511
|
+
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
512
|
+
readonly streaming: "no";
|
|
513
|
+
readonly pagination: false;
|
|
514
|
+
readonly pathParams: readonly [{
|
|
515
|
+
readonly name: "agent_id";
|
|
516
|
+
readonly sdkName: "agent_id";
|
|
517
|
+
}, {
|
|
518
|
+
readonly name: "version";
|
|
519
|
+
readonly sdkName: "version";
|
|
520
|
+
}];
|
|
521
|
+
readonly query: readonly [];
|
|
509
522
|
}, {
|
|
510
523
|
readonly resource: "agent.computers";
|
|
511
524
|
readonly method: "list";
|
|
@@ -1478,7 +1491,7 @@ export declare const operations: readonly [{
|
|
|
1478
1491
|
readonly resource: "agent.sessions";
|
|
1479
1492
|
readonly method: "create";
|
|
1480
1493
|
readonly summary: "Create session";
|
|
1481
|
-
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id (
|
|
1494
|
+
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.";
|
|
1482
1495
|
readonly http: "POST";
|
|
1483
1496
|
readonly path: "/agent/v1/sessions";
|
|
1484
1497
|
readonly streaming: "no";
|
|
@@ -2880,12 +2893,12 @@ export declare const operations: readonly [{
|
|
|
2880
2893
|
readonly name: "namespace";
|
|
2881
2894
|
readonly type: "string";
|
|
2882
2895
|
readonly required: true;
|
|
2883
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
2896
|
+
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}.";
|
|
2884
2897
|
}, {
|
|
2885
2898
|
readonly name: "name";
|
|
2886
2899
|
readonly type: "string";
|
|
2887
2900
|
readonly required: true;
|
|
2888
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
2901
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2889
2902
|
}, {
|
|
2890
2903
|
readonly name: "description";
|
|
2891
2904
|
readonly type: "string";
|
|
@@ -2937,8 +2950,8 @@ export declare const operations: readonly [{
|
|
|
2937
2950
|
}, {
|
|
2938
2951
|
readonly resource: "automation.actions";
|
|
2939
2952
|
readonly method: "retrieve";
|
|
2940
|
-
readonly summary: "Get an
|
|
2941
|
-
readonly description: "Read the
|
|
2953
|
+
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
2954
|
+
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.";
|
|
2942
2955
|
readonly http: "GET";
|
|
2943
2956
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2944
2957
|
readonly streaming: "no";
|
|
@@ -3382,8 +3395,8 @@ export declare const operations: readonly [{
|
|
|
3382
3395
|
}, {
|
|
3383
3396
|
readonly resource: "automation.runs";
|
|
3384
3397
|
readonly method: "create";
|
|
3385
|
-
readonly summary: "
|
|
3386
|
-
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
|
|
3398
|
+
readonly summary: "Run a published target or execute draft source";
|
|
3399
|
+
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.";
|
|
3387
3400
|
readonly http: "POST";
|
|
3388
3401
|
readonly path: "/automation/v1/runs";
|
|
3389
3402
|
readonly streaming: "no";
|
|
@@ -3766,7 +3779,7 @@ export declare const operations: readonly [{
|
|
|
3766
3779
|
readonly resource: "automation.scripts";
|
|
3767
3780
|
readonly method: "create";
|
|
3768
3781
|
readonly summary: "Create a script";
|
|
3769
|
-
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
|
|
3782
|
+
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.";
|
|
3770
3783
|
readonly http: "POST";
|
|
3771
3784
|
readonly path: "/automation/v1/scripts";
|
|
3772
3785
|
readonly streaming: "no";
|
|
@@ -3779,12 +3792,12 @@ export declare const operations: readonly [{
|
|
|
3779
3792
|
readonly name: "namespace";
|
|
3780
3793
|
readonly type: "string";
|
|
3781
3794
|
readonly required: true;
|
|
3782
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3795
|
+
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}.";
|
|
3783
3796
|
}, {
|
|
3784
3797
|
readonly name: "name";
|
|
3785
3798
|
readonly type: "string";
|
|
3786
3799
|
readonly required: true;
|
|
3787
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3800
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3788
3801
|
}, {
|
|
3789
3802
|
readonly name: "description";
|
|
3790
3803
|
readonly type: "string";
|
|
@@ -3823,7 +3836,7 @@ export declare const operations: readonly [{
|
|
|
3823
3836
|
readonly resource: "automation.scripts";
|
|
3824
3837
|
readonly method: "update";
|
|
3825
3838
|
readonly summary: "Update a script draft";
|
|
3826
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
3839
|
+
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.";
|
|
3827
3840
|
readonly http: "PATCH";
|
|
3828
3841
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3829
3842
|
readonly streaming: "no";
|
|
@@ -4582,7 +4595,7 @@ export declare const operations: readonly [{
|
|
|
4582
4595
|
readonly resource: "automation.workflows";
|
|
4583
4596
|
readonly method: "create";
|
|
4584
4597
|
readonly summary: "Create a workflow";
|
|
4585
|
-
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
|
|
4598
|
+
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.";
|
|
4586
4599
|
readonly http: "POST";
|
|
4587
4600
|
readonly path: "/automation/v1/workflows";
|
|
4588
4601
|
readonly streaming: "no";
|
|
@@ -4595,12 +4608,12 @@ export declare const operations: readonly [{
|
|
|
4595
4608
|
readonly name: "namespace";
|
|
4596
4609
|
readonly type: "string";
|
|
4597
4610
|
readonly required: true;
|
|
4598
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4611
|
+
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}.";
|
|
4599
4612
|
}, {
|
|
4600
4613
|
readonly name: "name";
|
|
4601
4614
|
readonly type: "string";
|
|
4602
4615
|
readonly required: true;
|
|
4603
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4616
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4604
4617
|
}, {
|
|
4605
4618
|
readonly name: "description";
|
|
4606
4619
|
readonly type: "string";
|
|
@@ -10959,6 +10972,1161 @@ export declare const operations: readonly [{
|
|
|
10959
10972
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10960
10973
|
}];
|
|
10961
10974
|
};
|
|
10975
|
+
}, {
|
|
10976
|
+
readonly resource: "ticket.activity";
|
|
10977
|
+
readonly method: "retrieve";
|
|
10978
|
+
readonly summary: "List activity";
|
|
10979
|
+
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.";
|
|
10980
|
+
readonly http: "GET";
|
|
10981
|
+
readonly path: "/ticket/v1/activity";
|
|
10982
|
+
readonly streaming: "no";
|
|
10983
|
+
readonly pagination: false;
|
|
10984
|
+
readonly pathParams: readonly [];
|
|
10985
|
+
readonly query: readonly [{
|
|
10986
|
+
readonly name: "repository";
|
|
10987
|
+
readonly type: "string";
|
|
10988
|
+
readonly required: false;
|
|
10989
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
10990
|
+
}, {
|
|
10991
|
+
readonly name: "page_size";
|
|
10992
|
+
readonly type: "integer";
|
|
10993
|
+
readonly required: false;
|
|
10994
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
10995
|
+
}, {
|
|
10996
|
+
readonly name: "page_token";
|
|
10997
|
+
readonly type: "string";
|
|
10998
|
+
readonly required: false;
|
|
10999
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11000
|
+
}, {
|
|
11001
|
+
readonly name: "filter";
|
|
11002
|
+
readonly type: "string";
|
|
11003
|
+
readonly required: false;
|
|
11004
|
+
readonly description: "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service.";
|
|
11005
|
+
}];
|
|
11006
|
+
}, {
|
|
11007
|
+
readonly resource: "ticket.comments";
|
|
11008
|
+
readonly method: "delete";
|
|
11009
|
+
readonly summary: "Remove comments";
|
|
11010
|
+
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.";
|
|
11011
|
+
readonly http: "DELETE";
|
|
11012
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11013
|
+
readonly streaming: "no";
|
|
11014
|
+
readonly pagination: false;
|
|
11015
|
+
readonly pathParams: readonly [{
|
|
11016
|
+
readonly name: "id";
|
|
11017
|
+
readonly sdkName: "id";
|
|
11018
|
+
}];
|
|
11019
|
+
readonly query: readonly [{
|
|
11020
|
+
readonly name: "repository";
|
|
11021
|
+
readonly type: "string";
|
|
11022
|
+
readonly required: false;
|
|
11023
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11024
|
+
}];
|
|
11025
|
+
}, {
|
|
11026
|
+
readonly resource: "ticket.comments";
|
|
11027
|
+
readonly method: "retrieve";
|
|
11028
|
+
readonly summary: "Read comments";
|
|
11029
|
+
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.";
|
|
11030
|
+
readonly http: "GET";
|
|
11031
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11032
|
+
readonly streaming: "no";
|
|
11033
|
+
readonly pagination: false;
|
|
11034
|
+
readonly pathParams: readonly [{
|
|
11035
|
+
readonly name: "id";
|
|
11036
|
+
readonly sdkName: "id";
|
|
11037
|
+
}];
|
|
11038
|
+
readonly query: readonly [{
|
|
11039
|
+
readonly name: "repository";
|
|
11040
|
+
readonly type: "string";
|
|
11041
|
+
readonly required: false;
|
|
11042
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11043
|
+
}];
|
|
11044
|
+
}, {
|
|
11045
|
+
readonly resource: "ticket.comments";
|
|
11046
|
+
readonly method: "update";
|
|
11047
|
+
readonly summary: "Update comments";
|
|
11048
|
+
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.";
|
|
11049
|
+
readonly http: "PATCH";
|
|
11050
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11051
|
+
readonly streaming: "no";
|
|
11052
|
+
readonly pagination: false;
|
|
11053
|
+
readonly pathParams: readonly [{
|
|
11054
|
+
readonly name: "id";
|
|
11055
|
+
readonly sdkName: "id";
|
|
11056
|
+
}];
|
|
11057
|
+
readonly query: readonly [{
|
|
11058
|
+
readonly name: "repository";
|
|
11059
|
+
readonly type: "string";
|
|
11060
|
+
readonly required: false;
|
|
11061
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11062
|
+
}];
|
|
11063
|
+
readonly body: {
|
|
11064
|
+
readonly required: true;
|
|
11065
|
+
readonly fields: readonly [{
|
|
11066
|
+
readonly name: "body";
|
|
11067
|
+
readonly type: "string";
|
|
11068
|
+
readonly required: true;
|
|
11069
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11070
|
+
}, {
|
|
11071
|
+
readonly name: "in_reply_to";
|
|
11072
|
+
readonly type: "string";
|
|
11073
|
+
readonly required: false;
|
|
11074
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11075
|
+
}];
|
|
11076
|
+
};
|
|
11077
|
+
}, {
|
|
11078
|
+
readonly resource: "ticket.comments.reactions";
|
|
11079
|
+
readonly method: "list";
|
|
11080
|
+
readonly summary: "List reactions";
|
|
11081
|
+
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.";
|
|
11082
|
+
readonly http: "GET";
|
|
11083
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11084
|
+
readonly streaming: "no";
|
|
11085
|
+
readonly pagination: false;
|
|
11086
|
+
readonly pathParams: readonly [{
|
|
11087
|
+
readonly name: "id";
|
|
11088
|
+
readonly sdkName: "id";
|
|
11089
|
+
}];
|
|
11090
|
+
readonly query: readonly [{
|
|
11091
|
+
readonly name: "repository";
|
|
11092
|
+
readonly type: "string";
|
|
11093
|
+
readonly required: false;
|
|
11094
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11095
|
+
}, {
|
|
11096
|
+
readonly name: "page_size";
|
|
11097
|
+
readonly type: "integer";
|
|
11098
|
+
readonly required: false;
|
|
11099
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11100
|
+
}, {
|
|
11101
|
+
readonly name: "page_token";
|
|
11102
|
+
readonly type: "string";
|
|
11103
|
+
readonly required: false;
|
|
11104
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11105
|
+
}];
|
|
11106
|
+
}, {
|
|
11107
|
+
readonly resource: "ticket.comments.reactions";
|
|
11108
|
+
readonly method: "create";
|
|
11109
|
+
readonly summary: "Create or add reactions";
|
|
11110
|
+
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.";
|
|
11111
|
+
readonly http: "POST";
|
|
11112
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11113
|
+
readonly streaming: "no";
|
|
11114
|
+
readonly pagination: false;
|
|
11115
|
+
readonly pathParams: readonly [{
|
|
11116
|
+
readonly name: "id";
|
|
11117
|
+
readonly sdkName: "id";
|
|
11118
|
+
}];
|
|
11119
|
+
readonly query: readonly [{
|
|
11120
|
+
readonly name: "repository";
|
|
11121
|
+
readonly type: "string";
|
|
11122
|
+
readonly required: false;
|
|
11123
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11124
|
+
}];
|
|
11125
|
+
readonly body: {
|
|
11126
|
+
readonly required: true;
|
|
11127
|
+
readonly fields: readonly [{
|
|
11128
|
+
readonly name: "content";
|
|
11129
|
+
readonly type: "string";
|
|
11130
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11131
|
+
readonly required: true;
|
|
11132
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11133
|
+
}];
|
|
11134
|
+
};
|
|
11135
|
+
}, {
|
|
11136
|
+
readonly resource: "ticket.comments.reactions";
|
|
11137
|
+
readonly method: "delete";
|
|
11138
|
+
readonly summary: "Remove reactions";
|
|
11139
|
+
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.";
|
|
11140
|
+
readonly http: "DELETE";
|
|
11141
|
+
readonly path: "/ticket/v1/comments/{id}/reactions/{content}";
|
|
11142
|
+
readonly streaming: "no";
|
|
11143
|
+
readonly pagination: false;
|
|
11144
|
+
readonly pathParams: readonly [{
|
|
11145
|
+
readonly name: "id";
|
|
11146
|
+
readonly sdkName: "id";
|
|
11147
|
+
}, {
|
|
11148
|
+
readonly name: "content";
|
|
11149
|
+
readonly sdkName: "content";
|
|
11150
|
+
}];
|
|
11151
|
+
readonly query: readonly [{
|
|
11152
|
+
readonly name: "repository";
|
|
11153
|
+
readonly type: "string";
|
|
11154
|
+
readonly required: false;
|
|
11155
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11156
|
+
}];
|
|
11157
|
+
}, {
|
|
11158
|
+
readonly resource: "ticket.labels";
|
|
11159
|
+
readonly method: "list";
|
|
11160
|
+
readonly summary: "List labels";
|
|
11161
|
+
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.";
|
|
11162
|
+
readonly http: "GET";
|
|
11163
|
+
readonly path: "/ticket/v1/labels";
|
|
11164
|
+
readonly streaming: "no";
|
|
11165
|
+
readonly pagination: false;
|
|
11166
|
+
readonly pathParams: readonly [];
|
|
11167
|
+
readonly query: readonly [{
|
|
11168
|
+
readonly name: "repository";
|
|
11169
|
+
readonly type: "string";
|
|
11170
|
+
readonly required: false;
|
|
11171
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11172
|
+
}, {
|
|
11173
|
+
readonly name: "page_size";
|
|
11174
|
+
readonly type: "integer";
|
|
11175
|
+
readonly required: false;
|
|
11176
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11177
|
+
}, {
|
|
11178
|
+
readonly name: "page_token";
|
|
11179
|
+
readonly type: "string";
|
|
11180
|
+
readonly required: false;
|
|
11181
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11182
|
+
}];
|
|
11183
|
+
}, {
|
|
11184
|
+
readonly resource: "ticket.labels";
|
|
11185
|
+
readonly method: "create";
|
|
11186
|
+
readonly summary: "Create or add labels";
|
|
11187
|
+
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.";
|
|
11188
|
+
readonly http: "POST";
|
|
11189
|
+
readonly path: "/ticket/v1/labels";
|
|
11190
|
+
readonly streaming: "no";
|
|
11191
|
+
readonly pagination: false;
|
|
11192
|
+
readonly pathParams: readonly [];
|
|
11193
|
+
readonly query: readonly [{
|
|
11194
|
+
readonly name: "repository";
|
|
11195
|
+
readonly type: "string";
|
|
11196
|
+
readonly required: false;
|
|
11197
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11198
|
+
}];
|
|
11199
|
+
readonly body: {
|
|
11200
|
+
readonly required: true;
|
|
11201
|
+
readonly fields: readonly [{
|
|
11202
|
+
readonly name: "name";
|
|
11203
|
+
readonly type: "string";
|
|
11204
|
+
readonly required: true;
|
|
11205
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11206
|
+
}, {
|
|
11207
|
+
readonly name: "color";
|
|
11208
|
+
readonly type: "string";
|
|
11209
|
+
readonly required: true;
|
|
11210
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11211
|
+
}, {
|
|
11212
|
+
readonly name: "description";
|
|
11213
|
+
readonly type: "string";
|
|
11214
|
+
readonly required: false;
|
|
11215
|
+
readonly description: "Label's purpose.";
|
|
11216
|
+
}];
|
|
11217
|
+
};
|
|
11218
|
+
}, {
|
|
11219
|
+
readonly resource: "ticket.labels";
|
|
11220
|
+
readonly method: "delete";
|
|
11221
|
+
readonly summary: "Remove labels";
|
|
11222
|
+
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.";
|
|
11223
|
+
readonly http: "DELETE";
|
|
11224
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11225
|
+
readonly streaming: "no";
|
|
11226
|
+
readonly pagination: false;
|
|
11227
|
+
readonly pathParams: readonly [{
|
|
11228
|
+
readonly name: "name";
|
|
11229
|
+
readonly sdkName: "name";
|
|
11230
|
+
}];
|
|
11231
|
+
readonly query: readonly [{
|
|
11232
|
+
readonly name: "repository";
|
|
11233
|
+
readonly type: "string";
|
|
11234
|
+
readonly required: false;
|
|
11235
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11236
|
+
}];
|
|
11237
|
+
}, {
|
|
11238
|
+
readonly resource: "ticket.labels";
|
|
11239
|
+
readonly method: "update";
|
|
11240
|
+
readonly summary: "Update labels";
|
|
11241
|
+
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.";
|
|
11242
|
+
readonly http: "PATCH";
|
|
11243
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11244
|
+
readonly streaming: "no";
|
|
11245
|
+
readonly pagination: false;
|
|
11246
|
+
readonly pathParams: readonly [{
|
|
11247
|
+
readonly name: "name";
|
|
11248
|
+
readonly sdkName: "name";
|
|
11249
|
+
}];
|
|
11250
|
+
readonly query: readonly [{
|
|
11251
|
+
readonly name: "repository";
|
|
11252
|
+
readonly type: "string";
|
|
11253
|
+
readonly required: false;
|
|
11254
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11255
|
+
}];
|
|
11256
|
+
readonly body: {
|
|
11257
|
+
readonly required: true;
|
|
11258
|
+
readonly fields: readonly [{
|
|
11259
|
+
readonly name: "color";
|
|
11260
|
+
readonly type: "string";
|
|
11261
|
+
readonly required: false;
|
|
11262
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11263
|
+
}, {
|
|
11264
|
+
readonly name: "description";
|
|
11265
|
+
readonly type: "string";
|
|
11266
|
+
readonly required: false;
|
|
11267
|
+
readonly description: "Label's purpose.";
|
|
11268
|
+
}, {
|
|
11269
|
+
readonly name: "new_name";
|
|
11270
|
+
readonly type: "string";
|
|
11271
|
+
readonly required: false;
|
|
11272
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11273
|
+
}];
|
|
11274
|
+
};
|
|
11275
|
+
}, {
|
|
11276
|
+
readonly resource: "ticket.milestones";
|
|
11277
|
+
readonly method: "list";
|
|
11278
|
+
readonly summary: "List milestones";
|
|
11279
|
+
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.";
|
|
11280
|
+
readonly http: "GET";
|
|
11281
|
+
readonly path: "/ticket/v1/milestones";
|
|
11282
|
+
readonly streaming: "no";
|
|
11283
|
+
readonly pagination: false;
|
|
11284
|
+
readonly pathParams: readonly [];
|
|
11285
|
+
readonly query: readonly [{
|
|
11286
|
+
readonly name: "repository";
|
|
11287
|
+
readonly type: "string";
|
|
11288
|
+
readonly required: false;
|
|
11289
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11290
|
+
}, {
|
|
11291
|
+
readonly name: "page_size";
|
|
11292
|
+
readonly type: "integer";
|
|
11293
|
+
readonly required: false;
|
|
11294
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11295
|
+
}, {
|
|
11296
|
+
readonly name: "page_token";
|
|
11297
|
+
readonly type: "string";
|
|
11298
|
+
readonly required: false;
|
|
11299
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11300
|
+
}];
|
|
11301
|
+
}, {
|
|
11302
|
+
readonly resource: "ticket.milestones";
|
|
11303
|
+
readonly method: "create";
|
|
11304
|
+
readonly summary: "Create or add milestones";
|
|
11305
|
+
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.";
|
|
11306
|
+
readonly http: "POST";
|
|
11307
|
+
readonly path: "/ticket/v1/milestones";
|
|
11308
|
+
readonly streaming: "no";
|
|
11309
|
+
readonly pagination: false;
|
|
11310
|
+
readonly pathParams: readonly [];
|
|
11311
|
+
readonly query: readonly [{
|
|
11312
|
+
readonly name: "repository";
|
|
11313
|
+
readonly type: "string";
|
|
11314
|
+
readonly required: false;
|
|
11315
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11316
|
+
}];
|
|
11317
|
+
readonly body: {
|
|
11318
|
+
readonly required: true;
|
|
11319
|
+
readonly fields: readonly [{
|
|
11320
|
+
readonly name: "title";
|
|
11321
|
+
readonly type: "string";
|
|
11322
|
+
readonly required: true;
|
|
11323
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11324
|
+
}, {
|
|
11325
|
+
readonly name: "description";
|
|
11326
|
+
readonly type: "string";
|
|
11327
|
+
readonly required: false;
|
|
11328
|
+
readonly description: "Milestone description.";
|
|
11329
|
+
}, {
|
|
11330
|
+
readonly name: "due_on";
|
|
11331
|
+
readonly type: "string";
|
|
11332
|
+
readonly required: false;
|
|
11333
|
+
readonly description: "Due date, or null if unset.";
|
|
11334
|
+
}, {
|
|
11335
|
+
readonly name: "state";
|
|
11336
|
+
readonly type: "string";
|
|
11337
|
+
readonly enum: readonly ["open", "closed"];
|
|
11338
|
+
readonly required: false;
|
|
11339
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11340
|
+
}];
|
|
11341
|
+
};
|
|
11342
|
+
}, {
|
|
11343
|
+
readonly resource: "ticket.milestones";
|
|
11344
|
+
readonly method: "delete";
|
|
11345
|
+
readonly summary: "Remove milestones";
|
|
11346
|
+
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.";
|
|
11347
|
+
readonly http: "DELETE";
|
|
11348
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11349
|
+
readonly streaming: "no";
|
|
11350
|
+
readonly pagination: false;
|
|
11351
|
+
readonly pathParams: readonly [{
|
|
11352
|
+
readonly name: "number";
|
|
11353
|
+
readonly sdkName: "number";
|
|
11354
|
+
}];
|
|
11355
|
+
readonly query: readonly [{
|
|
11356
|
+
readonly name: "repository";
|
|
11357
|
+
readonly type: "string";
|
|
11358
|
+
readonly required: false;
|
|
11359
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11360
|
+
}];
|
|
11361
|
+
}, {
|
|
11362
|
+
readonly resource: "ticket.milestones";
|
|
11363
|
+
readonly method: "retrieve";
|
|
11364
|
+
readonly summary: "Read milestones";
|
|
11365
|
+
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.";
|
|
11366
|
+
readonly http: "GET";
|
|
11367
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11368
|
+
readonly streaming: "no";
|
|
11369
|
+
readonly pagination: false;
|
|
11370
|
+
readonly pathParams: readonly [{
|
|
11371
|
+
readonly name: "number";
|
|
11372
|
+
readonly sdkName: "number";
|
|
11373
|
+
}];
|
|
11374
|
+
readonly query: readonly [{
|
|
11375
|
+
readonly name: "repository";
|
|
11376
|
+
readonly type: "string";
|
|
11377
|
+
readonly required: false;
|
|
11378
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11379
|
+
}];
|
|
11380
|
+
}, {
|
|
11381
|
+
readonly resource: "ticket.milestones";
|
|
11382
|
+
readonly method: "update";
|
|
11383
|
+
readonly summary: "Update milestones";
|
|
11384
|
+
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.";
|
|
11385
|
+
readonly http: "PATCH";
|
|
11386
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11387
|
+
readonly streaming: "no";
|
|
11388
|
+
readonly pagination: false;
|
|
11389
|
+
readonly pathParams: readonly [{
|
|
11390
|
+
readonly name: "number";
|
|
11391
|
+
readonly sdkName: "number";
|
|
11392
|
+
}];
|
|
11393
|
+
readonly query: readonly [{
|
|
11394
|
+
readonly name: "repository";
|
|
11395
|
+
readonly type: "string";
|
|
11396
|
+
readonly required: false;
|
|
11397
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11398
|
+
}];
|
|
11399
|
+
readonly body: {
|
|
11400
|
+
readonly required: true;
|
|
11401
|
+
readonly fields: readonly [{
|
|
11402
|
+
readonly name: "title";
|
|
11403
|
+
readonly type: "string";
|
|
11404
|
+
readonly required: false;
|
|
11405
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11406
|
+
}, {
|
|
11407
|
+
readonly name: "description";
|
|
11408
|
+
readonly type: "string";
|
|
11409
|
+
readonly required: false;
|
|
11410
|
+
readonly description: "Milestone description.";
|
|
11411
|
+
}, {
|
|
11412
|
+
readonly name: "due_on";
|
|
11413
|
+
readonly type: "string";
|
|
11414
|
+
readonly required: false;
|
|
11415
|
+
readonly description: "Due date, or null if unset.";
|
|
11416
|
+
}, {
|
|
11417
|
+
readonly name: "state";
|
|
11418
|
+
readonly type: "string";
|
|
11419
|
+
readonly enum: readonly ["open", "closed"];
|
|
11420
|
+
readonly required: false;
|
|
11421
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11422
|
+
}];
|
|
11423
|
+
};
|
|
11424
|
+
}, {
|
|
11425
|
+
readonly resource: "ticket.repositories";
|
|
11426
|
+
readonly method: "list";
|
|
11427
|
+
readonly summary: "List repositories";
|
|
11428
|
+
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.";
|
|
11429
|
+
readonly http: "GET";
|
|
11430
|
+
readonly path: "/ticket/v1/repositories";
|
|
11431
|
+
readonly streaming: "no";
|
|
11432
|
+
readonly pagination: false;
|
|
11433
|
+
readonly pathParams: readonly [];
|
|
11434
|
+
readonly query: readonly [{
|
|
11435
|
+
readonly name: "page_size";
|
|
11436
|
+
readonly type: "integer";
|
|
11437
|
+
readonly required: false;
|
|
11438
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11439
|
+
}, {
|
|
11440
|
+
readonly name: "page_token";
|
|
11441
|
+
readonly type: "string";
|
|
11442
|
+
readonly required: false;
|
|
11443
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11444
|
+
}];
|
|
11445
|
+
}, {
|
|
11446
|
+
readonly resource: "ticket.tickets";
|
|
11447
|
+
readonly method: "list";
|
|
11448
|
+
readonly summary: "List tickets";
|
|
11449
|
+
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.";
|
|
11450
|
+
readonly http: "GET";
|
|
11451
|
+
readonly path: "/ticket/v1/tickets";
|
|
11452
|
+
readonly streaming: "no";
|
|
11453
|
+
readonly pagination: false;
|
|
11454
|
+
readonly pathParams: readonly [];
|
|
11455
|
+
readonly query: readonly [{
|
|
11456
|
+
readonly name: "repository";
|
|
11457
|
+
readonly type: "string";
|
|
11458
|
+
readonly required: false;
|
|
11459
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11460
|
+
}, {
|
|
11461
|
+
readonly name: "page_size";
|
|
11462
|
+
readonly type: "integer";
|
|
11463
|
+
readonly required: false;
|
|
11464
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11465
|
+
}, {
|
|
11466
|
+
readonly name: "page_token";
|
|
11467
|
+
readonly type: "string";
|
|
11468
|
+
readonly required: false;
|
|
11469
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11470
|
+
}, {
|
|
11471
|
+
readonly name: "filter";
|
|
11472
|
+
readonly type: "string";
|
|
11473
|
+
readonly required: false;
|
|
11474
|
+
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.";
|
|
11475
|
+
}];
|
|
11476
|
+
}, {
|
|
11477
|
+
readonly resource: "ticket.tickets";
|
|
11478
|
+
readonly method: "create";
|
|
11479
|
+
readonly summary: "Create or add tickets";
|
|
11480
|
+
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.";
|
|
11481
|
+
readonly http: "POST";
|
|
11482
|
+
readonly path: "/ticket/v1/tickets";
|
|
11483
|
+
readonly streaming: "no";
|
|
11484
|
+
readonly pagination: false;
|
|
11485
|
+
readonly pathParams: readonly [];
|
|
11486
|
+
readonly query: readonly [{
|
|
11487
|
+
readonly name: "repository";
|
|
11488
|
+
readonly type: "string";
|
|
11489
|
+
readonly required: false;
|
|
11490
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11491
|
+
}];
|
|
11492
|
+
readonly body: {
|
|
11493
|
+
readonly required: true;
|
|
11494
|
+
readonly fields: readonly [{
|
|
11495
|
+
readonly name: "title";
|
|
11496
|
+
readonly type: "string";
|
|
11497
|
+
readonly required: true;
|
|
11498
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11499
|
+
}, {
|
|
11500
|
+
readonly name: "body";
|
|
11501
|
+
readonly type: "string";
|
|
11502
|
+
readonly required: false;
|
|
11503
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11504
|
+
}, {
|
|
11505
|
+
readonly name: "type";
|
|
11506
|
+
readonly type: "string";
|
|
11507
|
+
readonly required: false;
|
|
11508
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11509
|
+
}, {
|
|
11510
|
+
readonly name: "labels";
|
|
11511
|
+
readonly type: "array";
|
|
11512
|
+
readonly itemType: "string";
|
|
11513
|
+
readonly required: false;
|
|
11514
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11515
|
+
}, {
|
|
11516
|
+
readonly name: "assignees";
|
|
11517
|
+
readonly type: "array";
|
|
11518
|
+
readonly itemType: "string";
|
|
11519
|
+
readonly required: false;
|
|
11520
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11521
|
+
}, {
|
|
11522
|
+
readonly name: "milestone";
|
|
11523
|
+
readonly type: "integer";
|
|
11524
|
+
readonly required: false;
|
|
11525
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11526
|
+
}, {
|
|
11527
|
+
readonly name: "parent";
|
|
11528
|
+
readonly type: "integer";
|
|
11529
|
+
readonly required: false;
|
|
11530
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11531
|
+
}];
|
|
11532
|
+
};
|
|
11533
|
+
}, {
|
|
11534
|
+
readonly resource: "ticket.tickets";
|
|
11535
|
+
readonly method: "retrieve";
|
|
11536
|
+
readonly summary: "Read tickets";
|
|
11537
|
+
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.";
|
|
11538
|
+
readonly http: "GET";
|
|
11539
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11540
|
+
readonly streaming: "no";
|
|
11541
|
+
readonly pagination: false;
|
|
11542
|
+
readonly pathParams: readonly [{
|
|
11543
|
+
readonly name: "number";
|
|
11544
|
+
readonly sdkName: "number";
|
|
11545
|
+
}];
|
|
11546
|
+
readonly query: readonly [{
|
|
11547
|
+
readonly name: "repository";
|
|
11548
|
+
readonly type: "string";
|
|
11549
|
+
readonly required: false;
|
|
11550
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11551
|
+
}];
|
|
11552
|
+
}, {
|
|
11553
|
+
readonly resource: "ticket.tickets";
|
|
11554
|
+
readonly method: "update";
|
|
11555
|
+
readonly summary: "Update tickets";
|
|
11556
|
+
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.";
|
|
11557
|
+
readonly http: "PATCH";
|
|
11558
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11559
|
+
readonly streaming: "no";
|
|
11560
|
+
readonly pagination: false;
|
|
11561
|
+
readonly pathParams: readonly [{
|
|
11562
|
+
readonly name: "number";
|
|
11563
|
+
readonly sdkName: "number";
|
|
11564
|
+
}];
|
|
11565
|
+
readonly query: readonly [{
|
|
11566
|
+
readonly name: "repository";
|
|
11567
|
+
readonly type: "string";
|
|
11568
|
+
readonly required: false;
|
|
11569
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11570
|
+
}];
|
|
11571
|
+
readonly body: {
|
|
11572
|
+
readonly required: true;
|
|
11573
|
+
readonly fields: readonly [{
|
|
11574
|
+
readonly name: "title";
|
|
11575
|
+
readonly type: "string";
|
|
11576
|
+
readonly required: false;
|
|
11577
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11578
|
+
}, {
|
|
11579
|
+
readonly name: "body";
|
|
11580
|
+
readonly type: "string";
|
|
11581
|
+
readonly required: false;
|
|
11582
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11583
|
+
}, {
|
|
11584
|
+
readonly name: "type";
|
|
11585
|
+
readonly type: "string";
|
|
11586
|
+
readonly required: false;
|
|
11587
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11588
|
+
}, {
|
|
11589
|
+
readonly name: "labels";
|
|
11590
|
+
readonly type: "array";
|
|
11591
|
+
readonly itemType: "string";
|
|
11592
|
+
readonly required: false;
|
|
11593
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11594
|
+
}, {
|
|
11595
|
+
readonly name: "assignees";
|
|
11596
|
+
readonly type: "array";
|
|
11597
|
+
readonly itemType: "string";
|
|
11598
|
+
readonly required: false;
|
|
11599
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11600
|
+
}, {
|
|
11601
|
+
readonly name: "milestone";
|
|
11602
|
+
readonly type: "integer";
|
|
11603
|
+
readonly required: false;
|
|
11604
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11605
|
+
}, {
|
|
11606
|
+
readonly name: "state";
|
|
11607
|
+
readonly type: "string";
|
|
11608
|
+
readonly enum: readonly ["open", "closed"];
|
|
11609
|
+
readonly required: false;
|
|
11610
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11611
|
+
}, {
|
|
11612
|
+
readonly name: "state_reason";
|
|
11613
|
+
readonly type: "string";
|
|
11614
|
+
readonly enum: readonly ["completed", "not_planned", "duplicate"];
|
|
11615
|
+
readonly required: false;
|
|
11616
|
+
readonly description: "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate.";
|
|
11617
|
+
}, {
|
|
11618
|
+
readonly name: "duplicate_of";
|
|
11619
|
+
readonly type: "integer";
|
|
11620
|
+
readonly required: false;
|
|
11621
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11622
|
+
}];
|
|
11623
|
+
};
|
|
11624
|
+
}, {
|
|
11625
|
+
readonly resource: "ticket.tickets.comments";
|
|
11626
|
+
readonly method: "list";
|
|
11627
|
+
readonly summary: "List comments";
|
|
11628
|
+
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.";
|
|
11629
|
+
readonly http: "GET";
|
|
11630
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11631
|
+
readonly streaming: "no";
|
|
11632
|
+
readonly pagination: false;
|
|
11633
|
+
readonly pathParams: readonly [{
|
|
11634
|
+
readonly name: "number";
|
|
11635
|
+
readonly sdkName: "number";
|
|
11636
|
+
}];
|
|
11637
|
+
readonly query: readonly [{
|
|
11638
|
+
readonly name: "repository";
|
|
11639
|
+
readonly type: "string";
|
|
11640
|
+
readonly required: false;
|
|
11641
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11642
|
+
}, {
|
|
11643
|
+
readonly name: "page_size";
|
|
11644
|
+
readonly type: "integer";
|
|
11645
|
+
readonly required: false;
|
|
11646
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11647
|
+
}, {
|
|
11648
|
+
readonly name: "page_token";
|
|
11649
|
+
readonly type: "string";
|
|
11650
|
+
readonly required: false;
|
|
11651
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11652
|
+
}];
|
|
11653
|
+
}, {
|
|
11654
|
+
readonly resource: "ticket.tickets.comments";
|
|
11655
|
+
readonly method: "create";
|
|
11656
|
+
readonly summary: "Create or add comments";
|
|
11657
|
+
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.";
|
|
11658
|
+
readonly http: "POST";
|
|
11659
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11660
|
+
readonly streaming: "no";
|
|
11661
|
+
readonly pagination: false;
|
|
11662
|
+
readonly pathParams: readonly [{
|
|
11663
|
+
readonly name: "number";
|
|
11664
|
+
readonly sdkName: "number";
|
|
11665
|
+
}];
|
|
11666
|
+
readonly query: readonly [{
|
|
11667
|
+
readonly name: "repository";
|
|
11668
|
+
readonly type: "string";
|
|
11669
|
+
readonly required: false;
|
|
11670
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11671
|
+
}];
|
|
11672
|
+
readonly body: {
|
|
11673
|
+
readonly required: true;
|
|
11674
|
+
readonly fields: readonly [{
|
|
11675
|
+
readonly name: "body";
|
|
11676
|
+
readonly type: "string";
|
|
11677
|
+
readonly required: true;
|
|
11678
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11679
|
+
}, {
|
|
11680
|
+
readonly name: "in_reply_to";
|
|
11681
|
+
readonly type: "string";
|
|
11682
|
+
readonly required: false;
|
|
11683
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11684
|
+
}];
|
|
11685
|
+
};
|
|
11686
|
+
}, {
|
|
11687
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11688
|
+
readonly method: "retrieveBlockedBy";
|
|
11689
|
+
readonly summary: "List blocked by";
|
|
11690
|
+
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.";
|
|
11691
|
+
readonly http: "GET";
|
|
11692
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11693
|
+
readonly streaming: "no";
|
|
11694
|
+
readonly pagination: false;
|
|
11695
|
+
readonly pathParams: readonly [{
|
|
11696
|
+
readonly name: "number";
|
|
11697
|
+
readonly sdkName: "number";
|
|
11698
|
+
}];
|
|
11699
|
+
readonly query: readonly [{
|
|
11700
|
+
readonly name: "repository";
|
|
11701
|
+
readonly type: "string";
|
|
11702
|
+
readonly required: false;
|
|
11703
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11704
|
+
}, {
|
|
11705
|
+
readonly name: "page_size";
|
|
11706
|
+
readonly type: "integer";
|
|
11707
|
+
readonly required: false;
|
|
11708
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11709
|
+
}, {
|
|
11710
|
+
readonly name: "page_token";
|
|
11711
|
+
readonly type: "string";
|
|
11712
|
+
readonly required: false;
|
|
11713
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11714
|
+
}];
|
|
11715
|
+
}, {
|
|
11716
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11717
|
+
readonly method: "create";
|
|
11718
|
+
readonly summary: "Create or add blocked by";
|
|
11719
|
+
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.";
|
|
11720
|
+
readonly http: "POST";
|
|
11721
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
11722
|
+
readonly streaming: "no";
|
|
11723
|
+
readonly pagination: false;
|
|
11724
|
+
readonly pathParams: readonly [{
|
|
11725
|
+
readonly name: "number";
|
|
11726
|
+
readonly sdkName: "number";
|
|
11727
|
+
}];
|
|
11728
|
+
readonly query: readonly [{
|
|
11729
|
+
readonly name: "repository";
|
|
11730
|
+
readonly type: "string";
|
|
11731
|
+
readonly required: false;
|
|
11732
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11733
|
+
}];
|
|
11734
|
+
readonly body: {
|
|
11735
|
+
readonly required: true;
|
|
11736
|
+
readonly fields: readonly [{
|
|
11737
|
+
readonly name: "blocked_by";
|
|
11738
|
+
readonly type: "integer";
|
|
11739
|
+
readonly required: true;
|
|
11740
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11741
|
+
}];
|
|
11742
|
+
};
|
|
11743
|
+
}, {
|
|
11744
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
11745
|
+
readonly method: "delete";
|
|
11746
|
+
readonly summary: "Remove blocked by";
|
|
11747
|
+
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.";
|
|
11748
|
+
readonly http: "DELETE";
|
|
11749
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}";
|
|
11750
|
+
readonly streaming: "no";
|
|
11751
|
+
readonly pagination: false;
|
|
11752
|
+
readonly pathParams: readonly [{
|
|
11753
|
+
readonly name: "number";
|
|
11754
|
+
readonly sdkName: "number";
|
|
11755
|
+
}, {
|
|
11756
|
+
readonly name: "n";
|
|
11757
|
+
readonly sdkName: "n";
|
|
11758
|
+
}];
|
|
11759
|
+
readonly query: readonly [{
|
|
11760
|
+
readonly name: "repository";
|
|
11761
|
+
readonly type: "string";
|
|
11762
|
+
readonly required: false;
|
|
11763
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11764
|
+
}];
|
|
11765
|
+
}, {
|
|
11766
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
11767
|
+
readonly method: "retrieveBlocking";
|
|
11768
|
+
readonly summary: "List blocking";
|
|
11769
|
+
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.";
|
|
11770
|
+
readonly http: "GET";
|
|
11771
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocking";
|
|
11772
|
+
readonly streaming: "no";
|
|
11773
|
+
readonly pagination: false;
|
|
11774
|
+
readonly pathParams: readonly [{
|
|
11775
|
+
readonly name: "number";
|
|
11776
|
+
readonly sdkName: "number";
|
|
11777
|
+
}];
|
|
11778
|
+
readonly query: readonly [{
|
|
11779
|
+
readonly name: "repository";
|
|
11780
|
+
readonly type: "string";
|
|
11781
|
+
readonly required: false;
|
|
11782
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11783
|
+
}, {
|
|
11784
|
+
readonly name: "page_size";
|
|
11785
|
+
readonly type: "integer";
|
|
11786
|
+
readonly required: false;
|
|
11787
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11788
|
+
}, {
|
|
11789
|
+
readonly name: "page_token";
|
|
11790
|
+
readonly type: "string";
|
|
11791
|
+
readonly required: false;
|
|
11792
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11793
|
+
}];
|
|
11794
|
+
}, {
|
|
11795
|
+
readonly resource: "ticket.tickets.events";
|
|
11796
|
+
readonly method: "list";
|
|
11797
|
+
readonly summary: "List events";
|
|
11798
|
+
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.";
|
|
11799
|
+
readonly http: "GET";
|
|
11800
|
+
readonly path: "/ticket/v1/tickets/{number}/events";
|
|
11801
|
+
readonly streaming: "no";
|
|
11802
|
+
readonly pagination: false;
|
|
11803
|
+
readonly pathParams: readonly [{
|
|
11804
|
+
readonly name: "number";
|
|
11805
|
+
readonly sdkName: "number";
|
|
11806
|
+
}];
|
|
11807
|
+
readonly query: readonly [{
|
|
11808
|
+
readonly name: "repository";
|
|
11809
|
+
readonly type: "string";
|
|
11810
|
+
readonly required: false;
|
|
11811
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11812
|
+
}, {
|
|
11813
|
+
readonly name: "page_size";
|
|
11814
|
+
readonly type: "integer";
|
|
11815
|
+
readonly required: false;
|
|
11816
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11817
|
+
}, {
|
|
11818
|
+
readonly name: "page_token";
|
|
11819
|
+
readonly type: "string";
|
|
11820
|
+
readonly required: false;
|
|
11821
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11822
|
+
}];
|
|
11823
|
+
}, {
|
|
11824
|
+
readonly resource: "ticket.tickets";
|
|
11825
|
+
readonly method: "deleteLock";
|
|
11826
|
+
readonly summary: "Remove lock";
|
|
11827
|
+
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.";
|
|
11828
|
+
readonly http: "DELETE";
|
|
11829
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
11830
|
+
readonly streaming: "no";
|
|
11831
|
+
readonly pagination: false;
|
|
11832
|
+
readonly pathParams: readonly [{
|
|
11833
|
+
readonly name: "number";
|
|
11834
|
+
readonly sdkName: "number";
|
|
11835
|
+
}];
|
|
11836
|
+
readonly query: readonly [{
|
|
11837
|
+
readonly name: "repository";
|
|
11838
|
+
readonly type: "string";
|
|
11839
|
+
readonly required: false;
|
|
11840
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11841
|
+
}];
|
|
11842
|
+
}, {
|
|
11843
|
+
readonly resource: "ticket.tickets";
|
|
11844
|
+
readonly method: "updateLock";
|
|
11845
|
+
readonly summary: "Update lock";
|
|
11846
|
+
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.";
|
|
11847
|
+
readonly http: "PUT";
|
|
11848
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
11849
|
+
readonly streaming: "no";
|
|
11850
|
+
readonly pagination: false;
|
|
11851
|
+
readonly pathParams: readonly [{
|
|
11852
|
+
readonly name: "number";
|
|
11853
|
+
readonly sdkName: "number";
|
|
11854
|
+
}];
|
|
11855
|
+
readonly query: readonly [{
|
|
11856
|
+
readonly name: "repository";
|
|
11857
|
+
readonly type: "string";
|
|
11858
|
+
readonly required: false;
|
|
11859
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11860
|
+
}];
|
|
11861
|
+
readonly body: {
|
|
11862
|
+
readonly required: false;
|
|
11863
|
+
readonly fields: readonly [{
|
|
11864
|
+
readonly name: "lock_reason";
|
|
11865
|
+
readonly type: "string";
|
|
11866
|
+
readonly enum: readonly ["off-topic", "too heated", "resolved", "spam"];
|
|
11867
|
+
readonly required: false;
|
|
11868
|
+
readonly description: "Reason for locking: off-topic, too heated, resolved, or spam.";
|
|
11869
|
+
}];
|
|
11870
|
+
};
|
|
11871
|
+
}, {
|
|
11872
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11873
|
+
readonly method: "list";
|
|
11874
|
+
readonly summary: "List reactions";
|
|
11875
|
+
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.";
|
|
11876
|
+
readonly http: "GET";
|
|
11877
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
11878
|
+
readonly streaming: "no";
|
|
11879
|
+
readonly pagination: false;
|
|
11880
|
+
readonly pathParams: readonly [{
|
|
11881
|
+
readonly name: "number";
|
|
11882
|
+
readonly sdkName: "number";
|
|
11883
|
+
}];
|
|
11884
|
+
readonly query: readonly [{
|
|
11885
|
+
readonly name: "repository";
|
|
11886
|
+
readonly type: "string";
|
|
11887
|
+
readonly required: false;
|
|
11888
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11889
|
+
}, {
|
|
11890
|
+
readonly name: "page_size";
|
|
11891
|
+
readonly type: "integer";
|
|
11892
|
+
readonly required: false;
|
|
11893
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11894
|
+
}, {
|
|
11895
|
+
readonly name: "page_token";
|
|
11896
|
+
readonly type: "string";
|
|
11897
|
+
readonly required: false;
|
|
11898
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11899
|
+
}];
|
|
11900
|
+
}, {
|
|
11901
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11902
|
+
readonly method: "create";
|
|
11903
|
+
readonly summary: "Create or add reactions";
|
|
11904
|
+
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.";
|
|
11905
|
+
readonly http: "POST";
|
|
11906
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
11907
|
+
readonly streaming: "no";
|
|
11908
|
+
readonly pagination: false;
|
|
11909
|
+
readonly pathParams: readonly [{
|
|
11910
|
+
readonly name: "number";
|
|
11911
|
+
readonly sdkName: "number";
|
|
11912
|
+
}];
|
|
11913
|
+
readonly query: readonly [{
|
|
11914
|
+
readonly name: "repository";
|
|
11915
|
+
readonly type: "string";
|
|
11916
|
+
readonly required: false;
|
|
11917
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11918
|
+
}];
|
|
11919
|
+
readonly body: {
|
|
11920
|
+
readonly required: true;
|
|
11921
|
+
readonly fields: readonly [{
|
|
11922
|
+
readonly name: "content";
|
|
11923
|
+
readonly type: "string";
|
|
11924
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11925
|
+
readonly required: true;
|
|
11926
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11927
|
+
}];
|
|
11928
|
+
};
|
|
11929
|
+
}, {
|
|
11930
|
+
readonly resource: "ticket.tickets.reactions";
|
|
11931
|
+
readonly method: "delete";
|
|
11932
|
+
readonly summary: "Remove reactions";
|
|
11933
|
+
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.";
|
|
11934
|
+
readonly http: "DELETE";
|
|
11935
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions/{content}";
|
|
11936
|
+
readonly streaming: "no";
|
|
11937
|
+
readonly pagination: false;
|
|
11938
|
+
readonly pathParams: readonly [{
|
|
11939
|
+
readonly name: "number";
|
|
11940
|
+
readonly sdkName: "number";
|
|
11941
|
+
}, {
|
|
11942
|
+
readonly name: "content";
|
|
11943
|
+
readonly sdkName: "content";
|
|
11944
|
+
}];
|
|
11945
|
+
readonly query: readonly [{
|
|
11946
|
+
readonly name: "repository";
|
|
11947
|
+
readonly type: "string";
|
|
11948
|
+
readonly required: false;
|
|
11949
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11950
|
+
}];
|
|
11951
|
+
}, {
|
|
11952
|
+
readonly resource: "ticket.tickets.relations";
|
|
11953
|
+
readonly method: "list";
|
|
11954
|
+
readonly summary: "List relations";
|
|
11955
|
+
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.";
|
|
11956
|
+
readonly http: "GET";
|
|
11957
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
11958
|
+
readonly streaming: "no";
|
|
11959
|
+
readonly pagination: false;
|
|
11960
|
+
readonly pathParams: readonly [{
|
|
11961
|
+
readonly name: "number";
|
|
11962
|
+
readonly sdkName: "number";
|
|
11963
|
+
}];
|
|
11964
|
+
readonly query: readonly [{
|
|
11965
|
+
readonly name: "repository";
|
|
11966
|
+
readonly type: "string";
|
|
11967
|
+
readonly required: false;
|
|
11968
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11969
|
+
}, {
|
|
11970
|
+
readonly name: "page_size";
|
|
11971
|
+
readonly type: "integer";
|
|
11972
|
+
readonly required: false;
|
|
11973
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11974
|
+
}, {
|
|
11975
|
+
readonly name: "page_token";
|
|
11976
|
+
readonly type: "string";
|
|
11977
|
+
readonly required: false;
|
|
11978
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11979
|
+
}];
|
|
11980
|
+
}, {
|
|
11981
|
+
readonly resource: "ticket.tickets.relations";
|
|
11982
|
+
readonly method: "create";
|
|
11983
|
+
readonly summary: "Create or add relations";
|
|
11984
|
+
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.";
|
|
11985
|
+
readonly http: "POST";
|
|
11986
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
11987
|
+
readonly streaming: "no";
|
|
11988
|
+
readonly pagination: false;
|
|
11989
|
+
readonly pathParams: readonly [{
|
|
11990
|
+
readonly name: "number";
|
|
11991
|
+
readonly sdkName: "number";
|
|
11992
|
+
}];
|
|
11993
|
+
readonly query: readonly [{
|
|
11994
|
+
readonly name: "repository";
|
|
11995
|
+
readonly type: "string";
|
|
11996
|
+
readonly required: false;
|
|
11997
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11998
|
+
}];
|
|
11999
|
+
readonly body: {
|
|
12000
|
+
readonly required: true;
|
|
12001
|
+
readonly fields: readonly [{
|
|
12002
|
+
readonly name: "relates_to";
|
|
12003
|
+
readonly type: "integer";
|
|
12004
|
+
readonly required: true;
|
|
12005
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12006
|
+
}];
|
|
12007
|
+
};
|
|
12008
|
+
}, {
|
|
12009
|
+
readonly resource: "ticket.tickets.relations";
|
|
12010
|
+
readonly method: "delete";
|
|
12011
|
+
readonly summary: "Remove relations";
|
|
12012
|
+
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.";
|
|
12013
|
+
readonly http: "DELETE";
|
|
12014
|
+
readonly path: "/ticket/v1/tickets/{number}/relations/{n}";
|
|
12015
|
+
readonly streaming: "no";
|
|
12016
|
+
readonly pagination: false;
|
|
12017
|
+
readonly pathParams: readonly [{
|
|
12018
|
+
readonly name: "number";
|
|
12019
|
+
readonly sdkName: "number";
|
|
12020
|
+
}, {
|
|
12021
|
+
readonly name: "n";
|
|
12022
|
+
readonly sdkName: "n";
|
|
12023
|
+
}];
|
|
12024
|
+
readonly query: readonly [{
|
|
12025
|
+
readonly name: "repository";
|
|
12026
|
+
readonly type: "string";
|
|
12027
|
+
readonly required: false;
|
|
12028
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12029
|
+
}];
|
|
12030
|
+
}, {
|
|
12031
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12032
|
+
readonly method: "list";
|
|
12033
|
+
readonly summary: "List sub tickets";
|
|
12034
|
+
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.";
|
|
12035
|
+
readonly http: "GET";
|
|
12036
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12037
|
+
readonly streaming: "no";
|
|
12038
|
+
readonly pagination: false;
|
|
12039
|
+
readonly pathParams: readonly [{
|
|
12040
|
+
readonly name: "number";
|
|
12041
|
+
readonly sdkName: "number";
|
|
12042
|
+
}];
|
|
12043
|
+
readonly query: readonly [{
|
|
12044
|
+
readonly name: "repository";
|
|
12045
|
+
readonly type: "string";
|
|
12046
|
+
readonly required: false;
|
|
12047
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12048
|
+
}, {
|
|
12049
|
+
readonly name: "page_size";
|
|
12050
|
+
readonly type: "integer";
|
|
12051
|
+
readonly required: false;
|
|
12052
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12053
|
+
}, {
|
|
12054
|
+
readonly name: "page_token";
|
|
12055
|
+
readonly type: "string";
|
|
12056
|
+
readonly required: false;
|
|
12057
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12058
|
+
}];
|
|
12059
|
+
}, {
|
|
12060
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12061
|
+
readonly method: "create";
|
|
12062
|
+
readonly summary: "Create or add sub tickets";
|
|
12063
|
+
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.";
|
|
12064
|
+
readonly http: "POST";
|
|
12065
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12066
|
+
readonly streaming: "no";
|
|
12067
|
+
readonly pagination: false;
|
|
12068
|
+
readonly pathParams: readonly [{
|
|
12069
|
+
readonly name: "number";
|
|
12070
|
+
readonly sdkName: "number";
|
|
12071
|
+
}];
|
|
12072
|
+
readonly query: readonly [{
|
|
12073
|
+
readonly name: "repository";
|
|
12074
|
+
readonly type: "string";
|
|
12075
|
+
readonly required: false;
|
|
12076
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12077
|
+
}];
|
|
12078
|
+
readonly body: {
|
|
12079
|
+
readonly required: true;
|
|
12080
|
+
readonly fields: readonly [{
|
|
12081
|
+
readonly name: "child";
|
|
12082
|
+
readonly type: "integer";
|
|
12083
|
+
readonly required: true;
|
|
12084
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12085
|
+
}, {
|
|
12086
|
+
readonly name: "replace_parent";
|
|
12087
|
+
readonly type: "boolean";
|
|
12088
|
+
readonly required: false;
|
|
12089
|
+
readonly description: "Allow replacing an existing parent.";
|
|
12090
|
+
}];
|
|
12091
|
+
};
|
|
12092
|
+
}, {
|
|
12093
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12094
|
+
readonly method: "delete";
|
|
12095
|
+
readonly summary: "Remove sub tickets";
|
|
12096
|
+
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.";
|
|
12097
|
+
readonly http: "DELETE";
|
|
12098
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets/{child}";
|
|
12099
|
+
readonly streaming: "no";
|
|
12100
|
+
readonly pagination: false;
|
|
12101
|
+
readonly pathParams: readonly [{
|
|
12102
|
+
readonly name: "number";
|
|
12103
|
+
readonly sdkName: "number";
|
|
12104
|
+
}, {
|
|
12105
|
+
readonly name: "child";
|
|
12106
|
+
readonly sdkName: "child";
|
|
12107
|
+
}];
|
|
12108
|
+
readonly query: readonly [{
|
|
12109
|
+
readonly name: "repository";
|
|
12110
|
+
readonly type: "string";
|
|
12111
|
+
readonly required: false;
|
|
12112
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12113
|
+
}];
|
|
12114
|
+
}, {
|
|
12115
|
+
readonly resource: "ticket.types";
|
|
12116
|
+
readonly method: "list";
|
|
12117
|
+
readonly summary: "Read types";
|
|
12118
|
+
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.";
|
|
12119
|
+
readonly http: "GET";
|
|
12120
|
+
readonly path: "/ticket/v1/types";
|
|
12121
|
+
readonly streaming: "no";
|
|
12122
|
+
readonly pagination: false;
|
|
12123
|
+
readonly pathParams: readonly [];
|
|
12124
|
+
readonly query: readonly [{
|
|
12125
|
+
readonly name: "repository";
|
|
12126
|
+
readonly type: "string";
|
|
12127
|
+
readonly required: false;
|
|
12128
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12129
|
+
}];
|
|
10962
12130
|
}, {
|
|
10963
12131
|
readonly resource: "vault.authorizations";
|
|
10964
12132
|
readonly method: "create";
|